feat(client): propagate AbortSignal reason to APIUserAbortError#1611
Open
christian-bromann wants to merge 1 commit intoopenai:masterfrom
Open
feat(client): propagate AbortSignal reason to APIUserAbortError#1611christian-bromann wants to merge 1 commit intoopenai:masterfrom
christian-bromann wants to merge 1 commit intoopenai:masterfrom
Conversation
- Pass abort signal reason to APIUserAbortError constructor - Update error handling in fetchWithTimeout to include abort reason - Add tests to verify abort reason is properly propagated - Add test to ensure no request is made when signal is pre-aborted This allows consumers to provide and receive custom abort reasons when cancelling requests, improving debugging and error handling capabilities.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes being requested
This PR enhances the error handling for aborted requests by propagating the abort reason from the AbortSignal to the APIUserAbortError.
What changed:
APIUserAbortErrorinstantiation to include the abort signal's reason as the error messageclient.tswhereAPIUserAbortErroris thrown to pass the abort reasonWhy this is useful:
controller.abort('user cancelled')) and receive them in error handlersAdditional context & links
This change addresses the common use case where applications need to distinguish between different types of request cancellations (user-initiated vs timeout vs navigation away, etc.). By propagating the abort reason, error handlers can make more informed decisions about how to respond to aborted requests.
Example usage: