Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions sdk/typescript/src/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1499,13 +1499,16 @@ export async function main(
},
createSecurity: dependencies.createSecurity,
signal: controller.signal,
onProgress: ({ repository, status, attempt, error }) => {
onProgress: ({ repository, status, attempt, error, warning }) => {
const detail = error ?? warning;
errorOutput.write(
`codex-security: ${repository} ${status} (attempt ${attempt})${error === undefined ? "" : `: ${redactedErrorMessage(error)}`}\n`,
`codex-security: ${repository} ${status} (attempt ${attempt})${detail === undefined ? "" : `: ${redactedErrorMessage(detail)}`}\n`,
);
},
});
exitCode = interruptedExitCode() ?? (result.failed > 0 ? 2 : 0);
exitCode =
interruptedExitCode() ??
(result.failed > 0 || result.incomplete > 0 ? 2 : 0);
return { ...result };
} catch (error) {
exitCode =
Expand Down
91 changes: 80 additions & 11 deletions sdk/typescript/src/multiscan.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import type { CodexSecurity } from "./api.js";
import type { CodexSecurityConfig } from "./config.js";
import type { ScanCost } from "./cost.js";
import { redactedErrorMessage } from "./errors.js";
import type { CoverageDocument } from "./models.js";
import type { ScanMode } from "./targets.js";
import { resolveTrustedExecutable } from "./trusted-executable.js";

Expand All @@ -43,11 +44,13 @@ interface MultiscanTask {
}

interface MultiscanReceipt extends MultiscanTask {
status: "completed" | "failed";
status: "completed" | "completed_with_incomplete_coverage" | "failed";
attempt: number;
outputDir: string;
coverage?: CoverageDocument["completeness"];
cost?: ScanCost;
error?: string;
warning?: string;
}

export interface MultiscanOptions {
Expand All @@ -67,15 +70,21 @@ export interface MultiscanOptions {
signal?: AbortSignal;
onProgress?(event: {
repository: string;
status: "started" | "completed" | "failed";
status:
| "started"
| "completed"
| "completed_with_incomplete_coverage"
| "failed";
attempt: number;
error?: string;
warning?: string;
}): void;
}

export interface MultiscanResult {
total: number;
completed: number;
incomplete: number;
failed: number;
skipped: number;
resultsPath: string;
Expand Down Expand Up @@ -118,24 +127,44 @@ async function runCampaign(
const receipts = await readReceipts(ledger);
const pending: MultiscanTask[] = [];
let completed = 0;
let incomplete = 0;
for (const task of tasks) {
const receipt = receipts.get(task.id.toLowerCase());
if (
receipt?.status === "completed" &&
receipt !== undefined &&
receipt.outputDir ===
join(output, "artifacts", task.id, `attempt-${receipt.attempt}`) &&
(await hasArtifacts(receipt.outputDir))
) {
completed += 1;
} else {
pending.push(task);
if (receipt.status === "completed") {
completed += 1;
continue;
}
const coverage =
receipt.status === "completed_with_incomplete_coverage"
? receipt.coverage ?? "unknown"
: await legacyIncompleteCoverage(receipt);
if (coverage !== undefined) {
incomplete += 1;
options.onProgress?.({
repository: task.id,
status: "completed_with_incomplete_coverage",
attempt: receipt.attempt,
warning:
receipt.warning ??
`Scan coverage is ${coverage}; results may be incomplete.`,
});
continue;
}
}
pending.push(task);
}
const skipped = completed;
const skipped = completed + incomplete;
if (pending.length === 0) {
return {
total: tasks.length,
completed,
incomplete,
failed: 0,
skipped,
resultsPath: ledger,
Expand Down Expand Up @@ -165,6 +194,8 @@ async function runCampaign(
const progress = { repository: task.id, attempt };
options.onProgress?.({ ...progress, status: "started" });
let failure: string | undefined;
let warning: string | undefined;
let coverage: CoverageDocument["completeness"] | undefined;
let cost: Readonly<ScanCost> | null = null;
try {
await mkdir(dirname(scanDir), { recursive: true, mode: 0o700 });
Expand Down Expand Up @@ -204,34 +235,49 @@ async function runCampaign(
...(options.signal === undefined ? {} : { signal: options.signal }),
});
cost = result.cost;
if (result.coverage.completeness !== "complete") {
throw new Error("Multiscan repository coverage is incomplete.");
coverage = result.coverage.completeness;
if (coverage !== "complete") {
if (!(await hasArtifacts(scanDir))) {
throw new Error(
"Multiscan scan output is missing required artifacts.",
);
}
warning = `Scan coverage is ${coverage}; results may be incomplete.`;
}
} catch (error) {
if (options.signal?.aborted === true) options.signal.throwIfAborted();
failure = redactedErrorMessage(error);
} finally {
await rm(checkout, { recursive: true, force: true });
}
const status = failure === undefined ? "completed" : "failed";
const status =
failure !== undefined
? "failed"
: warning === undefined
? "completed"
: "completed_with_incomplete_coverage";
await appendReceipt(
ledger,
`${JSON.stringify({
...task,
status,
attempt,
outputDir: scanDir,
...(coverage === undefined ? {} : { coverage }),
...(cost === null ? {} : { cost }),
...(failure === undefined ? {} : { error: failure }),
...(warning === undefined ? {} : { warning }),
})}\n`,
);
options.onProgress?.({
...progress,
status,
...(failure === undefined ? {} : { error: failure }),
...(warning === undefined ? {} : { warning }),
});
if (failure === undefined) {
completed += 1;
if (warning === undefined) completed += 1;
else incomplete += 1;
break;
}
if (retry === options.maxAttempts - 1) failed += 1;
Expand All @@ -256,6 +302,7 @@ async function runCampaign(
return {
total: tasks.length,
completed,
incomplete,
failed,
skipped,
resultsPath: ledger,
Expand Down Expand Up @@ -508,6 +555,28 @@ async function hasArtifacts(path: string): Promise<boolean> {
}
}

async function legacyIncompleteCoverage(
receipt: MultiscanReceipt,
): Promise<Exclude<CoverageDocument["completeness"], "complete"> | undefined> {
if (
receipt.status !== "failed" ||
receipt.error !== "Multiscan repository coverage is incomplete."
) {
return undefined;
}
try {
const coverage = JSON.parse(
await readFile(join(receipt.outputDir, "coverage.json"), "utf8"),
) as { completeness?: unknown };
return coverage.completeness === "partial" ||
coverage.completeness === "unknown"
? coverage.completeness
: undefined;
} catch {
return undefined;
}
}

function parseInventory(
source: string,
directory: string,
Expand Down
Loading
Loading