Add first esm unit test

Author: timokoessler

.github/workflows/unit-test-esm.yml

@@ -0,0 +1,29 @@
+name: Unit tests (ESM)
+on:
+  push: {}
+  workflow_call: {}
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [22.x]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Add local.aikido.io to /etc/hosts
+        run: |
+          sudo echo "127.0.0.1 local.aikido.io" | sudo tee -a /etc/hosts
+      - run: make install
+      - run: cd library && npm run test:esm
+      - name: "Upload coverage"
+        uses: codecov/codecov-action@v4.0.1
+        with:
+          file: ./library/.tap/report/lcov.info
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+          slug: AikidoSec/firewall-node

library/agent/hooks/wrapImport.test.mjs

@@ -0,0 +1,40 @@
+import t from "tap";
+
+import wrapImport from "./wrapImport.js";
+import Package from "./Package.js";
+import BuiltinModule from "./BuiltinModule.js";
+
+t.test("it works", async (t) => {
+  const initialSqlite3 = await import("sqlite3");
+  t.same(typeof initialSqlite3.default, "object");
+
+  const sqlite3Pkg = new Package.Package("sqlite3");
+  sqlite3Pkg.withVersion("^5.0.0").onRequire((exports, pkgInfo) => {
+    t.same(pkgInfo.name, "sqlite3");
+    t.same(pkgInfo.type, "external");
+    t.ok(pkgInfo.path?.base.endsWith("node_modules/sqlite3"));
+    t.same(pkgInfo.path?.relative, "lib/sqlite3.js");
+
+    exports.default = 42;
+  });
+
+  const internalFs = new BuiltinModule.BuiltinModule("fs");
+  internalFs.onRequire((exports, pkgInfo) => {
+    t.same(pkgInfo.name, "fs");
+    t.same(pkgInfo.type, "builtin");
+    t.same(pkgInfo.path, undefined);
+
+    exports.readFile = () => "hello from aikido";
+  });
+
+  wrapImport.wrapImport([sqlite3Pkg], [internalFs]);
+
+  // Should not change anything
+  wrapImport.wrapImport();
+
+  const sqlite3 = await import("sqlite3");
+  t.same(sqlite3.default, 42);
+
+  const fs = await import("fs");
+  t.same(fs.readFile(), "hello from aikido");
+});

library/agent/hooks/wrapRequire.ts

@@ -12,7 +12,7 @@ import { isMainJsFile } from "./isMainJsFile";
 import { getInstance } from "../AgentSingleton";
 import { executeInterceptors } from "./executeInterceptors";
 
-const originalRequire = mod.prototype.require;
+let originalRequire: typeof mod.prototype.require | undefined;
 let isRequireWrapped = false;
 
 let packages: Package[] = [];
@@ -36,6 +36,8 @@ export function wrapRequire() {
   }
   // Prevent wrapping the require function multiple times
   isRequireWrapped = true;
+  // Save the original require function
+  originalRequire = mod.prototype.require;
 
   // @ts-expect-error TS doesn't know that we are not overwriting the subproperties
   mod.prototype.require = function wrapped() {

library/package.json

@@ -99,7 +99,8 @@
     "build:watch": "tsc --watch",
     "lint": "npm run lint-eslint && npm run lint-tsc",
     "lint-eslint": "eslint '**/*.ts'",
-    "lint-tsc": "tsc --noEmit"
+    "lint-tsc": "tsc --noEmit",
+    "test:esm": "npx tap --tsconfig ./tsconfig.esm-test.json '!(*node_modules)/**/*.test.mjs'"
   },
   "dependencies": {
     "import-in-the-middle": "^1.11.1"

library/tsconfig.esm-test.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "lib": ["ESNext", "DOM"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "declaration": true,
+    "strict": true,
+    "allowJs": false,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["**/*.test.mjs"]
+}

library/tsconfig.json

@@ -11,5 +11,5 @@
     "skipLibCheck": true
   },
   "include": ["**/*.ts"],
-  "exclude": ["**/*.test.ts"]
+  "exclude": ["**/*.test.ts", "**/*.test.mjs"]
 }