Skip to content

fix(thread/github): degrade a non-JSON sandbox-git response instead of raw SyntaxError #6358

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.

Sign up for GitHub

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

Closed
pedrofrxncx wants to merge 1 commit into from
Closed

fix(thread/github): degrade a non-JSON sandbox-git response instead of raw SyntaxError #6358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions apps/web/src/components/thread/github/sandbox-git-api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ import {
isDecoOnlyPaths,
needsSmartReviewJudgment,
normalizePublishPolicy,
parseJson,
resolvePathGate,
reviewDiffSignature,
SandboxGitError,
sandboxGitStatusQueryKey,
sandboxGitStatusQueryOptions,
shouldUseBaseDiff,
Expand Down Expand Up @@ -655,3 +657,31 @@ describe("hasNothingToReview", () => {
expect(hasNothingToReview({ ...cleanStatus, unpushed: 1 })).toBe(false);
});
});

describe("parseJson", () => {
test("returns the parsed body on a 2xx JSON response", async () => {
const res = new Response(JSON.stringify({ ok: true }), { status: 200 });
expect(await parseJson<{ ok: boolean }>(res)).toEqual({ ok: true });
});

test("throws a SandboxGitError with the response's error field on non-2xx JSON", async () => {
const res = new Response(JSON.stringify({ error: "no runner" }), {
status: 503,
});
await expect(parseJson(res)).rejects.toMatchObject(
new SandboxGitError("no runner", 503),
);
});

test("degrades a non-JSON error page instead of throwing a raw SyntaxError", async () => {
const page = () =>
new Response("<html>502 Bad Gateway</html>", { status: 502 });
await expect(parseJson(page())).rejects.toBeInstanceOf(SandboxGitError);
await expect(parseJson(page())).rejects.toMatchObject({ status: 502 });
});

test("degrades a non-JSON 2xx body instead of throwing a raw SyntaxError", async () => {
const res = new Response("not json", { status: 200 });
await expect(parseJson(res)).rejects.toBeInstanceOf(SandboxGitError);
});
});
23 changes: 18 additions & 5 deletions apps/web/src/components/thread/github/sandbox-git-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ function buildSandboxGitUrl(

/** Error carrying the HTTP status so callers can back off on unreachable
* sandboxes (503 no runner, 410 handle gone) instead of polling forever. */
class SandboxGitError extends Error {
export class SandboxGitError extends Error {
constructor(
message: string,
readonly status: number,
Expand Down Expand Up @@ -103,11 +103,24 @@ function retryGitRequest(failureCount: number, error: unknown): boolean {
return failureCount < 1;
}

async function parseJson<T>(res: Response): Promise<T> {
const body = (await res.json()) as T & { error?: string };
if (!res.ok) {
/**
* A gateway/proxy hiccup between the browser and the sandbox daemon (a 502/504
* error page, an empty body on a dropped connection) is not guaranteed to be
* JSON even on a non-2xx response. `res.json()` throwing a raw `SyntaxError`
* on that would surface as an opaque "Unexpected token" instead of a
* `SandboxGitError` callers can branch on (e.g. `isSandboxUnreachable`).
*/
export async function parseJson<T>(res: Response): Promise<T> {
const text = await res.text();
let body: (T & { error?: string }) | undefined;
try {
body = text ? (JSON.parse(text) as T & { error?: string }) : undefined;
} catch {
body = undefined;
}
if (!res.ok || body === undefined) {
throw new SandboxGitError(
typeof body.error === "string"
typeof body?.error === "string"
? body.error
: `Request failed (${res.status})`,
res.status,
Expand Down
Loading