feat: update to new syntest-core api (#175)

Removes "_conditionAST" everywhere
Passes the entire error object from failing tests instead of just the message
Renames some functions

Author: dstallenberg

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

@@ -28,11 +28,10 @@ import {
   Node,
   NodeType,
 } from "@syntest/cfg";
-import { getLogger } from "@syntest/logging";
+import { Logger, getLogger } from "@syntest/logging";
 
 export class ControlFlowGraphVisitor extends AbstractSyntaxTreeVisitor {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  protected static override LOGGER: any;
+  protected static override LOGGER: Logger;
 
   private _nodesList: Node[];
   private _nodes: Map<string, Node>;
@@ -300,29 +299,6 @@ export class ControlFlowGraphVisitor extends AbstractSyntaxTreeVisitor {
     return node;
   }
 
-  // private _isSpecial(path: NodePath): boolean {
-  //   return (
-  //     path.isFunction() ||
-  //     path.isClass() ||
-  //     path.isConditional() ||
-  //     path.isLoop() ||
-  //     path.isBlock() ||
-  //     // terminating statements
-  //     path.isBreakStatement() ||
-  //     path.isContinueStatement() ||
-  //     path.isReturnStatement() ||
-  //     path.isThrowStatement() ||
-  //     // exports
-  //     path.isExportAllDeclaration() ||
-  //     path.isExportDeclaration() ||
-  //     path.isExportDefaultDeclaration() ||
-  //     path.isExportDefaultSpecifier() ||
-  //     path.isExportNamedDeclaration() ||
-  //     path.isExportNamespaceSpecifier() ||
-  //     path.isExportSpecifier()
-  //   );
-  // }
-
   private _createEdge(
     source: Node,
     target: Node,

libraries/instrumentation-javascript/lib/instrumentation/VisitState.ts

@@ -367,10 +367,6 @@ export class VisitState {
     const metaTracker = T.callExpression(T.identifier(this.metaVarName), [
       T.stringLiteral(`${branchName}`),
       T.objectExpression([
-        T.objectProperty(
-          T.stringLiteral("condition_ast"),
-          T.stringLiteral("TODO we should remove the condition asts entirely")
-        ),
         T.objectProperty(
           T.stringLiteral("condition"),
           T.stringLiteral(testAsCode)

libraries/instrumentation-javascript/package.json

@@ -46,10 +46,10 @@
     "test:watch": "mocha --config ../../.mocharc.json --watch"
   },
   "dependencies": {
+    "@syntest/analysis-javascript": "^0.1.0-beta.20",
     "@babel/core": "7.20.12",
     "@babel/traverse": "7.20.12",
     "@istanbuljs/schema": "^0.1.3",
-    "@syntest/analysis-javascript": "^0.1.0-beta.20",
     "@syntest/ast-visitor-javascript": "*",
     "@syntest/storage": "*",
     "istanbul-lib-coverage": "^3.2.0"

libraries/search-javascript/lib/criterion/BranchDistance.ts

@@ -38,7 +38,6 @@ export class BranchDistance extends CoreBranchDistance {
   }
 
   calculate(
-    _conditionAST: string, // deprecated
     condition: string,
     variables: Record<string, unknown>,
     trueOrFalse: boolean

libraries/search-javascript/lib/search/JavaScriptExecutionResult.ts

@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 
-import { Datapoint, ExecutionResult } from "@syntest/search";
+import { Trace, ExecutionResult } from "@syntest/search";
 
 export enum JavaScriptExecutionStatus {
   PASSED,
@@ -42,7 +42,7 @@ export class JavaScriptExecutionResult implements ExecutionResult {
    * ARRAY of traces of the execution.
    * @protected
    */
-  protected _traces: Datapoint[];
+  protected _traces: Trace[];
 
   /**
    * Duration of the execution.
@@ -51,10 +51,10 @@ export class JavaScriptExecutionResult implements ExecutionResult {
   protected _duration: number;
 
   /**
-   * Exception of execution.
+   * Error of execution.
    * @protected
    */
-  protected _exception: string;
+  protected _error: Error | undefined;
 
   /**
    * Constructor.
@@ -66,14 +66,14 @@ export class JavaScriptExecutionResult implements ExecutionResult {
    */
   public constructor(
     status: JavaScriptExecutionStatus,
-    traces: Datapoint[],
+    traces: Trace[],
     duration: number,
-    exception?: string | undefined
+    error?: Error | undefined
   ) {
     this._status = status;
     this._traces = traces;
     this._duration = duration;
-    this._exception = exception;
+    this._error = error;
   }
 
   /**
@@ -132,22 +132,22 @@ export class JavaScriptExecutionResult implements ExecutionResult {
   /**
    * @inheritDoc
    */
-  public getExceptions(): string {
-    return this._exception;
+  public getError(): Error {
+    return this._error;
   }
 
   /**
    * @inheritDoc
    */
-  public getTraces(): Datapoint[] {
+  public getTraces(): Trace[] {
     return this._traces;
   }
 
   /**
    * @inheritDoc
    */
-  public hasExceptions(): boolean {
-    return this._exception !== null && this._exception !== undefined;
+  public hasError(): boolean {
+    return this._error !== null && this._error !== undefined;
   }
 
   /**

libraries/search-javascript/lib/testcase/execution/ExecutionInformationIntegrator.ts

@@ -42,7 +42,11 @@ export class ExecutionInformationIntegrator {
       const children = root.getChildren();
 
       for (const child of children) {
-        if (testResult.exception && testResult.exception.includes(child.name)) {
+        if (
+          testResult.error &&
+          testResult.error.message &&
+          testResult.error.message.includes(child.name)
+        ) {
           this._typeModel.addExecutionScore(
             child.variableIdentifier,
             child.typeIdentifier,

libraries/search-javascript/lib/testcase/execution/JavaScriptRunner.ts

@@ -18,7 +18,7 @@
 
 import * as path from "node:path";
 
-import { Datapoint, EncodingRunner, ExecutionResult } from "@syntest/search";
+import { Trace, EncodingRunner, ExecutionResult } from "@syntest/search";
 import { getLogger, Logger } from "@syntest/logging";
 
 import {
@@ -112,7 +112,6 @@ export class JavaScriptRunner implements EncodingRunner<JavaScriptTestCase> {
         if (data.message === "done") {
           childProcess.removeAllListeners();
           clearTimeout(timeout);
-
           if (!data.instrumentationData) {
             return reject("no instrumentation data found");
           }
@@ -161,7 +160,7 @@ export class JavaScriptRunner implements EncodingRunner<JavaScriptTestCase> {
       // If one of the executions failed, log it
       this.executionInformationIntegrator.process(testCase, test, stats);
 
-      const traces: Datapoint[] = this._extractTraces(
+      const traces: Trace[] = this._extractTraces(
         instrumentationData,
         metaData
       );
@@ -171,7 +170,7 @@ export class JavaScriptRunner implements EncodingRunner<JavaScriptTestCase> {
         test.status,
         traces,
         test.duration,
-        test.exception
+        test.error
       );
     } catch (error) {
       if (error === "timeout") {
@@ -201,8 +200,8 @@ export class JavaScriptRunner implements EncodingRunner<JavaScriptTestCase> {
   private _extractTraces(
     instrumentationData: InstrumentationData,
     metaData: MetaData
-  ): Datapoint[] {
-    const traces: Datapoint[] = [];
+  ): Trace[] {
+    const traces: Trace[] = [];
 
     for (const key of Object.keys(instrumentationData)) {
       for (const functionKey of Object.keys(instrumentationData[key].fnMap)) {
@@ -254,7 +253,6 @@ export class JavaScriptRunner implements EncodingRunner<JavaScriptTestCase> {
 
           hits: hits[0],
 
-          condition_ast: meta?.condition_ast,
           condition: meta?.condition,
           variables: meta?.variables,
         });
@@ -273,7 +271,6 @@ export class JavaScriptRunner implements EncodingRunner<JavaScriptTestCase> {
 
               hits: hits[index],
 
-              condition_ast: meta?.condition_ast,
               condition: meta?.condition,
               variables: meta?.variables,
             });
@@ -289,7 +286,6 @@ export class JavaScriptRunner implements EncodingRunner<JavaScriptTestCase> {
 
             hits: hits[1],
 
-            condition_ast: meta?.condition_ast,
             condition: meta?.condition,
             variables: meta?.variables,
           });
@@ -306,7 +302,6 @@ export class JavaScriptRunner implements EncodingRunner<JavaScriptTestCase> {
 
             hits: hits[0] ? 0 : 1,
 
-            condition_ast: meta?.condition_ast,
             condition: meta?.condition,
             variables: meta?.variables,
           });

libraries/search-javascript/lib/testcase/execution/TestExecutor.ts

@@ -50,7 +50,7 @@ export type Suite = {
 
 export type Test = {
   status: JavaScriptExecutionStatus;
-  exception?: string;
+  error?: Error | undefined;
   duration: number;
 };
 
@@ -118,11 +118,16 @@ async function runMocha(silent: boolean, paths: string[], timeout: number) {
         } else {
           status = JavaScriptExecutionStatus.FAILED;
         }
+
         return {
           status: status,
-          exception:
+          error:
             status === JavaScriptExecutionStatus.FAILED
-              ? test.err.message
+              ? {
+                  name: test.err.name,
+                  message: test.err.message,
+                  stack: test.err.stack,
+                }
               : undefined,
           duration: test.duration,
         };