diff --git a/scripts/verify/architecture-guard-baselines.json b/scripts/verify/architecture-guard-baselines.json index dd76a2e308..15e52621a3 100644 --- a/scripts/verify/architecture-guard-baselines.json +++ b/scripts/verify/architecture-guard-baselines.json @@ -366,15 +366,11 @@ "src/desktop/AgentEnvSolveHelper.ts": 2, "src/desktop/BuildComputerLongRuns.ts": 1, "src/desktop/ScreenJudgeProcess.ts": 1, - "src/ghidra/GhidraCheckpoint.ts": 1, - "src/ghidra/GhidraClient.ts": 1, "src/ida/IdaSessionClient.ts": 1, "src/javascript/sourceMaps/SourceMapCommand.ts": 1, "src/kuna/KunaProjectCache.ts": 1, "src/native/CommandRunner.ts": 1, "src/native/LldbCallTracer.ts": 1, - "src/process/DarwinHelperCache.ts": 1, - "src/process/DarwinProcessRunTokenReader.ts": 1, "src/process/OwnedDebuggerSessionRegistry.ts": 1, "src/providers/AnalysisClientFailure.ts": 1, "src/server/environment/serveEnvironment.ts": 1, @@ -485,8 +481,7 @@ "src/pcap/PcapProvider.ts": 7, "src/pcap/PcapSnapshot.ts": 1, "src/process/ArtifactAnalysisResources.ts": 4, - "src/process/DarwinHelperCache.ts": 1, - "src/process/DarwinProcessRunTokenReader.ts": 3, + "src/process/DarwinProcessRunTokenReader.ts": 2, "src/process/capture/FilesystemSnapshot.ts": 1, "src/process/capture/ProcessCaptureError.ts": 3, "src/process/capture/ProcessCaptureLifecycle.ts": 1, diff --git a/src/domain/analysisCleanupRelease.test.ts b/src/domain/analysisCleanupRelease.test.ts new file mode 100644 index 0000000000..65c6cb325b --- /dev/null +++ b/src/domain/analysisCleanupRelease.test.ts @@ -0,0 +1,31 @@ +import { expect, it } from "vitest"; + +import { AnalysisCleanupRelease } from "./analysisCleanupRelease.js"; +import { ProviderCleanupError } from "./providerCleanupError.js"; + +const failure = () => + new ProviderCleanupError( + "process-ownership", + ["/tmp/rea-owned"], + { reason: "removal failed" }, + { operation: "prepare_owned_process" }, + ); + +it("lets every bound error read one owner's confirmed release", () => { + const release = new AnalysisCleanupRelease(); + const first = release.bind(failure()); + const second = release.bind(failure()); + expect([first.cleanupIncomplete, second.cleanupIncomplete]).toEqual([ + true, + true, + ]); + + release.confirm(); + + expect([first.cleanupIncomplete, second.cleanupIncomplete]).toEqual([ + false, + false, + ]); + // An error bound after the release reads it immediately. + expect(release.bind(failure()).cleanupIncomplete).toBe(false); +}); diff --git a/src/domain/analysisCleanupRelease.ts b/src/domain/analysisCleanupRelease.ts new file mode 100644 index 0000000000..ea5a0e2fd3 --- /dev/null +++ b/src/domain/analysisCleanupRelease.ts @@ -0,0 +1,26 @@ +import type { + AnalysisCleanupReleaseClaim, + AnalysisError, +} from "./analysisErrorBase.js"; + +/** + * Release recorded by an owner that retries its cleanup in place instead of + * through one `close()`. Errors bound to it read the release when asked; it is + * never pushed to them. Start a new one for each unreleased cleanup. + */ +export class AnalysisCleanupRelease implements AnalysisCleanupReleaseClaim { + #released = false; + + get cleanupReleased(): boolean { + return this.#released; + } + + /** Let `error` report this owner's release whenever it is asked. */ + bind(error: T): T { + return error.bindCleanupReleaseClaim(this); + } + + confirm(): void { + this.#released = true; + } +} diff --git a/src/ghidra/GhidraCheckpoint.ts b/src/ghidra/GhidraCheckpoint.ts index e526dc129e..161a3272e6 100644 --- a/src/ghidra/GhidraCheckpoint.ts +++ b/src/ghidra/GhidraCheckpoint.ts @@ -15,6 +15,7 @@ import { z } from "zod"; import type { AnalysisProfileCommitment } from "../domain/analysisProfile.js"; import { ConfigurationError } from "../domain/configurationErrors.js"; import { ProviderCleanupError } from "../domain/providerCleanupError.js"; +import { AnalysisCleanupRelease } from "../domain/analysisCleanupRelease.js"; import { analysisErrorWithCleanupFailure } from "../domain/analysisErrorCleanup.js"; import type { ArtifactResourceScope } from "../artifacts/ArtifactResourceScope.js"; import { @@ -204,7 +205,8 @@ export class GhidraCheckpoint { #source: CheckpointSource | null | undefined; #state: GhidraCheckpointSelection["state"]; readonly #pendingRemoval = new Set(); - readonly #cleanupFailures = new Set(); + /** Reported by every removal failure until a retry removes every file. */ + #cleanupRelease = new AnalysisCleanupRelease(); #publishedInput: string | undefined; constructor( readonly selection: GhidraCheckpointSelection, @@ -406,12 +408,11 @@ export class GhidraCheckpoint { }, { cause }, ); - this.#cleanupFailures.add(error); - throw error; + throw this.#cleanupRelease.bind(error); } } - for (const failure of this.#cleanupFailures) failure.resolveCleanup(); - this.#cleanupFailures.clear(); + this.#cleanupRelease.confirm(); + this.#cleanupRelease = new AnalysisCleanupRelease(); } async close(): Promise { await this.retryCleanup(); diff --git a/src/ghidra/GhidraClient.ts b/src/ghidra/GhidraClient.ts index efaf607616..7f5176526e 100644 --- a/src/ghidra/GhidraClient.ts +++ b/src/ghidra/GhidraClient.ts @@ -17,6 +17,7 @@ import { AnalysisError } from "../domain/analysisErrorBase.js"; import type { JsonValue } from "../domain/jsonValue.js"; import type { NativeValueFlowLimits } from "../domain/native/nativeValueFlow.js"; import { ProviderCleanupError } from "../domain/providerCleanupError.js"; +import { AnalysisCleanupRelease } from "../domain/analysisCleanupRelease.js"; import { providerRetryAction, type ProviderOperationHealth, @@ -163,7 +164,8 @@ export class GhidraClient { | { readonly path: string; readonly disposition: "publish" | "discard" } | undefined; #checkpointRestore: GhidraPackedProgram | undefined; - readonly #cleanupFailures = new Set(); + /** Reported by every cleanup failure until a close releases everything. */ + #cleanupRelease = new AnalysisCleanupRelease(); #targetAdmission: JsonValue | undefined; #token: string | undefined; // Retain authentication identities for diagnostics from late request settlement. @@ -894,8 +896,7 @@ export class GhidraClient { ]; }, }); - this.#cleanupFailures.add(failure); - return failure; + return this.#cleanupRelease.bind(failure); } /** Observed failures that prevent a retained session from being reused. */ @@ -1436,8 +1437,8 @@ export class GhidraClient { this.#runId = undefined; this.#responseLines.reset(); if (forcedStopFailure !== undefined) throw forcedStopFailure.cause; - for (const failure of this.#cleanupFailures) failure.resolveCleanup(); - this.#cleanupFailures.clear(); + this.#cleanupRelease.confirm(); + this.#cleanupRelease = new AnalysisCleanupRelease(); } finally { this.#closing = false; } diff --git a/src/process/DarwinHelperCache.ts b/src/process/DarwinHelperCache.ts index db4f623f79..90f59552a6 100644 --- a/src/process/DarwinHelperCache.ts +++ b/src/process/DarwinHelperCache.ts @@ -18,6 +18,7 @@ import { dirname, isAbsolute, join } from "node:path"; import { z } from "zod"; import { ProviderCleanupError } from "../domain/providerCleanupError.js"; +import { AnalysisCleanupRelease } from "../domain/analysisCleanupRelease.js"; import { safeParseJson } from "../domain/safeJson.js"; import { appendCallerPath } from "../filesystem/callerPath.js"; import type { OwnedFileHandle } from "../filesystem/OwnedFileHandle.js"; @@ -169,8 +170,8 @@ export const createDarwinHelperCache = (options: { const uid = process.getuid?.(); // Failed closes and removals stay owned until close() retries them. const retained = new Map Promise>(); - // The first unresolved close failure; later ones depend on it. - let cleanupAnchor: ProviderCleanupError | undefined; + // Every close failure reports this release until a retry releases them all. + let cleanupRelease: AnalysisCleanupRelease | undefined; let key: Promise | undefined; const xcrun = async ( @@ -462,13 +463,10 @@ export const createDarwinHelperCache = (options: { operation: "prepare_owned_process", }, ); - // Every returned failure clears once a later retry releases them all. - if (cleanupAnchor === undefined) cleanupAnchor = failure; - else failure.bindCleanupDependencies([cleanupAnchor]); - throw failure; + throw (cleanupRelease ??= new AnalysisCleanupRelease()).bind(failure); } - cleanupAnchor?.resolveCleanup(); - cleanupAnchor = undefined; + cleanupRelease?.confirm(); + cleanupRelease = undefined; }; return { lookup, publish, close }; diff --git a/src/process/DarwinProcessRunTokenReader.ts b/src/process/DarwinProcessRunTokenReader.ts index 1687843934..5d35774bae 100644 --- a/src/process/DarwinProcessRunTokenReader.ts +++ b/src/process/DarwinProcessRunTokenReader.ts @@ -19,6 +19,7 @@ import { import { MAX_NODE_TIMER_DELAY_MS } from "../domain/analysisResourceLimits.js"; import { err, ok, type Result } from "../domain/result.js"; import { ProviderCleanupError } from "../domain/providerCleanupError.js"; +import { AnalysisCleanupRelease } from "../domain/analysisCleanupRelease.js"; import type { AnalysisCapturedOutput, AnalysisError, @@ -370,7 +371,8 @@ const compilerInspectionError = ( interface ProcessReaderRoot { readonly path: string; cleanupPromise?: Promise | undefined; - cleanupAnchor?: ProviderCleanupError | undefined; + /** Reported by every removal failure until a retry removes the root. */ + cleanupRelease?: AnalysisCleanupRelease | undefined; } interface ProcessReaderCompilation { @@ -508,13 +510,12 @@ export const createDarwinProcessRunTokenReader = ( }, { cause, operation: "prepare_owned_process" }, ); - if (target.cleanupAnchor === undefined) - target.cleanupAnchor = failure; - else failure.bindCleanupDependencies([target.cleanupAnchor]); - throw failure; + throw (target.cleanupRelease ??= new AnalysisCleanupRelease()).bind( + failure, + ); } - target.cleanupAnchor?.resolveCleanup(); - target.cleanupAnchor = undefined; + target.cleanupRelease?.confirm(); + target.cleanupRelease = undefined; if (root !== target) return; root = undefined; executable = undefined;