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(sdk): generate project schemas before bundling MCP (#2473)

Michael D'Angelo03915c1fd7a1
diff --git a/sdk/typescript/TESTING.md b/sdk/typescript/TESTING.md
index 00798860a..310e6fc33 100644
--- a/sdk/typescript/TESTING.md
+++ b/sdk/typescript/TESTING.md
@@ -58,6 +58,7 @@ pnpm run test:package
```
Replace `X.Y.Z` with the version in the filename printed by `pnpm pack`.
+Packing regenerates SDK defaults and project schemas before building the MCP runtime.
The authored plugin lives in `plugins/codex-security`. `pnpm pack` generates
the ignored `_bundled_plugin` runtime payload from `plugins/codex-security/plugin-files.json` during
diff --git a/sdk/typescript/package.json b/sdk/typescript/package.json
index 6d94ade71..d3f517c13 100644
--- a/sdk/typescript/package.json
+++ b/sdk/typescript/package.json
@@ -60,7 +60,7 @@
"scripts": {
"audit:prod": "pnpm audit --prod --audit-level high",
"clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
- "build": "node --run clean && node scripts/generate-plugin-defaults.mjs && tsc -p tsconfig.build.json && node scripts/build-embedding-tokenizer.mjs && node scripts/generate-project-config-schema.mjs",
+ "build": "node --run clean && node scripts/generate-plugin-defaults.mjs && tsc -p tsconfig.build.json && node scripts/build-embedding-tokenizer.mjs",
"build:ci": "tsc -p tsconfig.ci.json",
"build:evals": "node --run build && tsc -p ../../evals/tsconfig.json",
"build:examples": "tsc -p tsconfig.examples.json",
@@ -73,13 +73,13 @@
"generate:external-import-models": "node scripts/generate-external-import-models.cjs",
"generate:external-import-models:check": "node scripts/generate-external-import-models.cjs --check",
"lint": "tsc --noEmit",
- "prepack": "node --run build:plugin && node --run build",
+ "prepack": "node --run build && node --run build:plugin",
"test": "node --run build:plugin && bun test --timeout 30000 ./tests-ts",
"test:ci": "node -e \"require('node:fs').mkdirSync('reports',{recursive:true})\" && pnpm run test --coverage --coverage-reporter=text --coverage-reporter=lcov --reporter=junit --reporter-outfile=reports/junit.xml",
"test:mcp": "node --run build:plugin && pnpm --dir ../../plugins/codex-security/mcp-app run test:mcp",
"test:mutation": "pnpm --dir ../mutation install --frozen-lockfile && pnpm --dir ../mutation run test:sdk",
"test:package": "node scripts/smoke-package.mjs",
- "types": "node scripts/generate-plugin-defaults.mjs --check && node scripts/generate-project-config-schema.mjs --check && pnpm run generate:models:check && pnpm run generate:external-import-models:check && pnpm --dir ../../plugins/codex-security/mcp-app run typecheck && tsc --noEmit"
+ "types": "node scripts/generate-plugin-defaults.mjs --check && pnpm run generate:models:check && pnpm run generate:external-import-models:check && pnpm --dir ../../plugins/codex-security/mcp-app run typecheck && tsc --noEmit"
},
"dependencies": {
"@inquirer/checkbox": "5.2.8",
diff --git a/sdk/typescript/scripts/generate-plugin-defaults.mjs b/sdk/typescript/scripts/generate-plugin-defaults.mjs
index 1a35defd5..909447851 100644
--- a/sdk/typescript/scripts/generate-plugin-defaults.mjs
+++ b/sdk/typescript/scripts/generate-plugin-defaults.mjs
@@ -1,7 +1,28 @@
-import { readFile, writeFile } from "node:fs/promises";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+import { build } from "esbuild";
import { format } from "prettier";
-const plugin = new URL("../../../plugins/codex-security/", import.meta.url);
+const sdk = new URL("../", import.meta.url);
+const plugin = new URL("../../plugins/codex-security/", sdk);
+const check = process.argv.includes("--check");
+
+async function generate(parser, source, ...outputs) {
+ const contents = await format(source, { parser });
+ for (const output of outputs) {
+ if (check) {
+ const current = await readFile(output, "utf8");
+ if (current.replaceAll("\r\n", "\n") !== contents)
+ throw new Error(
+ `${fileURLToPath(output)} is out of date. Run pnpm build.`,
+ );
+ } else {
+ await mkdir(new URL(".", output), { recursive: true });
+ await writeFile(output, contents);
+ }
+ }
+}
+
const deepDefaults = JSON.parse(
await readFile(new URL("scripts/deep_scan_defaults.json", plugin), "utf8"),
);
@@ -18,12 +39,23 @@ for (const [filename, source] of [
`// Generated from the plugin ${rubricPath}. Run pnpm build.\nexport const defaultSeverityRubric = ${JSON.stringify(rubric)};\n`,
],
]) {
- const contents = await format(source, { parser: "typescript" });
- const output = new URL(`../src/${filename}`, import.meta.url);
- if (process.argv.includes("--check")) {
- if ((await readFile(output, "utf8")).replaceAll("\r\n", "\n") !== contents)
- throw new Error(`${filename} is out of date. Run pnpm build.`);
- } else {
- await writeFile(output, contents);
- }
+ await generate("typescript", source, new URL(`src/${filename}`, sdk));
}
+
+// The project schema uses the generated Deep Scan defaults.
+const bundled = await build({
+ entryPoints: [fileURLToPath(new URL("src/project-config-schema.ts", sdk))],
+ bundle: true,
+ platform: "node",
+ format: "esm",
+ write: false,
+});
+const { projectConfigJsonSchema } = await import(
+ `data:text/javascript;base64,${Buffer.from(bundled.outputFiles[0].contents).toString("base64")}`
+);
+await generate(
+ "json",
+ JSON.stringify(projectConfigJsonSchema()),
+ new URL("schemas/project-config.schema.json", sdk),
+ new URL("mcp-app/src/deep-scan/project-config.schema.json", plugin),
+);
diff --git a/sdk/typescript/scripts/generate-project-config-schema.mjs b/sdk/typescript/scripts/generate-project-config-schema.mjs
deleted file mode 100644
index c01a3b104..000000000
--- a/sdk/typescript/scripts/generate-project-config-schema.mjs
+++ /dev/null
@@ -1,43 +0,0 @@
-import { mkdir, readFile, writeFile } from "node:fs/promises";
-import { fileURLToPath } from "node:url";
-import { build } from "esbuild";
-import { format } from "prettier";
-
-// Load the source schema without requiring a prior SDK build during typechecks.
-const bundled = await build({
- entryPoints: [
- fileURLToPath(new URL("../src/project-config-schema.ts", import.meta.url)),
- ],
- bundle: true,
- platform: "node",
- format: "esm",
- write: false,
-});
-const { projectConfigJsonSchema } = await import(
- `data:text/javascript;base64,${Buffer.from(bundled.outputFiles[0].contents).toString("base64")}`
-);
-
-const outputs = [
- new URL("../schemas/project-config.schema.json", import.meta.url),
- new URL(
- "../../../plugins/codex-security/mcp-app/src/deep-scan/project-config.schema.json",
- import.meta.url,
- ),
-];
-const contents = await format(JSON.stringify(projectConfigJsonSchema()), {
- parser: "json",
-});
-for (const output of outputs) {
- if (process.argv.includes("--check")) {
- if (
- (await readFile(output, "utf8")).replaceAll("\r\n", "\n") !== contents
- ) {
- throw new Error(
- "Project configuration schema is out of date. Run pnpm build.",
- );
- }
- } else {
- await mkdir(new URL(".", output), { recursive: true });
- await writeFile(output, contents);
- }
-}
diff --git a/sdk/typescript/tests-ts/skeleton.test.ts b/sdk/typescript/tests-ts/skeleton.test.ts
index b807e8d0c..d6204c9f7 100644
--- a/sdk/typescript/tests-ts/skeleton.test.ts
+++ b/sdk/typescript/tests-ts/skeleton.test.ts
@@ -497,7 +497,9 @@ describe("TypeScript package skeleton", () => {
);
expect(packageJson.scripts.build).not.toMatch(/\b(?:pnpm|npm|bun)\b/u);
- expect(packageJson.scripts.build).toMatch(/^node --run clean &&/u);
+ expect(packageJson.scripts.build).toStartWith(
+ "node --run clean && node scripts/generate-plugin-defaults.mjs && ",
+ );
expect(packageJson.scripts["build:plugin"]).toBe(
"node scripts/build-plugin.mjs",
);
@@ -505,7 +507,7 @@ describe("TypeScript package skeleton", () => {
"node scripts/check-plugin-source.mjs",
);
expect(packageJson.scripts.prepack).toBe(
- "node --run build:plugin && node --run build",
+ "node --run build && node --run build:plugin",
);
expect(packageJson.scripts.types).not.toContain("check:plugin-source");
expect(packageJson.scripts["audit:prod"]).toBe(