OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security
TypeScript ai-securityapplication-securityclicode-scanningcodexcodex-securitycybersecuritydevsecopsnodejsnpmopenaisdksecuritytypescriptvulnerability-scanning
refactor(sdk): share CLI cancellation signal handling (#1371)
mldangelo-oaic0192a9e3f16
diff --git a/sdk/typescript/scripts/check-package.mjs b/sdk/typescript/scripts/check-package.mjsindex 665308b93..cdfb5e2b2 100644--- a/sdk/typescript/scripts/check-package.mjs+++ b/sdk/typescript/scripts/check-package.mjs@@ -151,6 +151,7 @@ const allowedFiles = new Set(["cli","cli-help","cli-scan-logs-json",+ "cli-signals","classify-severity","classify-scan-severity","severity-store",diff --git a/sdk/typescript/src/cli-signals.ts b/sdk/typescript/src/cli-signals.tsnew file mode 100644index 000000000..1e55afad9--- /dev/null+++ b/sdk/typescript/src/cli-signals.ts@@ -0,0 +1,39 @@+type SignalName = "SIGINT" | "SIGTERM";++export function listenForAbort(+ dependencies: {+ addSignalListener(signal: SignalName, listener: () => void): void;+ removeSignalListener(signal: SignalName, listener: () => void): void;+ now(): number;+ },+ controller: AbortController,+ onRepeatedSignal?: (signal: SignalName) => void,+): () => void {+ let firstSignalAt = 0;+ const signalListener = (signal: SignalName) => () => {+ if (onRepeatedSignal !== undefined) {+ if (controller.signal.aborted) {+ // Ignore duplicate initial delivery; a later or different signal exits.+ if (+ controller.signal.reason === signal &&+ dependencies.now() - firstSignalAt < 500+ )+ return;+ removeSignalListeners();+ onRepeatedSignal(signal);+ return;+ }+ firstSignalAt = dependencies.now();+ }+ controller.abort(signal);+ };+ const interrupt = signalListener("SIGINT");+ const terminate = signalListener("SIGTERM");+ const removeSignalListeners = () => {+ dependencies.removeSignalListener("SIGINT", interrupt);+ dependencies.removeSignalListener("SIGTERM", terminate);+ };+ dependencies.addSignalListener("SIGINT", interrupt);+ dependencies.addSignalListener("SIGTERM", terminate);+ return removeSignalListeners;+}diff --git a/sdk/typescript/src/cli.ts b/sdk/typescript/src/cli.tsindex 4933f69ef..1c7a5a141 100644--- a/sdk/typescript/src/cli.ts+++ b/sdk/typescript/src/cli.ts@@ -1,4 +1,5 @@#!/usr/bin/env node+import { listenForAbort } from "./cli-signals.js";import { isNonEmptyString } from "./value.js";import {@@ -1881,28 +1882,9 @@ export async function main(selection: MatchingCliOptions,): Promise<JsonObject> => {const controller = new AbortController();- let firstSignalAt = 0;- const cancel = (signal: SignalName): void => {- if (controller.signal.aborted) {- if (- signal === controller.signal.reason &&- dependencies.now() - firstSignalAt < DUPLICATE_SIGNAL_WINDOW_MS- ) {- return;- }- removeListeners();- dependencies.forceExit(signal);- } else {- firstSignalAt = dependencies.now();- controller.abort(signal);- }- };- const onInterrupt = (): void => cancel("SIGINT");- const onTerminate = (): void => cancel("SIGTERM");- const removeListeners = (): void => {- signalHandlers(dependencies, "remove", onInterrupt, onTerminate);- };- signalHandlers(dependencies, "add", onInterrupt, onTerminate);+ const removeListeners = listenForAbort(dependencies, controller, (signal) =>+ dependencies.forceExit(signal),+ );let previousProgress = "";try {const result = await operation({@@ -9697,23 +9679,6 @@ if (invokedAsMain()) {);}-function listenForAbort(- dependencies: Pick<- CliDependencies,- "addSignalListener" | "removeSignalListener"- >,- controller: AbortController,-): () => void {- const onInterrupt = () => controller.abort("SIGINT");- const onTerminate = () => controller.abort("SIGTERM");- dependencies.addSignalListener("SIGINT", onInterrupt);- dependencies.addSignalListener("SIGTERM", onTerminate);- return () => {- dependencies.removeSignalListener("SIGINT", onInterrupt);- dependencies.removeSignalListener("SIGTERM", onTerminate);- };-}-function withoutLinearCredentials(environment: NodeJS.ProcessEnv,): NodeJS.ProcessEnv {diff --git a/sdk/typescript/src/security-policy-cli.ts b/sdk/typescript/src/security-policy-cli.tsindex 6e1f24413..26e1ae751 100644--- a/sdk/typescript/src/security-policy-cli.ts+++ b/sdk/typescript/src/security-policy-cli.ts@@ -1,3 +1,4 @@+import { listenForAbort } from "./cli-signals.js";import type { CodexSecurity, ScanAuthMode } from "./api.js";import type { BulkScanPrompt } from "./bulk-scan-discovery.js";import type { CodexSecurityConfig } from "./config.js";@@ -73,30 +74,11 @@ export async function runPolicyCommand(errorOutput.write(`${message}\n`);} catch {}};- let firstSignalAt = 0;- const signalListener = (signal: SignalName) => () => {- if (controller.signal.aborted) {- // Match scan's handling of duplicate initial signals from launchers.- if (- controller.signal.reason === signal &&- dependencies.now() - firstSignalAt < 500- )- return;- removeSignalListeners();- dependencies.forceExit(signal);- return;- }- firstSignalAt = dependencies.now();- controller.abort(signal);- };- const interrupt = signalListener("SIGINT");- const terminate = signalListener("SIGTERM");- const removeSignalListeners = () => {- dependencies.removeSignalListener("SIGINT", interrupt);- dependencies.removeSignalListener("SIGTERM", terminate);- };- dependencies.addSignalListener("SIGINT", interrupt);- dependencies.addSignalListener("SIGTERM", terminate);+ const removeSignalListeners = listenForAbort(+ dependencies,+ controller,+ (signal) => dependencies.forceExit(signal),+ );try {const auth =interactive && !options.dryRundiff --git a/sdk/typescript/src/targets.ts b/sdk/typescript/src/targets.tsindex 82e3c0908..3bd10f93c 100644--- a/sdk/typescript/src/targets.ts+++ b/sdk/typescript/src/targets.ts@@ -788,18 +788,15 @@ export async function abortable<T>(return await new Promise<T>((resolvePromise, reject) => {const onAbort = (): void => reject(abortReason(signal));signal.addEventListener("abort", onAbort, { once: true });+ const finish =+ <U>(settle: (value: U) => void) =>+ (value: U): void => {+ signal.removeEventListener("abort", onAbort);+ settle(value);+ };void Promise.resolve().then(operation)- .then(- (value) => {- signal.removeEventListener("abort", onAbort);- resolvePromise(value);- },- (error: unknown) => {- signal.removeEventListener("abort", onAbort);- reject(error);- },- );+ .then(finish(resolvePromise), finish(reject));});}