Files
reverse-engineering-anything/src/application/analysisView/evidenceFileSource.ts
T
morluto 2826592759 refactor(application): build application cancellations with a required reason (#10574)
* refactor(application): build application cancellations with a required reason

Migrate every AnalysisCancelledError construction under src/application
to cancelledBy and lower the guard baseline from 671 to 442.

Shutdown refusals in BinarySession report OwnerCancellation.ownerClosed
when the caller did not abort, instead of an undefined reason.
ReverseEngineeringService and DesktopBuildOwnedWork close their work
with the typed owner reason. SharedStartupAttempt returns the departing
caller's reason with a cancelled wait. One shared isAborted predicate
replaces eleven local copies and narrows a checked signal for
cancelledBy.

* refactor(desktop): drop an unused cancellation import from desktop capture state
2026-11-15 18:38:24 +08:00

217 lines
7.5 KiB
TypeScript

import type { z } from "zod";
import { requireAuthenticationHeadroom } from "../JsonAuthenticationHeadroom.js";
import { authenticateEvidenceBundleValue } from "../EvidenceBundleFiles.js";
import type { ArtifactResourceScope } from "../../artifacts/ArtifactResourceScope.js";
import type { AnalysisError } from "../../domain/analysisErrorBase.js";
import {
AnalysisInputError,
type AnalysisInputIssue,
cancelledBy,
} from "../../domain/analysisErrorCore.js";
import { INSPECT_ANALYSIS_VIEW_OPERATION } from "../../domain/analysisView/analysisViewErrors.js";
import { err, ok, type Result } from "../../domain/result.js";
import type { Evidence } from "../../domain/evidence.js";
import { safeParseImmutableEvidence } from "../../domain/evidenceValidation.js";
import { EvidenceFileError } from "../../domain/evidenceErrors.js";
import { projectInputIssuesBounded } from "../../domain/inputIssueProjection.js";
import { readJsonFile } from "../JsonFiles.js";
/** The request cancellation and the scope retaining descriptors whose close failed. */
export interface EvidenceFileReadOptions {
readonly signal?: AbortSignal;
readonly resources?: ArtifactResourceScope;
}
/** Caller context and related-record resolution for this admitted file. */
export interface EvidenceFileSourceContext {
readonly operation: string;
readonly path: readonly (string | number)[];
readonly resolveSelected?: EvidenceFileRecordResolver;
}
/** Resolve related facts while the authenticated file records are in scope. */
export type EvidenceFileRecordResolver = (
selected: Evidence,
lookup: (evidenceId: string) => Evidence | undefined,
) => Result<Evidence, AnalysisError>;
const ANALYSIS_VIEW_SOURCE: EvidenceFileSourceContext = {
operation: INSPECT_ANALYSIS_VIEW_OPERATION,
path: ["source"],
};
const selectionError = (
site: EvidenceFileSourceContext,
message: string,
): AnalysisInputError =>
new AnalysisInputError(site.operation, { userMessage: message }, [
{
path: [...site.path, "evidence_id"],
reason: "invalid_value",
message,
},
]);
/** Listed identities stay bounded so a large bundle cannot grow the error itself. */
const RECORD_REFERENCE_PREVIEW_BYTES = 2048;
/** Select the one record a source names from an authenticated bundle. */
const selectBundleRecord = (
records: readonly Evidence[],
path: string,
evidenceId: string | undefined,
site: EvidenceFileSourceContext,
): Result<Evidence, AnalysisError> => {
if (evidenceId !== undefined) {
const selected = records.find(
(record) => record.evidence_id === evidenceId,
);
return selected === undefined
? err(
selectionError(
site,
`Evidence bundle ${path} holds no record ${evidenceId}. It holds ${listRecordIds(records)}.`,
),
)
: ok(selected);
}
const only = records[0];
if (only === undefined)
return err(
selectionError(site, `Evidence bundle ${path} holds no records.`),
);
if (records.length > 1)
return err(
selectionError(
site,
`Evidence bundle ${path} holds ${String(records.length)} records; select one with ${[...site.path, "evidence_id"].join(".")}. It holds ${listRecordIds(records)}.`,
),
);
return ok(only);
};
const listRecordIds = (records: readonly Evidence[]): string => {
const labels: string[] = [];
let bytes = 0;
for (const record of records) {
const separator = labels.length === 0 ? "" : ", ";
const remaining = RECORD_REFERENCE_PREVIEW_BYTES - bytes;
let label = `${record.evidence_id} (operation omitted)`;
// UTF-8/JSON cannot use fewer bytes than the source UTF-16 code units.
// Reject a label before copying it when even that lower bound cannot fit.
if (record.operation.length <= remaining) {
const complete = `${record.evidence_id} (${record.operation})`;
if (
Buffer.byteLength(JSON.stringify(separator + complete), "utf8") <=
remaining
)
label = complete;
}
const encodedBytes = Buffer.byteLength(
JSON.stringify(separator + label),
"utf8",
);
if (encodedBytes > remaining) break;
labels.push(label);
bytes += encodedBytes;
}
const omitted = records.length - labels.length;
const listed = labels.join(", ");
return omitted > 0 ? `${listed} and ${String(omitted)} more` : listed;
};
/**
* Budget for projected field-level diagnostics. A malformed file can carry tens
* of thousands of issues, and projecting all of them pushes the error past the
* MCP response budget, which then hides the typed file error and its path. Keep
* the leading issues that fit and say how many were omitted.
*/
const EVIDENCE_CONTENT_ISSUE_BUDGET_BYTES = 65_536;
const boundedContentIssues = (
issues: readonly z.core.$ZodIssue[],
input: unknown,
): readonly AnalysisInputIssue[] => {
const bounded = projectInputIssuesBounded(
issues,
input,
EVIDENCE_CONTENT_ISSUE_BUDGET_BYTES,
);
if (bounded.omittedIssueCount === 0) return bounded.issues;
return [
...bounded.issues,
{
path: [],
reason: "invalid_value",
message: `${String(bounded.omittedIssueCount)} of ${String(issues.length)} validator issues were omitted because they do not fit the response budget; repair the reported fields and retry.`,
},
];
};
/** Read one Evidence record or select from an authenticated bundle without rereading the file. */
export const readEvidenceFileSource = async (
path: string,
options: EvidenceFileReadOptions = {},
evidenceId?: string,
site: EvidenceFileSourceContext = ANALYSIS_VIEW_SOURCE,
): Promise<Result<Evidence, AnalysisError>> => {
const { signal, resources } = options;
const { operation } = site;
const resolveSelected =
site.resolveSelected ?? ((selected: Evidence) => ok(selected));
if (signal?.aborted) return err(cancelledBy(operation, signal));
const loaded = await readJsonFile(path, signal, resources, operation);
if (!loaded.ok) return loaded;
if (signal?.aborted) return err(cancelledBy(operation, signal));
const value = loaded.value;
if (
typeof value === "object" &&
value !== null &&
!Array.isArray(value) &&
Object.hasOwn(value, "records")
) {
const bundle = authenticateEvidenceBundleValue(value, path, {
operation,
immutable: true,
});
if (!bundle.ok) return bundle;
const selected = selectBundleRecord(
bundle.value.records,
path,
evidenceId,
site,
);
return selected.ok
? resolveSelected(selected.value, (id) =>
bundle.value.records.find((record) => record.evidence_id === id),
)
: selected;
}
const headroom = requireAuthenticationHeadroom(value, {
operation,
path,
description: "Insufficient heap headroom to authenticate the Evidence file",
});
if (!headroom.ok) return headroom;
const parsed = safeParseImmutableEvidence(value);
if (!parsed.ok)
return err(
new EvidenceFileError("read", "wrong-kind", {
path,
cause: parsed.error,
contentIssues: boundedContentIssues(parsed.error.issues, value),
userMessage:
"The selected file does not contain valid Evidence. Repair or recreate the file and try again.",
}),
);
if (evidenceId !== undefined && parsed.value.evidence_id !== evidenceId)
return err(
selectionError(
site,
`Evidence file ${path} holds ${parsed.value.evidence_id}, not selected record ${evidenceId}.`,
),
);
return resolveSelected(parsed.value, (id) =>
parsed.value.evidence_id === id ? parsed.value : undefined,
);
};