feat(api): abort signal support for unbound, vercel-ai-gateway, zoo-gateway by easonLiangWorldedtech · Pull Request #1653 · Zoo-Code-Org/Zoo-Code

easonLiangWorldedtech · 2026-09-16T03:05:54Z

Wires the external abort signal and per-request timeout into the completePrompt (non-streaming) and createMessage (streaming) paths of the Unbound, Vercel AI Gateway, and Zoo Gateway providers. Stacks on the shared-util and opencode-go units of this split (resolveModelWithAbort in utils/abort-signal.ts).

Each provider:

createMessage: bridges metadata?.abortSignal (Bedrock pattern: pre-aborted guard, { once: true } listener, detached on completion so a task-scoped signal does not accumulate listeners) into a per-request AbortController; model resolution runs inside the shared resolveModelWithAbort cancellation scope (pre-aborted fast-fail before any catalog/SDK work, mid-resolution race). Aborted requests (pre-aborted, mid-resolution, mid-stream) normalize to the provider AbortError; non-abort failures propagate or wrap unchanged.
completePrompt: forwards abortSignal/ timeoutMs to the OpenAI SDK (timeoutMs <= 0 omits the SDK timeout option, since the SDK treats timeout: 0 as an immediate abort); aborted completions and APIConnectionTimeoutError normalize to the provider AbortError (series standard).

Zoo Gateway places the entry fast-fail before ensureAuthenticated() so a pre-aborted task surfaces the AbortError instead of an auth failure.

Tests:

Ported the reference abort/timeout completePrompt pass-through tests (signal, timeoutMs incl. 0, and no-options backward compatibility) for all three providers, plus normalization/identity tests for aborted and timed-out completions.
createMessage bridging tests per provider: pre-aborted signal -> rejects with the standardized AbortError before any request work (catalog and SDK both uncalled; unbound additionally asserts the SDK-level rejection identity since its error wrapper preserves main's behavior); abort mid-resolution -> settles on the standardized AbortError before the lookup is released, no late request; detach tests use the reference-identity pattern (the resolution race registers its own "abort" listener, so the bridge is the last registration).

Series and unit

Unit 3/3 of the #1295 split (content source: 62f596c5d); stacks on the shared-util and opencode-go units. Three sibling OpenAI-SDK gateway providers with an identical abort-wiring shape are kept as one unit to avoid tripling the review surface for mechanically identical changes (a+d soft-cap rationale per the split budget; the mutation gate is measured on the unit delta and is green).

Part of the abort-signal series (round 1). Builds on #674, #901, #1008. Addresses #404.

Review response (maintainer review of #1295)

The model-resolution guard, the rejectOnAbort race, and the abort normalization now live once in the shared util (resolveModelWithAbort, unit 1/3) instead of being inlined per provider; all three providers call it and each spec exercises it end-to-end (pre-aborted -> catalog and SDK both uncalled; mid-resolution -> standardized AbortError before the lookup is released, no late request).
The createMessage catches use the wider isRequestAborted condition (aborted signal, DOM AbortError, SDK APIUserAbortError, exact "Request was aborted." message; name/message checks require a real Error instance).
The detach tests assert reference identity on the last "abort" registration, because the resolution race registers its own listener on the same external signal.

Evidence

vitest: 139/139 passing across the three gateway suites (134 changed executable lines, all covered)
Local Stryker mutation gate (unit delta vs own base): 185 valid mutants (≤400), 176 killed, 9 directive-ignored (the per-request bridge's unreachable pre-aborted branch per provider, with invariant-citing proofs), 0 Survived / 0 NoCoverage / 0 Timeout

Updated this round (2026-10-13)

Merged current upstream main into the branch to clear the dirty state. Conflicts: vercel-ai-gateway.ts/zoo-gateway.ts (imports only — main's model-cache fetcher imports plus this branch's abort-signal utility imports, both kept) and unbound.spec.ts (main's new "model catalog" describe block coexists with this branch's appended abort/cancellation suites — both kept).

Verification at this head: 535/535 green across the touched provider specs (unbound, vercel-ai-gateway, zoo-gateway, opencode-go); tsc --noEmit → 0 errors; per-file ESLint (--max-warnings=0) clean; prettier --check clean on touched files.

…utils Extend src/api/providers/utils/abort-signal.ts with the abort-signal series helpers used by the gateway providers: - isRequestAborted(error, signal): wider abort detection - an aborted signal, a DOM AbortError, the OpenAI/Anthropic SDK APIUserAbortError (name check), or the exact SDK abort message "Request was aborted." - trusting name/message only on real Error instances so a plain object that merely looks like an abort propagates unchanged - createAbortError(providerName): fresh error satisfying the Task.ts abort contract (name "AbortError", message ending in "aborted") - rejectOnAbort(pending, signal, providerName): settle a signal-less async phase (model discovery) on the provider AbortError when the signal fires first; the abort listener detaches when pending settles - resolveModelWithAbort(fetchModel, signal, providerName): run model resolution inside a cancellation scope - entry fast-fail for a pre-aborted signal, the rejectOnAbort race while the lookup is pending, and normalization of abort-flavored lookup failures; any other resolution failure propagates unchanged Includes direct unit tests for the resolveModelWithAbort cancellation scope (pre-aborted fast-fail, no-signal pass-through, mid-resolution race, abort normalization, non-abort propagation), the isRequestAborted instanceof tightening tests, and the settle-guard test utility. Unit 1/3 of the Zoo-Code-Org#1295 split (content source: 62f596c). Part of the abort-signal series (round 1). Builds on Zoo-Code-Org#674, Zoo-Code-Org#901, Zoo-Code-Org#1008. Addresses Zoo-Code-Org#404.

- createMessage: bridge metadata.abortSignal to a per-request AbortController (Bedrock pattern: pre-aborted guard, once-listener, detached on completion so a task-scoped signal does not accumulate listeners); model resolution runs inside the shared resolveModelWithAbort cancellation scope (pre-aborted fast-fail, mid-resolution race) - aborted/timeout requests normalize to the provider AbortError on all three wire formats (anthropic /v1/messages, responses /v1/responses, openai chat completions), both pre-stream and mid-stream; non-abort failures keep the wrapped "Opencode Go completion error:" identity - completePrompt: forwards abortSignal/timeoutMs to all three SDK paths (timeoutMs <= 0 omits the SDK timeout option, since the SDK treats timeout: 0 as an immediate abort); aborted completions and APIConnectionTimeoutError/APITimeoutError normalize to the provider AbortError (series standard) The two inner pre-stream guard mutants (the abort-normalization condition and its provider-name literal) are documented as provably equivalent with mutator-specific Stryker directives: createMessage's outer catch applies the identical isRequestAborted check to the same controller signal and re-standardizes, so the inner layer's only unique behavior is the non-abort completion-error wrap (stays kill-tested). Unit 2/3 of the Zoo-Code-Org#1295 split (content source: 62f596c); stacks on the shared-util unit. Part of the abort-signal series (round 1). Builds on Zoo-Code-Org#674, Zoo-Code-Org#901, Zoo-Code-Org#1008. Addresses Zoo-Code-Org#404.

…ateway Each provider's createMessage bridges metadata.abortSignal to a per-request AbortController (Bedrock pattern: pre-aborted guard, { once: true } listener, detached on completion so a task-scoped signal does not accumulate listeners) and runs model resolution inside the shared resolveModelWithAbort cancellation scope; aborted requests (pre-aborted, mid-resolution, mid-stream) normalize to the provider AbortError while non-abort failures propagate or wrap unchanged. completePrompt forwards abortSignal/timeoutMs to the OpenAI SDK (timeoutMs <= 0 omits the SDK timeout option); aborted completions and APIConnectionTimeoutError normalize to the provider AbortError (series standard). Zoo Gateway places the entry fast-fail before ensureAuthenticated() so a pre-aborted task surfaces the AbortError instead of an auth failure (pinned by an unauthenticated pre-abort test). Unit 3/3 of the Zoo-Code-Org#1295 split (content source: 62f596c); stacks on the shared-util and opencode-go units. Three sibling OpenAI-SDK gateway providers with an identical abort-wiring shape are kept as one unit to avoid tripling the review surface for mechanically identical changes (a+d soft-cap rationale per the split budget; the mutation gate is measured on the unit delta and is green). Part of the abort-signal series (round 1). Builds on Zoo-Code-Org#674, Zoo-Code-Org#901, Zoo-Code-Org#1008. Addresses Zoo-Code-Org#404.

coderabbitai · 2026-09-16T03:06:00Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: Zoo-Code-Org/Zoo-Code/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: c6a27e8c-4030-4ed5-9a46-46e67c765ea5

📥 Commits

Reviewing files that changed from the base of the PR and between 1b9814a and cd8edc3.

📒 Files selected for processing (6)

src/api/providers/__tests__/opencode-go.spec.ts
src/api/providers/__tests__/unbound.spec.ts
src/api/providers/opencode-go.ts
src/api/providers/unbound.ts
src/api/providers/vercel-ai-gateway.ts
src/api/providers/zoo-gateway.ts

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.

📜 Recent review details

🧰 Additional context used

📓 Path-based instructions (5)

Treat model, provider, MCP, path, command, and tool data as untrusted.