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(patch): keep every scroll step in the finding details pane (#2016)

125648dc9c565e
diff --git a/sdk/typescript/src/patch-tui.tsx b/sdk/typescript/src/patch-tui.tsx
index 42d55058f..108c6d492 100644
--- a/sdk/typescript/src/patch-tui.tsx
+++ b/sdk/typescript/src/patch-tui.tsx
@@ -2,7 +2,7 @@ import { readFileSync, realpathSync } from "node:fs";
import { basename, isAbsolute, relative, resolve, sep } from "node:path";
import { stripVTControlCharacters } from "node:util";
import { Box, Text, render, useApp, useInput, useStdout } from "ink";
-import { useMemo, useRef, useState } from "react";
+import { useEffect, useEffectEvent, useMemo, useRef, useState } from "react";
import type { Finding, FindingCodeEvidence } from "./models.js";
import { SCAN_SEVERITIES } from "./scan-settings.js";
@@ -194,11 +194,7 @@ function matchesSeverity(finding: Finding, severity: PatchSeverity): boolean {
);
}
-function findingLines(
- finding: Finding,
- repository: string,
- width: number,
-): string[] {
+function findingLines(finding: Finding, repository: string): string[] {
const evidenceById = new Map(
(finding.codeEvidence ?? []).map((item) => [item.id, item]),
);
@@ -211,7 +207,7 @@ function findingLines(
),
];
- const lines = [safeLine(finding.title), ""];
+ const parts: (string | string[])[] = [safeLine(finding.title), ""];
for (const [key, value] of fields) {
if (
value === null ||
@@ -220,7 +216,7 @@ function findingLines(
) {
continue;
}
- lines.push(fieldLabel(key).toUpperCase());
+ parts.push(fieldLabel(key).toUpperCase());
if (key === "codeEvidence" && Array.isArray(value)) {
for (const evidence of value as FindingCodeEvidence[]) {
const { label, path, startLine, endLine, code, explanation, ...other } =
@@ -228,30 +224,33 @@ function findingLines(
const location = `${safeLine(path)}:${startLine}${
endLine === undefined ? "" : `–${endLine}`
}`;
- lines.push(
+ parts.push(
label ? `${safeLine(label)} · ${location}` : location,
- ...numberedCode(safeText(code).split("\n"), startLine),
- ...safeText(explanation).split("\n"),
- ...detailLines(other, " ", evidenceById),
+ numberedCode(safeText(code).split("\n"), startLine),
+ safeText(explanation).split("\n"),
+ detailLines(other, " ", evidenceById),
);
}
} else if (key === "locations" && Array.isArray(value)) {
for (const location of value as Finding["locations"]) {
const { path, startLine, endLine, role, ...other } = location;
- lines.push(
+ parts.push(
`${safeLine(path)}:${startLine}${endLine === undefined ? "" : `–${endLine}`}${
role === undefined ? "" : ` · ${safeLine(role)}`
}`,
- ...locationSource(repository, location),
- ...detailLines(other, " ", evidenceById),
+ locationSource(repository, location),
+ detailLines(other, " ", evidenceById),
);
}
} else {
- lines.push(...detailLines(value, "", evidenceById));
+ parts.push(detailLines(value, "", evidenceById));
}
- lines.push("");
+ parts.push("");
}
+ return parts.flat();
+}
+function wrapFindingLines(lines: readonly string[], width: number): string[] {
return lines.flatMap((line) => {
if (line.length === 0) return [""];
const source = SOURCE_LINE.exec(line);
@@ -378,10 +377,18 @@ export function PatchTui({
),
[inputFindings],
);
- const [pane, setPane] = useState<"findings" | "details">("findings");
- const [focused, setFocused] = useState(0);
- const focusedFinding = useRef(focused);
- const [offset, setOffset] = useState(0);
+ const [navigation, setNavigation] = useState({
+ detailsActive: false,
+ focused: 0,
+ offset: 0,
+ });
+ // Ink can deliver several keys before React commits the next frame.
+ const cursor = useRef(navigation);
+ const navigate = (change: Partial<typeof navigation>) => {
+ cursor.current = { ...cursor.current, ...change };
+ setNavigation(cursor.current);
+ };
+ const { detailsActive, focused } = navigation;
const [preset, setPreset] = useState<PatchSeverity>("low");
const [instructions, setInstructions] = useState<Record<string, string>>({});
const [createPullRequest, setCreatePullRequest] = useState(false);
@@ -394,33 +401,74 @@ export function PatchTui({
rows?: number;
columns?: number;
};
- const rows = terminal.rows ?? 28;
- const columns = terminal.columns ?? 100;
- const visibleRows = Math.max(4, rows - 15);
+ const viewportFor = useMemo(() => {
+ let cached:
+ | { finding: Finding; lines: string[]; width: number; details: string[] }
+ | undefined;
+ return (finding: Finding) => {
+ const rows = terminal.rows ?? 28;
+ const width = Math.max(
+ 18,
+ Math.floor((terminal.columns ?? 100) * 0.58) - 7,
+ );
+ if (cached?.finding !== finding || cached.width !== width) {
+ const lines =
+ cached?.finding === finding
+ ? cached.lines
+ : findingLines(finding, repository);
+ cached = {
+ finding,
+ lines,
+ width,
+ details: wrapFindingLines(lines, width),
+ };
+ }
+ const visibleRows = Math.max(4, rows - 15);
+ return {
+ rows,
+ visibleRows,
+ details: cached.details,
+ maximumOffset: Math.max(0, cached.details.length - visibleRows),
+ };
+ };
+ }, [repository, terminal]);
+ const current = findings[focused]!;
+ const { rows, visibleRows, details, maximumOffset } = viewportFor(current);
+ const offset = Math.min(navigation.offset, maximumOffset);
const listStart = Math.max(
0,
Math.min(focused - visibleRows + 1, findings.length - visibleRows),
);
- const current = findings[focused]!;
- const details = useMemo(
- () =>
- findingLines(
- current,
- repository,
- Math.max(18, Math.floor(columns * 0.58) - 7),
- ),
- [columns, current, repository],
- );
- const maximumOffset = Math.max(0, details.length - visibleRows);
+ const scroll = (direction: number, page = false) => {
+ try {
+ const { maximumOffset, visibleRows } = viewportFor(
+ findings[cursor.current.focused]!,
+ );
+ const previous = Math.min(cursor.current.offset, maximumOffset);
+ const next = previous + direction * (page ? visibleRows : 1);
+ const offset = Math.max(0, Math.min(maximumOffset, next));
+ // A resize must repaint even if the same row stays at the top.
+ if (direction === 0 || offset !== cursor.current.offset)
+ navigate({ offset });
+ } catch (error) {
+ exit(error instanceof Error ? error : new Error(String(error)));
+ }
+ };
+ const resize = useEffectEvent(() => scroll(0));
+ useEffect(() => {
+ terminal.on("resize", resize);
+ return () => {
+ terminal.off("resize", resize);
+ };
+ }, [terminal]);
const accent = color ? "cyan" : undefined;
const muted = color ? "gray" : undefined;
const instructionColor = color ? "magentaBright" : undefined;
const success = color ? "green" : undefined;
const severityColor = (severity: PatchSeverity) =>
color ? SEVERITY_COLORS[severity] : undefined;
- const findingsColor =
- pane === "findings" && editing === null ? accent : muted;
- const detailsColor = pane === "details" && editing === null ? accent : muted;
+ const findingsColor = !detailsActive && editing === null ? accent : muted;
+ const detailsColor = detailsActive && editing === null ? accent : muted;
const currentInstructions = instructions[current.occurrenceId];
const selectedFindings = findings.filter(({ occurrenceId }) =>
selected.has(occurrenceId),
@@ -489,36 +537,27 @@ export function PatchTui({
} else if (input === "r") {
setCreatePullRequest((previous) => !previous);
} else if (input === "i") {
- const occurrenceId = findings[focusedFinding.current]!.occurrenceId;
+ const occurrenceId = findings[cursor.current.focused]!.occurrenceId;
setDraft(instructions[occurrenceId] ?? "");
setEditing(occurrenceId);
} else if (key.tab || key.leftArrow || key.rightArrow || input === "d") {
- setPane(pane === "findings" ? "details" : "findings");
+ navigate({ detailsActive: !cursor.current.detailsActive });
} else if (key.upArrow || key.downArrow || input === "j" || input === "k") {
const direction = key.downArrow || input === "j" ? 1 : -1;
- if (pane === "findings") {
- focusedFinding.current = Math.max(
+ if (!cursor.current.detailsActive) {
+ const focused = Math.max(
0,
- Math.min(findings.length - 1, focusedFinding.current + direction),
+ Math.min(findings.length - 1, cursor.current.focused + direction),
);
- setFocused(focusedFinding.current);
- setOffset(0);
- } else {
- setOffset(Math.max(0, Math.min(maximumOffset, offset + direction)));
- }
+ if (focused !== cursor.current.focused || cursor.current.offset !== 0) {
+ navigate({ focused, offset: 0 });
+ }
+ } else scroll(direction);
} else if (key.pageUp || key.pageDown) {
- setOffset(
- Math.max(
- 0,
- Math.min(
- maximumOffset,
- offset + (key.pageDown ? 1 : -1) * visibleRows,
- ),
- ),
- );
+ scroll(key.pageDown ? 1 : -1, true);
} else if (input === " ") {
const next = new Set(selected);
- const occurrenceId = findings[focusedFinding.current]!.occurrenceId;
+ const occurrenceId = findings[cursor.current.focused]!.occurrenceId;
if (next.has(occurrenceId)) next.delete(occurrenceId);
else next.add(occurrenceId);
setSelected(next);
diff --git a/sdk/typescript/tests-ts/fixtures/patch-large-excerpt.ts b/sdk/typescript/tests-ts/fixtures/patch-large-excerpt.ts
new file mode 100644
index 000000000..7dcf872ea
--- /dev/null
+++ b/sdk/typescript/tests-ts/fixtures/patch-large-excerpt.ts
@@ -0,0 +1,31 @@
+import assert from "node:assert/strict";
+import { stripVTControlCharacters } from "node:util";
+import { render } from "ink-testing-library";
+import { act, createElement } from "react";
+import { PatchTui } from "../../src/patch-tui.js";
+import type { Finding } from "../../src/models.js";
+
+const repository = process.argv[2];
+assert.ok(repository, "Expected a temporary repository");
+const finding: Finding = JSON.parse(process.argv[3]!);
+const app = render(
+ createElement(PatchTui, {
+ repository,
+ findings: [finding],
+ color: false,
+ onComplete() {},
+ }),
+);
+const frame = () => stripVTControlCharacters(app.lastFrame() ?? "");
+const firstFrame = frame();
+const range = firstFrame.match(/DETAILS\s+1–(\d+)\/(\d+)/u);
+assert.ok(range, firstFrame);
+Object.assign(globalThis, { IS_REACT_ACT_ENVIRONMENT: true });
+await act(async () => {
+ app.stdin.write(
+ "\u001B[6~".repeat(Math.ceil(Number(range[2]) / Number(range[1]))),
+ );
+});
+Object.assign(globalThis, { IS_REACT_ACT_ENVIRONMENT: false });
+assert.match(frame(), /150000 │ last source line/u);
+app.unmount();
diff --git a/sdk/typescript/tests-ts/patch-tui.test.ts b/sdk/typescript/tests-ts/patch-tui.test.ts
index edcd364e6..2baa002ce 100644
--- a/sdk/typescript/tests-ts/patch-tui.test.ts
+++ b/sdk/typescript/tests-ts/patch-tui.test.ts
@@ -9,6 +9,7 @@ import { act, createElement } from "react";
import type { Finding, SeverityLevel } from "../src/index.js";
import { PatchTui, type PatchSelection } from "../src/patch-tui.js";
import { fakeResult } from "./cli-fixtures.js";
+import { scopedTemporaryDirectory } from "./support/temporary-directories.js";
afterEach(() => cleanup());
@@ -94,16 +95,13 @@ function renderSelection(inputFindings: Finding[]) {
return { app, selected };
}
-async function press(
- app: ReturnType<typeof render>,
- input: string,
-): Promise<void> {
+async function update(action: () => void): Promise<void> {
const environment = globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean };
const previous = environment.IS_REACT_ACT_ENVIRONMENT;
environment.IS_REACT_ACT_ENVIRONMENT = true;
try {
await act(async () => {
- app.stdin.write(input);
+ action();
await nextTurn();
});
} finally {
@@ -112,6 +110,10 @@ async function press(
}
}
+function press(app: ReturnType<typeof render>, input: string): Promise<void> {
+ return update(() => app.stdin.write(input));
+}
+
describe("interactive patch finding browser", () => {
test("orders findings by severity while keeping navigation and selection aligned", async () => {
const inputFindings = findings([
@@ -267,6 +269,10 @@ describe("interactive patch finding browser", () => {
}),
);
+ // Resizing rewraps the source excerpt already displayed for this finding.
+ await writeFile(join(repository, "src", "finding-1.ts"), "file changed");
+ Object.defineProperty(app.stdout, "columns", { value: 110 });
+ await update(() => app.stdout.emit("resize"));
const frames = [app.lastFrame() ?? ""];
for (let page = 0; page < 12; page += 1) {
await press(app, "\u001B[6~");
@@ -407,6 +413,77 @@ describe("interactive patch finding browser", () => {
]);
});
+ test("shows the final source line of a large excerpt under Node", async () => {
+ await using repository = await scopedTemporaryDirectory(
+ "patch-large-excerpt-",
+ );
+ const lineCount = 150_000;
+ const path = "large.ts";
+ await writeFile(
+ join(repository.path, path),
+ "x\n".repeat(lineCount - 1) + "last source line\n",
+ );
+ const finding = {
+ ...fakeResult(["high"]).findings.findings[0]!,
+ title: "Large excerpt",
+ occurrenceId: "occ_large",
+ locations: [{ path, startLine: 1, endLine: lineCount }],
+ };
+ const built = await Bun.build({
+ entrypoints: [
+ join(import.meta.dirname, "fixtures", "patch-large-excerpt.ts"),
+ ],
+ target: "node",
+ packages: "external",
+ });
+ expect(built.success).toBe(true);
+ const result = spawnSync(
+ "node",
+ ["--input-type=module", "-", repository.path, JSON.stringify(finding)],
+ {
+ cwd: join(import.meta.dirname, ".."),
+ input: await built.outputs[0]!.text(),
+ encoding: "utf8",
+ },
+ );
+ expect(result.status, result.stderr).toBe(0);
+ });
+
+ test("uses the current finding and viewport for every buffered scroll key", async () => {
+ const items = findings(["high", "medium"]);
+ items[1]!.summary = "Review this long finding. ".repeat(80);
+ const { app } = renderSelection(items);
+ const down = "\u001B[B";
+ const pageDown = "\u001B[6~";
+ const pageUp = "\u001B[5~";
+ const detailRange = () =>
+ app.lastFrame()!.match(/DETAILS\s+(\d+)–\d+\/(\d+)/u)!;
+
+ await press(app, down + "\t" + pageDown.repeat(40));
+ expect(app.lastFrame()).toContain("occ_2");
+ await press(app, pageUp.repeat(40) + down.repeat(3));
+ expect(app.lastFrame()).toContain("DETAILS 4–16/");
+ await press(app, pageDown.repeat(2));
+ expect(app.lastFrame()).toContain("DETAILS 30–42/");
+
+ const wideRows = Number(detailRange()[2]);
+ Object.defineProperty(app.stdout, "columns", { value: 50 });
+ await update(() => app.stdout.emit("resize"));
+ expect(Number(detailRange()[2])).toBeGreaterThan(wideRows);
+ await press(app, pageDown.repeat(40));
+ expect(app.lastFrame()).toContain("occ_2");
+ const lastPageStart = Number(detailRange()[1]);
+ Object.defineProperty(app.stdout, "rows", { value: 38 });
+ await update(() => app.stdout.emit("resize"));
+ expect(app.lastFrame()).toContain(`DETAILS ${lastPageStart - 10}–`);
+ await press(app, pageDown + pageUp);
+ const previousPage = app.lastFrame();
+ expect(previousPage).not.toContain("occ_2");
+ await press(app, pageDown);
+ await press(app, pageUp);
+ expect(app.lastFrame()).toBe(previousPage);
+ });
+
test("allows selecting none and canceling without patching", async () => {
for (const input of ["q", "\r"]) {
const { app, selected } = renderSelection(findings(["high"]));