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: paginate GitHub organizations in bulk-scan discovery (#392)

mldangelo-oaidf998f6970a4
diff --git a/sdk/typescript/src/bulk-scan-discovery.ts b/sdk/typescript/src/bulk-scan-discovery.ts
index cfad210a7..22d8ac2f7 100644
--- a/sdk/typescript/src/bulk-scan-discovery.ts
+++ b/sdk/typescript/src/bulk-scan-discovery.ts
@@ -197,12 +197,24 @@ async function selectGitHubOwner(
prompt: BulkScanPrompt,
signal?: AbortSignal,
): Promise<string> {
- const [orgs, user] = await Promise.all([
+ const [firstPage, user] = await Promise.all([
github.request("GET /user/orgs", { per_page: 100, request: { signal } }),
github.request("GET /user", { request: { signal } }),
]);
+ const organizations = [...firstPage.data];
+ let response = firstPage;
+ let page = 1;
+ while (response.headers.link?.includes('rel="next"')) {
+ signal?.throwIfAborted();
+ response = await github.request("GET /user/orgs", {
+ per_page: 100,
+ page: ++page,
+ request: { signal },
+ });
+ organizations.push(...response.data);
+ }
const personal = user.data.login;
- const owners = [personal, ...orgs.data.map(({ login }) => login)].sort();
+ const owners = [personal, ...organizations.map(({ login }) => login)].sort();
if (owners.length > 1) {
return await prompt.select(
"Which account or organization should we scan?",
diff --git a/sdk/typescript/tests-ts/bulk-scan-discovery.test.ts b/sdk/typescript/tests-ts/bulk-scan-discovery.test.ts
index a8337649d..718f9be93 100644
--- a/sdk/typescript/tests-ts/bulk-scan-discovery.test.ts
+++ b/sdk/typescript/tests-ts/bulk-scan-discovery.test.ts
@@ -159,10 +159,21 @@ function discoveryDependencies(
});
if (path === "/user/orgs") {
+ const organizations = options.organizations ?? [];
+ const page = Number(url.searchParams.get("page") ?? "1");
+ const perPage = Number(
+ url.searchParams.get("per_page") ?? "30",
+ );
+ const offset = (page - 1) * perPage;
+ const next = new URL(url);
+ next.searchParams.set("page", String(page + 1));
return Response.json(
- (options.organizations ?? []).map((login) => ({
- login,
- })),
+ organizations
+ .slice(offset, offset + perPage)
+ .map((login) => ({ login })),
+ offset + perPage < organizations.length
+ ? { headers: { link: `<${next.href}>; rel="next"` } }
+ : undefined,
);
}
if (path === "/user") {
@@ -349,6 +360,30 @@ describe("bulk scan repository discovery", () => {
).toBe("personal-account");
});
+ test("includes organizations beyond the first GitHub results page", async () => {
+ const root = await temporaryDirectory();
+ const organizations = Array.from(
+ { length: 101 },
+ (_value, index) => `organization-${String(index).padStart(3, "0")}`,
+ );
+ const { dependencies, prompt, requests } = discoveryDependencies(root, {
+ organizations,
+ });
+ prompt.confirms = [true];
+ prompt.choices = ["organization-100"];
+
+ await runBulkScanWizard(dependencies);
+
+ expect(prompt.searchOptions[0]).toContain("organization-100");
+ expect(prompt.searchOptions[0]).toHaveLength(102);
+ expect(requests.filter(({ path }) => path === "/user/orgs")).toHaveLength(
+ 2,
+ );
+ expect(
+ requests.find(({ path }) => path === "/graphql")?.variables?.owner,
+ ).toBe("organization-100");
+ });
+
test("does not write an inventory when canceled or no repositories match", async () => {
for (const options of [
{ confirms: [false] },