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

refactor(plugin): colocate runtime payload contract (#686)

soyeon-oaic61b46e16a2c
diff --git a/sdk/typescript/plugin-files.json b/plugins/codex-security/plugin-files.json
similarity index 100%
rename from sdk/typescript/plugin-files.json
rename to plugins/codex-security/plugin-files.json
diff --git a/sdk/typescript/TESTING.md b/sdk/typescript/TESTING.md
index 42ce8d399..f8c4e65bd 100644
--- a/sdk/typescript/TESTING.md
+++ b/sdk/typescript/TESTING.md
@@ -18,7 +18,7 @@ pnpm run test:package
```
The authored plugin lives in `plugins/codex-security`. `pnpm pack` generates
-the ignored `_bundled_plugin` runtime payload from `plugin-files.json` during
+the ignored `_bundled_plugin` runtime payload from `plugins/codex-security/plugin-files.json` during
`prepack`, including the MCP runtime built from `mcp-app`; do not edit generated
files there. Run `pnpm run build:plugin` when you need to inspect the staged
payload locally. `plugins/codex-security` contains authored source and assets,
diff --git a/sdk/typescript/scripts/build-plugin.mjs b/sdk/typescript/scripts/build-plugin.mjs
index bc6609510..7f8dbbbce 100644
--- a/sdk/typescript/scripts/build-plugin.mjs
+++ b/sdk/typescript/scripts/build-plugin.mjs
@@ -55,7 +55,12 @@ async function destinationFiles(root, prefix = "") {
}
export async function buildBundledPlugin({
- contractPath = join(packageRoot, "plugin-files.json"),
+ contractPath = join(
+ repositoryRoot,
+ "plugins",
+ "codex-security",
+ "plugin-files.json",
+ ),
destination = join(packageRoot, "_bundled_plugin"),
source = join(repositoryRoot, "plugins", "codex-security"),
} = {}) {
diff --git a/sdk/typescript/scripts/check-package.mjs b/sdk/typescript/scripts/check-package.mjs
index ab48965a5..28c48626b 100644
--- a/sdk/typescript/scripts/check-package.mjs
+++ b/sdk/typescript/scripts/check-package.mjs
@@ -14,7 +14,10 @@ const args = process.argv.slice(2);
if (args[0] === "--") args.shift();
const [
archive,
- contractPath = new URL("../plugin-files.json", import.meta.url),
+ contractPath = new URL(
+ "../../../plugins/codex-security/plugin-files.json",
+ import.meta.url,
+ ),
] = args;
if (archive === undefined || args.length > 2) {
throw new Error(
diff --git a/sdk/typescript/scripts/smoke-package.mjs b/sdk/typescript/scripts/smoke-package.mjs
index 80a442b47..a04c43436 100644
--- a/sdk/typescript/scripts/smoke-package.mjs
+++ b/sdk/typescript/scripts/smoke-package.mjs
@@ -30,7 +30,13 @@ const packageManifest = JSON.parse(
await readFile(new URL("../package.json", import.meta.url), "utf8"),
);
const pluginContract = JSON.parse(
- await readFile(new URL("../plugin-files.json", import.meta.url), "utf8"),
+ await readFile(
+ new URL(
+ "../../../plugins/codex-security/plugin-files.json",
+ import.meta.url,
+ ),
+ "utf8",
+ ),
);
async function resolveArchive() {
diff --git a/sdk/typescript/tests-ts/build-plugin.test.ts b/sdk/typescript/tests-ts/build-plugin.test.ts
index 615f17085..b1097d920 100644
--- a/sdk/typescript/tests-ts/build-plugin.test.ts
+++ b/sdk/typescript/tests-ts/build-plugin.test.ts
@@ -131,7 +131,7 @@ describe("bundled plugin build", () => {
),
);
await writeFixture(
- packageRoot,
+ source,
"plugin-files.json",
`${JSON.stringify({
externalOwnedExact: [".codex-plugin/plugin.json"],
@@ -157,7 +157,7 @@ describe("bundled plugin build", () => {
const root = await temporaryDirectory();
const source = join(root, "plugins", "codex-security");
const destination = join(root, "sdk", "typescript", "_bundled_plugin");
- const contractPath = join(root, "sdk", "typescript", "plugin-files.json");
+ const contractPath = join(source, "plugin-files.json");
await writeFixture(
source,
@@ -193,7 +193,7 @@ await writeFile(join(output, "server.mjs"), "generated mcp runtime\\n");
await writeFixture(source, "sdk/typescript/owned-by-sdk.txt", "sdk\n");
await writeFixture(destination, "stale.txt", "stale\n");
await writeFixture(
- join(root, "sdk", "typescript"),
+ source,
"plugin-files.json",
`${JSON.stringify(
{
@@ -239,11 +239,11 @@ await writeFile(join(output, "server.mjs"), "generated mcp runtime\\n");
const root = await temporaryDirectory();
const source = join(root, "plugins", "codex-security");
const destination = join(root, "sdk", "typescript", "_bundled_plugin");
- const contractPath = join(root, "sdk", "typescript", "plugin-files.json");
+ const contractPath = join(source, "plugin-files.json");
await writeFixture(source, ".codex-plugin/plugin.json", "{}\n");
await writeFixture(
- join(root, "sdk", "typescript"),
+ source,
"plugin-files.json",
`${JSON.stringify({
externalOwnedExact: [".codex-plugin/plugin.json"],
diff --git a/sdk/typescript/tests-ts/runtime.test.ts b/sdk/typescript/tests-ts/runtime.test.ts
index 3bc32a8bc..37749d7db 100644
--- a/sdk/typescript/tests-ts/runtime.test.ts
+++ b/sdk/typescript/tests-ts/runtime.test.ts
@@ -617,7 +617,13 @@ describe("plugin runtime preparation", () => {
test("keeps native scan tools without the obsolete setup widget", async () => {
const contract = JSON.parse(
- await readFile(new URL("../plugin-files.json", import.meta.url), "utf8"),
+ await readFile(
+ new URL(
+ "../../../plugins/codex-security/plugin-files.json",
+ import.meta.url,
+ ),
+ "utf8",
+ ),
) as { shippedExact: string[] };
expect(contract.shippedExact).not.toContain("mcp/mcp-app.html.br");
expect(existsSync(join(PLUGIN_ROOT, "mcp", "mcp-app.html.br"))).toBe(false);
@@ -701,7 +707,10 @@ describe("plugin runtime preparation", () => {
const source = await resolvePluginPath(undefined, workspace);
expect(source).toBe(await bundledPluginRoot());
- const publicContractPath = new URL("../plugin-files.json", import.meta.url);
+ const publicContractPath = new URL(
+ "../../../plugins/codex-security/plugin-files.json",
+ import.meta.url,
+ );
const contractPath = existsSync(publicContractPath)
? publicContractPath
: join(