fix(api): abort rate-limit retry backoff - #2004
Open
Osraka wants to merge 1 commit into
Open
Conversation
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.
Motivation
Closes #2003
RequestOptions.signalreaches each individual fetch attempt, but it does not reach the delay between rate-limit retries. If a caller aborts after a 429/599 response, the API promise remains pending for the full backoff (up to the five-minuteRetry-Aftercap), then starts another attempt before_fetchnotices the already-aborted signal.This makes cancellation timing-dependent: it works before or during a fetch, but not while that same request is waiting to retry.
Solution
Allow
RateLimitOptionsto receive an optional signal and use it only to cancel a pending retry delay.OpenSeaAPI.getandOpenSeaAPI.requestnow pass their existing request signal into the retry layer. Aborting clears the pending timer, removes the event listener, rejects with the existingRequest abortedmessage, and does not start another attempt.The change does not alter retry counts, 429/599 detection,
Retry-Afterparsing, timeout semantics, or non-aborted retry behavior.Regression coverage verifies:
executeWithRateLimitrejects promptly when aborted during backoffgetnorrequeststarts a second attempt after cancellationmainwith the promise stillpendingValidation:
npm run buildnpm run check-typesnpm run lint(passes with the existing unrelatedFunctionwarning)npm test(47 files, 1010 tests)