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(scripts): run entrypoints through symlinked paths (#1256)

mldangelo-oai4cf2b14ffe08
diff --git a/.github/scripts/invoice-desk-source.mjs b/.github/scripts/invoice-desk-source.mjs
index 787d6b405..84dfd9c9b 100644
--- a/.github/scripts/invoice-desk-source.mjs
+++ b/.github/scripts/invoice-desk-source.mjs
@@ -1,7 +1,7 @@
import { execFileSync } from "node:child_process";
import { closeSync, mkdirSync, openSync } from "node:fs";
import { dirname, resolve, sep } from "node:path";
-import { pathToFileURL } from "node:url";
+import { isMain } from "../../sdk/typescript/scripts/is-main.mjs";
export function extractApplication(repository, sha, destination) {
const git = (args) =>
@@ -43,10 +43,7 @@ export function extractApplication(repository, sha, destination) {
return entries.length;
}
-if (
- process.argv[1] &&
- import.meta.url === pathToFileURL(process.argv[1]).href
-) {
+if (isMain(import.meta.url)) {
const count = extractApplication(
process.env.SOURCE_REPOSITORY,
process.env.SOURCE_SHA,
diff --git a/.github/scripts/invoice-desk-target.mjs b/.github/scripts/invoice-desk-target.mjs
index c84f1f1e5..0b425b495 100644
--- a/.github/scripts/invoice-desk-target.mjs
+++ b/.github/scripts/invoice-desk-target.mjs
@@ -1,6 +1,6 @@
import { execFileSync } from "node:child_process";
import { appendFileSync, readFileSync } from "node:fs";
-import { pathToFileURL } from "node:url";
+import { isMain } from "../../sdk/typescript/scripts/is-main.mjs";
function eligible(pr, repository, sha) {
return (
@@ -61,10 +61,7 @@ export async function resolveScanTargets(
return [{ pr: pr.number, sha: sourceSha }];
}
-if (
- process.argv[1] &&
- import.meta.url === pathToFileURL(process.argv[1]).href
-) {
+if (isMain(import.meta.url)) {
const repository = process.env.GITHUB_REPOSITORY;
const targets = await resolveScanTargets(
{
diff --git a/examples/custom-validation/app.mts b/examples/custom-validation/app.mts
index 478d252a6..89ee4ce2a 100644
--- a/examples/custom-validation/app.mts
+++ b/examples/custom-validation/app.mts
@@ -1,8 +1,8 @@
// Deliberately vulnerable local fixture. Do not deploy this application.
import { once } from "node:events";
+import { realpathSync } from "node:fs";
import { createServer as createHttpServer, type Server } from "node:http";
import type { AddressInfo } from "node:net";
-import { pathToFileURL } from "node:url";
// These identities, tokens, and records are synthetic demo data.
const tokens = new Map([
@@ -49,10 +49,19 @@ export async function createServer(): Promise<Server> {
return server;
}
-if (
- process.argv[1] &&
- import.meta.url === pathToFileURL(process.argv[1]).href
-) {
+// Keep the copied demo fixture independent of repository helpers.
+function isMain(): boolean {
+ try {
+ return (
+ process.argv[1] !== undefined &&
+ realpathSync(process.argv[1]) === realpathSync(new URL(import.meta.url))
+ );
+ } catch {
+ return false;
+ }
+}
+
+if (isMain()) {
const server = await createServer();
console.log(`http://127.0.0.1:${(server.address() as AddressInfo).port}`);
}
diff --git a/sdk/typescript/scripts/build-plugin.mjs b/sdk/typescript/scripts/build-plugin.mjs
index b80b99bbf..8227afa3f 100644
--- a/sdk/typescript/scripts/build-plugin.mjs
+++ b/sdk/typescript/scripts/build-plugin.mjs
@@ -9,8 +9,8 @@ import {
rm,
} from "node:fs/promises";
import { dirname, join, posix, resolve } from "node:path";
-import { pathToFileURL } from "node:url";
import { promisify } from "node:util";
+import { isMain } from "./is-main.mjs";
import { pluginContractFiles } from "./plugin-contract.mjs";
const packageRoot = resolve(import.meta.dirname, "..");
@@ -119,11 +119,7 @@ export async function buildBundledPlugin({
return files;
}
-const invokedPath = process.argv[1];
-if (
- invokedPath !== undefined &&
- pathToFileURL(resolve(invokedPath)).href === import.meta.url
-) {
+if (isMain(import.meta.url)) {
buildBundledPlugin()
.then((files) => {
console.log(`Generated bundled plugin with ${files.length} files.`);
diff --git a/sdk/typescript/scripts/check-plugin-source.mjs b/sdk/typescript/scripts/check-plugin-source.mjs
index 568e4111b..5754f207d 100644
--- a/sdk/typescript/scripts/check-plugin-source.mjs
+++ b/sdk/typescript/scripts/check-plugin-source.mjs
@@ -1,7 +1,7 @@
import { execFile } from "node:child_process";
import { resolve } from "node:path";
-import { pathToFileURL } from "node:url";
import { promisify } from "node:util";
+import { isMain } from "./is-main.mjs";
const execFileAsync = promisify(execFile);
const defaultPackageRoot = resolve(import.meta.dirname, "..");
@@ -22,11 +22,7 @@ export async function assertGeneratedPluginUntracked({
}
}
-const invokedPath = process.argv[1];
-if (
- invokedPath !== undefined &&
- pathToFileURL(resolve(invokedPath)).href === import.meta.url
-) {
+if (isMain(import.meta.url)) {
assertGeneratedPluginUntracked()
.then(() => {
console.log("Verified _bundled_plugin contains no tracked files.");
diff --git a/sdk/typescript/scripts/is-main.mjs b/sdk/typescript/scripts/is-main.mjs
new file mode 100644
index 000000000..d2edfc3c7
--- /dev/null
+++ b/sdk/typescript/scripts/is-main.mjs
@@ -0,0 +1,13 @@
+import { realpathSync } from "node:fs";
+
+export function isMain(url) {
+ try {
+ return (
+ process.argv[1] !== undefined &&
+ realpathSync(process.argv[1]) === realpathSync(new URL(url))
+ );
+ } catch {
+ // Imported modules may receive a non-file argument from node --eval.
+ return false;
+ }
+}
diff --git a/sdk/typescript/scripts/release-automation.mjs b/sdk/typescript/scripts/release-automation.mjs
index e197b503c..7844c2098 100644
--- a/sdk/typescript/scripts/release-automation.mjs
+++ b/sdk/typescript/scripts/release-automation.mjs
@@ -1,7 +1,7 @@
import { X509Certificate, hash } from "node:crypto";
import { readFileSync } from "node:fs";
import { basename } from "node:path";
-import { pathToFileURL } from "node:url";
+import { isMain } from "./is-main.mjs";
import { assertExpectedGitHead } from "./package-provenance.mjs";
const packageName = "@openai/codex-security";
@@ -999,9 +999,6 @@ function main() {
);
}
-if (
- process.argv[1] !== undefined &&
- import.meta.url === pathToFileURL(process.argv[1]).href
-) {
+if (isMain(import.meta.url)) {
main();
}
diff --git a/sdk/typescript/scripts/release-pr.mjs b/sdk/typescript/scripts/release-pr.mjs
index 35d6cab09..aa912cede 100644
--- a/sdk/typescript/scripts/release-pr.mjs
+++ b/sdk/typescript/scripts/release-pr.mjs
@@ -2,9 +2,10 @@ import { gitText } from "../../../plugins/codex-security/mcp-app/scripts/git.mjs
import { execFileSync } from "node:child_process";
import { hash } from "node:crypto";
import { setTimeout as delay } from "node:timers/promises";
-import { fileURLToPath, pathToFileURL } from "node:url";
+import { fileURLToPath } from "node:url";
import { isDeepStrictEqual } from "node:util";
import { assertStableVersion, releaseVersion } from "./release-automation.mjs";
+import { isMain } from "./is-main.mjs";
export const packagePath = "sdk/typescript/package.json";
export const notesPath = ".github/release-notes.md";
@@ -682,10 +683,7 @@ export function createGitHubClient(repository, token, fetcher = fetch) {
};
}
-if (
- process.argv[1] &&
- import.meta.url === pathToFileURL(process.argv[1]).href
-) {
+if (isMain(import.meta.url)) {
const directory = fileURLToPath(new URL("../../..", import.meta.url));
const repository = process.env.GITHUB_REPOSITORY ?? "openai/codex-security";
const token =
diff --git a/sdk/typescript/scripts/smoke-published-package.mjs b/sdk/typescript/scripts/smoke-published-package.mjs
index 4213b51d7..830483a3a 100644
--- a/sdk/typescript/scripts/smoke-published-package.mjs
+++ b/sdk/typescript/scripts/smoke-published-package.mjs
@@ -3,7 +3,7 @@ import { execFileSync } from "node:child_process";
import { mkdir, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join } from "node:path";
-import { fileURLToPath } from "node:url";
+import { isMain } from "./is-main.mjs";
import { resolveNpm } from "./package-smoke-npm.mjs";
import { packageSmokeTimeouts } from "./package-smoke-timeouts.mjs";
@@ -165,6 +165,6 @@ async function smokePublishedPackage() {
}
}
-if (process.argv[1] === fileURLToPath(import.meta.url)) {
+if (isMain(import.meta.url)) {
await smokePublishedPackage();
}
diff --git a/sdk/typescript/tests-ts/build-plugin.test.ts b/sdk/typescript/tests-ts/build-plugin.test.ts
index 760417d41..cf670f145 100644
--- a/sdk/typescript/tests-ts/build-plugin.test.ts
+++ b/sdk/typescript/tests-ts/build-plugin.test.ts
@@ -130,6 +130,7 @@ describe("bundled plugin build", () => {
for (const script of [
"build-plugin",
"check-plugin-source",
+ "is-main",
"plugin-contract",
]) {
await writeFixture(
diff --git a/sdk/typescript/tests-ts/script-entrypoints.test.ts b/sdk/typescript/tests-ts/script-entrypoints.test.ts
new file mode 100644
index 000000000..d48e9b8fd
--- /dev/null
+++ b/sdk/typescript/tests-ts/script-entrypoints.test.ts
@@ -0,0 +1,131 @@
+import { afterAll, beforeAll, expect, test } from "bun:test";
+import { mkdtemp, mkdir, rm, symlink, writeFile } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { fileURLToPath, pathToFileURL } from "node:url";
+import { runCommand } from "./support/shell.js";
+
+const repository = fileURLToPath(new URL("../../..", import.meta.url));
+let root: string;
+let linkedRepository: string;
+let compiled: string;
+let preload: string;
+
+beforeAll(async () => {
+ root = await mkdtemp(join(tmpdir(), "script entrypoints "));
+ linkedRepository = join(root, "linked checkout");
+ compiled = join(root, "compiled");
+ preload = join(root, "stop-main.mjs");
+ await mkdir(compiled);
+ await symlink(repository, linkedRepository, "junction");
+ await writeFile(
+ join(root, "package.json"),
+ JSON.stringify({ name: "@openai/codex-security", version: "99.1.2" }),
+ );
+ await writeFile(join(root, "event.json"), "{}");
+ await writeFile(
+ preload,
+ `
+ import childProcess from "node:child_process";
+ import fs from "node:fs/promises";
+ import http from "node:http";
+ import { syncBuiltinESMExports } from "node:module";
+ function entered() { throw new Error("SCRIPT_MAIN_REACHED"); }
+ globalThis.fetch = entered;
+ childProcess.execFile = entered;
+ childProcess.execFileSync = entered;
+ http.createServer = entered;
+ fs.mkdtemp = entered;
+ const readFile = fs.readFile;
+ fs.readFile = (path, ...args) => String(path).endsWith("plugin-files.json")
+ ? entered() : readFile(path, ...args);
+ syncBuiltinESMExports();
+ `,
+ );
+ const build = await runCommand(
+ "node",
+ ["--run", "build:examples", "--", "--outDir", compiled],
+ {
+ cwd: join(repository, "sdk", "typescript"),
+ timeout: 30_000,
+ },
+ );
+ expect(build.status, build.stderr).toBe(0);
+ await symlink(
+ join(compiled, "app.mjs"),
+ join(root, "linked app.mjs"),
+ "file",
+ );
+});
+
+afterAll(async () => {
+ await rm(root, { recursive: true, force: true });
+});
+
+test.each([
+ "sdk/typescript/scripts/release-automation.mjs",
+ "sdk/typescript/scripts/release-pr.mjs",
+ "sdk/typescript/scripts/check-plugin-source.mjs",
+ "sdk/typescript/scripts/build-plugin.mjs",
+ "sdk/typescript/scripts/smoke-published-package.mjs",
+ ".github/scripts/invoice-desk-source.mjs",
+ ".github/scripts/invoice-desk-target.mjs",
+ "app.mjs",
+])("runs %s through symlinks and stays inert when imported", async (script) => {
+ const direct =
+ script === "app.mjs" ? join(compiled, script) : join(repository, script);
+ const linked =
+ script === "app.mjs"
+ ? join(root, "linked app.mjs")
+ : join(linkedRepository, script);
+ const version = script.endsWith("release-automation.mjs");
+ const target = script.endsWith("invoice-desk-target.mjs");
+ const args = version ? ["version", join(root, "package.json")] : [];
+ const environment = {
+ ...process.env,
+ GITHUB_EVENT_NAME: "workflow_dispatch",
+ GITHUB_EVENT_PATH: join(root, "event.json"),
+ GITHUB_REPOSITORY: "example/project",
+ GITHUB_SHA: "1".repeat(40),
+ GITHUB_OUTPUT: join(root, "output"),
+ GITHUB_STEP_SUMMARY: "",
+ PR_NUMBER: undefined,
+ };
+ for (const invocation of [
+ [direct],
+ [linked],
+ ["--preserve-symlinks-main", linked],
+ ]) {
+ const result = await runCommand(
+ "node",
+ ["--import", pathToFileURL(preload).href, ...invocation, ...args],
+ {
+ env: environment,
+ timeout: 30_000,
+ },
+ );
+ expect(result.status, result.stderr).toBe(version || target ? 0 : 1);
+ if (version) expect(result.stdout).toBe("99.1.2\n");
+ else if (target)
+ expect(result.stdout).toContain(
+ `Main baseline at ${environment.GITHUB_SHA}`,
+ );
+ else expect(result.stderr).toContain("SCRIPT_MAIN_REACHED");
+ }
+ for (const argument of [[], ["unrelated argument"]]) {
+ const result = await runCommand(
+ "node",
+ [
+ "--import",
+ pathToFileURL(preload).href,
+ "--input-type=module",
+ "--eval",
+ `await import(${JSON.stringify(pathToFileURL(linked).href)})`,
+ ...argument,
+ ],
+ { env: environment, timeout: 30_000 },
+ );
+ expect(result.status, result.stderr).toBe(0);
+ expect(result.stdout + result.stderr).toBe("");
+ }
+});