feat(api): add exponential backoff retry for 5xx errors #1401
+217
−32
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.
Automatically retry API requests up to 3 times with exponential backoff (1s, 2s, 4s) when receiving 5xx server errors. This helps handle transient 502/503 errors during bulk page uploads. Note that although I wasn't able to reproduce the failed upload bug locally, this should still help in case it ever happens.
Ref: #1325
🧰 Changes
This PR adds automatic retry logic with exponential backoff to
readmeAPIv2Fetch()to handle transient 5xx server errors that occur during bulk uploads.Background
Users uploading large numbers of pages (66+) via
rdme docs uploadhave reported intermittent failures with the error: Unexpected token '<', "<!DOCTYPE "... is not valid JSON.This occurs when the ReadMe API returns a 502 Bad Gateway HTML error page instead of JSON during high load. The client-side JSON parser then fails on the HTML content.
Implementation
handleAPIRes)Related
🧬 QA & Testing
Automated Tests
The following scenarios are now tested in
__tests__/lib/fetch.test.ts:Manual Testing