diff --git a/scripts/verify/architecture-guard-baselines.json b/scripts/verify/architecture-guard-baselines.json index a460891ccc..41455ba456 100644 --- a/scripts/verify/architecture-guard-baselines.json +++ b/scripts/verify/architecture-guard-baselines.json @@ -1,20 +1,5 @@ { "analysis-cancelled-constructor": { - "src/adb/AdbCommand.ts": 2, - "src/adb/AdbConfiguration.ts": 2, - "src/adb/AdbInputSnapshot.ts": 1, - "src/adb/AdbProvider.ts": 12, - "src/android/AndroidMappingFile.ts": 1, - "src/android/JadxConfiguration.ts": 2, - "src/android/JadxFailure.ts": 3, - "src/android/JadxJavaProbe.ts": 1, - "src/android/JadxProvider.ts": 5, - "src/android/JadxSession.ts": 1, - "src/apkSignature/ApkSignatureAdmission.ts": 2, - "src/apkSignature/apkSignatureFailures.ts": 1, - "src/apktool/ApktoolConfiguration.ts": 3, - "src/apktool/ApktoolProvider.ts": 7, - "src/apktool/ApktoolStringTables.ts": 1, "src/application/AnalysisContextQueries.ts": 6, "src/application/AnalysisDocument.ts": 3, "src/application/AnalysisInput.ts": 1, @@ -137,16 +122,12 @@ "src/doctorRuntime.ts": 3, "src/domain/apple/dylibResolution.ts": 1, "src/domain/explicitSensitiveFailure.ts": 1, - "src/dotnet/ManagedSnapshot.ts": 5, - "src/dotnet/ManagedStaticProvider.ts": 2, "src/electron/ElectronFuseFailures.ts": 3, "src/evm/EvmoleFailures.ts": 2, "src/evm/EvmoleInterfaceProvider.ts": 6, "src/firmware/FirmwareFailures.ts": 1, "src/firmware/FirmwareFiles.ts": 1, "src/firmware/FirmwareProvider.ts": 1, - "src/flutter/FlutterBuildProvider.ts": 8, - "src/frida/FridaInstrumentationManager.ts": 2, "src/gdb/GdbSessionManager.ts": 14, "src/gpu/GpuCodeObjectsProvider.ts": 1, "src/hopper/HopperAnalysisProfile.ts": 1, @@ -154,8 +135,6 @@ "src/hopper/HopperFileOffset.ts": 1, "src/hopper/HopperMachOImage.ts": 10, "src/hopper/HopperRegexSearch.ts": 3, - "src/il2cpp/Il2cppGhidraSeedWriter.ts": 1, - "src/il2cpp/Il2cppMetadataProvider.ts": 1, "src/inspector/JavaScriptRuntimeScope.ts": 1, "src/inspector/V8InspectorProvider.ts": 2, "src/javascript/analysis/JavaScriptAnalysisWorker.ts": 5, diff --git a/src/adb/AdbCommand.ts b/src/adb/AdbCommand.ts index ebb79b90c4..bf25548dcf 100644 --- a/src/adb/AdbCommand.ts +++ b/src/adb/AdbCommand.ts @@ -1,9 +1,10 @@ import { - AnalysisCancelledError, AnalysisProtocolError, AnalysisResourceConstraintError, AnalysisTimeoutError, AnalysisUnsupportedTargetError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import type { AnalysisError } from "../domain/analysisErrorBase.js"; import { fixedAllowanceOptions } from "../domain/fixedAllowanceRemediation.js"; @@ -132,8 +133,7 @@ export const runAdbCapture = async ( limits: AdbRunLimits, signal: AbortSignal | undefined, ): Promise> => { - if (signal?.aborted === true) - return err(new AnalysisCancelledError(operation, { cause: signal.reason })); + if (signal?.aborted === true) return err(cancelledBy(operation, signal)); try { return ok( await execFileBytes(selection.binary, arguments_, { @@ -148,12 +148,13 @@ export const runAdbCapture = async ( const failure = execFileOutputFailure(cause); if (cause instanceof ExecFileOutputCancelledError) return err( - new AnalysisCancelledError(operation, { - cause: cause.cause, - ...(failure === undefined + cancelledBy( + operation, + carriedReason(cause.cause), + failure === undefined ? {} - : { capturedOutput: execFileFailureCapturedOutput(failure) }), - }), + : { capturedOutput: execFileFailureCapturedOutput(failure) }, + ), ); if (failure === undefined) return err( diff --git a/src/adb/AdbConfiguration.ts b/src/adb/AdbConfiguration.ts index 0c432ce6b6..f0ffcb190c 100644 --- a/src/adb/AdbConfiguration.ts +++ b/src/adb/AdbConfiguration.ts @@ -1,7 +1,8 @@ import { - AnalysisCancelledError, AnalysisResourceConstraintError, AnalysisTimeoutError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import { isAbsolute, win32 } from "node:path"; import { findWindowsExecutable } from "../process/WindowsExecutable.js"; @@ -96,9 +97,7 @@ const resolveWindowsAdb = async ( const failure = found.error; if (failure.kind === "interrupted") { if (deadline.interruption === "cancelled") - throw new AnalysisCancelledError("inspect_adb_client", { - cause: signal?.reason, - }); + throw cancelledBy("inspect_adb_client", carriedReason(signal?.reason)); throw new AnalysisTimeoutError("inspect_adb_client", VERSION_TIMEOUT_MS, { diagnostics: { phase: "windows_path_lookup" }, }); @@ -216,12 +215,13 @@ export const inspectAdbClient = async ( if (cause instanceof AdbConfigurationFailure) throw cause; const failure = execFileOutputFailure(cause); if (cause instanceof ExecFileOutputCancelledError) - throw new AnalysisCancelledError("inspect_adb_client", { - cause: cause.cause, - ...(failure === undefined + throw cancelledBy( + "inspect_adb_client", + carriedReason(cause.cause), + failure === undefined ? {} - : { capturedOutput: execFileFailureCapturedOutput(failure) }), - }); + : { capturedOutput: execFileFailureCapturedOutput(failure) }, + ); const diagnostics = { selected_binary: selection.binary, path_source: selection.pathSource, diff --git a/src/adb/AdbInputSnapshot.ts b/src/adb/AdbInputSnapshot.ts index 8dd04107f1..e54371fabc 100644 --- a/src/adb/AdbInputSnapshot.ts +++ b/src/adb/AdbInputSnapshot.ts @@ -5,8 +5,9 @@ import { basename, join } from "node:path"; import type { ArtifactResourceScope } from "../artifacts/ArtifactResourceScope.js"; import { AnalysisArtifactChangedError, - AnalysisCancelledError, AnalysisOutputError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import { AnalysisError } from "../domain/analysisErrorBase.js"; import { @@ -134,7 +135,7 @@ export const snapshotAdbInput = async ( } else { primaryCause = signal?.aborted === true - ? new AnalysisCancelledError(operation, { cause }) + ? cancelledBy(operation, carriedReason(cause)) : cause; } } diff --git a/src/adb/AdbProvider.test.ts b/src/adb/AdbProvider.test.ts index eaa64105b8..5b071f5fb1 100644 --- a/src/adb/AdbProvider.test.ts +++ b/src/adb/AdbProvider.test.ts @@ -11,6 +11,7 @@ import { import { join } from "node:path"; import { expect, onTestFinished, test, vi } from "vitest"; import { primaryAnalysisError } from "../domain/analysisErrorBase.js"; +import { OwnerCancellation } from "../domain/analysisErrorCore.js"; const adbTestHooks = vi.hoisted(() => ({ afterScreencap: undefined as (() => void) | undefined, @@ -184,6 +185,7 @@ fi`, await closing; await expect(provider.inspectAvailability()).rejects.toMatchObject({ _tag: "AnalysisCancelledError", + cause: OwnerCancellation.ownerClosed, }); } finally { await writeFile(join(root, "release"), ""); diff --git a/src/adb/AdbProvider.ts b/src/adb/AdbProvider.ts index e9bbb5458c..4404b34bec 100644 --- a/src/adb/AdbProvider.ts +++ b/src/adb/AdbProvider.ts @@ -66,6 +66,8 @@ import { AnalysisUnsupportedTargetError, cancelledBy, OwnerCancellation, + carriedReason, + isAborted, } from "../domain/analysisErrorCore.js"; import { AnalysisError } from "../domain/analysisErrorBase.js"; import { analysisErrorWithCleanupFailure } from "../domain/analysisErrorCleanup.js"; @@ -224,7 +226,7 @@ const hashAdbFile = async ( }, ); if (cause instanceof RegularFileOperationCancelled) - throw new AnalysisCancelledError(operation, { cause: cause.reason }); + throw cancelledBy(operation, carriedReason(cause.reason)); throw cause; } }; @@ -245,8 +247,7 @@ const adbDigestError = ( digestOutcome.value, ); if (digestFailure instanceof RegularFileCancelled) - return new AnalysisCancelledError(operation, { - cause: digestFailure.reason, + return cancelledBy(operation, carriedReason(digestFailure.reason), { partialObservation, }); const resource = `${digestFailure.path} (ADB digest handle)`; @@ -268,8 +269,7 @@ const adbDigestError = ( digestOutcome.kind === "failed" ? digestOutcome.cause : undefined; const cancellation = regularFileCancellation(digestFailure); if (cancellation !== undefined) { - const error = new AnalysisCancelledError(operation, { - cause: cancellation.reason, + const error = cancelledBy(operation, carriedReason(cancellation.reason), { cleanup: { reason, resources: [resource] }, partialObservation, }); @@ -482,8 +482,7 @@ const publishScreenExclusively = async ( operation: string, signal: AbortSignal | undefined, ): Promise => { - if (signal?.aborted === true) - throw new AnalysisCancelledError(operation, { cause: signal.reason }); + if (signal?.aborted === true) throw cancelledBy(operation, signal); const output = await open(outputPath, "wx", 0o600); // Successful exclusive creation is this fallback's cutoff. Finish and sync // the visible file despite later cancellation so its receipt remains known. @@ -622,24 +621,29 @@ const cancellationWithCleanupFailure = ( cleanup: AnalysisError, resources: readonly string[], ): AnalysisCancelledError => - new AnalysisCancelledError(primary.operation, { - cause: new AggregateError( - [primary, cleanup], - "ADB cancellation cleanup failed", - { cause: primary }, + cancelledBy( + primary.operation, + carriedReason( + new AggregateError( + [primary, cleanup], + "ADB cancellation cleanup failed", + { cause: primary }, + ), ), - diagnostics: primary.diagnostics, - ...(primary.capturedOutput === undefined - ? {} - : { capturedOutput: primary.capturedOutput }), - cleanup: { - reason: [primary.cleanup?.reason, cleanup.message] - .filter((reason): reason is string => reason !== undefined) - .join("; "), - resources: [...new Set([...primary.cleanupResources, ...resources])], + { + diagnostics: primary.diagnostics, + ...(primary.capturedOutput === undefined + ? {} + : { capturedOutput: primary.capturedOutput }), + cleanup: { + reason: [primary.cleanup?.reason, cleanup.message] + .filter((reason): reason is string => reason !== undefined) + .join("; "), + resources: [...new Set([...primary.cleanupResources, ...resources])], + }, + partialObservation: primary.partialObservation, }, - partialObservation: primary.partialObservation, - }); + ); /** Publish an ADB-produced archive without replacing an existing caller file. */ const publishBugreport = async ( @@ -878,9 +882,10 @@ export class AdbProvider { signal?: AbortSignal, ): Promise { if (this.#closing) - throw new AnalysisCancelledError("inspect_adb_client", { - cause: signal?.reason, - }); + throw cancelledBy( + "inspect_adb_client", + isAborted(signal) ? signal : OwnerCancellation.ownerClosed, + ); const release = this.#beginOperation(); try { const selection = await this.selection(signal); @@ -1101,13 +1106,12 @@ export class AdbProvider { if (failure !== undefined) primary = analysisErrorWithCancellation( failure, - new AnalysisCancelledError(operation, { cause: signal.reason }), + cancelledBy(operation, signal), ); } if (primary === undefined && result?.ok && signal?.aborted === true) { const completed = result.value; - primary = new AnalysisCancelledError(operation, { - cause: signal.reason, + primary = cancelledBy(operation, signal, { partialObservation: createEvidence( completed.subject ?? undefined, completed.provider, @@ -1327,9 +1331,7 @@ export class AdbProvider { ): Promise> { const signal = options?.signal; if (signal?.aborted === true) - return err( - new AnalysisCancelledError(request.operation, { cause: signal.reason }), - ); + return err(cancelledBy(request.operation, signal)); let selection: AdbBinarySelection; let identity: AdbClientIdentity; try { @@ -3087,10 +3089,7 @@ export class AdbProvider { signal, ); if (!captured.ok) return captured; - if (signal?.aborted === true) - return err( - new AnalysisCancelledError(operation, { cause: signal.reason }), - ); + if (signal?.aborted === true) return err(cancelledBy(operation, signal)); const dimensions = readPngHeaderDimensions(captured.value.stdout); if (dimensions === undefined) return err( @@ -3111,9 +3110,7 @@ export class AdbProvider { await writeFile(stagedPath, captured.value.stdout, { flag: "wx" }); await syncStagedAdbFile(stagedPath, resources, operation); if (signal?.aborted === true) - return err( - new AnalysisCancelledError(operation, { cause: signal.reason }), - ); + return err(cancelledBy(operation, signal)); try { // A same-filesystem hard link atomically publishes without replacing // caller output. Its success is the publication cutoff. @@ -3344,8 +3341,7 @@ export class AdbProvider { signal?.aborted === true ? analysisErrorWithCancellation( failure, - new AnalysisCancelledError(operation, { - cause: signal.reason, + cancelledBy(operation, signal, { partialObservation: retainedObservation, }), ) diff --git a/src/android/AndroidMappingFile.ts b/src/android/AndroidMappingFile.ts index a0f5b4cc72..200061ab0b 100644 --- a/src/android/AndroidMappingFile.ts +++ b/src/android/AndroidMappingFile.ts @@ -17,10 +17,11 @@ import { analysisErrorWithCleanupFailure } from "../domain/analysisErrorCleanup. import { AnalysisAccessDeniedError, AnalysisArtifactChangedError, - AnalysisCancelledError, AnalysisInputError, AnalysisResourceConstraintError, AnalysisTimeoutError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import { ProviderAdapterError } from "../domain/providerAdapterError.js"; import { ProviderCleanupError } from "../domain/providerCleanupError.js"; @@ -51,7 +52,7 @@ const mappingInterruption = ( cause, ...jadxOperationTimeoutGuidance(read.deadline.timeoutMs), }) - : new AnalysisCancelledError(read.operation, { cause }); + : cancelledBy(read.operation, carriedReason(cause)); const invalidMapping = ( read: MappingRead, diff --git a/src/android/JadxConfiguration.ts b/src/android/JadxConfiguration.ts index d2a29e47c2..ea46137285 100644 --- a/src/android/JadxConfiguration.ts +++ b/src/android/JadxConfiguration.ts @@ -19,9 +19,10 @@ import { inspectWindowsNativeReadiness } from "../process/WindowsAuthority.js"; import { systemWindowsNativeAuthority } from "../windows/WindowsNativeLoader.js"; import { providerStartupTimeoutSchema } from "../config/providerStartupTimeout.js"; import { - AnalysisCancelledError, AnalysisTimeoutError, AnalysisCapabilityUnavailableError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import type { AndroidOperation } from "../domain/android/androidAnalysis.js"; import type { JsonValue } from "../domain/jsonValue.js"; @@ -198,9 +199,9 @@ export const inspectJadxAvailability = async ( }; } catch (cause) { if (cause instanceof JadxInterruption) - throw new AnalysisCancelledError( + throw cancelledBy( options.operation ?? "inspect_jadx_configuration", - { cause: cause.reason }, + carriedReason(cause.reason), ); if (cause instanceof JadxConfigurationFailure) return { @@ -483,7 +484,7 @@ const archiveCancellation = ( diagnostics, ...jadxOperationTimeoutGuidance(options.operationDeadline.timeoutMs), }) - : new AnalysisCancelledError(operation, { cause: reason, diagnostics }); + : cancelledBy(operation, carriedReason(reason), { diagnostics }); }; const requireSupportedHost = (): void => { diff --git a/src/android/JadxFailure.ts b/src/android/JadxFailure.ts index 7eaf117afe..68f8723555 100644 --- a/src/android/JadxFailure.ts +++ b/src/android/JadxFailure.ts @@ -3,11 +3,12 @@ import { JadxInterruption } from "./JadxInterruption.js"; import { z } from "zod"; import { AnalysisError } from "../domain/analysisErrorBase.js"; import { - AnalysisCancelledError, AnalysisCapabilityUnavailableError, AnalysisOutputError, AnalysisResourceConstraintError, AnalysisTimeoutError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import { ProviderAdapterError } from "../domain/providerAdapterError.js"; import { ProviderCleanupError } from "../domain/providerCleanupError.js"; @@ -116,9 +117,7 @@ const observeJadxFailure = ( cause: cancellation.reason, ...jadxOperationTimeoutGuidance(timeoutMs), }) - : new AnalysisCancelledError(request.operation, { - cause: cancellation.reason, - }); + : cancelledBy(request.operation, carriedReason(cancellation.reason)); if (cause instanceof RegularFileCleanupFailure) { const reason = cause.cleanupCause instanceof Error @@ -141,9 +140,10 @@ const observeJadxFailure = ( cause: nestedCancellation.reason, ...jadxOperationTimeoutGuidance(timeoutMs), }) - : new AnalysisCancelledError(request.operation, { - cause: nestedCancellation.reason, - }); + : cancelledBy( + request.operation, + carriedReason(nestedCancellation.reason), + ); const snapshotObservation = completed === undefined ? undefined @@ -315,12 +315,14 @@ const presentDiagnosticFailure = ( failure: DiagnosticFailure, ): AnalysisError => { const output = failure.transport?.diagnostics(); - const options = { - cause: failure.cause, - ...(output === undefined ? {} : { capturedOutput: output }), - }; + const captured = output === undefined ? {} : { capturedOutput: output }; + const options = { cause: failure.cause, ...captured }; if (failure.kind === "cancelled") - return new AnalysisCancelledError(failure.operation, options); + return cancelledBy( + failure.operation, + carriedReason(failure.cause), + captured, + ); if (failure.kind === "timeout") return new AnalysisTimeoutError(failure.operation, failure.timeoutMs, { ...options, diff --git a/src/android/JadxJavaProbe.ts b/src/android/JadxJavaProbe.ts index 1313e9949a..dc10438dfa 100644 --- a/src/android/JadxJavaProbe.ts +++ b/src/android/JadxJavaProbe.ts @@ -6,9 +6,10 @@ import { type AnalysisCapturedOutput, } from "../domain/analysisErrorBase.js"; import { - AnalysisCancelledError, AnalysisCapabilityUnavailableError, AnalysisTimeoutError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import { ProviderAdapterError } from "../domain/providerAdapterError.js"; import { analysisErrorWithCleanupFailure } from "../domain/analysisErrorCleanup.js"; @@ -176,7 +177,6 @@ export const inspectJadxJava = async ( ) { const reason = command.cancellation.reason; const errorOptions = { - cause: reason, ...(output === undefined ? {} : { capturedOutput: output }), ...(observed?.ok === true ? { @@ -197,13 +197,14 @@ export const inspectJadxJava = async ( options.operationDeadline.timeoutMs, { ...errorOptions, + cause: reason, ...jadxOperationTimeoutGuidance( options.operationDeadline.timeoutMs, ), }, ) : (inspectionCancellation ?? - new AnalysisCancelledError(operation, errorOptions)); + cancelledBy(operation, carriedReason(reason), errorOptions)); } else if (inspectionCancellation !== undefined) { primary = inspectionCancellation; } else if ( diff --git a/src/android/JadxProvider.ts b/src/android/JadxProvider.ts index 3de0a13bbf..9b1039561e 100644 --- a/src/android/JadxProvider.ts +++ b/src/android/JadxProvider.ts @@ -14,9 +14,11 @@ import { fileURLToPath } from "node:url"; import type { AndroidAnalysisPort } from "../application/android/AndroidAnalysisPort.js"; import { AnalysisError } from "../domain/analysisErrorBase.js"; import { - AnalysisCancelledError, AnalysisCapabilityUnavailableError, AnalysisInputError, + cancelledBy, + carriedReason, + OwnerCancellation, } from "../domain/analysisErrorCore.js"; import { ProviderCleanupError } from "../domain/providerCleanupError.js"; import { analysisErrorWithCleanupFailure } from "../domain/analysisErrorCleanup.js"; @@ -66,11 +68,7 @@ const waitForTurn = ( ): Promise => new Promise((resolve, reject) => { const abort = () => - reject( - new AnalysisCancelledError(request.operation, { - cause: signal?.reason, - }), - ); + reject(cancelledBy(request.operation, carriedReason(signal?.reason))); signal?.addEventListener("abort", abort, { once: true }); if (signal?.aborted === true) abort(); void predecessor.then(() => { @@ -327,11 +325,7 @@ export class JadxProvider implements AndroidAnalysisPort { options?: ExecutionOptions, ): Promise { if (this.#shutdown.signal.aborted) - return err( - new AnalysisCancelledError(request.operation, { - cause: this.#shutdown.signal.reason, - }), - ); + return err(cancelledBy(request.operation, this.#shutdown.signal)); const signal = options?.signal === undefined ? this.#shutdown.signal @@ -348,16 +342,11 @@ export class JadxProvider implements AndroidAnalysisPort { return err( cause instanceof AnalysisError ? cause - : new AnalysisCancelledError(request.operation, { cause }), + : cancelledBy(request.operation, carriedReason(cause)), ); } try { - if (signal.aborted) - return err( - new AnalysisCancelledError(request.operation, { - cause: signal.reason, - }), - ); + if (signal.aborted) return err(cancelledBy(request.operation, signal)); clearTimeout(this.#idle); const retired = this.#pendingCleanup === undefined @@ -378,11 +367,7 @@ export class JadxProvider implements AndroidAnalysisPort { : !cleanup.ok ? cleanup : signal.aborted - ? err( - new AnalysisCancelledError(request.operation, { - cause: signal.reason, - }), - ) + ? err(cancelledBy(request.operation, signal)) : await this.#execute(target, request, { signal }); // A refusal before session work, such as a bad mapping, keeps the session. if ( @@ -401,7 +386,7 @@ export class JadxProvider implements AndroidAnalysisPort { /** Cancel queued/active operations and join the owned engine and workspace cleanup. */ close(): Promise { - this.#shutdown.abort(); + this.#shutdown.abort(OwnerCancellation.ownerClosed); clearTimeout(this.#idle); this.#closePromise ??= this.#tail .then(async () => { diff --git a/src/android/JadxSession.ts b/src/android/JadxSession.ts index dbaf9c5cea..c821455409 100644 --- a/src/android/JadxSession.ts +++ b/src/android/JadxSession.ts @@ -13,8 +13,9 @@ import { AnalysisInputError, AnalysisOutputError, AnalysisResourceConstraintError, - AnalysisCancelledError, AnalysisTimeoutError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import type { BinaryTarget } from "../domain/binaryTargetTypes.js"; import { @@ -263,9 +264,7 @@ export class JadxSession { ...jadxOperationTimeoutGuidance(timeoutMs), }, ) - : new AnalysisCancelledError(request.operation, { - cause: reason, - }), + : cancelledBy(request.operation, carriedReason(reason)), }); if ( value.inventory.status === "complete" && diff --git a/src/apkSignature/ApkSignatureAdmission.ts b/src/apkSignature/ApkSignatureAdmission.ts index 9c3803bc0d..7d5e4d241a 100644 --- a/src/apkSignature/ApkSignatureAdmission.ts +++ b/src/apkSignature/ApkSignatureAdmission.ts @@ -1,6 +1,7 @@ import { - AnalysisCancelledError, AnalysisResourceConstraintError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import { APK_SIGNATURE_LIMITS } from "./ApkSignatureRelease.js"; @@ -13,10 +14,7 @@ class ApkSignatureAdmission { readonly #waiting: (() => void)[] = []; acquire(signal?: AbortSignal): Promise { - if (signal?.aborted) - return Promise.reject( - new AnalysisCancelledError(OPERATION, { cause: signal.reason }), - ); + if (signal?.aborted) return Promise.reject(cancelledBy(OPERATION, signal)); if (!this.#active) { this.#active = true; return Promise.resolve(this.#release()); @@ -42,9 +40,7 @@ class ApkSignatureAdmission { const onAbort = () => { const index = this.#waiting.indexOf(grant); if (index !== -1) this.#waiting.splice(index, 1); - reject( - new AnalysisCancelledError(OPERATION, { cause: signal?.reason }), - ); + reject(cancelledBy(OPERATION, carriedReason(signal?.reason))); }; signal?.addEventListener("abort", onAbort, { once: true }); this.#waiting.push(grant); diff --git a/src/apkSignature/apkSignatureFailures.ts b/src/apkSignature/apkSignatureFailures.ts index 82e08fe916..a129774c2e 100644 --- a/src/apkSignature/apkSignatureFailures.ts +++ b/src/apkSignature/apkSignatureFailures.ts @@ -14,10 +14,11 @@ import { AnalysisError } from "../domain/analysisErrorBase.js"; import { AnalysisAccessDeniedError, AnalysisArtifactChangedError, - AnalysisCancelledError, AnalysisInputError, AnalysisResourceConstraintError, AnalysisUnsupportedTargetError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import type { ApkSchemeError } from "../domain/apkSignature/apkSignatureSchemes.js"; import type { ApkSigningBlockError } from "../domain/apkSignature/apkSigningBlock.js"; @@ -222,9 +223,10 @@ const artifactReaderFailure = ( cause, }); case "cancelled": - return new AnalysisCancelledError(OPERATION, { - cause: artifactFileCancellationCause(cause), - }); + return cancelledBy( + OPERATION, + carriedReason(artifactFileCancellationCause(cause)), + ); case "limit": return new AnalysisResourceConstraintError( OPERATION, diff --git a/src/apktool/ApktoolConfiguration.ts b/src/apktool/ApktoolConfiguration.ts index b8458ec412..150be55f14 100644 --- a/src/apktool/ApktoolConfiguration.ts +++ b/src/apktool/ApktoolConfiguration.ts @@ -11,9 +11,10 @@ import { AnalysisError } from "../domain/analysisErrorBase.js"; import { ProviderAdapterError } from "../domain/providerAdapterError.js"; import { DarwinProcessOwnershipInspectionError } from "../process/DarwinProcessRunTokenReader.js"; import { - AnalysisCancelledError, AnalysisResourceConstraintError, AnalysisTimeoutError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import { isAbsolute, win32 } from "node:path"; import { snapshotEnvironment } from "../process/snapshotEnvironment.js"; @@ -73,9 +74,7 @@ export const resolveApktoolCommand = async ( signal?: AbortSignal, ): Promise => { if (signal?.aborted === true) - throw new AnalysisCancelledError("inspect_apktool_client", { - cause: signal.reason, - }); + throw cancelledBy("inspect_apktool_client", signal); const selectedEnvironment = snapshotEnvironment(environment, platform); const configured = selectedEnvironment[APKTOOL_COMMAND_ENV]; if (configured !== undefined && configured.trim() !== "") { @@ -98,9 +97,7 @@ export const resolveApktoolCommand = async ( const deadline = new ProviderStartupDeadline(VERSION_TIMEOUT_MS, signal); const lookupInterruption = () => deadline.interruption === "cancelled" - ? new AnalysisCancelledError("inspect_apktool_client", { - cause: signal?.reason, - }) + ? cancelledBy("inspect_apktool_client", carriedReason(signal?.reason)) : new AnalysisTimeoutError("inspect_apktool_client", VERSION_TIMEOUT_MS, { diagnostics: { phase: "windows_path_lookup" }, ...apktoolVersionProbeTimeoutGuidance(), @@ -481,13 +478,16 @@ const versionProbeFailure = ( ) return ( inspectionCancellation ?? - new AnalysisCancelledError("inspect_apktool_client", { - cause: cause.cancellation.reason, - ...(output === undefined ? {} : { capturedOutput: output }), - ...(observed === undefined - ? {} - : { diagnostics: { client: { version: observed.version } } }), - }) + cancelledBy( + "inspect_apktool_client", + carriedReason(cause.cancellation.reason), + { + ...(output === undefined ? {} : { capturedOutput: output }), + ...(observed === undefined + ? {} + : { diagnostics: { client: { version: observed.version } } }), + }, + ) ); if (inspectionCancellation !== undefined) return inspectionCancellation; if ( diff --git a/src/apktool/ApktoolProvider.ts b/src/apktool/ApktoolProvider.ts index 8c8a8eb162..c25f82090d 100644 --- a/src/apktool/ApktoolProvider.ts +++ b/src/apktool/ApktoolProvider.ts @@ -41,13 +41,13 @@ import { import { projectApktoolStringTables } from "./ApktoolStringTables.js"; import { AnalysisCapabilityUnavailableError, - AnalysisCancelledError, AnalysisProtocolError, AnalysisResourceConstraintError, AnalysisTimeoutError, AnalysisUnsupportedTargetError, cancelledBy, OwnerCancellation, + carriedReason, } from "../domain/analysisErrorCore.js"; import { analysisErrorWithCleanupFailure } from "../domain/analysisErrorCleanup.js"; import { fixedAllowanceOptions } from "../domain/fixedAllowanceRemediation.js"; @@ -95,8 +95,7 @@ const throwIfCancelled = ( operation: string, signal: AbortSignal | undefined, ): void => { - if (signal?.aborted === true) - throw new AnalysisCancelledError(operation, { cause: signal.reason }); + if (signal?.aborted === true) throw cancelledBy(operation, signal); }; interface DecodeLimits { @@ -115,10 +114,7 @@ const runApktool = async ( commands: ApktoolCommandCleanup, root: string, ): Promise> => { - if (signal?.aborted === true) - return err( - new AnalysisCancelledError(operation, { cause: signal?.reason }), - ); + if (signal?.aborted === true) return err(cancelledBy(operation, signal)); let invocation: ReturnType; try { invocation = apktoolInvocation(selection, arguments_, environment); @@ -191,10 +187,11 @@ const apktoolCommandFailure = ( const output = cause.snapshot; if (cause.reason === "cancelled" && cause.cancellation !== undefined) - return new AnalysisCancelledError(operation, { - cause: cause.cancellation.reason, - ...(capturedOutput === undefined ? {} : { capturedOutput }), - }); + return cancelledBy( + operation, + carriedReason(cause.cancellation.reason), + capturedOutput === undefined ? {} : { capturedOutput }, + ); if (cause.reason === "timeout") return new AnalysisTimeoutError(operation, limits.timeoutMs, { cause, @@ -364,7 +361,7 @@ export class ApktoolProvider { /** Retain failed cleanup ownership and retry it on close. */ async close(): Promise { this.#closing = true; - this.#shutdown.abort(); + this.#shutdown.abort(OwnerCancellation.ownerClosed); this.#closePromise ??= this.#drainAndClean().catch((cause: unknown) => { this.#closePromise = undefined; throw cause; @@ -407,9 +404,7 @@ export class ApktoolProvider { signal: AbortSignal, ): Promise> { if (signal?.aborted === true) - return err( - new AnalysisCancelledError(request.operation, { cause: signal.reason }), - ); + return err(cancelledBy(request.operation, signal)); const environment = this.operationEnvironment(); let selection: ApktoolCommandSelection; let identity: ApktoolClientIdentity; @@ -448,10 +443,7 @@ export class ApktoolProvider { ), ); } - if (signal.aborted) - return err( - new AnalysisCancelledError(request.operation, { cause: signal.reason }), - ); + if (signal.aborted) return err(cancelledBy(request.operation, signal)); const client = { command: selection.command, command_source: selection.commandSource, @@ -698,9 +690,10 @@ export class ApktoolProvider { : origin === "owned-or-classified" && physical instanceof ArtifactReaderFailure && physical.reason === "cancelled" - ? new AnalysisCancelledError(operation, { - cause: artifactFileCancellationCause(physical), - }) + ? cancelledBy( + operation, + carriedReason(artifactFileCancellationCause(physical)), + ) : new AnalysisProtocolError("Apktool resource projection failed", { cause: physical, }); @@ -775,10 +768,7 @@ export class ApktoolProvider { : undefined; if (result.ok && signal?.aborted) result = err( - new AnalysisCancelledError(operation, { - cause: signal.reason, - partialObservation: observation, - }), + cancelledBy(operation, signal, { partialObservation: observation }), ); if (released.kind === "failed") { const cleanup = new ProviderCleanupError( diff --git a/src/apktool/ApktoolStringTables.ts b/src/apktool/ApktoolStringTables.ts index 34f0a8c4f5..dd153e319d 100644 --- a/src/apktool/ApktoolStringTables.ts +++ b/src/apktool/ApktoolStringTables.ts @@ -11,7 +11,7 @@ import { type ApktoolRequest, type StringTable, } from "../domain/apktool/apktoolResourceAnalysis.js"; -import { AnalysisCancelledError } from "../domain/analysisErrorCore.js"; +import { cancelledBy } from "../domain/analysisErrorCore.js"; import { parseDecodedStrings, type DecodedStringEntry, @@ -210,9 +210,7 @@ export const projectApktoolStringTables = async ( for (const [index, locale] of locales.entries()) { pendingIndex = index; if (signal?.aborted) - throw new AnalysisCancelledError("decode_android_resources", { - cause: signal.reason, - }); + throw cancelledBy("decode_android_resources", signal); const directory = locale === null ? "values" diff --git a/src/dotnet/ManagedSnapshot.ts b/src/dotnet/ManagedSnapshot.ts index ac2f660d4c..44c3249b95 100644 --- a/src/dotnet/ManagedSnapshot.ts +++ b/src/dotnet/ManagedSnapshot.ts @@ -18,8 +18,9 @@ import { analysisErrorWithCleanupFailure } from "../domain/analysisErrorCleanup. import { AnalysisError } from "../domain/analysisErrorBase.js"; import { AnalysisArtifactChangedError, - AnalysisCancelledError, AnalysisResourceConstraintError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import { err, ok, type Result } from "../domain/result.js"; import { DEFAULT_MANAGED_SNAPSHOT_BYTES } from "../domain/managed/managedInspectionLimits.js"; @@ -171,9 +172,7 @@ const readManagedFile = ( const failure = identity !== undefined && !identity.ok ? identity.error - : new AnalysisCancelledError(operation, { - cause: cancellation.reason, - }); + : cancelledBy(operation, carriedReason(cancellation.reason)); throw failure.retainPartialObservation({ kind: "file-snapshot-hash", path, @@ -252,9 +251,7 @@ export const managedCleanupError = ( ? identity.error : cancellation === undefined ? undefined - : new AnalysisCancelledError(operation, { - cause: cancellation.reason, - }); + : cancelledBy(operation, carriedReason(cancellation.reason)); // This boundary produces only these snapshot facts. The descriptor owner // confirms completion independently of a failed final close. if (cause.outcome.kind === "completed") { @@ -288,13 +285,15 @@ export const managedCleanupError = ( ); bindRegularFileCleanup(cause, error); if (cause.reason === "cancelled") { - const cancelled = new AnalysisCancelledError(operation, { - cause: + const cancelled = cancelledBy( + operation, + carriedReason( cause.cancellation === undefined ? cause.cause : cause.cancellation.reason, - partialObservation: cause.partialObservation, - }); + ), + { partialObservation: cause.partialObservation }, + ); return analysisErrorWithCleanupFailure( cancelled, error, @@ -313,7 +312,7 @@ const normalizeReadFailure = ( signal?: AbortSignal, ): unknown => { if (signal?.aborted === true && cause === signal.reason) - return new AnalysisCancelledError(operation, { cause }); + return cancelledBy(operation, carriedReason(cause)); if (cause instanceof RegularFileChangedError) return new AnalysisArtifactChangedError(operation, path, cause.message, { cause, @@ -322,7 +321,7 @@ const normalizeReadFailure = ( return ( classifyBinaryTargetFilesystemFailure(path, cause) ?? (signal?.aborted === true - ? new AnalysisCancelledError(operation, { cause }) + ? cancelledBy(operation, carriedReason(cause)) : cause) ); }; diff --git a/src/dotnet/ManagedStaticProvider.ts b/src/dotnet/ManagedStaticProvider.ts index 3797f6ce50..43996e5435 100644 --- a/src/dotnet/ManagedStaticProvider.ts +++ b/src/dotnet/ManagedStaticProvider.ts @@ -20,9 +20,9 @@ import { import { AnalysisError } from "../domain/analysisErrorBase.js"; import type { BinaryTarget } from "../domain/binaryTargetTypes.js"; import { - AnalysisCancelledError, AnalysisCapabilityUnavailableError, AnalysisUnsupportedTargetError, + cancelledBy, } from "../domain/analysisErrorCore.js"; import { ProviderAdapterError } from "../domain/providerAdapterError.js"; import { ProviderCleanupError } from "../domain/providerCleanupError.js"; @@ -119,11 +119,7 @@ class ManagedStaticClient implements AnalysisClient { : { maxBytes: input.data.max_snapshot_bytes }), }; if (options?.signal?.aborted === true) - return err( - new AnalysisCancelledError(operation, { - cause: options.signal.reason, - }), - ); + return err(cancelledBy(operation, options.signal)); const snapshot = this.#snapshotBytes; const observed = snapshot === undefined @@ -166,11 +162,7 @@ class ManagedStaticClient implements AnalysisClient { return err(this.#cleanupError(operation, cause)); if (cause instanceof AnalysisError) return err(cause); if (options?.signal?.aborted === true) - return err( - new AnalysisCancelledError(operation, { - cause: options.signal.reason, - }), - ); + return err(cancelledBy(operation, options.signal)); const inputFailure = managedInspectionInputFailure( operation, this.target.path, diff --git a/src/flutter/FlutterBuildProvider.ts b/src/flutter/FlutterBuildProvider.ts index 70d7cb322f..37826c3bf2 100644 --- a/src/flutter/FlutterBuildProvider.ts +++ b/src/flutter/FlutterBuildProvider.ts @@ -39,6 +39,8 @@ import { AnalysisResourceConstraintError, AnalysisUnsupportedTargetError, AnalysisProtocolError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import { compareUnicodeCodePoints } from "../domain/unicodeCodePointOrder.js"; import { fixedAllowanceOptions as flutterBudget } from "../domain/fixedAllowanceRemediation.js"; @@ -106,8 +108,7 @@ const sha256File = async ( try { const stream = createReadStream(path, { signal: owner.signal }); for await (const chunk of stream) { - if (signal?.aborted === true) - throw new AnalysisCancelledError(operation, { cause: signal.reason }); + if (signal?.aborted === true) throw cancelledBy(operation, signal); hash.update(chunk as Buffer); } return hash.digest("hex"); @@ -117,7 +118,7 @@ const sha256File = async ( cause.name === "AbortError" && cause.cause === marker ) - throw new AnalysisCancelledError(operation, { cause: signal?.reason }); + throw cancelledBy(operation, carriedReason(signal?.reason)); throw cause; } finally { signal?.removeEventListener("abort", abort); @@ -197,9 +198,7 @@ const mapInputFailure = ( if (cause instanceof AnalysisError) return cause; const cancellation = observedCancellation(cause); if (cancellation !== undefined) - return new AnalysisCancelledError(operation, { - cause: cancellation.reason, - }); + return cancelledBy(operation, carriedReason(cancellation.reason)); if ( cause instanceof Error && "code" in cause && @@ -255,9 +254,7 @@ const mapOwnedIoFailure = ( if (cause instanceof AnalysisError) return cause; const cancellation = observedCancellation(cause); if (cancellation !== undefined) - return new AnalysisCancelledError(operation, { - cause: cancellation.reason, - }); + return cancelledBy(operation, carriedReason(cancellation.reason)); if ( cause instanceof Error && "code" in cause && @@ -696,9 +693,7 @@ export class FlutterBuildProvider { ): Promise> { const cancellation = (): AnalysisCancelledError | undefined => options?.signal?.aborted === true - ? new AnalysisCancelledError(request.operation, { - cause: options.signal.reason, - }) + ? cancelledBy(request.operation, options.signal) : undefined; const beforeCleanup = cancellation(); if (beforeCleanup !== undefined) return err(beforeCleanup); @@ -775,8 +770,7 @@ export class FlutterBuildProvider { // the completed facts, composed exactly as the uncancelled Evidence. if (signal?.aborted === true && result.ok) { result = err( - new AnalysisCancelledError(request.operation, { - cause: signal.reason, + cancelledBy(request.operation, signal, { partialObservation: createAnalysisExecutionEvidence( request.operation, request.input, @@ -790,9 +784,7 @@ export class FlutterBuildProvider { result = err( analysisErrorWithCancellation( result.error, - new AnalysisCancelledError(request.operation, { - cause: signal.reason, - }), + cancelledBy(request.operation, signal), ), ); if (cleanup !== undefined) { @@ -877,11 +869,7 @@ export class FlutterBuildProvider { let headerBytes = 0; for await (const chunk of stream) { if (signal?.aborted === true) - return err( - new AnalysisCancelledError(operation, { - cause: signal.reason, - }), - ); + return err(cancelledBy(operation, signal)); const view = chunk as Buffer; headerBytes += view.copy( headerPrefix, @@ -1165,11 +1153,7 @@ export class FlutterBuildProvider { let total = 0; for await (const chunk of stream) { if (signal?.aborted === true) - return err( - new AnalysisCancelledError("inspect_dart_aot", { - cause: signal.reason, - }), - ); + return err(cancelledBy("inspect_dart_aot", signal)); const view = chunk as Buffer; total += view.byteLength; if (total > LIBRARY_MAX_BYTES) @@ -1199,11 +1183,7 @@ export class FlutterBuildProvider { ); while (imageLength < image.length) { if (signal?.aborted === true) - return err( - new AnalysisCancelledError("inspect_dart_aot", { - cause: signal.reason, - }), - ); + return err(cancelledBy("inspect_dart_aot", signal)); const result = await file.handle.read( image, imageLength, diff --git a/src/frida/FridaInstrumentationManager.ts b/src/frida/FridaInstrumentationManager.ts index f453f6c479..e4679edc38 100644 --- a/src/frida/FridaInstrumentationManager.ts +++ b/src/frida/FridaInstrumentationManager.ts @@ -31,6 +31,8 @@ import { AnalysisCapabilityUnavailableError, AnalysisInputError, AnalysisTimeoutError, + cancelledBy, + carriedReason, } from "../domain/analysisErrorCore.js"; import { AnalysisError } from "../domain/analysisErrorBase.js"; import { isValidFridaRemoteAddress } from "../domain/fridaRemoteAddress.js"; @@ -1686,8 +1688,7 @@ const providerError = ( }), }); if (cause instanceof AnalysisCancelledError) - return new AnalysisCancelledError(operation, { - cause: cause.cause, + return cancelledBy(operation, carriedReason(cause.cause), { diagnostics, ...(cleanupReason === undefined ? {} @@ -1727,8 +1728,7 @@ const errorMessage = (cause: unknown): string => const cancelledOperation = ( operation: string, signal: AbortSignal, -): AnalysisCancelledError => - new AnalysisCancelledError(operation, { cause: signal.reason }); +): AnalysisCancelledError => cancelledBy(operation, signal); interface CapturedMessage { readonly observation: JsonValue; diff --git a/src/il2cpp/Il2cppGhidraSeedWriter.ts b/src/il2cpp/Il2cppGhidraSeedWriter.ts index c4d7483638..337c8f6257 100644 --- a/src/il2cpp/Il2cppGhidraSeedWriter.ts +++ b/src/il2cpp/Il2cppGhidraSeedWriter.ts @@ -12,9 +12,9 @@ import { ArtifactReaderFailure } from "../artifacts/ArtifactReader.js"; import { AnalysisCleanupLease } from "../artifacts/AnalysisCleanupLease.js"; import { AnalysisError } from "../domain/analysisErrorBase.js"; import { - AnalysisCancelledError, AnalysisInputError, AnalysisResourceConstraintError, + cancelledBy, } from "../domain/analysisErrorCore.js"; import { EvidenceFileError } from "../domain/evidenceErrors.js"; import { ProviderCleanupError } from "../domain/providerCleanupError.js"; @@ -41,9 +41,7 @@ export class Il2cppGhidraSeedWriter implements Il2cppSeedWriterPort { options?: ExecutionOptions, ): Promise> { if (options?.signal?.aborted) - return err( - new AnalysisCancelledError(OPERATION, { cause: options.signal.reason }), - ); + return err(cancelledBy(OPERATION, options.signal)); if (!isAbsolute(output.path)) return err( invalid( diff --git a/src/il2cpp/Il2cppMetadataProvider.ts b/src/il2cpp/Il2cppMetadataProvider.ts index 1c489ff96d..dcd6c18720 100644 --- a/src/il2cpp/Il2cppMetadataProvider.ts +++ b/src/il2cpp/Il2cppMetadataProvider.ts @@ -35,12 +35,12 @@ import { createIl2cppMetadataAdmission } from "./Il2cppMetadataAdmission.js"; import { hexAddress as hex } from "./Il2cppBinaryImage.js"; import { jsonValueByteLength } from "../domain/jsonValueByteLength.js"; import { - AnalysisCancelledError, AnalysisCapabilityUnavailableError, AnalysisInputError, AnalysisOutputError, AnalysisResourceConstraintError, AnalysisUnsupportedTargetError, + cancelledBy, } from "../domain/analysisErrorCore.js"; import { il2cppMetadataSchema, @@ -396,9 +396,7 @@ export class Il2cppMetadataProvider implements Il2cppMetadataPort { options?: ExecutionOptions, ): Promise> { if (options?.signal?.aborted) - return err( - new AnalysisCancelledError(OPERATION, { cause: options.signal.reason }), - ); + return err(cancelledBy(OPERATION, options.signal)); if (this.#admissionStopped) return err( new AnalysisCapabilityUnavailableError(