Repository navigation
feat(hub): connect administrator security audit #216
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
86e78a4
feat(hub): connect administrator security audit
9889ddd
fix(hub): use canonical audit story route
2ea2ebe
test(hub): cover ended session audit context
0e53d4c
fix(hub): address audit frontend review
6532f37
fix(hub): clarify audit presentation
475c5d0
fix(hub): stabilize audit table columns
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
23 changes: 23 additions & 0 deletions
23
hub/client/application/hub/is-administrator-route/index.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import { describe, expect, it } from "vitest" | ||
|
|
||
| import { isAdministratorRoute } from "." | ||
|
|
||
| describe("isAdministratorRoute()", () => { | ||
| it.each([ | ||
| "/settings/administrators", | ||
| "/settings/administrators/11111111-1111-4111-8111-111111111111", | ||
| "/settings/admins", | ||
| "/settings/admins/11111111-1111-4111-8111-111111111111", | ||
| "/settings/audit", | ||
| "/settings/audit/", | ||
| "/Settings/Audit", | ||
| ])("classifies %s as an administrator route", (pathname) => { | ||
| expect(isAdministratorRoute(new Request(`https://hub.example.test${pathname}`))).toBe(true) | ||
| }) | ||
|
|
||
| it("does not classify ordinary settings routes as administrator routes", () => { | ||
| expect(isAdministratorRoute(new Request("https://hub.example.test/settings/sharing"))).toBe( | ||
| false, | ||
| ) | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,10 @@ | ||
| export function isAdministratorRoute(request: Request) { | ||
| const { pathname } = new URL(request.url) | ||
| const pathname = new URL(request.url).pathname.toLowerCase().replace(/\/+$/, "") | ||
| return ( | ||
| pathname === "/settings/administrators" || | ||
| pathname.startsWith("/settings/administrators/") || | ||
| pathname === "/settings/admins" || | ||
| pathname.startsWith("/settings/admins/") | ||
| pathname.startsWith("/settings/admins/") || | ||
| pathname === "/settings/audit" | ||
| ) | ||
| } | ||
46 changes: 46 additions & 0 deletions
46
hub/client/application/hub/requests/get-security-audits/index.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| import { http, HttpResponse } from "msw" | ||
| import { setupServer } from "msw/node" | ||
| import { describe, expect, it, onTestFinished, vi } from "vitest" | ||
|
|
||
| import { getSecurityAudits } from "." | ||
|
|
||
| describe("getSecurityAudits()", () => { | ||
| it("requests exactly 50 records and preserves an opaque cursor as one encoded parameter", async () => { | ||
| vi.stubEnv("MODE", "development") | ||
| const origin = "https://hub.example.test" | ||
| const cursor = "opaque+/cursor==&unchanged" | ||
| let receivedUrl: URL | undefined | ||
| const server = setupServer( | ||
| http.get(`${origin}/api/security-audits`, ({ request }) => { | ||
| receivedUrl = new URL(request.url) | ||
| return HttpResponse.json({ records: [], nextCursor: null }) | ||
| }), | ||
| ) | ||
| server.listen({ onUnhandledRequest: "error" }) | ||
| onTestFinished(() => server.close()) | ||
|
|
||
| await getSecurityAudits(new Request(`${origin}/settings/audit?scope=hub`), cursor) | ||
|
|
||
| expect(receivedUrl?.pathname).toBe("/api/security-audits") | ||
| expect(receivedUrl?.search).toBe(`?limit=50&before=${encodeURIComponent(cursor)}`) | ||
| expect(receivedUrl?.searchParams.get("before")).toBe(cursor) | ||
| }) | ||
|
|
||
| it("omits before on the first page", async () => { | ||
| vi.stubEnv("MODE", "development") | ||
| const origin = "https://hub.example.test" | ||
| let receivedUrl: URL | undefined | ||
| const server = setupServer( | ||
| http.get(`${origin}/api/security-audits`, ({ request }) => { | ||
| receivedUrl = new URL(request.url) | ||
| return HttpResponse.json({ records: [], nextCursor: null }) | ||
| }), | ||
| ) | ||
| server.listen({ onUnhandledRequest: "error" }) | ||
| onTestFinished(() => server.close()) | ||
|
|
||
| await getSecurityAudits(new Request(`${origin}/settings/audit?scope=hub`)) | ||
|
|
||
| expect(receivedUrl?.search).toBe("?limit=50") | ||
| }) | ||
| }) |
10 changes: 10 additions & 0 deletions
10
hub/client/application/hub/requests/get-security-audits/index.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| import { securityAuditResponseSchema } from "@application/hub/security-audit-contracts" | ||
|
|
||
| import { requestJson } from "../request-json" | ||
|
|
||
| export function getSecurityAudits(request: Request, before?: string) { | ||
| const url = new URL("/api/security-audits", request.url) | ||
| url.searchParams.set("limit", "50") | ||
| if (before) url.searchParams.set("before", before) | ||
| return requestJson(url, securityAuditResponseSchema, { signal: request.signal }) | ||
| } |
258 changes: 258 additions & 0 deletions
258
hub/client/application/hub/routes/security-audit-flow.test.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,258 @@ | ||
| import type { RouteConfigEntry } from "@react-router/dev/routes" | ||
| import { act, render, screen } from "@testing-library/react" | ||
| import { http, HttpResponse } from "msw" | ||
| import { setupServer } from "msw/node" | ||
| import type { ComponentType } from "react" | ||
| import { | ||
| createBrowserRouter, | ||
| RouterProvider, | ||
| useLoaderData, | ||
| type ActionFunction, | ||
| type LoaderFunction, | ||
| type RouteObject, | ||
| } from "react-router" | ||
| import { describe, expect, it, onTestFinished, vi } from "vitest" | ||
|
|
||
| type RouteModule = { | ||
| default?: ComponentType<{ loaderData: unknown }> | ||
| clientLoader?: LoaderFunction | ||
| clientAction?: ActionFunction | ||
| ErrorBoundary?: ComponentType | ||
| HydrateFallback?: ComponentType | ||
| } | ||
|
|
||
| const routeModules = import.meta.glob<RouteModule>([ | ||
| "../root.tsx", | ||
| "./**/index.tsx", | ||
| "!./fixtures/**", | ||
| ]) | ||
|
|
||
| const membershipId = "11111111-1111-4111-8111-111111111111" | ||
|
|
||
| function applicationRoute(entry: RouteConfigEntry): RouteObject { | ||
| const modulePath = | ||
| entry.file === "root.tsx" ? "../root.tsx" : `./${entry.file.replace(/^routes\//, "")}` | ||
| const loadModule = routeModules[modulePath] | ||
| if (!loadModule) throw new Error(`Missing application route module: ${entry.file}`) | ||
| const common = { | ||
| id: entry.id ?? entry.file.replace(/\.tsx$/, ""), | ||
| path: entry.path, | ||
| lazy: async () => { | ||
| const module = await loadModule() | ||
| const Page = module.default | ||
| return { | ||
| loader: module.clientLoader, | ||
| action: module.clientAction, | ||
| ErrorBoundary: module.ErrorBoundary, | ||
| HydrateFallback: module.HydrateFallback, | ||
| Component: Page ? () => <Page loaderData={useLoaderData()} /> : undefined, | ||
| } | ||
| }, | ||
| } | ||
| return entry.index | ||
| ? { ...common, index: true } | ||
| : { ...common, children: entry.children?.map(applicationRoute) } | ||
| } | ||
|
|
||
| function session(role = "ADMINISTRATOR") { | ||
| return { | ||
| authenticated: true, | ||
| membershipId, | ||
| userId: "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa", | ||
| provider: "github", | ||
| login: "octocat", | ||
| name: "The Octocat", | ||
| role, | ||
| } | ||
| } | ||
|
|
||
| async function renderApplication(path: string, handlers: Parameters<typeof setupServer>) { | ||
| vi.stubEnv("MODE", "development") | ||
| vi.stubEnv("DEV", true) | ||
| const requests: string[] = [] | ||
| const server = setupServer(...handlers) | ||
| server.events.on("request:start", ({ request }) => { | ||
| const url = new URL(request.url) | ||
| requests.push(`${request.method} ${url.pathname}${url.search}`) | ||
| }) | ||
| server.listen({ onUnhandledRequest: "error" }) | ||
| onTestFinished(() => server.close()) | ||
| const [{ default: routes }, { HubThemeProvider }] = await Promise.all([ | ||
| import("../routes"), | ||
| import("@hooks/use-hub-theme"), | ||
| ]) | ||
| window.history.replaceState(null, "", path) | ||
| const router = createBrowserRouter( | ||
| [applicationRoute({ id: "root", file: "root.tsx", children: routes })], | ||
| { window }, | ||
| ) | ||
| onTestFinished(() => router.dispose()) | ||
| await act(async () => { | ||
| await vi.waitFor(() => expect(router.state.initialized).toBe(true), { timeout: 10_000 }) | ||
| }) | ||
| render( | ||
| <HubThemeProvider> | ||
| <RouterProvider router={router} /> | ||
| </HubThemeProvider>, | ||
| ) | ||
| return { requests, router } | ||
| } | ||
|
|
||
| function authenticatedSession() { | ||
| return http.get(`${window.location.origin}/api/auth/session`, () => HttpResponse.json(session())) | ||
| } | ||
|
|
||
| function expectOnlyRealAuditRequests(requests: string[]) { | ||
| expect( | ||
| requests.every( | ||
| (request) => | ||
| request === "GET /api/auth/session" || request.startsWith("GET /api/security-audits?"), | ||
| ), | ||
| ).toBe(true) | ||
| } | ||
|
|
||
| describe("real security audit frontend integration", () => { | ||
| it("loads only the canonical Hub audit APIs and preserves opaque pagination", async () => { | ||
| const before = "current+/cursor==" | ||
| const nextCursor = "next+/cursor==" | ||
| const { requests } = await renderApplication( | ||
| `/settings/audit?scope=hub&before=${encodeURIComponent(before)}`, | ||
| [ | ||
| authenticatedSession(), | ||
| http.get(`${window.location.origin}/api/security-audits`, ({ request }) => { | ||
| expect(new URL(request.url).searchParams.get("before")).toBe(before) | ||
| return HttpResponse.json({ | ||
| records: [ | ||
| { | ||
| id: "22222222-2222-4222-8222-222222222222", | ||
| occurredAt: "2026-11-10T12:00:00.000Z", | ||
| action: "unknown.future.action", | ||
| outcome: null, | ||
| actor: null, | ||
| context: {}, | ||
| }, | ||
| ], | ||
| nextCursor, | ||
| }) | ||
| }), | ||
| ], | ||
| ) | ||
|
|
||
| expect(await screen.findByText("unknown.future.action")).toBeVisible() | ||
| expect(requests.filter((request) => request.includes("/api/security-audits"))).toEqual([ | ||
| `GET /api/security-audits?limit=50&before=${encodeURIComponent(before)}`, | ||
| ]) | ||
| expectOnlyRealAuditRequests(requests) | ||
| expect(screen.getByRole("link", { name: "Older actions" })).toHaveAttribute( | ||
| "href", | ||
| `/settings/audit?scope=hub&before=${encodeURIComponent(nextCursor)}`, | ||
| ) | ||
| }) | ||
|
|
||
| it("keeps the real Hub audit read-only without requesting product settings APIs", async () => { | ||
| const { requests, router } = await renderApplication("/settings/audit?scope=hub", [ | ||
| authenticatedSession(), | ||
| http.get(`${window.location.origin}/api/security-audits`, () => | ||
| HttpResponse.json({ records: [], nextCursor: null }), | ||
| ), | ||
| ]) | ||
| await screen.findByText("No Hub security actions are available.") | ||
|
|
||
| await act(async () => { | ||
| await router.navigate("/settings/audit?scope=hub", { | ||
| formMethod: "post", | ||
| formData: new FormData(), | ||
| }) | ||
| }) | ||
|
|
||
| expect(await screen.findByText("405")).toBeVisible() | ||
| expect(screen.getByText("The Hub security audit is read-only.")).toBeVisible() | ||
| expectOnlyRealAuditRequests(requests) | ||
| }) | ||
|
|
||
| it.each([ | ||
| ["an unsupported query field", "/settings/audit?scope=hub&page=2", null], | ||
| [ | ||
| "repository scope", | ||
| "/settings/audit?scope=repository", | ||
| "Only the Hub-wide security audit is available.", | ||
| ], | ||
| ["an empty cursor", "/settings/audit?scope=hub&before=", null], | ||
| ["repeated cursors", "/settings/audit?scope=hub&before=one&before=two", null], | ||
| ["an oversized cursor", `/settings/audit?scope=hub&before=${"a".repeat(501)}`, null], | ||
| ])("shows a 400 error for %s before loading audit data", async (_label, path, message) => { | ||
| const { requests } = await renderApplication(path, [authenticatedSession()]) | ||
|
|
||
| expect(await screen.findByRole("heading", { name: "Invalid address" })).toBeVisible() | ||
| expect(screen.getByText("400")).toBeVisible() | ||
| if (message) expect(screen.getByText(message)).toBeVisible() | ||
| expect(requests.some((request) => request.includes("/api/security-audits"))).toBe(false) | ||
| }) | ||
|
|
||
| it("requires a current administrator session before loading audit data", async () => { | ||
| const { requests } = await renderApplication("/settings/audit?scope=hub", [ | ||
| http.get(`${window.location.origin}/api/auth/session`, () => | ||
| HttpResponse.json(session("MEMBER")), | ||
| ), | ||
| ]) | ||
|
|
||
| expect(await screen.findByRole("heading", { name: "Access denied" })).toBeVisible() | ||
| expect(screen.getByText("Administrator access is required.")).toBeVisible() | ||
| expect(requests.some((request) => request.includes("/api/security-audits"))).toBe(false) | ||
| }) | ||
|
|
||
| it.each([ | ||
| { | ||
| label: "an API failure", | ||
| response: () => HttpResponse.json({ error: "Security audit unavailable." }, { status: 503 }), | ||
| message: "Security audit unavailable.", | ||
| }, | ||
| { | ||
| label: "malformed JSON", | ||
| response: () => | ||
| new HttpResponse("{", { | ||
| status: 200, | ||
| headers: { "Content-Type": "application/json" }, | ||
| }), | ||
| message: "The API returned invalid JSON.", | ||
| }, | ||
| { | ||
| label: "a malformed response", | ||
| response: () => HttpResponse.json({ records: "not-an-array", nextCursor: null }), | ||
| message: "The API returned data in an unexpected shape.", | ||
| }, | ||
| { | ||
| label: "a network failure", | ||
| response: () => HttpResponse.error(), | ||
| message: "Unable to reach the Hub API.", | ||
| }, | ||
| ])("keeps $label visible without mock fallback", async ({ response, message }) => { | ||
| const { requests } = await renderApplication("/settings/audit?scope=hub", [ | ||
| authenticatedSession(), | ||
| http.get(`${window.location.origin}/api/security-audits`, response), | ||
| ]) | ||
|
|
||
| expect(await screen.findByText(message)).toBeVisible() | ||
| expectOnlyRealAuditRequests(requests) | ||
| }) | ||
|
|
||
| it("rereads the session after an audit 403 and reports lost administrator access", async () => { | ||
| let auditDenied = false | ||
| let refreshedSessionRequests = 0 | ||
| await renderApplication("/settings/audit?scope=hub", [ | ||
| http.get(`${window.location.origin}/api/auth/session`, () => { | ||
| if (!auditDenied) return HttpResponse.json(session()) | ||
| refreshedSessionRequests += 1 | ||
| return HttpResponse.json(session("MEMBER")) | ||
| }), | ||
| http.get(`${window.location.origin}/api/security-audits`, () => { | ||
| auditDenied = true | ||
| return HttpResponse.json({ error: "forbidden" }, { status: 403 }) | ||
| }), | ||
| ]) | ||
|
|
||
| expect(await screen.findByRole("heading", { name: "Access denied" })).toBeVisible() | ||
| expect(screen.getByText("Your account no longer has Hub administrator access.")).toBeVisible() | ||
| expect(refreshedSessionRequests).toBe(1) | ||
| }) | ||
| }) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.