Files
reverse-engineering-anything/tests/composition/reverseEngineeringEdgeCases.test.ts
T
morluto 1f24b3fa57 feat(evidence)!: name the Evidence subject by its target identity (format revision 2) (#11416)
* feat(evidence)!: name the Evidence subject by its target identity (format revision 2)

The Evidence subject carries subject.identity (kind, sha256, format,
architecture, selection) and the Evidence ID commits to it, so raw/DOL
entry points and ESP flash offsets of the same bytes are different
subjects. Every record declares evidence_format: 2; revision 1 bundles,
standalone records and snapshots are refused with the recreate guidance.
binaryTargetIdentity is the one projection of an open target, used by
Evidence and snapshot comparison.

BREAKING CHANGE: Evidence format revision 2. Evidence IDs commit to the
subject's target identity (subject.identity, including the raw/DOL entry
point or ESP flash offsets), and every record declares evidence_format: 2.
Evidence bundles, records and analysis snapshots from earlier releases are
refused; recreate the observations with this release.

* refactor(analysis-view): read parent subjects through the Evidence identity accessors (#11423)

Analysis views compare their parent's file identity (evidenceFileTarget)
and take path and digest from evidenceSubjectTarget instead of reading
the subject's digest, format and architecture members, which duplicate
subject.identity until they are removed. A counted guard
(evidence-subject-declaration-read) keeps new direct reads out and
records the 20 remaining files.

* fix(evidence): carry format refusals through Evidence readers and bind target selections

- safeParseEvidence/safeParseImmutableEvidence return the format refusal as
  an expected failure; every consumer maps it to the one integrity refusal
  with the recreate guidance. An unmarked object is an earlier record only
  when it has every member records have always carried.
- ArtifactProvider inventory roots and provider subjects that name the
  target's own bytes carry the target's selection (ESP flash offsets).
- Snapshot rows bind only Evidence whose identity, selection included,
  matches the snapshot target.
- Entry-point selections use the raw-binary entry point form.

* fix(evidence): refuse unauthenticated or earlier-format records instead of reading them as absent

- recognizeEvidence (evidenceValidation) replaces tryParseEvidence: input
  without an evidence_id is not Evidence (ok(undefined)); a record that names
  one but fails authentication or is from another format revision is an
  EvidenceIntegrityError carrying the recreate guidance, never undefined.
- Direct analysis retains that refusal as a secondary failure instead of
  silently skipping source capture; cleanup projection, source-closure
  annotation and the flutter, debugger and release-exposure recoveries use
  the same owner (the last three previously read the unauthenticated schema).
- A desktop capture.json from an earlier format is refused with the recreate
  guidance instead of "not desktop application capture Evidence".

* fix(evidence): advertise revision 2 ledger examples and rank delivery omissions by serialized size

- The obligation ledger and reconstruction coverage examples named
  evidence_format 1, which revision 2 refuses; they now use
  EVIDENCE_FORMAT_REVISION.
- MCP delivery chose which unretained recovery to omit by a parsed-storage
  lower bound clipped at the response budget. Once revision 2 subjects made
  the source record's estimate cross the budget, both candidates tied at the
  clip and the smaller source was omitted ahead of the larger completed
  observation. Candidates are now ranked by serialized size, which is what
  the budget counts.

* refactor(native): compare function snapshots by their Evidence target identity (#11450)

Function snapshots carry the subject's file target identity instead of the
duplicated subject declaration. Call paths and function comparisons compare
targets through sameTargetIdentity, so the same bytes opened at a different
raw entry point or ESP flash offset no longer count as one coordinate space:
build_call_path refuses the mix, and compare_functions no longer matches
entries by address across selections. Structural candidates and native
function matching read the architecture and digest through
evidenceFileTarget.

Refs #11417

* refactor(artifacts): compare artifact and WASM summaries by their Evidence target identity (#11461)

Artifact comparison authenticates a summary against its retained inventory
through sameTargetIdentity and rebinds the alias with the whole target,
selection included, so a flash-selected inventory summary taken under an
alias path is no longer refused. WASM comparison, the analysis view
artifact projection and the inventory root check read the digest, format
and display path through the Evidence identity accessors.

Refs #11417

* refactor(evidence): read record subjects through the identity accessors in JS, managed, ledger and bundle readers (#11470)

JavaScript application graphs, runtime reconciliation, managed inspection
and native verification sources, the record summary filter, the ledger's
residual-unknown target and bundle scope selection read the subject digest,
format and display path through evidenceFileTarget and
evidenceSubjectDisplay. No comparison changes: each reader matches one
record's facts against its own payload or a caller filter.

Refs #11417

* refactor(evidence)!: name the Evidence subject only by its target identity (#11497)

* refactor(evidence)!: name the Evidence subject only by its target identity

The subject keeps `identity` and the display facts `name` and `local_path`.
The duplicated `digest`, `format` and `architecture` members are removed; the
format-owned declaration now validates the identity itself. Readers the type
checker found move to the owner accessors; untyped reads in verify scripts,
the efficiency harness and test matchers move to `subject.identity`. The
`evidence-subject-declaration-read` text guard and its baseline are deleted.

Fixes #11473
Refs #11417

BREAKING CHANGE: the Evidence subject no longer has `digest`, `format` or
`architecture`; read `subject.identity.sha256`, `subject.identity.format` and
`subject.identity.architecture`. A record that still carries them is refused.

* test(evidence): give the Flutter verifier fixture the identity subject and check the DOL declaration without the ID

* test(evidence): drop the removed subject members from the declaration matrix and tamper fixtures

* feat(evidence)!: give every Evidence record an explicit subject identity (#11536)

* feat(evidence)!: give every Evidence record an explicit subject identity

A producer that cannot name a file passes an `unknown` target identity
with a closed reason (derived-from-linked-evidence, not-observed,
unsupported-subject) instead of no subject. The subject is non-null;
unknown subjects have no display facts. The generic missing-subject
limitation and `subjectUnavailableReason` are removed; producer-specific
explanations are ordinary limitations. Comparison identity requires the
derived unknown, and null-subject consumers ask the owner accessors.

Refs #11417

BREAKING CHANGE: every Evidence record has a subject. A record without a
file target names `subject.identity` `{ "kind": "unknown", "reason": … }`
with `name` and `local_path` null, instead of `subject: null` and the
limitation "Artifact identity is unavailable for this observation.".
Their Evidence IDs change.

* fix(evidence): name explicit unknown subjects in JavaScript callers and keep a managed graph's file subject

The verification scripts are not type-checked, so five createEvidence
callers still passed undefined (or a missing first target) after the subject
became required. They now pass unknownTarget("not-observed").

A managed application graph chose the first present input subject. Every
subject is now present, so an unknown artifact subject hid a file subject on
the member or boundary Evidence. The graph now takes the first input subject
that names a file.

* test(evidence): assert the subject kind instead of a presence the type now guarantees

Every Evidence record has a subject after this change, so test guards and
assertions that checked it for null always passed. Each now checks that the
fixture subject names a file, or is removed where a later fileIdentity,
fileSubjectTarget or fileSubjectDisplay call already requires that. Non-null
assertions on Evidence subjects are removed; analysis-view inputs, whose
subject is optional, keep an undefined check.

* test(evidence): expect the Evidence subject format under its identity

Two boundary tests still matched subject.format, which slice 2e moved into
subject.identity. toMatchObject is not type-checked against the Evidence
shape, so they failed only when run (the signature test on macOS).
2026-11-16 06:28:01 +08:00

1226 lines
38 KiB
TypeScript

import { rm } from "node:fs/promises";
import type { Stats } from "node:fs";
import { expect, it, vi } from "vitest";
import { registerSharedReverseEngineeringEdgeCaseTests } from "../support/reverseEngineeringCompositionEdgeCases.js";
import { registerOwnedRizinCommandEvidenceTests } from "../support/ownedRizinCommandEvidenceTests.js";
import {
createArtifact,
ownedFailure,
ownedOutput,
providerSnapshot,
} from "../support/reverseEngineeringCompositionFixtures.js";
import { TestReverseEngineeringService as ReverseEngineeringService } from "../support/reverseEngineeringService.js";
import {
AnalysisCapabilityUnavailableError,
AnalysisResourceConstraintError,
} from "../../src/domain/analysisErrorCore.js";
import { ReverseEngineeringService as CoreReverseEngineeringService } from "../../src/application/reverse/ReverseEngineeringService.js";
import { createReverseEngineeringCommandPort } from "../../src/composition/reverseEngineering.js";
import { objdumpCommand } from "../../src/objdump/ObjdumpCommand.js";
import {
OwnedCommandFailure,
runOwnedCommand,
} from "../../src/process/OwnedCommand.js";
import type { ProviderProcessSupervisor } from "../../src/process/ProviderProcess.js";
import { REVERSE_ENGINEERING_TOOL_CONTRACTS } from "../../src/contracts/reverseEngineeringToolContracts.js";
import { awaitAcknowledgement } from "../fixtures/lifecycleAcknowledgement.js";
import { withVerifierCleanup } from "../../scripts/lib/verifier-cleanup.mjs";
registerSharedReverseEngineeringEdgeCaseTests();
registerOwnedRizinCommandEvidenceTests({ sweepTokenOwnedProcesses: true });
it.each(["objdump", "rizin"] as const)(
"retains %s output-limit Evidence when owned cleanup remains incomplete",
async (provider) => {
const { directory, path } = await createArtifact();
const service = new ReverseEngineeringService({
runOwned: async (_spawn, limits) => {
expect(limits.diagnosticBytes).toBe(16 * 1024 * 1024);
throw new OwnedCommandFailure(
"output-limit",
"diagnostic output exceeded its budget",
providerSnapshot({
exitCode: null,
signal: "SIGTERM",
diagnosticTruncated: true,
}),
"owned descendant remains",
undefined,
["run-id", "pid:42"],
);
},
});
try {
const result =
provider === "objdump"
? await service.inspectWithObjdump({ path, operation: "symbols" })
: await service.executeRizinCommand({ path, command: "iI" });
expect(result).toMatchObject({
ok: false,
error: {
_tag: "AnalysisOutputError",
cleanupIncomplete: true,
cleanup: {
reason: "owned descendant remains",
resources: ["run-id", "pid:42"],
},
partialObservation: {
raw_result: {
stdout: "captured owned output",
exit_code: null,
signal: "SIGTERM",
output_truncated: true,
completion_status: "unknown",
artifact_sha256_after: null,
artifact_changed: null,
},
limitations: expect.arrayContaining([
expect.stringContaining("max_output_bytes=16777216"),
]),
},
},
});
} finally {
await rm(directory, { recursive: true, force: true });
}
},
);
it("records pathless objdump architecture support as provider capability evidence", async () => {
const { directory, path } = await createArtifact();
expect(objdumpCommand({ operation: "architectures" })).toEqual(["-i"]);
const digest = vi.fn(async () => "a".repeat(64));
const service = new CoreReverseEngineeringService({
commands: createReverseEngineeringCommandPort(process.env),
digest,
runOwned: async () => ownedOutput("elf64-x86-64"),
});
try {
const result = await service.inspectWithObjdump({
operation: "architectures",
});
if (!result.ok) throw result.error;
expect(result.value.subject.identity.kind).toBe("unknown");
expect(result.value.parameters).not.toHaveProperty("path");
expect(result.value.parameters).not.toHaveProperty(
"artifact_sha256_before",
);
expect(result.value.normalized_result).toMatchObject({
artifact_sha256_after: null,
artifact_changed: null,
});
const contract = REVERSE_ENGINEERING_TOOL_CONTRACTS.find(
({ name }) => name === "inspect_with_objdump",
);
expect(contract?.outputSchema.safeParse(result.value).success).toBe(true);
expect(digest).not.toHaveBeenCalled();
expect(
await service.inspectWithObjdump({ path, operation: "architectures" }),
).toMatchObject({ ok: false, error: { _tag: "AnalysisInputError" } });
const ordinaryInspection = await service.inspectWithObjdump({
path,
operation: "file_headers",
});
expect(ordinaryInspection.ok).toBe(true);
expect(digest).toHaveBeenCalledTimes(2);
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("uses the host environment when the service environment is omitted", async () => {
const { directory, path } = await createArtifact();
const key = "REA_REVERSE_TOOLS_ENV_FALLBACK_TEST";
const previous = process.env[key];
process.env[key] = "host-value";
let observedEnvironment: NodeJS.ProcessEnv | undefined;
const service = new CoreReverseEngineeringService({
commands: createReverseEngineeringCommandPort(process.env),
runOwned: async (spawn) => {
observedEnvironment = spawn.env;
return ownedOutput("ok");
},
});
try {
const result = await service.inspectWithObjdump({
path,
operation: "file_headers",
});
expect(result.ok).toBe(true);
expect(observedEnvironment?.[key]).toBe("host-value");
} finally {
if (previous === undefined) delete process.env[key];
else process.env[key] = previous;
await rm(directory, { recursive: true, force: true });
}
});
it.each(["cancellation", "deadline"] as const)(
"interrupts a pending stat on %s and observes its eventual rejection",
async (interruption) => {
const { directory, path } = await createArtifact();
const controller = new AbortController();
let rejectStat: ((cause: Error) => void) | undefined;
let announceStat: (() => void) | undefined;
const statStarted = new Promise<void>((resolve) => {
announceStat = resolve;
});
const service = new ReverseEngineeringService({
stat: async () => {
announceStat?.();
return await new Promise<Stats>((_resolve, reject) => {
rejectStat = reject;
});
},
runOwned: async () => ownedOutput(),
});
const resultPromise = service.inspectWithObjdump(
{ path, operation: "file_headers", command_timeout_ms: 1_000 },
{ signal: controller.signal },
);
await withVerifierCleanup(async () => {
await awaitAcknowledgement(statStarted, resultPromise, "stat request");
if (interruption === "cancellation") controller.abort();
await expect(resultPromise).resolves.toMatchObject({
ok: false,
error: {
_tag:
interruption === "cancellation"
? "AnalysisCancelledError"
: "AnalysisTimeoutError",
},
});
rejectStat?.(new Error("late stat failure"));
await Promise.resolve();
}, [
() => {
controller.abort();
rejectStat?.(new Error("stat fixture cleanup"));
},
async () => {
await resultPromise;
},
async () => {
await rm(directory, { recursive: true, force: true });
},
]);
},
);
it("handles cancellation that races with stat listener registration", async () => {
const { directory, path } = await createArtifact();
let aborted = false;
const signal = {
get aborted() {
return aborted;
},
addEventListener: (
_type: string,
listener: Parameters<EventTarget["addEventListener"]>[1],
) => {
aborted = true;
if (typeof listener === "function") listener(new Event("abort"));
else listener.handleEvent(new Event("abort"));
},
removeEventListener: () => {},
dispatchEvent: () => true,
onabort: null,
reason: undefined,
throwIfAborted: () => {},
} as AbortSignal;
const stat = vi.fn(async () => ({ isFile: () => true }) as unknown as Stats);
const runOwned = vi.fn(async () => ownedOutput());
const service = new ReverseEngineeringService({ stat, runOwned });
try {
const result = await service.inspectWithObjdump(
{ path, operation: "file_headers" },
{ signal },
);
expect(result).toMatchObject({
ok: false,
error: { _tag: "AnalysisCancelledError" },
});
expect(stat).not.toHaveBeenCalled();
expect(runOwned).not.toHaveBeenCalled();
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("handles a synchronous stat provider throw as an artifact input failure", async () => {
const { directory, path } = await createArtifact();
const stat = vi.fn(() => {
throw Object.assign(new Error("stat failed before returning a promise"), {
code: "ENOENT",
});
});
const runOwned = vi.fn(async () => ownedOutput());
const service = new ReverseEngineeringService({
stat: stat as unknown as (path: string) => Promise<Stats>,
runOwned,
});
try {
const result = await service.inspectWithObjdump({
path,
operation: "file_headers",
});
expect(result).toMatchObject({
ok: false,
error: { _tag: "AnalysisInputError" },
});
expect(stat).toHaveBeenCalledTimes(1);
expect(runOwned).not.toHaveBeenCalled();
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("cancels an artifact stream when cancellation races with its listener registration", async () => {
const { directory, path } = await createArtifact();
let aborted = false;
let registrations = 0;
const signal = {
get aborted() {
return aborted;
},
addEventListener: (
_type: string,
listener: Parameters<EventTarget["addEventListener"]>[1],
) => {
registrations += 1;
if (registrations === 2) {
aborted = true;
if (typeof listener === "function") listener(new Event("abort"));
else listener.handleEvent(new Event("abort"));
}
},
removeEventListener: () => {},
dispatchEvent: () => true,
onabort: null,
reason: undefined,
throwIfAborted: () => {},
} as AbortSignal;
const stat = vi.fn(async () => ({ isFile: () => true }) as unknown as Stats);
const runOwned = vi.fn(async () => ownedOutput());
const service = new ReverseEngineeringService({ stat, runOwned });
try {
const result = await service.inspectWithObjdump(
{ path, operation: "file_headers" },
{ signal },
);
expect(result).toMatchObject({
ok: false,
error: { _tag: "AnalysisCancelledError" },
});
expect(registrations).toBe(2);
expect(stat).toHaveBeenCalledTimes(1);
expect(runOwned).not.toHaveBeenCalled();
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("cancels before stream listeners when the signal changes after stat", async () => {
const { directory, path } = await createArtifact();
let abortedReads = 0;
const signal = {
get aborted() {
abortedReads += 1;
return abortedReads >= 5;
},
addEventListener: () => {},
removeEventListener: () => {},
dispatchEvent: () => true,
onabort: null,
reason: undefined,
throwIfAborted: () => {},
} as AbortSignal;
const stat = vi.fn(async () => ({ isFile: () => true }) as unknown as Stats);
const runOwned = vi.fn(async () => ownedOutput());
const service = new ReverseEngineeringService({ stat, runOwned });
try {
const result = await service.inspectWithObjdump(
{ path, operation: "file_headers" },
{ signal },
);
expect(result).toMatchObject({
ok: false,
error: { _tag: "AnalysisCancelledError" },
});
// Cancellation checks may be repeated by the digest cleanup path.
expect(abortedReads).toBeGreaterThanOrEqual(5);
expect(stat).toHaveBeenCalledTimes(1);
expect(runOwned).not.toHaveBeenCalled();
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("rejects malformed Rizin requests before touching the provider", async () => {
const runOwned = vi.fn(async () => ownedOutput());
const service = new ReverseEngineeringService({ runOwned });
const result = await service.executeRizinCommand({ path: "sample.bin" });
expect(result).toMatchObject({
ok: false,
error: {
_tag: "AnalysisInputError",
operation: "execute_rizin_command",
issues: [
{ path: ["command"], reason: "missing_argument", expected: "string" },
],
},
});
expect(runOwned).not.toHaveBeenCalled();
});
it("rejects new operations after service shutdown begins", async () => {
const { directory, path } = await createArtifact();
const runOwned = vi.fn(async () => ownedOutput());
const service = new ReverseEngineeringService({ runOwned });
try {
await service.close();
const result = await service.executeRizinCommand({ path, command: "iI" });
expect(result.ok).toBe(false);
if (!result.ok) {
expect(result.error._tag).toBe("AnalysisOutputError");
expect(result.error.message).toContain(
"Reverse-engineering service is closed.",
);
}
expect(runOwned).not.toHaveBeenCalled();
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("rejects work after reaching the concurrent provider-operation limit", async () => {
const { directory, path } = await createArtifact();
let releaseProviders: (() => void) | undefined;
const providerGate = new Promise<void>((resolve) => {
releaseProviders = resolve;
});
let providerCalls = 0;
const service = new ReverseEngineeringService({
runOwned: async () => {
providerCalls += 1;
await providerGate;
return ownedOutput("ok");
},
});
const admitted = Array.from({ length: 8 }, () =>
service.executeRizinCommand({ path, command: "iI" }),
);
await withVerifierCleanup(async () => {
const rejection = service.executeRizinCommand({ path, command: "iI" });
await awaitAcknowledgement(
rejection,
Promise.all(admitted),
"capacity response",
);
const rejected = await rejection;
expect(rejected.ok).toBe(false);
if (!rejected.ok) {
expect(rejected.error._tag).toBe("AnalysisResourceConstraintError");
expect(rejected.error).toBeInstanceOf(AnalysisResourceConstraintError);
if (rejected.error instanceof AnalysisResourceConstraintError)
expect(rejected.error.reportedLimits).toMatchObject({
max_concurrent_operations: 8,
active_operations: 8,
});
}
expect(providerCalls).toBe(0);
releaseProviders?.();
const results = await Promise.all(admitted);
expect(results.every((result) => result.ok)).toBe(true);
expect(providerCalls).toBe(8);
}, [
() => releaseProviders?.(),
async () => {
await Promise.allSettled(admitted);
},
async () => {
await rm(directory, { recursive: true, force: true });
},
]);
});
it("cancels when an AbortSignal becomes aborted during listener registration", async () => {
const { directory, path } = await createArtifact();
const controller = new AbortController();
let abortedReads = 0;
const signal = new Proxy(controller.signal, {
get(target, property) {
if (property === "aborted") return ++abortedReads > 1;
const value = Reflect.get(target, property, target) as unknown;
return typeof value === "function" ? value.bind(target) : value;
},
});
const runOwned = vi.fn(async () => ownedOutput());
const service = new ReverseEngineeringService({ runOwned });
try {
const result = await service.inspectWithObjdump(
{ path, operation: "file_headers" },
{ signal },
);
expect(result).toMatchObject({
ok: false,
error: { _tag: "AnalysisCancelledError" },
});
expect(abortedReads).toBe(2);
expect(runOwned).not.toHaveBeenCalled();
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("drains an active provider operation before service shutdown resolves", async () => {
const { directory, path } = await createArtifact();
let signal: AbortSignal | undefined;
let releaseRun!: () => void;
const runGate = new Promise<void>((resolve) => {
releaseRun = resolve;
});
let runStarted: (() => void) | undefined;
const started = new Promise<void>((resolve) => {
runStarted = resolve;
});
const service = new ReverseEngineeringService({
runOwned: async (_spawn, _limits, options) => {
signal = options?.signal;
runStarted?.();
await runGate;
return ownedOutput("finished");
},
});
const operation = service.executeRizinCommand({ path, command: "iI" });
let closing: Promise<void> | undefined;
await withVerifierCleanup(async () => {
await awaitAcknowledgement(started, operation, "provider command");
let closed = false;
closing = service.close().then(() => {
closed = true;
});
expect(signal?.aborted).toBe(true);
expect(closed).toBe(false);
releaseRun();
await closing;
expect(closed).toBe(true);
await expect(operation).resolves.toMatchObject({
ok: false,
error: { _tag: "AnalysisCancelledError" },
});
}, [
releaseRun,
async () => {
await operation;
},
async () => {
await closing;
},
() => service.close(),
() => rm(directory, { recursive: true, force: true }),
]);
});
it("relays caller cancellation to the admitted provider signal", async () => {
const { directory, path } = await createArtifact();
const controller = new AbortController();
const addAbortListener = vi.spyOn(controller.signal, "addEventListener");
let announceStarted: (() => void) | undefined;
const started = new Promise<void>((resolve) => {
announceStarted = resolve;
});
let releaseRun!: () => void;
const runGate = new Promise<void>((resolve) => {
releaseRun = resolve;
});
let providerSignal: AbortSignal | undefined;
const service = new CoreReverseEngineeringService({
commands: createReverseEngineeringCommandPort(process.env),
runOwned: async (_spawn, _limits, options) => {
providerSignal = options?.signal;
announceStarted?.();
await runGate;
return ownedOutput("captured");
},
});
const operation = service.inspectWithObjdump(
{ path, operation: "file_headers" },
{ signal: controller.signal },
);
await withVerifierCleanup(async () => {
await awaitAcknowledgement(started, operation, "provider command");
controller.abort();
expect(addAbortListener).toHaveBeenCalledWith(
"abort",
expect.any(Function),
{ once: true },
);
expect(providerSignal?.aborted).toBe(true);
releaseRun();
await expect(operation).resolves.toMatchObject({
ok: false,
error: { _tag: "AnalysisCancelledError" },
});
}, [
() => controller.abort(),
releaseRun,
async () => {
await operation;
},
() => service.close(),
() => rm(directory, { recursive: true, force: true }),
]);
});
it("passes an AbortSignal-like caller value through without relaying it", async () => {
const { directory, path } = await createArtifact();
const signal = {
aborted: false,
addEventListener: vi.fn(() => {
throw new Error(
"A non-native signal must not register a relay listener.",
);
}),
removeEventListener: vi.fn(),
} as unknown as AbortSignal;
const digest = vi.fn(async (_path: string, receivedSignal?: AbortSignal) => {
expect(receivedSignal).toBe(signal);
return "a".repeat(64);
});
const runOwned = vi.fn<typeof runOwnedCommand>(
async (_spawn, _limits, options) => {
expect(options?.signal).toBe(signal);
return ownedOutput("ok");
},
);
const service = new CoreReverseEngineeringService({
commands: createReverseEngineeringCommandPort(process.env),
digest,
runOwned,
});
try {
const result = await service.inspectWithObjdump(
{ path, operation: "file_headers" },
{ signal },
);
expect(result.ok).toBe(true);
expect(signal.addEventListener).not.toHaveBeenCalled();
expect(signal.removeEventListener).toHaveBeenCalledTimes(1);
expect(digest).toHaveBeenCalledTimes(2);
expect(runOwned).toHaveBeenCalledTimes(1);
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("cancels after operation admission and before starting the artifact digest", async () => {
const { directory, path } = await createArtifact();
let reads = 0;
const signal = {
get aborted() {
reads += 1;
return reads > 1;
},
addEventListener() {},
removeEventListener() {},
throwIfAborted() {},
onabort: null,
reason: undefined,
dispatchEvent: () => true,
} as AbortSignal;
let digestStarted = false;
const service = new ReverseEngineeringService({
digest: async () => {
digestStarted = true;
return "a".repeat(64);
},
});
try {
const result = await service.inspectWithObjdump(
{ path, operation: "file_headers" },
{ signal },
);
expect(result).toMatchObject({
ok: false,
error: { _tag: "AnalysisCancelledError" },
});
expect(reads).toBeGreaterThanOrEqual(2);
expect(digestStarted).toBe(false);
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("preserves raw retained byte counts when output text replaces invalid UTF-8", async () => {
const { directory, path } = await createArtifact();
const snapshot = providerSnapshot({
stdout: { text: "�", bytes: 1, observedBytes: 1, invalidUtf8: true },
stderr: { text: "�", bytes: 2, observedBytes: 2, invalidUtf8: true },
exitCode: 7,
});
const service = new ReverseEngineeringService({
runOwned: async () => {
throw new OwnedCommandFailure(
"cancelled",
"Command was cancelled after output capture",
snapshot,
);
},
});
try {
const result = await service.executeRizinCommand({ path, command: "iI" });
expect(result).toMatchObject({
ok: false,
error: {
_tag: "AnalysisCancelledError",
capturedOutput: {
stdout: "�",
stderr: "�",
stdout_bytes: 1,
stderr_bytes: 2,
},
},
});
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("preserves the provider remediation when owned process preparation fails", async () => {
const { directory, path } = await createArtifact();
const remediation = new AnalysisCapabilityUnavailableError(
"rizin",
"execute_rizin_command",
"Rizin needs permission to inspect this process",
{ userMessage: "Grant process inspection permission, then retry." },
);
const service = new ReverseEngineeringService({
runOwned: async () => {
throw new OwnedCommandFailure(
"process",
"Could not prepare process ownership",
null,
null,
{ cause: remediation },
);
},
});
try {
const result = await service.executeRizinCommand({ path, command: "iI" });
expect(result).toMatchObject({
ok: false,
error: {
_tag: "AnalysisCapabilityUnavailableError",
providerId: "rizin",
reason: remediation.reason,
userMessage: remediation.userMessage,
},
});
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it.each([
["Error", new Error("cleanup state unknown"), "cleanup state unknown"],
["non-Error", "cleanup state unknown", "cleanup state unknown"],
] as const)(
"preserves a thrown %s cleanup reason while blocking new provider work",
async (_label, cause, expectedReason) => {
const { directory, path } = await createArtifact();
const cleanupOwner = {
stop: vi.fn(async () => Promise.reject(cause)),
} as unknown as ProviderProcessSupervisor;
const runOwned = vi.fn<typeof runOwnedCommand>(async () => {
throw new OwnedCommandFailure(
"cancelled",
"command cancelled",
providerSnapshot({ exitCode: null }),
"cleanup pending",
undefined,
["run-id", "pid:42"],
cleanupOwner,
);
});
const service = new ReverseEngineeringService({ runOwned });
try {
const first = await service.executeRizinCommand({ path, command: "iI" });
expect(first.ok).toBe(false);
const blocked = await service.executeRizinCommand({
path,
command: "iI",
});
expect(blocked).toMatchObject({
ok: false,
error: {
_tag: "AnalysisOutputError",
cleanup: { reason: expectedReason, resources: ["run-id", "pid:42"] },
},
});
await expect(service.close()).rejects.toMatchObject({
cleanup: { reason: expectedReason, resources: ["run-id", "pid:42"] },
});
expect(cleanupOwner.stop).toHaveBeenCalledTimes(2);
expect(runOwned).toHaveBeenCalledTimes(1);
} finally {
await service.close().catch(() => undefined);
await rm(directory, { recursive: true, force: true });
}
},
);
it("releases a retained provider owner after cleanup succeeds", async () => {
const { directory, path } = await createArtifact();
const cleanupOwner = {
stop: vi.fn(async () => ({ status: "verified-cleanup" as const })),
} as unknown as ProviderProcessSupervisor;
const runOwned = vi
.fn<typeof runOwnedCommand>()
.mockRejectedValueOnce(
new OwnedCommandFailure(
"cancelled",
"command cancelled",
providerSnapshot({ exitCode: null }),
"cleanup pending",
undefined,
["run-id", "pid:42"],
cleanupOwner,
),
)
.mockResolvedValue(providerSnapshot());
const service = new ReverseEngineeringService({ runOwned });
try {
const first = await service.executeRizinCommand({ path, command: "iI" });
expect(first.ok).toBe(false);
const recovered = await service.executeRizinCommand({
path,
command: "iI",
});
expect(recovered.ok).toBe(true);
expect(cleanupOwner.stop).toHaveBeenCalledTimes(1);
expect(runOwned).toHaveBeenCalledTimes(2);
} finally {
await service.close().catch(() => undefined);
await rm(directory, { recursive: true, force: true });
}
});
it("retains an objdump command's unverified process owner until a later inspection stops it", async () => {
const { directory, path } = await createArtifact();
let stopped = false;
const cleanupOwner = {
stop: vi.fn(async () =>
stopped
? { status: "verified-cleanup" as const }
: { status: "incomplete" as const, reason: "objdump group remains" },
),
} as unknown as ProviderProcessSupervisor;
const runOwned = vi
.fn<typeof runOwnedCommand>()
.mockRejectedValueOnce(
new OwnedCommandFailure(
"process",
"objdump cleanup could not be verified",
providerSnapshot({ exitCode: null }),
"objdump group remains",
undefined,
["run-id", "pid:42"],
cleanupOwner,
),
)
.mockResolvedValue(providerSnapshot());
const service = new ReverseEngineeringService({ runOwned });
try {
const first = await service.inspectWithObjdump({
path,
operation: "symbols",
});
if (first.ok) throw new Error("Expected retained objdump cleanup");
expect(first.error.cleanupIncomplete).toBe(true);
expect(first.error.cleanup).toMatchObject({
reason: "objdump group remains",
resources: ["run-id", "pid:42"],
});
const blocked = await service.inspectWithObjdump({
path,
operation: "symbols",
});
expect(blocked).toMatchObject({
ok: false,
error: { cleanupIncomplete: true },
});
expect(runOwned).toHaveBeenCalledOnce();
stopped = true;
const recovered = await service.inspectWithObjdump({
path,
operation: "symbols",
});
if (!recovered.ok) throw recovered.error;
expect(first.error.cleanupIncomplete).toBe(false);
expect(cleanupOwner.stop).toHaveBeenCalledTimes(2);
expect(runOwned).toHaveBeenCalledTimes(2);
} finally {
await service.close().catch(() => undefined);
await rm(directory, { recursive: true, force: true });
}
});
it("retains a capability failure when its injected owned runner also reports incomplete cleanup", async () => {
const { directory, path } = await createArtifact();
const capability = new AnalysisCapabilityUnavailableError(
"rizin",
"execute_rizin_command",
"Ownership inspection is unavailable.",
{ diagnostics: { source: "owned-runner" } },
);
const cleanupOwner = {
stop: vi.fn(async () => ({ status: "verified-cleanup" as const })),
} as unknown as ProviderProcessSupervisor;
const runOwned = vi
.fn<typeof runOwnedCommand>()
.mockRejectedValueOnce(
new OwnedCommandFailure(
"process",
"Ownership inspection failed after launch.",
null,
"owned descendant remains",
{ cause: capability },
["run-id", "pid:42"],
cleanupOwner,
),
)
.mockResolvedValue(providerSnapshot());
const service = new ReverseEngineeringService({ runOwned });
try {
const first = await service.executeRizinCommand({ path, command: "iI" });
if (first.ok) throw new Error("Expected the capability failure");
expect(first.error._tag).toBe("AnalysisCapabilityUnavailableError");
expect(first.error).toBeInstanceOf(AnalysisCapabilityUnavailableError);
expect(first.error.diagnostics).toEqual({ source: "owned-runner" });
expect(first.error.cleanupIncomplete).toBe(true);
expect(first.error.cleanup).toMatchObject({
reason: "owned descendant remains",
resources: ["run-id", "pid:42"],
});
const recovered = await service.executeRizinCommand({
path,
command: "iI",
});
if (!recovered.ok) throw recovered.error;
expect(cleanupOwner.stop).toHaveBeenCalledOnce();
expect(first.error.cleanupIncomplete).toBe(false);
expect(runOwned).toHaveBeenCalledTimes(2);
} finally {
await service.close().catch(() => undefined);
await rm(directory, { recursive: true, force: true });
}
});
it("preserves a provider timeout when cancellation arrives during the final digest", async () => {
const { directory, path } = await createArtifact();
const controller = new AbortController();
let digests = 0;
const service = new ReverseEngineeringService({
digest: async () => {
digests += 1;
if (digests === 2) controller.abort();
return "a".repeat(64);
},
runOwned: async () => {
throw ownedFailure(
"timeout",
ownedOutput("partial timeout output", "timeout diagnostic", {
exitCode: null,
}),
);
},
});
try {
const result = await service.executeRizinCommand(
{ path, command: "iI" },
{ signal: controller.signal },
);
expect(result).toMatchObject({
ok: false,
error: {
_tag: "AnalysisTimeoutError",
capturedOutput: {
stdout: "partial timeout output",
stderr: "timeout diagnostic",
},
partialObservation: {
raw_result: {
stdout: "partial timeout output",
completion_status: "unknown",
},
limitations: expect.arrayContaining([
expect.stringContaining("AnalysisTimeoutError"),
]),
},
},
});
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("classifies E2BIG as a provider command resource constraint", async () => {
const { directory, path } = await createArtifact();
const cleanupOwner = {
stop: vi.fn(async () => ({ status: "verified-cleanup" as const })),
} as unknown as ProviderProcessSupervisor;
const runOwned = vi
.fn<typeof runOwnedCommand>()
.mockRejectedValueOnce(
new OwnedCommandFailure(
"process",
"Command launch failed.",
null,
"owned descendant remains",
{
cause: Object.assign(new Error("argument list too long"), {
code: "E2BIG",
}),
},
["run-id", "pid:42"],
cleanupOwner,
),
)
.mockResolvedValue(providerSnapshot());
const service = new ReverseEngineeringService({
runOwned,
});
try {
const result = await service.executeRizinCommand({ path, command: "iI" });
expect(result).toMatchObject({
ok: false,
error: {
_tag: "AnalysisResourceConstraintError",
resource: "transport",
operation: "execute_rizin_command",
},
});
if (!result.ok)
expect(result.error.message).toContain(
"The host rejected the provider command because its argument list exceeds the process launch limit.",
);
if (!result.ok) {
expect(result.error.cleanupIncomplete).toBe(true);
expect(result.error.cleanup?.resources).toEqual(["run-id", "pid:42"]);
expect(result.error).toBeInstanceOf(AnalysisResourceConstraintError);
if (result.error instanceof AnalysisResourceConstraintError)
expect(result.error.reportedLimits).toMatchObject({
argument_bytes: expect.any(Number),
});
}
const retried = await service.executeRizinCommand({ path, command: "iI" });
expect(retried.ok).toBe(true);
if (!result.ok) expect(result.error.cleanupIncomplete).toBe(false);
expect(cleanupOwner.stop).toHaveBeenCalledOnce();
expect(runOwned).toHaveBeenCalledTimes(2);
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("preserves completed command Evidence while its post-run digest awaits cleanup", async () => {
const { directory, path } = await createArtifact();
const service = new ReverseEngineeringService({
runOwned: async () => {
throw new OwnedCommandFailure(
"process",
"Owned process cleanup remains incomplete.",
providerSnapshot({ exitCode: 0 }),
"descendant remains active",
undefined,
["run-id", "pid:42"],
);
},
});
try {
const result = await service.executeRizinCommand({ path, command: "iI" });
expect(result).toMatchObject({
ok: false,
error: {
_tag: "AnalysisOutputError",
partialObservation: {
raw_result: {
exit_code: 0,
completion_status: "complete",
artifact_sha256_after: null,
artifact_changed: null,
},
limitations: expect.arrayContaining([
expect.stringContaining(
"owned provider cleanup was incomplete at observation time",
),
]),
},
},
});
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it("records an explicit loss marker when provider bytes are invalid UTF-8", async () => {
const { directory, path } = await createArtifact();
const service = new ReverseEngineeringService({
runOwned: async () =>
providerSnapshot({
stdout: {
text: "captured � output",
bytes: 17,
observedBytes: 17,
invalidUtf8: true,
},
}),
});
try {
const result = await service.executeRizinCommand({ path, command: "iI" });
expect(result.ok).toBe(true);
if (result.ok) {
expect(result.value).toMatchObject({
raw_result: { stdout: "captured � output" },
});
expect(result.value.limitations).toContainEqual(
expect.stringMatching(
/stdout bytes.*invalid or incomplete UTF-8.*replacement characters.*do not preserve the original bytes/iu,
),
);
}
} finally {
await rm(directory, { recursive: true, force: true });
}
});
it.each([
[
"stderr only",
{
stderr: {
text: "diagnostic � output",
bytes: 22,
observedBytes: 22,
invalidUtf8: true,
},
},
"stderr",
],
[
"both streams",
{
stdout: {
text: "captured � output",
bytes: 17,
observedBytes: 17,
invalidUtf8: true,
},
stderr: {
text: "diagnostic � output",
bytes: 22,
observedBytes: 22,
invalidUtf8: true,
},
},
"stdout and stderr",
],
] as const)(
"records invalid UTF-8 loss for %s",
async (_label, overrides, streams) => {
const { directory, path } = await createArtifact();
const service = new ReverseEngineeringService({
runOwned: async () => providerSnapshot(overrides),
});
try {
const result = await service.executeRizinCommand({ path, command: "iI" });
expect(result.ok).toBe(true);
if (result.ok)
expect(result.value.limitations).toContainEqual(
expect.stringMatching(
new RegExp(
`${streams} bytes.*invalid or incomplete UTF-8.*replacement characters.*do not preserve the original bytes`,
"iu",
),
),
);
} finally {
await rm(directory, { recursive: true, force: true });
}
},
);
it.each(["objdump", "rizin"] as const)(
"preserves successful %s output-loss facts independently of process completion",
async (provider) => {
const { directory, path } = await createArtifact();
const service = new ReverseEngineeringService({
runOwned: async () => providerSnapshot({ diagnosticTruncated: true }),
});
try {
const result =
provider === "objdump"
? await service.inspectWithObjdump({ path, operation: "symbols" })
: await service.executeRizinCommand({ path, command: "iI" });
if (!result.ok) throw result.error;
expect(result.value.normalized_result).toMatchObject({
exit_code: 0,
output_truncated: true,
completion_status: "complete",
});
expect(result.value.limitations).toContainEqual(
expect.stringMatching(
/output is partial.*bytes were omitted.*process completion.*separately/iu,
),
);
} finally {
await service.close();
await rm(directory, { recursive: true, force: true });
}
},
);