refactor: move ProbeRunner to ASTAnalyser instead of SourceFile

Author: fraxken

.changeset/ten-tires-write.md

@@ -0,0 +1,5 @@
+---
+"@nodesecure/js-x-ray": minor
+---
+
+move ProbeRunner from SourceFile to AstAnalyser class

workspaces/js-x-ray/src/AstAnalyser.ts

@@ -9,14 +9,18 @@ import type { ESTree } from "meriyah";
 import isMinified from "is-minified-code";
 
 // Import Internal Dependencies
-import { generateWarning, type Warning } from "./warnings.js";
+import {
+  generateWarning,
+  type Warning,
+  type OptionalWarningName
+} from "./warnings.js";
 import {
   SourceFile,
-  type ProbesOptions,
   type SourceFlags
 } from "./SourceFile.js";
 import { isOneLineExpressionExport } from "./utils/index.js";
 import { JsSourceParser, type SourceParser } from "./JsSourceParser.js";
+import { ProbeRunner, type Probe } from "./ProbeRunner.js";
 
 export interface Dependency {
   unsafe: boolean;
@@ -63,11 +67,23 @@ export type ReportOnFile = {
   warnings: Warning[];
 };
 
-export interface AstAnalyserOptions extends ProbesOptions {
+export interface AstAnalyserOptions {
   /**
    * @default JsSourceParser
    */
   customParser?: SourceParser;
+  /**
+   * @default []
+   */
+  customProbes?: Probe[];
+  /**
+   * @default false
+   */
+  skipDefaultProbes?: boolean;
+  /**
+   * @default false
+   */
+  optionalWarnings?: boolean | Iterable<OptionalWarningName>;
 }
 
 export interface PrepareSourceOptions {
@@ -76,15 +92,40 @@ export interface PrepareSourceOptions {
 
 export class AstAnalyser {
   parser: SourceParser;
-  probesOptions: ProbesOptions;
+  probes: Probe[];
 
   constructor(options: AstAnalyserOptions = {}) {
+    const {
+      customProbes = [],
+      optionalWarnings = false,
+      skipDefaultProbes = false
+    } = options;
+
     this.parser = options.customParser ?? new JsSourceParser();
-    this.probesOptions = {
-      customProbes: options.customProbes ?? [],
-      skipDefaultProbes: options.skipDefaultProbes ?? false,
-      optionalWarnings: options.optionalWarnings ?? false
-    };
+
+    let probes = ProbeRunner.Defaults;
+    if (
+      Array.isArray(customProbes) &&
+      customProbes.length > 0
+    ) {
+      probes = skipDefaultProbes === true ?
+        customProbes :
+        [...probes, ...customProbes];
+    }
+
+    if (typeof optionalWarnings === "boolean") {
+      if (optionalWarnings) {
+        probes = [...probes, ...Object.values(ProbeRunner.Optionals)];
+      }
+    }
+    else {
+      const optionalProbes = Array.from(optionalWarnings ?? [])
+        .flatMap((warning) => ProbeRunner.Optionals[warning] ?? []);
+
+      probes = [...probes, ...optionalProbes];
+    }
+
+    this.probes = probes;
   }
 
   analyse(
@@ -102,7 +143,8 @@ export class AstAnalyser {
     const body = this.parser.parse(this.prepareSource(str, { removeHTMLComments }), {
       isEcmaScriptModule: Boolean(module)
     });
-    const source = new SourceFile(str, this.probesOptions);
+    const source = new SourceFile(str);
+    const runner = new ProbeRunner(source, this.probes);
 
     // TODO: this check should be factorized in a way that we reuse it
     // on analyze and anlyseFile
@@ -116,13 +158,14 @@ export class AstAnalyser {
     // we walk each AST Nodes, this is a purely synchronous I/O
     // @ts-expect-error
     walk(body, {
-      enter(node) {
+      enter(node: any) {
         // Skip the root of the AST.
         if (Array.isArray(node)) {
           return;
         }
 
-        const action = source.walk(node as ESTree.Node);
+        source.walk(node);
+        const action = runner.walk(node);
         if (action === "skip") {
           this.skip();
         }
@@ -137,7 +180,7 @@ export class AstAnalyser {
       }
       finalize(source);
     }
-    source.probesRunner.finalize();
+    runner.finalize();
 
     // Add oneline-require flag if this is a one-line require expression
     if (isOneLineExpressionExport(body)) {

workspaces/js-x-ray/src/SourceFile.ts

@@ -7,11 +7,9 @@ import type { ESTree } from "meriyah";
 import { rootLocation, toArrayLocation } from "./utils/index.js";
 import {
   generateWarning,
-  type OptionalWarningName,
   type Warning
 } from "./warnings.js";
 import type { Dependency } from "./AstAnalyser.js";
-import { ProbeRunner, type Probe } from "./ProbeRunner.js";
 import { Deobfuscator } from "./Deobfuscator.js";
 import * as trojan from "./obfuscators/trojan-source.js";
 
@@ -23,24 +21,8 @@ export type SourceFlags =
   | "oneline-require"
   | "is-minified";
 
-export interface ProbesOptions {
-  /**
-   * @default []
-   */
-  customProbes?: Probe[];
-  /**
-   * @default false
-   */
-  skipDefaultProbes?: boolean;
-  /**
-   * @default false
-   */
-  optionalWarnings?: boolean | Iterable<OptionalWarningName>;
-}
-
 export class SourceFile {
-  tracer: VariableTracer;
-  probesRunner: ProbeRunner;
+  tracer = new VariableTracer().enableDefaultTracing();
   inTryStatement = false;
   dependencyAutoWarning = false;
   deobfuscator = new Deobfuscator();
@@ -50,36 +32,8 @@ export class SourceFile {
   flags = new Set<SourceFlags>();
 
   constructor(
-    sourceCodeString: string,
-    probesOptions: ProbesOptions = {}
+    sourceCodeString: string
   ) {
-    this.tracer = new VariableTracer()
-      .enableDefaultTracing();
-
-    let probes = ProbeRunner.Defaults;
-    if (
-      Array.isArray(probesOptions.customProbes) &&
-      probesOptions.customProbes.length > 0
-    ) {
-      probes = probesOptions.skipDefaultProbes === true ?
-        probesOptions.customProbes :
-        [...probes, ...probesOptions.customProbes];
-    }
-
-    if (typeof probesOptions.optionalWarnings === "boolean") {
-      if (probesOptions.optionalWarnings) {
-        probes = [...probes, ...Object.values(ProbeRunner.Optionals)];
-      }
-    }
-    else {
-      const optionalProbes = Array.from(probesOptions.optionalWarnings ?? [])
-        .flatMap((warning) => ProbeRunner.Optionals[warning] ?? []);
-
-      probes = [...probes, ...optionalProbes];
-    }
-
-    this.probesRunner = new ProbeRunner(this, probes);
-
     if (trojan.verify(sourceCodeString)) {
       this.warnings.push(
         generateWarning("obfuscated-code", { value: "trojan-source" })
@@ -203,7 +157,7 @@ export class SourceFile {
 
   walk(
     node: ESTree.Node
-  ): null | "skip" {
+  ): void {
     this.tracer.walk(node);
     this.deobfuscator.walk(node);
 
@@ -214,8 +168,6 @@ export class SourceFile {
     else if (node.type === "CatchClause") {
       this.inTryStatement = false;
     }
-
-    return this.probesRunner.walk(node);
   }
 }
 

workspaces/js-x-ray/test/AstAnalyser.spec.ts

@@ -9,6 +9,7 @@ import path from "node:path";
 // Import Internal Dependencies
 import { AstAnalyser, JsSourceParser } from "../src/index.js";
 import { FakeSourceParser } from "./fixtures/FakeSourceParser.js";
+import { ProbeRunner } from "../src/ProbeRunner.js";
 import { SourceFile } from "../src/SourceFile.js";
 import {
   customProbes,
@@ -693,8 +694,7 @@ describe("AstAnalyser", () => {
     it("should instantiate with correct default options", () => {
       const analyser = new AstAnalyser();
       assert.ok(analyser.parser instanceof JsSourceParser);
-      assert.deepStrictEqual(analyser.probesOptions.customProbes, []);
-      assert.strictEqual(analyser.probesOptions.skipDefaultProbes, false);
+      assert.deepStrictEqual(analyser.probes, ProbeRunner.Defaults);
     });
 
     it("should properly instanciate default or custom parser (using analyseFile)", async(t) => {