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

3.8 KB
Raw Blame
import { once } from "node:events";
import { describe, expect, test, mock } from "bun:test";
import {
  ScanProgressTracker,
  deepScanProgressFromWorkbench,
  type DeepScanProgress,
} from "../src/scan-progress.js";

function workbenchResult(
  independentReviews?: Record<string, unknown>,
): Record<string, unknown> {
  return {
    scan: {
      progress: {
        ...(independentReviews === undefined ? {} : { independentReviews }),
      },
    },
  };
}

describe("Deep Scan progress", () => {
  test("reads durable independent-review counts from the workbench projection", () => {
    expect(
      deepScanProgressFromWorkbench(
        workbenchResult({
          completed: 34,
          active: 2,
          maximum: 40,
          consolidating: false,
        }),
      ),
    ).toEqual({ completed: 34, active: 2, maximum: 40, consolidating: false });
  });

  test("waits for the Deep Scan coordinator to create independent-review state", () => {
    expect(deepScanProgressFromWorkbench(workbenchResult())).toBeNull();
  });

  test.each([
    { completed: -1, active: 0, maximum: 40 },
    { completed: 0, active: 0, maximum: 0 },
    { completed: 0, active: "two", maximum: 40 },
    { completed: 2, active: 0, maximum: 40, consolidating: "false" },
    { completed: 2, active: 0, maximum: 40, consolidating: null },
  ])("rejects invalid workbench progress %#", (independentReviews) => {
    expect(() =>
      deepScanProgressFromWorkbench(workbenchResult(independentReviews)),
    ).toThrow("invalid Deep Scan progress");
  });

  test("reports only changed progress and ignores refresh after stop", async () => {
    const reads = [
      workbenchResult(),
      workbenchResult({ completed: 0, active: 2, maximum: 40 }),
      workbenchResult({ completed: 0, active: 2, maximum: 40 }),
      workbenchResult({ completed: 1, active: 1, maximum: 40 }),
    ];
    const progress: DeepScanProgress[] = [];
    const read = mock(async () => {
      return reads.shift() ?? workbenchResult();
    });
    const tracker = new ScanProgressTracker({
      read,
      onDeepProgress: (update) => progress.push(update),
    });

    await tracker.refresh();
    await tracker.refresh();
    await tracker.refresh();
    await tracker.refresh();
    await tracker.stop();
    await tracker.refresh();

    expect(progress).toEqual([
      { completed: 0, active: 2, maximum: 40 },
      { completed: 1, active: 1, maximum: 40 },
    ]);
    expect(read).toHaveBeenCalledTimes(4);
  });

  test("does not queue or await stalled polls during stop", async () => {
    const progress: DeepScanProgress[] = [];
    const read = mock(async (signal: AbortSignal) => {
      await once(signal, "abort");
      aborted = true;
      return workbenchResult({ completed: 1, active: 0, maximum: 40 });
    });
    let aborted = false;
    const tracker = new ScanProgressTracker({
      read,
      onDeepProgress: (update) => progress.push(update),
    });

    const first = tracker.refresh();
    await Bun.sleep(0);
    const second = tracker.refresh();
    tracker.stop();
    await Promise.all([first, second]);

    expect(read).toHaveBeenCalledTimes(1);
    expect(aborted).toBe(true);
    expect(progress).toEqual([]);
  });

  test("reports reduction transitions when review counts remain unchanged", async () => {
    const reads = [false, true, true, false].map((consolidating) =>
      workbenchResult({ completed: 2, active: 2, maximum: 40, consolidating }),
    );
    const progress: DeepScanProgress[] = [];
    const tracker = new ScanProgressTracker({
      read: async () => reads.shift(),
      onDeepProgress: (update) => progress.push(update),
    });
    for (let index = 0; index < 4; index++) await tracker.refresh();
    tracker.stop();
    expect(progress.map((update) => update.consolidating)).toEqual([
      false,
      true,
      false,
    ]);
  });
});