feat: allow unsupported syntax (#171)

* Add syntax-forgiving debug parameter to allow/disallow unsupported syntax
* Add silence-test-output debug parameter to enable/disable test output to console
* Move constant pool code from launcher to root context
* Add common abstract factory for all analysis factories

Author: dstallenberg

libraries/analysis-javascript/index.ts

@@ -22,6 +22,7 @@ export * from "./lib/cfg/ControlFlowGraphFactory";
 export * from "./lib/cfg/ControlFlowGraphVisitor";
 
 export * from "./lib/constant/ConstantPool";
+export * from "./lib/constant/ConstantPoolFactory";
 export * from "./lib/constant/ConstantPoolManager";
 export * from "./lib/constant/ConstantVisitor";
 

libraries/analysis-javascript/lib/Factory.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2020-2023 Delft University of Technology and SynTest contributors
+ *
+ * This file is part of SynTest Framework - SynTest JavaScript.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export class Factory {
+  private _syntaxForgiving: boolean;
+
+  constructor(syntaxForgiving: boolean) {
+    this._syntaxForgiving = syntaxForgiving;
+  }
+
+  get syntaxForgiving() {
+    return this._syntaxForgiving;
+  }
+}

libraries/analysis-javascript/lib/RootContext.ts

@@ -37,12 +37,20 @@ import { Relation } from "./type/discovery/relation/Relation";
 import { TypePool } from "./type/resolving/TypePool";
 import TypedEmitter from "typed-emitter";
 import { Events } from "./Events";
+import { ConstantPoolManager } from "./constant/ConstantPoolManager";
+import { Logger, getLogger } from "@syntest/logging";
+import { ConstantPoolFactory } from "./constant/ConstantPoolFactory";
+import { ConstantPool } from "./constant/ConstantPool";
 
 export class RootContext extends CoreRootContext<t.Node> {
+  protected static LOGGER: Logger;
+
   protected _exportFactory: ExportFactory;
   protected _typeExtractor: TypeExtractor;
   protected _typeResolver: TypeModelFactory;
 
+  protected _constantPoolFactory: ConstantPoolFactory;
+
   protected _files: string[];
   // filepath -> id -> element
   protected _elementMap: Map<string, Map<string, Element>>;
@@ -65,7 +73,8 @@ export class RootContext extends CoreRootContext<t.Node> {
     dependencyFactory: DependencyFactory,
     exportFactory: ExportFactory,
     typeExtractor: TypeExtractor,
-    typeResolver: TypeModelFactory
+    typeResolver: TypeModelFactory,
+    constantPoolFactory: ConstantPoolFactory
   ) {
     super(
       rootPath,
@@ -75,9 +84,11 @@ export class RootContext extends CoreRootContext<t.Node> {
       targetFactory,
       dependencyFactory
     );
+    RootContext.LOGGER = getLogger("RootContext");
     this._exportFactory = exportFactory;
     this._typeExtractor = typeExtractor;
     this._typeResolver = typeResolver;
+    this._constantPoolFactory = constantPoolFactory;
   }
 
   get rootPath(): string {
@@ -317,4 +328,39 @@ export class RootContext extends CoreRootContext<t.Node> {
 
     return this._typePool;
   }
+
+  // TODO cache
+  private _getContextConstantPool(): ConstantPool {
+    const constantPool = new ConstantPool();
+    for (const filepath of this.getFiles()) {
+      const ast = this.getAbstractSyntaxTree(filepath);
+      this._constantPoolFactory.extract(filepath, ast, constantPool);
+    }
+
+    return constantPool;
+  }
+
+  // TODO cache
+  getConstantPoolManager(filepath: string): ConstantPoolManager {
+    const absolutePath = this.resolvePath(filepath);
+
+    RootContext.LOGGER.info("Extracting constants");
+    const ast = this.getAbstractSyntaxTree(absolutePath);
+
+    const targetConstantPool = this._constantPoolFactory.extract(
+      absolutePath,
+      ast
+    );
+    const contextConstantPool = this._getContextConstantPool();
+    const dynamicConstantPool = new ConstantPool();
+
+    const constantPoolManager = new ConstantPoolManager(
+      targetConstantPool,
+      contextConstantPool,
+      dynamicConstantPool
+    );
+
+    RootContext.LOGGER.info("Extracting constants done");
+    return constantPoolManager;
+  }
 }

libraries/analysis-javascript/lib/cfg/ControlFlowGraphFactory.ts

@@ -21,12 +21,14 @@ import { ControlFlowGraphFactory as CoreControlFlowGraphFactory } from "@syntest
 import { ControlFlowProgram, contractControlFlowProgram } from "@syntest/cfg";
 
 import { ControlFlowGraphVisitor } from "./ControlFlowGraphVisitor";
+import { Factory } from "../Factory";
 
 export class ControlFlowGraphFactory
+  extends Factory
   implements CoreControlFlowGraphFactory<t.Node>
 {
   convert(filePath: string, AST: t.Node): ControlFlowProgram {
-    const visitor = new ControlFlowGraphVisitor(filePath);
+    const visitor = new ControlFlowGraphVisitor(filePath, this.syntaxForgiving);
     traverse(AST, visitor);
 
     return contractControlFlowProgram(visitor.cfg);

libraries/analysis-javascript/lib/cfg/ControlFlowGraphVisitor.ts

@@ -127,8 +127,8 @@ export class ControlFlowGraphVisitor extends AbstractSyntaxTreeVisitor {
     };
   }
 
-  constructor(filePath: string) {
-    super(filePath);
+  constructor(filePath: string, syntaxForgiving: boolean) {
+    super(filePath, syntaxForgiving);
     ControlFlowGraphVisitor.LOGGER = getLogger("ControlFlowGraphVisitor");
 
     this._nodesList = [];
@@ -365,7 +365,10 @@ export class ControlFlowGraphVisitor extends AbstractSyntaxTreeVisitor {
       this._currentParents = [node.id];
     }
 
-    const subVisitor = new ControlFlowGraphVisitor(this.filePath);
+    const subVisitor = new ControlFlowGraphVisitor(
+      this.filePath,
+      this.syntaxForgiving
+    );
     path.traverse(subVisitor);
 
     if (!subVisitor._nodes.has("ENTRY")) {

libraries/analysis-javascript/lib/constant/ConstantPoolFactory.ts

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2020-2023 Delft University of Technology and SynTest contributors
+ *
+ * This file is part of SynTest Framework - SynTest JavaScript.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { traverse } from "@babel/core";
+import * as t from "@babel/types";
+
+import { Factory } from "../Factory";
+import { ConstantVisitor } from "./ConstantVisitor";
+import { ConstantPool } from "./ConstantPool";
+
+export class ConstantPoolFactory extends Factory {
+  /**
+   * Generate function map for specified target.
+   *
+   * @param AST The AST of the target
+   */
+  extract(
+    filePath: string,
+    AST: t.Node,
+    constantPool?: ConstantPool | undefined
+  ): ConstantPool {
+    if (!constantPool) {
+      constantPool = new ConstantPool();
+    }
+    const constantVisitor = new ConstantVisitor(
+      filePath,
+      this.syntaxForgiving,
+      constantPool
+    );
+    traverse(AST, constantVisitor);
+
+    return constantPool;
+  }
+}

libraries/analysis-javascript/lib/constant/ConstantPoolManager.ts

@@ -23,10 +23,14 @@ export class ConstantPoolManager {
   protected _contextConstantPool: ConstantPool;
   protected _dynamicConstantPool: ConstantPool;
 
-  constructor() {
-    this._targetConstantPool = new ConstantPool();
-    this._contextConstantPool = new ConstantPool();
-    this._dynamicConstantPool = new ConstantPool();
+  constructor(
+    targetConstantPool: ConstantPool,
+    contextConstantPool: ConstantPool,
+    dynamicConstantPool: ConstantPool
+  ) {
+    this._targetConstantPool = targetConstantPool;
+    this._contextConstantPool = contextConstantPool;
+    this._dynamicConstantPool = dynamicConstantPool;
   }
 
   public get targetConstantPool(): ConstantPool {

libraries/analysis-javascript/lib/constant/ConstantVisitor.ts

@@ -23,8 +23,16 @@ import { ConstantPool } from "./ConstantPool";
 export class ConstantVisitor extends AbstractSyntaxTreeVisitor {
   protected _constantPool: ConstantPool;
 
-  constructor(filePath: string, constantPool: ConstantPool) {
-    super(filePath);
+  get constantPool() {
+    return this._constantPool;
+  }
+
+  constructor(
+    filePath: string,
+    syntaxForgiving: boolean,
+    constantPool: ConstantPool
+  ) {
+    super(filePath, syntaxForgiving);
     this._constantPool = constantPool;
   }
 

libraries/analysis-javascript/lib/dependency/DependencyFactory.ts

@@ -21,20 +21,24 @@ import * as t from "@babel/types";
 import { DependencyFactory as CoreDependencyFactory } from "@syntest/analysis";
 
 import { DependencyVisitor } from "./DependencyVisitor";
+import { Factory } from "../Factory";
 
 /**
  * Dependency generator for targets.
  *
  * @author Dimitri Stallenberg
  */
-export class DependencyFactory implements CoreDependencyFactory<t.Node> {
+export class DependencyFactory
+  extends Factory
+  implements CoreDependencyFactory<t.Node>
+{
   /**
    * Generate function map for specified target.
    *
    * @param AST The AST of the target
    */
   extract(filePath: string, AST: t.Node): string[] {
-    const visitor = new DependencyVisitor(filePath);
+    const visitor = new DependencyVisitor(filePath, this.syntaxForgiving);
 
     traverse(AST, visitor);
 

libraries/analysis-javascript/lib/dependency/DependencyVisitor.ts

@@ -26,8 +26,8 @@ export class DependencyVisitor extends AbstractSyntaxTreeVisitor {
 
   private _imports: Set<string>;
 
-  constructor(filePath: string) {
-    super(filePath);
+  constructor(filePath: string, syntaxForgiving: boolean) {
+    super(filePath, syntaxForgiving);
     DependencyVisitor.LOGGER = getLogger("DependencyVisitor");
     this._imports = new Set<string>();
   }