forked from lidge-jun/opencodex
-
Notifications
You must be signed in to change notification settings - Fork 0
[WRONG BRANCH] Bound stalled upstream response bodies #176
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
Draft
luvs01
wants to merge
1
commit into
main
Choose a base branch
from
codex/propose-fix-for-header-only-timeout-issue
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+120
−0
Draft
Changes from all commits
Commits
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
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,71 @@ | ||
| import { idleDeadline } from "./abort"; | ||
|
|
||
| /** | ||
| * Bound response-body silence after fetch has returned its headers. The deadline is armed only | ||
| * while an upstream read is pending, so a downstream client applying backpressure does not count | ||
| * as an upstream stall. Non-empty chunks reset the window; normal completion leaves the upstream | ||
| * controller untouched. | ||
| */ | ||
| export function guardResponseBodyInactivity( | ||
| response: Response, | ||
| upstream: AbortController, | ||
| inactivityMs: number, | ||
| ): Response { | ||
| if (!response.body || inactivityMs <= 0) return response; | ||
|
|
||
| const reader = response.body.getReader(); | ||
| let settled = false; | ||
| let output: ReadableStreamDefaultController<Uint8Array> | undefined; | ||
| const timeoutError = new DOMException( | ||
| `Upstream response body stalled for ${inactivityMs}ms`, | ||
| "TimeoutError", | ||
| ); | ||
| const idle = idleDeadline(inactivityMs, () => { | ||
| if (settled) return; | ||
| settled = true; | ||
| upstream.abort(timeoutError); | ||
| reader.cancel(timeoutError).catch(() => {}); | ||
| try { output?.error(timeoutError); } catch { /* already torn down */ } | ||
| }); | ||
|
|
||
| const body = new ReadableStream<Uint8Array>({ | ||
| async pull(controller) { | ||
| output = controller; | ||
| try { | ||
| idle.reset(); | ||
| for (;;) { | ||
| const { done, value } = await reader.read(); | ||
| if (settled) return; | ||
| if (done) { | ||
| settled = true; | ||
| idle.cancel(); | ||
| controller.close(); | ||
| return; | ||
| } | ||
| if (value.byteLength === 0) continue; | ||
| idle.pause(); | ||
| controller.enqueue(value); | ||
| return; | ||
| } | ||
| } catch (error) { | ||
| if (settled) return; | ||
| settled = true; | ||
| idle.cancel(); | ||
| try { controller.error(error); } catch { /* already torn down */ } | ||
| } | ||
| }, | ||
| cancel(reason) { | ||
| if (settled) return; | ||
| settled = true; | ||
| idle.cancel(); | ||
| upstream.abort(reason); | ||
| reader.cancel(reason).catch(() => {}); | ||
| }, | ||
| }); | ||
|
|
||
| return new Response(body, { | ||
| status: response.status, | ||
| statusText: response.statusText, | ||
| headers: response.headers, | ||
| }); | ||
| } |
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
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
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,42 @@ | ||
| import { describe, expect, test } from "bun:test"; | ||
| import { guardResponseBodyInactivity } from "../src/lib/response-body-inactivity"; | ||
|
|
||
| describe("upstream response body inactivity", () => { | ||
| test("guards both passthrough and adapter response bodies after headers", async () => { | ||
| const core = await Bun.file(new URL("../src/server/responses/core.ts", import.meta.url)).text(); | ||
| expect(core).toContain("guardResponseBodyInactivity(upstreamResponse, upstream, bodyInactivityMs)"); | ||
| expect(core).toContain("guardResponseBodyInactivity(upstreamResponse, upstream, stallTimeoutMs)"); | ||
| }); | ||
|
|
||
| test("aborts a headers-only upstream", async () => { | ||
| const upstream = new AbortController(); | ||
| const response = guardResponseBodyInactivity(new Response( | ||
| new ReadableStream<Uint8Array>({ pull() { return new Promise<void>(() => {}); } }), | ||
| ), upstream, 20); | ||
|
|
||
| await expect(response.text()).rejects.toMatchObject({ name: "TimeoutError" }); | ||
| expect(upstream.signal.aborted).toBe(true); | ||
| expect(upstream.signal.reason).toMatchObject({ name: "TimeoutError" }); | ||
| }); | ||
|
|
||
| test("resets on bytes and ignores downstream backpressure", async () => { | ||
| const encoder = new TextEncoder(); | ||
| const upstream = new AbortController(); | ||
| let controller!: ReadableStreamDefaultController<Uint8Array>; | ||
| const guarded = guardResponseBodyInactivity(new Response(new ReadableStream({ | ||
| start(value) { controller = value; }, | ||
| })), upstream, 30); | ||
| const reader = guarded.body!.getReader(); | ||
|
|
||
| controller.enqueue(encoder.encode("one")); | ||
| controller.enqueue(encoder.encode("two")); | ||
| expect(new TextDecoder().decode((await reader.read()).value)).toBe("one"); | ||
| await Bun.sleep(45); | ||
| expect(upstream.signal.aborted).toBe(false); | ||
|
|
||
| expect(new TextDecoder().decode((await reader.read()).value)).toBe("two"); | ||
| controller.close(); | ||
| expect((await reader.read()).done).toBe(true); | ||
| expect(upstream.signal.aborted).toBe(false); | ||
| }); | ||
| }); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🩺 Stability & Availability | 🟠 Major | ⚡ Quick win
Guard terminal-continuation response bodies.
Line 2965 guards only the initial adapter response.
fetchTerminalGuardContinuationfetches another adapter response at line 3090. It parses that body at lines 3231-3235 without an inactivity guard.If the continuation sends headers and then stalls, the parser remains pending and the upstream turn remains active. Wrap the continuation response before checking its status or parsing its body. Add a regression test for a headers-only continuation response.
Proposed fix
As per path instructions, flag provider/adapter contract drift.
🤖 Prompt for AI Agents
Source: Path instructions