feat(api): add throwIfAborted helper and completePrompt options regression tests

[easonLiangWorldedtech]

Add the missing throwIfAborted fast-fail guard and the shared abort-detection / abort-error helpers to the abort-signal utilities (#1008 merged the merge helpers but not this guard), plus regression tests for the CompletePromptOptions interface added by #901.

• src/api/providers/utils/abort-signal.ts:
  • new throwIfAborted(signal?) — throws Error with name = "AbortError" when the signal is already aborted
  • new shared isRequestAborted(error, signal?) — true when the caller signal fired, a native AbortError / OpenAI SDK APIUserAbortError was raised, or the message is exactly "Request was aborted."
  • new shared createAbortError(providerName) — fresh AbortError with a provider-specific message ending in "aborted", satisfying the Task.ts abort contract
  • new exported OpenAiRequestOptions type
• src/api/providers/utils/__tests__/abort-signal.spec.ts: 3 throwIfAborted tests (undefined / not aborted / aborted) + 7 new tests for the shared helpers
• src/api/providers/__tests__/complete-prompt-options.spec.ts: new regression spec (4 tests) for the interface surface

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

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: fa28e9f3-4885-4251-b9f0-328d13cee5f1

📥 Commits

Reviewing files that changed from the base of the PR and between 74ecee0 and 3b63433.

📒 Files selected for processing (1)

• src/api/providers/utils/__tests__/abort-signal.spec.ts

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📜 Recent review details

⏰ Context from checks skipped due to timeout. (7)

• GitHub Check: platform-unit-test (windows-latest)
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: compile
• GitHub Check: Build test VSIX
• GitHub Check: platform-unit-test (ubuntu-latest)
• GitHub Check: e2e-mock
• GitHub Check: mutation-diff

🧰 Additional context used

📓 Path-based instructions (5)

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

⚙️ CodeRabbit configuration file

Files:

• src/api/providers/utils/__tests__/abort-signal.spec.ts

Require regression coverage at the lowest valid harness with behavior-focused assertions, including relevant negative, error, false/unset, and boundary cases.

⚙️ CodeRabbit configuration file

Files:

• src/api/providers/utils/__tests__/abort-signal.spec.ts

Check strict typing and exhaustive behavior across normal, boundary, error, cancellation, retry, and compatibility paths.

⚙️ CodeRabbit configuration file

Files:

• src/api/providers/utils/__tests__/abort-signal.spec.ts

Verify extension/webview contracts, cancellation and error propagation, VS Code lifecycle correctness, and behavior under retries and partial failure.

⚙️ CodeRabbit configuration file

Files:

• src/api/providers/utils/__tests__/abort-signal.spec.ts

Act as an adversarial second-opinion reviewer.

⚙️ CodeRabbit configuration file

Files:

• src/api/providers/utils/__tests__/abort-signal.spec.ts

🔇 Additional comments (1)

src/api/providers/utils/__tests__/abort-signal.spec.ts (1)

133-133: LGTM!

---

📝 Summary

Summary by CodeRabbit

• New Features

  • Added support for request cancellation signals alongside timeout options.
  • Added consistent detection and provider-specific errors for cancelled requests.

• Bug Fixes

  • Improved handling and reporting of cancellation across supported request and error formats.

• Tests

  • Expanded coverage for cancellation signals, timeout options, combined settings, empty configurations, and cancellation error handling.

Walkthrough

The provider API now includes abort-signal guards, detection, and error creation utilities. Tests cover abort behavior and valid CompletePromptOptions combinations.

Changes

Provider API updates

Layer / File(s)	Summary
Abort-signal utilities src/api/providers/utils/abort-signal.ts	Added throwIfAborted, OpenAiRequestOptions, isRequestAborted, and createAbortError.
Abort-signal behavior coverage src/api/providers/utils/__tests__/abort-signal.spec.ts	Expanded tests for signal states, native and SDK abort errors, exact abort messages, unrelated errors, and normalized error instances.
Completion option coverage src/api/providers/__tests__/complete-prompt-options.spec.ts	Added tests for abortSignal, timeoutMs, both properties, and an empty options object.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 3b634

The abort-signal utility regression coverage is strengthened without introducing an identified runtime or API risk. The change is ready to merge.

🚥 Pre-merge checks | ✅ 7

✅ Passed checks (7 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 3 files.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Regression Evidence	✅ Passed	PASS. The changed abort utilities have focused unit coverage at the utility layer. throwIfAborted covers undefined, active, and already-aborted signals, including AbortError name and message. `isR…
Trust And Persistence Invariants	✅ Passed	PASS. The PR adds only abort classification, normalized error creation, a type, and tests. throwIfAborted only checks an AbortSignal and throws a local error. isRequestAborted only reads error m…
Title check	✅ Passed	The title is concise, specific, and accurately describes the abort guard and CompletePromptOptions regression tests. It does not mention every shared helper, but it remains clearly related to the main…
Description check	✅ Passed	The description explains the implementation, issue context, affected files, and test coverage. It does not follow the full template because it omits the checklist and dedicated template sections, but …

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[easonLiangWorldedtech]

Series follow-up flag: adopt RequestConfigBuilder for abort/timeout option construction

This PR currently builds its abort/timeout request options directly with mergeAbortSignalAndTimeout(...) from src/api/providers/utils/abort-signal.ts. That is behaviorally identical to the RequestConfigBuilder path (src/api/providers/config-builder/request-config-builder.ts, introduced in #1008) - the builder wraps the same utility. The series plan is to make the builder the canonical call site for SDK request-option construction (typed TOptions variants per SDK), so this PR is flagged for that update.

Status: series foundation - nothing to migrate here. This PR ships the abort-signal utilities (including throwIfAborted and the timeout guard) that the builder delegates to; provider-side adoption is tracked on the individual provider PRs.

[easonLiangWorldedtech]

Round 1 — final status: all checks green, changed-line coverage verified

Part of the abort-signal series addressing #404 (builds on #674, #901, #1008). Foundation PR — canonical abort-signal utilities + CompletePromptOptions.

Final verified 2026-08-20: all CI checks green on this head (0 pending / 0 failed), CodeRabbit review clean, and zero new bot findings after this commit.

• Final head: e61feb13e (rebased onto main 252c69b52)
• Work in this round: new src/api/providers/utils/abort-signal.ts — mergeAbortSignalAndTimeout(externalSignal?, timeoutMs?), mergeAbortSignals(primary, secondary?), and the throwIfAborted helper (the series-wide API shape: no cleanup()/finally contract; callers own listener removal). All 16 utility tests green.
• Config builder: the statics added to RequestConfigBuilder in feat(api): abort signal support for openai-codex (completePrompt + createMessage) #1290/feat(api): abort signal support for openai-native and openai-compatible (completePrompt + createMessage) #1291 delegate to the utilities introduced here, so the canonical timeout-merge semantics have a single source.
• Changed-line coverage: 5/5 executable changed lines covered (100%). Measured with local vitest --coverage (v8 + lcov — same pipeline as the repo's codecov/patch check) and cross-referenced line-by-line against git diff 252c69b52..HEAD.

[github-actions]

Review status

Thanks for contributing. This comment tracks the review sequence and the next action.

Current step: Awaiting fresh human maintainer or CODEOWNER approval.

Automated review is complete for the latest commit but does not replace human approval.

Review-state labels are managed by this workflow; do not edit them manually.

[easonLiangWorldedtech]

@coderabbitai approve

[coderabbitai]

✅ Action performed

Comments resolved. Approval is disabled; enable reviews.request_changes_workflow to allow explicit top-level @coderabbitai resolve or @coderabbitai approve commands.

[coderabbitai]

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

bypassed review - will update ci

[edelauna]

Thanks