Files
reverse-engineering-anything/tests/acceptance/applications/packageSubpathsCli.test.ts
T
Yann Roberto 3ad5782dfd fix(javascript): honor package exports before sibling files
Resolve package exports before sibling-file fallback, preserve explicit export blocking, and retain precise CommonJS package self-reference behavior and caller provenance.

Fixes #1761.

Co-authored-by: Yann Roberto <165009858+shoyann@users.noreply.github.com>
2026-10-11 18:57:58 +08:00

246 lines
9.3 KiB
TypeScript

import { createHash } from "node:crypto";
import { mkdir, writeFile } from "node:fs/promises";
import { createRequire } from "node:module";
import { dirname, join, relative } from "node:path";
import { expect } from "vitest";
import { z } from "zod";
import { javascriptApplicationAnalysisResultSchema } from "../../../src/domain/javascript/javascriptApplicationAnalysis.js";
import { connectLocalToolsMcp } from "../../fixtures/localToolsMcp.js";
import { createTestTempDirectory } from "../../fixtures/temporaryDirectory.js";
import { cliTest } from "../../support/cli/cliFixture.js";
const createPackageSubpathFixture = async () => {
const root = await createTestTempDirectory("rea-package-subpaths-");
const source = [
'const nearest = require("fixture/parser");',
'const nested = require("nested/parser");',
'const parser = require("exported/parser");',
'const directory = require("exported/parser/");',
'const hidden = require("exported/hidden");',
'const missing = require("exported/missing");',
'new BrowserWindow({webPreferences:{preload:"exported/parser"}});',
'const file = require("fixture");',
'const packageDirectory = require("fixture/");',
'const selected = require("@scope/selected");',
'const blocked = require("blocked");',
'const literal = require("fi%xture");',
'const scalar = require("scalar");',
'const self = require("../node_modules/fi%xture/run.cjs");',
].join("\n");
const selfSource = 'const self = require("fi%xture"); module.exports = self;';
const importSource = 'import literal from "fi%xture";';
const files = {
"src/main.cjs": source,
"src/imports.mjs": importSource,
"src/node_modules/fixture/parser.js": "module.exports = 1;",
"src/node_modules/fixture.js": "module.exports = 'file';",
"src/node_modules/fixture/index.js": "module.exports = 'directory';",
"node_modules/fixture/package.json": "{}",
"node_modules/fixture/parser.js": "module.exports = 2;",
"node_modules/nested/package.json": "{}",
"node_modules/nested/parser/package.json": JSON.stringify({
main: "./entry.js",
exports: "./decoy.js",
}),
"node_modules/nested/parser/entry.js": "module.exports = 3;",
"node_modules/nested/parser/index.js": "module.exports = 4;",
"node_modules/nested/parser/decoy.js": "module.exports = 5;",
"node_modules/exported/package.json": JSON.stringify({
exports: {
"./parser": "./parser.cjs",
"./parser/": "./parser.cjs",
"./missing": "./missing.cjs",
},
}),
"node_modules/exported/parser.cjs": "module.exports = 6;",
"node_modules/exported/hidden.js": "module.exports = 7;",
"node_modules/exported/missing/index.js": "module.exports = 8;",
"node_modules/@scope/selected.js": "module.exports = 'sibling';",
"node_modules/@scope/selected/package.json": JSON.stringify({
exports: { require: "./actual.cjs" },
}),
"node_modules/@scope/selected/actual.cjs": "module.exports = 'export';",
"node_modules/blocked.js": "module.exports = 'sibling';",
"node_modules/blocked/package.json": JSON.stringify({
exports: { ".": null },
}),
"node_modules/fi%xture.js": "module.exports = 'literal sibling';",
"node_modules/fi%xture/package.json": JSON.stringify({
name: "fi%xture",
exports: "./actual.cjs",
main: "./legacy.cjs",
}),
"node_modules/fi%xture/actual.cjs": "module.exports = 'export';",
"node_modules/fi%xture/legacy.cjs": "module.exports = 'legacy';",
"node_modules/fi%xture/run.cjs": selfSource,
"node_modules/scalar.js": "module.exports = 'scalar sibling';",
"node_modules/scalar/package.json": JSON.stringify({ exports: false }),
};
await Promise.all(
Object.entries(files).map(async ([path, content]) => {
const absolute = join(root, path);
await mkdir(dirname(absolute), { recursive: true });
await writeFile(absolute, content);
}),
);
return { root, source, selfSource, importSource };
};
cliTest.for(["CLI", "stdio MCP"] as const)(
"resolves package subpaths with source provenance through %s",
async (surface, { cli }) => {
const { root, source, selfSource, importSource } =
await createPackageSubpathFixture();
const nativeRequire = createRequire(join(root, "src/main.cjs"));
const expectedTargets = {
"fixture/parser": "src/node_modules/fixture/parser.js",
fixture: "src/node_modules/fixture.js",
"fixture/": "src/node_modules/fixture/index.js",
"nested/parser": "node_modules/nested/parser/entry.js",
"exported/parser": "node_modules/exported/parser.cjs",
"@scope/selected": "node_modules/@scope/selected/actual.cjs",
"fi%xture": "node_modules/fi%xture.js",
scalar: "node_modules/scalar.js",
"../node_modules/fi%xture/run.cjs": "node_modules/fi%xture/run.cjs",
};
for (const [specifier, target] of Object.entries(expectedTargets))
expect(
relative(root, nativeRequire.resolve(specifier)).replaceAll("\\", "/"),
).toBe(target);
for (const specifier of ["exported/parser/", "exported/hidden", "blocked"])
expect(() => nativeRequire.resolve(specifier)).toThrow(
expect.objectContaining({ code: "ERR_PACKAGE_PATH_NOT_EXPORTED" }),
);
expect(() => nativeRequire.resolve("exported/missing")).toThrow(
expect.objectContaining({ code: "MODULE_NOT_FOUND" }),
);
const selfPath = "node_modules/fi%xture/run.cjs";
expect(
relative(
root,
createRequire(join(root, selfPath)).resolve("fi%xture"),
).replaceAll("\\", "/"),
).toBe("node_modules/fi%xture/actual.cjs");
let document: unknown;
if (surface === "CLI") {
const response = await cli.run({
arguments: ["analyze-javascript-application", root, "--format", "json"],
environment: { REA_LOG_LEVEL: "silent" },
});
expect(response.exitCode, response.stderr).toBe(0);
document = response.json;
} else {
const { call } = await connectLocalToolsMcp();
const response = await call("analyze_javascript_application", {
input_path: root,
format: "directory",
});
expect(response.isError, JSON.stringify(response)).not.toBe(true);
document = response.structuredContent;
}
const { graph } = z
.object({ normalized_result: javascriptApplicationAnalysisResultSchema })
.parse(document).normalized_result;
const imports = graph.edges.filter(
({ properties }) => properties.module_link_kind === "require",
);
for (const observation of [
{ sourcePath: "src/main.cjs", source, targets: expectedTargets },
{
sourcePath: selfPath,
source: selfSource,
targets: { "fi%xture": "node_modules/fi%xture/actual.cjs" },
},
])
expectResolvedImports(imports, observation);
expect(graph.edges).toContainEqual(
expect.objectContaining({
properties: expect.objectContaining({
module_link_kind: "import",
specifier: "fi%xture",
resolved_path: null,
resolution_status: "rejected",
}),
evidence: sourceEvidence("src/imports.mjs", importSource),
}),
);
for (const [specifier, status] of [
["exported/parser/", "external"],
["exported/hidden", "external"],
["exported/missing", "not-found"],
["blocked", "external"],
])
expect(imports).toContainEqual(
expect.objectContaining({
properties: expect.objectContaining({
specifier,
resolved_path: null,
resolution_status: status,
}),
}),
);
const preloads = graph.nodes.filter(
({ kind }) => kind === "electron-preload",
);
expect(preloads).toHaveLength(1);
expect(preloads[0]?.identity).toMatchObject({
key: "electron-preload:module-specifier:node_modules/exported/parser.cjs",
});
for (const observation of preloads[0]?.observations ?? [])
expect(observation).toMatchObject({
properties: {
declared_path: "exported/parser",
resolution_context: "module-specifier",
resolved_path: "node_modules/exported/parser.cjs",
},
evidence: {
location: {
available: true,
value: { source: "src/main.cjs", start: { line: 7 } },
},
},
});
},
);
const expectResolvedImports = (
imports: z.infer<
typeof javascriptApplicationAnalysisResultSchema
>["graph"]["edges"],
observation: {
readonly sourcePath: string;
readonly source: string;
readonly targets: Readonly<Record<string, string>>;
},
): void => {
for (const [specifier, target] of Object.entries(observation.targets))
expect.soft(imports).toContainEqual(
expect.objectContaining({
properties: expect.objectContaining({
specifier,
resolved_path: target,
resolution_status: "resolved",
}),
evidence: sourceEvidence(observation.sourcePath, observation.source),
}),
);
};
const sourceEvidence = (sourcePath: string, source: string): unknown =>
expect.objectContaining({
artifact: expect.objectContaining({
available: true,
sha256: createHash("sha256").update(source).digest("hex"),
}),
location: expect.objectContaining({
available: true,
value: expect.objectContaining({
kind: "source-range",
source: sourcePath,
}),
}),
});