mirror of
https://github.com/morluto/rea.git
synced 2026-11-22 14:35:45 +00:00
* test(architecture): fail on a stale layer baseline and document the declared layers verify:module-boundaries reported a layer baseline entry whose imports were gone but still passed, so main kept process -> artifacts at 20 after it fell to 17 and a later change could add three imports back unnoticed. A stale entry now fails like growth; --shrink-layer-baseline lowers it in the change that removes the imports. The architecture map and CONTRIBUTING name scripts/lib/module-layers.mjs as the per-directory layer declaration. * test(architecture): refuse to lower the layer baseline after an inspection failure A file that cannot be parsed contributes no imports, so a shrink run would record counts that fail as growth once the file is fixed. Whole-command tests cover stale rejection, shrinking, refused growth and the inspection failure. * refactor(ports): move the progress, work-scope and inspection-scope ports to src/ports (#11214) * refactor(ports): move the progress, work-scope and inspection-scope ports to src/ports Pure move with git mv and import specifier updates. * test(architecture): declare the ports layer and lower the layer baseline src/ports sits between the foundation and the providers. Moving the three ports removes 11 provider -> application imports. * refactor(ports): move AnalysisProvider to src/ports (#11217) * refactor(ports): move AnalysisProvider to src/ports Pure move with git mv and import specifier updates in its importers, the built-fixture path, the CI scope glob and the lint-rule test spellings. * test(architecture): lower the layer baseline after moving AnalysisProvider * refactor(ports): move the per-feature provider ports to src/ports (#11226) * refactor(ports): move the per-feature provider ports to src/ports Pure move with git mv and import specifier updates: the 47 *Port.ts and *Ports.ts files that providers implement, plus OptionalObservationProviders, which only composes the observation ports. * test(architecture): lower the layer baseline after moving the feature ports * refactor(providers): move closeAnalysisClient and the Frida session input errors to their owners (#11233) * refactor(providers): move closeAnalysisClient to src/providers and the Frida session input errors to src/frida Pure move with git mv and import specifier updates. * test(architecture): drop the application-providers and application-frida cycles from the layer baseline * fix(ci): keep provider lanes selecting the ports moved to src/ports Each lane glob that matched a moved port under src/application gains its src/ports counterpart; the change-scope test pins one moved port per lane. * refactor(domain): declare the localPath host exception and read HOST_PLATFORM there (#11256) absoluteLocalPathStringSchema decides which paths are absolute on the running host, so it reads HOST_PLATFORM instead of process.platform. Domain may not import outside domain/contracts; module-layers now declares LAYER_EXCEPTIONS, exact file-to-file imports with a reason, and both the layer count and the pure-layer boundary skip only that import. Any other domain -> platform import still fails. * refactor(ports): move the doctor check and provider inspection types to src/ports (#11246) * refactor(ports): move the doctor check and provider inspection types to src/ports Declaration move from application/Doctor.ts (unchanged text) and import updates; no re-export from Doctor.ts. * test(architecture): lower the layer baseline after moving the doctor provider types * refactor(ports): move the packet capture and signal recording ports to src/ports (#11249) * refactor(ports): move the packet capture and signal recording ports to src/ports Declaration move (unchanged text) out of the two application services, with import updates. * test(architecture): lower the layer baseline after moving the capture and signal ports * refactor(domain): move the analysis error projection schema from contracts to domain (#11251) * refactor(domain): move the analysis error projection schema from contracts to domain Declaration move (unchanged text) of the projection schemas that domain modules embed; contracts/errorSchemas.ts keeps the CLI envelope and the published JSON Schema. Import updates only. * test(architecture): drop the contracts-domain cycle from the layer baseline * refactor(ports): drop the imports the moved capture, signal and doctor types left behind Also give the packet capture and signal recording lanes the new port paths, with change-scope cases. * refactor(resources): add src/resources and move AnalysisCleanupLease and ArtifactReader there (#11259) * refactor(resources): move AnalysisCleanupLease to src/resources Pure move: git mv plus import specifier rewrites (source, tests, and the dist paths the verifier scripts load). * refactor(resources): declare src/resources as a foundation unit src/resources owns the shared analysis resource modules that process, windows and providers hold; AnalysisCleanupLease is the first. Its tests join the adapters project, the apk signature lane selects it beside src/artifacts, and the layer baseline drops the process and windows imports of the lease. * test(ci): pin the apk signature lane on the moved cleanup lease * refactor(resources): move ArtifactReader to src/resources Pure move: git mv plus import specifier rewrites (source, tests, and the dist path a verifier script loads). * test(architecture): lower the layer baseline after moving ArtifactReader windows no longer imports src/artifacts; process -> artifacts 11 -> 9. The CI lanes that selected src/artifacts/ArtifactReader.ts select its new path, pinned in the change-scope test. * refactor(resources): move ArtifactResourceScope to src/resources (#11265) * refactor(artifacts): name the output tree and private root capabilities the resource scope releases ArtifactResourceScope typed its output-tree and private-runtime-root owners with SafeOutputTree (src/artifacts) and PrivateRuntimeRoot (src/process). It only calls rollback() and close(), so it now declares those capabilities itself and names neither unit, which lets it move to src/resources without a resources <-> process cycle. The withheld-export test narrows to SafeOutputTree where it reads the published flag. * refactor(resources): move ArtifactResourceScope to src/resources Pure move: git mv plus import specifier rewrites (source, tests, the dist paths verifier scripts load, and the FIFO probe's module-relative URL). * test(architecture): lower the layer baseline after moving ArtifactResourceScope process -> artifacts 9 -> 5, and the artifacts <-> dotnet mutual pair is gone. The sqlite and agentenv lanes select the scope at its new path, pinned in the change-scope test. * refactor(resources): move ArtifactFileOperation to src/resources (#11269) * refactor(resources): move ArtifactFileOperation to src/resources Pure move: git mv plus import specifier rewrites (source, tests, and the dist paths verifier scripts load). * test(architecture): lower the layer baseline after moving ArtifactFileOperation process -> artifacts 5 -> 1. * refactor(resources): move readStableArtifact to src/resources (#11271) * refactor(resources): move readStableArtifact to src/resources Pure move: git mv plus import specifier rewrites. * test(architecture): lower the layer baseline after moving readStableArtifact process no longer imports src/artifacts: process -> artifacts 1 -> 0 and the artifacts <-> process mutual pair is gone. The seven lanes that selected readStableArtifact select its new path, pinned in the change-scope test; the architecture map lists what src/resources owns. * refactor(hopper): take Linux launcher verification from composition through a port (#11278) The Hopper launcher imported inspectLinuxHopperLauncher and retryLinuxHopperPublisherCleanup from src/application (the two hopper -> application imports). src/ports/LinuxHopperLauncherVerification.ts now names that capability; src/application/LinuxHopper.ts provides LINUX_HOPPER_LAUNCHER_VERIFICATION, binary composition passes it to HopperProvider, and the provider hands it to the launcher. A launcher built without one refuses a Linux demo launch with reason verification_unavailable before running the launcher. Layer baseline: hopper -> application 2 -> 0. * refactor(config): move Hopper launcher discovery to a src/hopperPaths foundation unit (#11292) * refactor(hopper): move the launcher discovery and macOS Hopper paths to src/hopperPaths Pure move: git mv plus import specifier rewrites. * refactor(hopper): declare src/hopperPaths as a foundation unit with the Linux launcher candidates Hopper install paths and launcher discovery are pure path facts that the Hopper provider, doctor and setup all read. Declare src/hopperPaths in the foundation layer, add it to the adapters test project, the architecture map and the package-baseline CI lane, and move the Linux launcher candidates out of src/application/LinuxHopper.ts into src/hopperPaths/LinuxHopperPaths.ts so discovery no longer imports application code. * refactor(config): leave Hopper launcher discovery to the Hopper provider parseConfig resolved an unset HOPPER_LAUNCHER_PATH by probing the filesystem through application-owned discovery, so config imported application (config -> application 2, application <-> config cycle) and read process.platform ambiently. AppConfig.hopperLauncherPath is now the caller's HOPPER_LAUNCHER_PATH unchanged (string | undefined). src/hopperPaths/HopperLauncherDiscovery.ts owns the selection (selectedHopperLauncherPath: the configured spelling, else discovery from the caller environment's home on the provider's platform); HopperProvider and the two real-Hopper verifiers read it. Discovery tests move from config.test.ts to src/hopperPaths; a provider test covers discovery from the provider's own platform and home. Module layers: config -> application 2 -> 0; application <-> config removed. Architecture guards: ambient platform reads in parseConfig.ts 2 -> 0. * refactor(providers): move owned-process prerequisite availability out of application (#11294) * refactor(providers): move the owned-process prerequisite availability mapping to src/providers Pure move: git mv plus import specifier rewrites. * test(architecture): lower the layer baseline after moving owned-process availability android -> application 1 -> 0; apktool -> application 1 -> 0. * refactor(process): move the regular-file read owner out of application (#11299) * refactor(process): move the regular-file read owner from src/application to src/process Pure move: git mv plus import specifier rewrites. * test(architecture): lower the layer baseline after moving the regular-file read owner desktop -> application 5 -> 4; dotnet -> application 2 -> 1. The agentenv lane listed src/application/RegularFileRead.ts. At its new path it is a src/process/ shared boundary: fast qualification selects the code and runtime checks (and the single owning lane, web_source_map, via src/process/**), and full qualification selects every lane, as for every other src/process/ module. A second owner entry would only suppress the web_source_map selection, so the agentenv entry is removed, not renamed. * refactor(resources): give atomic text writes their own owner (#11302) * refactor(resources): give atomic text writes their own owner in src/resources src/application/JsonFiles.ts owned both JSON input reads and the atomic text write (writeTextFile / writeTextParts and their staged-output publication). The write side depends only on domain, filesystem and resource owners, but il2cpp's Ghidra seed writer had to import application to reach it (il2cpp -> application). Move the write side verbatim to src/resources/TextFileWrite.ts (TextWriteCancellation, writeTextFile, writeTextParts and their private staging, publication and failure classification helpers). JsonFiles keeps the JSON read owner and reads the shared errno-to-reason classifier (fileAccessFailureReason) from the write owner instead of a copy. Importers (il2cpp seed writer, evidence bundle files, desktop build solves, analysis snapshot files and four boundary tests) read the new path; no re-export is left in JsonFiles. * test(architecture): lower the layer baseline after moving the text write owner il2cpp -> application 1 -> 0. * refactor(ports): move the desktop build host contract to src/ports (#11303) * refactor(domain): move the setup cancellation check from src/application to src/domain Pure move: git mv plus import specifier rewrites. * refactor(ports): move the desktop build host contract to src/ports The desktop provider implements doctor's desktop build facts reader and setup's desktop build host, but the contract it implements lived in application (DesktopBuildDoctor, SetupDesktopBuild, Doctor's clientRegistrations signature, ClientRegistrationEnvironment's setting types), so desktop imported application four times and the two units were a recorded mutual pair. src/ports/DesktopBuildHost.ts now holds that contract, moved verbatim: DesktopBuildCommand, DesktopBuildFacts, DesktopBuildFactsInput, DesktopBuildSetupFacts, DesktopBuildSetupHost, RecordedProviderSettings and OwnedProviderSetting. Two names are new: DesktopBuildRegistration, the registration facts the host reads (client, command and the recorded-settings names; client registration status satisfies it), and DesktopBuildRegistrationReader, which replaces DoctorHost["clientRegistrations"] in the setup host. The facts input's registration reader returns DesktopBuildRegistration instead of the full application status; the setup facts' settings are spelled Readonly<Record<string, string>> (SetupProviderEnvironment's definition). Application imports the types from the port; no re-export is left. * test(architecture): lower the layer baseline after the desktop build host port desktop -> application 4 -> 0; the application <-> desktop mutual pair is gone. * refactor(domain): define the resolved app bundle resource root beside its schema (#11304) * refactor(domain): define the resolved app bundle resource root beside its provenance schema ResolvedAppBundleResourceRoot (an app directory's resource-only identity) is a pure type over BundleResourceRoot's layout, but it lived in src/application/AppBundleExecutable.ts, so the native and artifact providers that receive it imported application. Move the interface verbatim to src/domain/apple/bundleResourceRoot.ts, which owns BundleResourceRoot, and point its eight readers there (native macOS provider and plist source, artifact provider, binary composition, and the binary session, status, port and bundle-resource session). The resolver that produces it stays in application. * test(architecture): lower the layer baseline after moving the resource root type native -> application 2 -> 0; artifacts -> application 2 -> 1 (the artifact provider still constructs BundleResourceSession). * refactor(config): move the pwntools input bound parser to src/config (#11306) * refactor(config): move the pwntools input bound parser from src/native to src/config Pure move: git mv plus import specifier rewrites, and the module path in docs/design/rea-limit-inventory.md (table realigned by oxfmt). * test(architecture): lower the layer baseline after moving the pwntools input bound config -> native 1 -> 0. The binary_layout and recorded_crash lanes, which select src/native/pwntools/**, also select src/config/pwntoolsInputLimit*.ts; ciChangeScope.test.ts pins both. * refactor(filesystem): move REA cache directory helpers out of config (#11309) * refactor(filesystem): move the REA cache directory and lexical directory helpers from src/config to src/filesystem Pure move: git mv plus import specifier rewrites. * test(architecture): drop the config and filesystem cycle from the layer baseline config no longer imports filesystem; filesystem still reads the Windows ChangeTime settle budget from config. * refactor(windows): break the process and windows import cycle (#11317) * refactor(domain): move the runtime-control and private-runtime-root refusals from src/process to src/domain Pure move: git mv plus import specifier rewrites (including the dist path scripts/verify-windows-native.mjs loads). * refactor(windows): type Job Object cleanup by what a Windows job reports WindowsOwnedProcess.cleanup() returned process-ownership's ProcessCleanupResult, so src/windows imported src/process for a type while process imports windows to supervise Windows trees. A Job Object stop only ever reports settled-and-signalled or a reason it did not settle; name that subset WindowsJobCleanupResult in windows. It stays assignable to ProcessCleanupResult, so the process supervisor reads it unchanged. * test(architecture): drop the process and windows cycle from the layer baseline * test(architecture): ratchet cross-provider imports and imports past a provider entry (#11386) * test(architecture): ratchet cross-provider imports and imports past a provider entry A provider folder may import the domain, contracts, foundation and ports layers, the shared provider core (src/providers) and its own files; an import of another provider folder is a recorded exception. Application, composition and the CLI/MCP adapters reach a provider only through src/<provider>/index.ts. verify:module-boundaries counts both kinds of import per unit pair in the layer baseline (crossProvider, providerEntry); like the upward counts they may only shrink, and a pair missing from the baseline fails. * refactor(resources): move StableArtifactFailure and StableArtifactObservation into src/resources (#11387) * refactor(resources): move StableArtifactFailure and StableArtifactObservation into src/resources Providers project stable-read failures through StableArtifactFailure next to the other shared provider toolkit owners (ArtifactReader, ArtifactResourceScope, ArtifactFileOperation, AnalysisCleanupLease, readStableArtifact) that already live in src/resources. Under src/artifacts it made every provider that reads a stable artifact import the artifacts provider. Pure move: git mv plus import specifier and baseline updates; the layer baseline drops the provider-boundary counts the move removes. * refactor(resources): reach the shared provider toolkit through src/resources/index.ts (#11390) * refactor(resources): import the shared provider toolkit through src/resources/index.ts Adds src/resources/index.ts, which exports the toolkit names that production code outside src/resources uses, and rewrites those importers (420 files) to import from it, merging each importer's toolkit imports into one declaration. Mechanical: import declarations only. * test(architecture): reach src/resources only through its entry file verify:module-boundaries now counts any production import of a src/resources file other than src/resources/index.ts, from any unit, with the imports past a provider entry. The count is renamed from providerEntry to entry ("import past the entry file"); it may only shrink, and src/resources starts at zero. * test(architecture): cover provider boundary counts through the verifier command * refactor(resources): move the safe output tree and artifact path owners into src/resources (#11398) * refactor(resources): move the safe output tree and artifact path owners into src/resources SafeOutputTree (with its admission, creation failure, readback, cleanup and identity files), StreamBytes, ArtifactPaths and readArtifactFileChunks depend only on domain, filesystem, platform and the toolkit, and browser, firmware, ghidra, javascript, android and apktool use them to publish outputs. Under src/artifacts every such provider imported the artifacts provider. Pure move: git mv, importers moved onto src/resources/index.ts (names added to the entry), the moved files import toolkit modules directly, path keys in the CI scopes and guard baseline follow the move, and the layer baseline drops the removed imports. * test(architecture): give the shared provider core its own layer below the providers (#11401) src/providers (deferred client owners and failure attribution) now imports only domain, ports, process, filesystem and the resources toolkit. Declaring it as the providerCore layer, between ports and providers, makes any import from it into a provider folder an upward import that verify:module-boundaries rejects, and lets every unit in the providers layer be a provider folder. * test(architecture): declare each provider's entry files instead of a provider barrel (#11407) * chore: ignore the source map parser move (#11348) in blame * test(architecture): declare inspector's use of the browser CDP client as a provider dependency (#11420)
534 lines
18 KiB
TypeScript
534 lines
18 KiB
TypeScript
import type { AnalysisProfileCommitment } from "../../domain/analysisProfile.js";
|
|
import { analysisProfilesEqual } from "../../domain/analysisProfile.js";
|
|
import type { AnalysisSnapshot } from "../../domain/analysisSnapshot.js";
|
|
import type { BinaryTarget } from "../../domain/binaryTargetTypes.js";
|
|
import type { Evidence } from "../../domain/evidence.js";
|
|
import type { EvidenceBundle } from "../../domain/evidenceBundle.js";
|
|
import type { JsonValue } from "../../domain/jsonValue.js";
|
|
import { evidenceBundleForTarget } from "../../domain/evidenceBundle.js";
|
|
import {
|
|
EvidenceIntegrityError,
|
|
AnalysisSnapshotMismatchError,
|
|
} from "../../domain/evidenceErrors.js";
|
|
import type { AnalysisError } from "../../domain/analysisErrorBase.js";
|
|
import type { InvestigationStatistics } from "../../domain/investigationLifecycle.js";
|
|
import {
|
|
AnalysisCapabilityUnavailableError,
|
|
cancelledBy,
|
|
OwnerCancellation,
|
|
} from "../../domain/analysisErrorCore.js";
|
|
import type { UnknownRegistryError } from "../../domain/unknownRegistryError.js";
|
|
import type {
|
|
RecordUnknownInput,
|
|
ResidualUnknown,
|
|
UnknownStatus,
|
|
UpdateUnknownInput,
|
|
} from "../../domain/residualUnknown.js";
|
|
import type {
|
|
EvidenceImportReceipt,
|
|
UnknownPage,
|
|
UnknownQuery,
|
|
} from "../investigation/InvestigationRecordPort.js";
|
|
import { err, ok, type Result } from "../../domain/result.js";
|
|
import type {
|
|
AnalysisExecution,
|
|
AnalysisOperation,
|
|
RetainedResourceScope,
|
|
} from "../../ports/AnalysisProvider.js";
|
|
import { AnalysisSnapshotCache } from "./AnalysisSnapshotCache.js";
|
|
import { InvestigationRecords } from "../investigation/InvestigationRecords.js";
|
|
import {
|
|
ArtifactResourceScope,
|
|
ArtifactReaderFailure,
|
|
} from "../../resources/index.js";
|
|
import { bindRegularFileCleanup } from "../../process/RegularFileRead.js";
|
|
import {
|
|
writeAnalysisSnapshot as writeSnapshotFile,
|
|
readAnalysisSnapshot as readSnapshotFile,
|
|
} from "./AnalysisSnapshotFiles.js";
|
|
import { ProviderCleanupError } from "../../domain/providerCleanupError.js";
|
|
import { workflowAnalysisProfile } from "../WorkflowAnalysisProfile.js";
|
|
import {
|
|
hasOnlyProfilelessNativeDispatchEntries,
|
|
profilelessSnapshotMismatch,
|
|
} from "./ProfilelessNativeWorkflowSnapshot.js";
|
|
|
|
const SNAPSHOT_MUTATION_RECOVERY =
|
|
"Export session observations through export_evidence_bundle if needed. Close the active target without saving a snapshot, then reopen it before importing or saving a snapshot.";
|
|
|
|
/** A missing replay prerequisite is not an Evidence integrity failure. */
|
|
const snapshotUnavailable = (reason: string) =>
|
|
new AnalysisCapabilityUnavailableError(
|
|
"rea",
|
|
"export_analysis_snapshot",
|
|
reason,
|
|
{
|
|
userMessage: `Analysis snapshot unavailable: ${reason}`,
|
|
remediationAction:
|
|
"Export session observations with export_evidence_bundle if needed, or call close_binary without snapshot_path to close the session.",
|
|
},
|
|
);
|
|
|
|
export interface ActiveAnalysisBinding {
|
|
readonly target: BinaryTarget;
|
|
readonly profile: AnalysisProfileCommitment | null;
|
|
/** Current route profile for the single profileless native dispatch workflow. */
|
|
readonly profilelessWorkflowProfile?: AnalysisProfileCommitment;
|
|
}
|
|
|
|
/** Validated composed-workflow payload bound to the active target and profile. */
|
|
export interface WorkflowSnapshotRecordInput {
|
|
readonly operation: AnalysisOperation;
|
|
readonly bindingProfile: AnalysisProfileCommitment;
|
|
readonly parameters: Readonly<Record<string, JsonValue>>;
|
|
readonly execution: Parameters<
|
|
AnalysisSnapshotCache["recordWorkflow"]
|
|
>[0]["execution"];
|
|
}
|
|
|
|
/** Own binary snapshots and coordinate the composed investigation records. */
|
|
export abstract class BinarySessionRecords {
|
|
readonly #records: InvestigationRecords;
|
|
protected readonly fileResources = new ArtifactResourceScope();
|
|
|
|
readonly resourceScope: RetainedResourceScope = {
|
|
retain: (owner, resource) =>
|
|
this.fileResources.retain({
|
|
kind: "lease",
|
|
resource,
|
|
lease: { release: () => owner.close() },
|
|
}),
|
|
run: (operation) => this.fileResources.run(operation),
|
|
};
|
|
|
|
protected get hasPendingFileResources(): boolean {
|
|
return this.fileResources.hasPending;
|
|
}
|
|
readonly #snapshot = new AnalysisSnapshotCache();
|
|
#snapshotInvalidated = false;
|
|
#investigationDisposed = false;
|
|
readonly #snapshotListeners = new Set<() => void | Promise<void>>();
|
|
|
|
constructor(records: InvestigationRecords = new InvestigationRecords()) {
|
|
this.#records = records;
|
|
}
|
|
|
|
/** Observe changes to the mutable current analysis snapshot resource. */
|
|
onAnalysisSnapshotChanged(listener: () => void | Promise<void>): () => void {
|
|
this.#snapshotListeners.add(listener);
|
|
return () => this.#snapshotListeners.delete(listener);
|
|
}
|
|
|
|
recordEvidence(
|
|
evidence: Evidence,
|
|
): Result<"added" | "duplicate", AnalysisError> {
|
|
if (this.#investigationDisposed)
|
|
return err(cancelledBy("record_evidence", OwnerCancellation.ownerClosed));
|
|
const recorded = this.#records.recordEvidence(evidence);
|
|
if (recorded.ok && recorded.value === "added") this.#emitSnapshotChanged();
|
|
return recorded;
|
|
}
|
|
|
|
admitRecoveryObservation(
|
|
input: unknown,
|
|
operation: string,
|
|
additional: {
|
|
readonly valueBytes: number;
|
|
readonly serializedUtf16Bytes: number;
|
|
},
|
|
): Result<void, AnalysisError> {
|
|
return this.#records.admitRecoveryObservation(input, operation, additional);
|
|
}
|
|
|
|
hasEvidence(evidenceId: string): boolean {
|
|
return this.#records.hasEvidence(evidenceId);
|
|
}
|
|
|
|
evidenceById(evidenceId: string): Evidence | undefined {
|
|
return this.#records.evidenceById(evidenceId);
|
|
}
|
|
|
|
/** Borrow immutable investigation Evidence without copying a complete graph. */
|
|
evidenceForAnalysis(evidenceId: string): Evidence | undefined {
|
|
return this.#records.evidenceForAnalysis(evidenceId);
|
|
}
|
|
|
|
exportEvidenceBundle(): EvidenceBundle {
|
|
return this.#records.exportEvidenceBundle();
|
|
}
|
|
|
|
/** Borrow the record owner's immutable bundle for read-only workflows. */
|
|
immutableEvidenceBundle(): EvidenceBundle {
|
|
return this.#records.immutableEvidenceBundle();
|
|
}
|
|
|
|
/** Read one snapshot while retaining failed descriptors under this session. */
|
|
readAnalysisSnapshot(path: string, signal?: AbortSignal) {
|
|
return readSnapshotFile(path, signal, this.fileResources);
|
|
}
|
|
|
|
/** Persist one provider-neutral snapshot under this session's resource owner. */
|
|
writeAnalysisSnapshot(
|
|
snapshot: AnalysisSnapshot,
|
|
path: string,
|
|
overwrite: boolean,
|
|
): Promise<
|
|
Result<{ readonly path: string; readonly bytes: number }, AnalysisError>
|
|
> {
|
|
return writeSnapshotFile(snapshot, path, overwrite, this.fileResources);
|
|
}
|
|
|
|
/** Retry retained target reads and snapshot files at the owning session shutdown. */
|
|
async closeFileResources(): Promise<Result<null, AnalysisError>> {
|
|
try {
|
|
await this.fileResources.retryCleanup();
|
|
return ok(null);
|
|
} catch (cause: unknown) {
|
|
const observation = ArtifactReaderFailure.cleanupObservation(
|
|
cause,
|
|
"analysis session files",
|
|
);
|
|
const error = new ProviderCleanupError(
|
|
"rea",
|
|
observation.resources,
|
|
{ reason: observation.reason },
|
|
{ cause, operation: "close_binary" },
|
|
);
|
|
bindRegularFileCleanup(cause, error);
|
|
return err(error);
|
|
}
|
|
}
|
|
|
|
importEvidenceBundle(
|
|
bundle: unknown,
|
|
): Result<EvidenceImportReceipt, AnalysisError> {
|
|
if (this.#investigationDisposed)
|
|
return err(
|
|
cancelledBy("import_evidence_bundle", OwnerCancellation.ownerClosed),
|
|
);
|
|
const imported = this.#records.mergeEvidenceBundle(bundle);
|
|
if (!imported.ok) return imported;
|
|
this.#snapshot.refreshEvidenceMetadata(imported.value.replacements);
|
|
if (imported.value.changed) this.#emitSnapshotChanged();
|
|
return ok({
|
|
recordsAdded: imported.value.recordsAdded,
|
|
unknownsAdded: imported.value.unknownsAdded,
|
|
totalRecords: this.#records.statistics().evidenceRecords,
|
|
});
|
|
}
|
|
|
|
protected abstract activeAnalysisBinding(): ActiveAnalysisBinding | undefined;
|
|
|
|
exportAnalysisSnapshot(): Result<AnalysisSnapshot, AnalysisError> {
|
|
const active = this.activeAnalysisBinding();
|
|
if (this.#snapshotInvalidated)
|
|
return err(
|
|
new EvidenceIntegrityError(
|
|
"Analysis snapshots are unavailable because analysis metadata may have changed",
|
|
{
|
|
userMessage: `Analysis snapshots are unavailable because analysis metadata may have changed. ${SNAPSHOT_MUTATION_RECOVERY}`,
|
|
},
|
|
),
|
|
);
|
|
const target = active?.target;
|
|
const profile =
|
|
active?.profile ?? active?.profilelessWorkflowProfile ?? undefined;
|
|
if (target !== undefined && profile === undefined)
|
|
return err(
|
|
snapshotUnavailable(
|
|
"The active target has no provider analysis profile for a snapshot.",
|
|
),
|
|
);
|
|
if (
|
|
active?.profile === null &&
|
|
(target === undefined ||
|
|
profile === undefined ||
|
|
!this.#snapshot.matches(target, profile) ||
|
|
this.#snapshot.entries().length !== 0 ||
|
|
!hasOnlyProfilelessNativeDispatchEntries(
|
|
this.#snapshot.workflowEntries(),
|
|
profile,
|
|
))
|
|
)
|
|
return err(
|
|
snapshotUnavailable(
|
|
"The active session does not have a supported snapshot binding with replayable workflow observations for this target.",
|
|
),
|
|
);
|
|
return this.#snapshot.export(
|
|
target,
|
|
profile,
|
|
target === undefined
|
|
? this.#records.exportEvidenceBundle()
|
|
: evidenceBundleForTarget(
|
|
this.#records.exportEvidenceBundle(),
|
|
target.sha256,
|
|
),
|
|
);
|
|
}
|
|
|
|
importAnalysisSnapshot(
|
|
snapshot: AnalysisSnapshot,
|
|
): Result<number, AnalysisError> {
|
|
if (this.#investigationDisposed)
|
|
return err(
|
|
cancelledBy("import_analysis_snapshot", OwnerCancellation.ownerClosed),
|
|
);
|
|
const active = this.activeAnalysisBinding();
|
|
if (active !== undefined && this.#snapshotInvalidated)
|
|
return err(
|
|
new EvidenceIntegrityError(
|
|
"Analysis snapshots cannot be imported because analysis metadata may have changed",
|
|
{
|
|
userMessage: `Analysis snapshots cannot be imported because analysis metadata may have changed. ${SNAPSHOT_MUTATION_RECOVERY}`,
|
|
},
|
|
),
|
|
);
|
|
const profile = active?.profile ?? active?.profilelessWorkflowProfile;
|
|
if (active?.profile === null) {
|
|
const mismatch = profilelessSnapshotMismatch(
|
|
snapshot,
|
|
active.target,
|
|
profile,
|
|
);
|
|
if (mismatch !== undefined)
|
|
return err(
|
|
new AnalysisSnapshotMismatchError(
|
|
"Analysis snapshot is not bound to the active native dispatch reader",
|
|
mismatch,
|
|
),
|
|
);
|
|
}
|
|
const imported = this.#snapshot.import(
|
|
snapshot,
|
|
active === undefined
|
|
? undefined
|
|
: profile === undefined
|
|
? undefined
|
|
: { target: active.target, profile },
|
|
(bundle) => {
|
|
const imported = this.#records.mergeEvidenceBundle(bundle);
|
|
if (!imported.ok) return imported;
|
|
this.#snapshot.refreshEvidenceMetadata(imported.value.replacements);
|
|
return ok(imported.value.recordsAdded);
|
|
},
|
|
);
|
|
if (imported.ok) this.#emitSnapshotChanged();
|
|
return imported;
|
|
}
|
|
|
|
protected snapshotMismatch(
|
|
target: BinaryTarget,
|
|
profile: AnalysisProfileCommitment | null,
|
|
) {
|
|
return this.#snapshot.mismatch(target, profile ?? undefined);
|
|
}
|
|
|
|
protected selectSnapshot(
|
|
target: BinaryTarget,
|
|
profile: AnalysisProfileCommitment,
|
|
): void {
|
|
this.#snapshot.select(target, profile);
|
|
this.#emitSnapshotChanged();
|
|
}
|
|
|
|
protected lookupSnapshot(
|
|
target: BinaryTarget,
|
|
profile: AnalysisProfileCommitment,
|
|
operation: AnalysisOperation,
|
|
parameters: Readonly<
|
|
Record<string, import("../../domain/jsonValue.js").JsonValue>
|
|
>,
|
|
): AnalysisExecution | undefined {
|
|
if (this.#snapshotInvalidated) return undefined;
|
|
return this.#snapshot.lookup(target, profile, operation, parameters, (id) =>
|
|
this.evidenceForAnalysis(id),
|
|
);
|
|
}
|
|
|
|
protected recordSnapshot(
|
|
input: Parameters<AnalysisSnapshotCache["record"]>[0],
|
|
): void {
|
|
if (this.#snapshotInvalidated) return;
|
|
this.#snapshot.record(input, (id) => this.evidenceForAnalysis(id));
|
|
this.#emitSnapshotChanged();
|
|
}
|
|
|
|
/** Retain one derived workflow result alongside its provider cache entries. */
|
|
recordWorkflowSnapshot(
|
|
input: WorkflowSnapshotRecordInput,
|
|
): Result<null, EvidenceIntegrityError> {
|
|
const active = this.activeAnalysisBinding();
|
|
if (active === undefined)
|
|
return err(
|
|
new EvidenceIntegrityError(
|
|
"Workflow snapshot entries require an active concrete provider profile",
|
|
),
|
|
);
|
|
if (this.#snapshotInvalidated) return ok(null);
|
|
const profile = active.profile ?? active.profilelessWorkflowProfile;
|
|
if (
|
|
profile === undefined ||
|
|
!analysisProfilesEqual(profile, input.bindingProfile) ||
|
|
!analysisProfilesEqual(
|
|
input.execution.analysisProfile,
|
|
workflowAnalysisProfile(profile, input.operation),
|
|
) ||
|
|
(active.profile === null &&
|
|
input.operation !== "inspect_native_dispatch_metadata")
|
|
)
|
|
return err(
|
|
new EvidenceIntegrityError(
|
|
"Workflow snapshot entry does not match the active reader profile",
|
|
),
|
|
);
|
|
try {
|
|
this.#snapshot.recordWorkflow({
|
|
target: active.target,
|
|
profile,
|
|
...input,
|
|
});
|
|
this.#emitSnapshotChanged();
|
|
return ok(null);
|
|
} catch (cause: unknown) {
|
|
return err(
|
|
new EvidenceIntegrityError(
|
|
cause instanceof Error
|
|
? cause.message
|
|
: "Workflow snapshot entry validation failed",
|
|
{ cause },
|
|
),
|
|
);
|
|
}
|
|
}
|
|
|
|
protected invalidateSnapshot(): void {
|
|
this.#snapshot.clear();
|
|
this.#snapshotInvalidated = true;
|
|
this.#emitSnapshotChanged();
|
|
}
|
|
|
|
protected resetSnapshotInvalidation(): void {
|
|
if (!this.#snapshotInvalidated) return;
|
|
this.#snapshot.clear();
|
|
this.#snapshotInvalidated = false;
|
|
this.#emitSnapshotChanged();
|
|
}
|
|
|
|
protected clearSnapshot(): void {
|
|
this.#snapshot.clear();
|
|
this.#emitSnapshotChanged();
|
|
}
|
|
|
|
/** Clear replay and engine invalidation state when the engine is retired. */
|
|
protected clearEngineRecords(): void {
|
|
this.#snapshot.clear();
|
|
this.#snapshotInvalidated = false;
|
|
this.#emitSnapshotChanged();
|
|
}
|
|
|
|
/** End investigation history without making mutated engine state replayable again. */
|
|
protected clearInvestigationRecords(): void {
|
|
this.#records.clear();
|
|
this.clearSnapshot();
|
|
}
|
|
|
|
/** Terminal runtime disposal also seals direct record-port writes. */
|
|
protected disposeInvestigationRecords(): void {
|
|
this.#investigationDisposed = true;
|
|
this.clearInvestigationRecords();
|
|
}
|
|
|
|
protected investigationStatistics(): InvestigationStatistics {
|
|
const statistics = this.#records.statistics();
|
|
return {
|
|
evidence_records: statistics.evidenceRecords,
|
|
unknown_revisions: statistics.unknownRevisions,
|
|
unknown_heads: statistics.unknownHeads,
|
|
retained_representation_bytes: statistics.retainedRepresentationBytes,
|
|
maximum_representation_bytes: statistics.maximumRepresentationBytes,
|
|
persistence: "memory",
|
|
};
|
|
}
|
|
|
|
#emitSnapshotChanged(): void {
|
|
for (const listener of this.#snapshotListeners) {
|
|
try {
|
|
const notification = listener();
|
|
if (notification !== undefined)
|
|
void notification.catch((cause: unknown) => {
|
|
// best-effort cleanup: async observer notifications must not reject unhandled.
|
|
void cause;
|
|
});
|
|
} catch (cause: unknown) {
|
|
// External resource observers are best-effort; one callback must not
|
|
// make a committed evidence mutation appear to fail.
|
|
void cause;
|
|
}
|
|
}
|
|
}
|
|
|
|
recordUnknown(
|
|
input: RecordUnknownInput,
|
|
): Result<ResidualUnknown, AnalysisError> {
|
|
if (this.#investigationDisposed)
|
|
return err(cancelledBy("record_unknown", OwnerCancellation.ownerClosed));
|
|
const target = this.activeAnalysisBinding()?.target;
|
|
const recorded = this.#records.recordUnknown(input, target);
|
|
if (recorded.ok) this.#emitSnapshotChanged();
|
|
return recorded;
|
|
}
|
|
|
|
recordEvidenceWithUnknown(
|
|
evidence: Evidence,
|
|
input: RecordUnknownInput,
|
|
): Result<ResidualUnknown | null, AnalysisError> {
|
|
if (this.#investigationDisposed)
|
|
return err(
|
|
cancelledBy(
|
|
"record_evidence_with_unknown",
|
|
OwnerCancellation.ownerClosed,
|
|
),
|
|
);
|
|
const recorded = this.#records.recordEvidenceWithUnknown(evidence, input);
|
|
if (recorded.ok) this.#emitSnapshotChanged();
|
|
return recorded;
|
|
}
|
|
|
|
updateUnknown(
|
|
input: UpdateUnknownInput,
|
|
): Result<ResidualUnknown, AnalysisError> {
|
|
if (this.#investigationDisposed)
|
|
return err(cancelledBy("update_unknown", OwnerCancellation.ownerClosed));
|
|
const target = this.activeAnalysisBinding()?.target;
|
|
const updated = this.#records.updateUnknown(input, target);
|
|
if (updated.ok) this.#emitSnapshotChanged();
|
|
return updated;
|
|
}
|
|
|
|
listUnknowns(
|
|
filters: {
|
|
readonly status?: UnknownStatus;
|
|
readonly severity?: ResidualUnknown["severity"];
|
|
readonly domain?: string;
|
|
} = {},
|
|
): ResidualUnknown[] {
|
|
return this.#records.listUnknowns(filters);
|
|
}
|
|
|
|
listUnknownsPage(query: UnknownQuery = {}): UnknownPage {
|
|
return this.#records.listUnknownsPage(query);
|
|
}
|
|
|
|
verifyUnknownResolution(unknownId: string): Result<
|
|
{
|
|
readonly valid: boolean;
|
|
readonly truthVerified: boolean;
|
|
readonly unknown: ResidualUnknown;
|
|
},
|
|
UnknownRegistryError
|
|
> {
|
|
return this.#records.verifyUnknownResolution(unknownId);
|
|
}
|
|
}
|