feat: implement new SourceFilePath to locate source code (#428)

Author: fraxken

.changeset/tired-ends-dream.md

@@ -0,0 +1,5 @@
+---
+"@nodesecure/js-x-ray": minor
+---
+
+Implement new SourceFilePath to locate source code

workspaces/js-x-ray/docs/AstAnalyser.md

@@ -63,6 +63,10 @@ The `analyseFile` and `analyseFileSync` methods is a superset of `analyse` with
 
 ```ts
 interface RuntimeOptions {
+  /**
+   * A filesystem location for the given source code.
+   */
+  location?: string;
   /**
    * @default true
    */

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

@@ -36,6 +36,10 @@ export interface Dependency {
 }
 
 export interface RuntimeOptions {
+  /**
+   * A filesystem location for the given source code.
+   */
+  location?: string;
   /**
    * @default true
    */
@@ -144,6 +148,7 @@ export class AstAnalyser {
     options: RuntimeOptions = {}
   ): Report {
     const {
+      location,
       isMinified = false,
       module = true,
       removeHTMLComments = false,
@@ -155,7 +160,7 @@ export class AstAnalyser {
       isEcmaScriptModule: Boolean(module)
     });
 
-    const source = new SourceFile();
+    const source = new SourceFile(location);
     if (trojan.verify(str)) {
       source.warnings.push(
         generateWarning("obfuscated-code", { value: "trojan-source" })
@@ -223,6 +228,7 @@ export class AstAnalyser {
 
       const isMin = filePathString.includes(".min") || isMinifiedCode(str);
       const data = this.analyse(str, {
+        location: path.dirname(filePathString),
         isMinified: isMin,
         module: path.extname(filePathString) === ".mjs" ? true : module,
         removeHTMLComments,
@@ -276,6 +282,7 @@ export class AstAnalyser {
 
       const isMin = filePathString.includes(".min") || isMinifiedCode(str);
       const data = this.analyse(str, {
+        location: path.dirname(filePathString),
         isMinified: isMin,
         module: path.extname(filePathString) === ".mjs" ? true : module,
         removeHTMLComments,

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

@@ -1,3 +1,6 @@
+// Import Node.js Dependencies
+import path from "node:path";
+
 // Import Third-party Dependencies
 import { Utils, Literal } from "@nodesecure/sec-literal";
 import { VariableTracer } from "@nodesecure/tracer";
@@ -29,6 +32,12 @@ export class SourceFile {
   encodedLiterals = new Map<string, string>();
   warnings: Warning[] = [];
   flags = new Set<SourceFlags>();
+  path = new SourceFilePath();
+
+  constructor(sourceLocation?: string) {
+    this.path.use(sourceLocation);
+  }
+
   addDependency(
     name: string,
     location?: ESTree.SourceLocation | null,
@@ -159,6 +168,26 @@ export class SourceFile {
   }
 }
 
+export class SourceFilePath {
+  location: string | null = null;
+
+  use(
+    location?: string
+  ) {
+    this.location = location ?? null;
+  }
+
+  resolve(
+    ...parts: string[]
+  ) {
+    if (this.location === null) {
+      return path.posix.join(...parts);
+    }
+
+    return path.posix.join(this.location, ...parts);
+  }
+}
+
 function sum(
   arr: number[] = []
 ): number {

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

@@ -0,0 +1,53 @@
+// Import Node.js Dependencies
+import { describe, it } from "node:test";
+import assert from "node:assert";
+
+// Import Internal Dependencies
+import { SourceFile, SourceFilePath } from "../src/SourceFile.js";
+
+describe("SourceFile", () => {
+  describe("constructor() with sourceLocation", () => {
+    it("should set the path location", () => {
+      const sourceFile = new SourceFile("/path/to/file.js");
+      assert.ok(sourceFile.path instanceof SourceFilePath);
+      assert.strictEqual(sourceFile.path.location, "/path/to/file.js");
+    });
+  });
+});
+
+describe("SourceFilePath", () => {
+  describe("constructor", () => {
+    it("should have location set to null by default", () => {
+      const sfp = new SourceFilePath();
+      assert.strictEqual(sfp.location, null);
+    });
+  });
+
+  describe("use()", () => {
+    it("should set location when provided", () => {
+      const sfp = new SourceFilePath();
+      sfp.use("/foo/bar");
+      assert.strictEqual(sfp.location, "/foo/bar");
+    });
+
+    it("should set location to null when undefined", () => {
+      const sfp = new SourceFilePath();
+      sfp.use("/foo");
+      sfp.use(undefined);
+      assert.strictEqual(sfp.location, null);
+    });
+  });
+
+  describe("resolve()", () => {
+    it("should join parts without base location", () => {
+      const sfp = new SourceFilePath();
+      assert.strictEqual(sfp.resolve("foo", "bar.js"), "foo/bar.js");
+    });
+
+    it("should join parts with base location", () => {
+      const sfp = new SourceFilePath();
+      sfp.use("/base");
+      assert.strictEqual(sfp.resolve("foo", "bar.js"), "/base/foo/bar.js");
+    });
+  });
+});