Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

fix(artifacts): retain finding details with own JSON keys (#1780)

Michael D'Angeloeac16cbd5fa1
diff --git a/plugins/codex-security/mcp-app/src/artifact-scan-draft.ts b/plugins/codex-security/mcp-app/src/artifact-scan-draft.ts
index b7107faea..1fdd1bc12 100644
--- a/plugins/codex-security/mcp-app/src/artifact-scan-draft.ts
+++ b/plugins/codex-security/mcp-app/src/artifact-scan-draft.ts
@@ -1523,8 +1523,10 @@ function containsSavedValue(current: unknown, previous: unknown): boolean {
if (isObject(previous)) {
return (
isObject(current) &&
- Object.entries(previous).every(([key, value]) =>
- containsSavedValue(current[key], value),
+ Object.entries(previous).every(
+ ([key, value]) =>
+ Object.hasOwn(current, key) &&
+ containsSavedValue(current[key], value),
)
);
}
diff --git a/plugins/codex-security/mcp-app/tests/test_finding_detail_preservation.ts b/plugins/codex-security/mcp-app/tests/test_finding_detail_preservation.ts
new file mode 100644
index 000000000..818766126
--- /dev/null
+++ b/plugins/codex-security/mcp-app/tests/test_finding_detail_preservation.ts
@@ -0,0 +1,76 @@
+import assert from "node:assert/strict";
+import { test } from "node:test";
+import { importSource } from "./import-module.ts";
+import { finding } from "./scan-draft-fixture.ts";
+
+const { parseCurrentFindings, preserveFindingDetails } = await importSource(
+ "src/artifact-scan-draft.ts",
+);
+
+function parsedFinding(auditJson: string) {
+ return parseCurrentFindings([
+ {
+ ...finding("saved-detail", "src/example.ts"),
+ extensions: { audit: JSON.parse(auditJson) },
+ },
+ ])[0];
+}
+
+for (const auditJson of [
+ '{"__proto__":{}}',
+ '{"__proto__":{"__proto__":null}}',
+]) {
+ test(`retains missing own JSON detail ${auditJson}`, () => {
+ const previous = parsedFinding(auditJson);
+ const current = parsedFinding("{}");
+ const previousBefore = structuredClone(previous);
+ assert.equal(Object.hasOwn(previous.extensions.audit, "__proto__"), true);
+ assert.equal(Object.hasOwn(current.extensions.audit, "__proto__"), false);
+
+ preserveFindingDetails(current, previous);
+
+ assert.deepEqual(current.provenance.previousFindings, [previousBefore]);
+ assert.deepEqual(current.extensions.audit, {});
+ assert.deepEqual(previous, previousBefore);
+ assert.deepEqual(JSON.parse(JSON.stringify(current)), current);
+
+ const retained = structuredClone(current);
+ preserveFindingDetails(current, previous);
+ assert.deepEqual(current, retained);
+ });
+}
+
+for (const [previousJson, currentJson] of [
+ ['{"__proto__":{}}', '{"__proto__":{}}'],
+ ['{"__proto__":{"__proto__":null}}', '{"__proto__":{"__proto__":null}}'],
+ [
+ '{"proof":{"kind":"source"},"metadata":{}}',
+ '{"proof":{"kind":"source","line":7},"metadata":{"revision":2},"extra":true}',
+ ],
+ [
+ '{"items":[{"kind":"source"},{"kind":"source"},"reviewed"]}',
+ '{"items":["extra","reviewed",{"kind":"source","line":7}]}',
+ ],
+ ['{"note":null}', '{"note":null}'],
+]) {
+ test(`accepts retained JSON detail ${previousJson}`, () => {
+ const previous = parsedFinding(previousJson);
+ const current = parsedFinding(currentJson);
+ const previousBefore = structuredClone(previous);
+ const currentBefore = structuredClone(current);
+
+ preserveFindingDetails(current, previous);
+
+ assert.deepEqual(current, currentBefore);
+ assert.deepEqual(previous, previousBefore);
+ });
+}
+
+test("retains a missing null-valued member", () => {
+ const previous = parsedFinding('{"note":null}');
+ const current = parsedFinding("{}");
+
+ preserveFindingDetails(current, previous);
+
+ assert.deepEqual(current.provenance.previousFindings, [previous]);
+});