Clarify that automatic network retries occur for most api errors #567
Conversation
README.md
Outdated
| @@ -147,7 +147,7 @@ if (process.env.http_proxy) { | |||
|
|
|||
| ### Network retries | |||
|
|
|||
| Automatic network retries can be enabled with `setMaxNetworkRetries`. This will retry requests `n` times with exponential backoff if they fail due to connection or conflict errors. [Idempotency keys](https://stripe.com/docs/api/idempotent_requests) are added where appropriate to prevent duplication. | |||
| Automatic network retries can be enabled with `setMaxNetworkRetries`. This will retry requests `n` times with exponential backoff if they fail due to connection errors or most api errors. [Idempotency keys](https://stripe.com/docs/api/idempotent_requests) are added where appropriate to prevent duplication. | |||
There was a problem hiding this comment.
What does "most api errors" imply? It seems wrong. The most important API errors are card_error and invalid_request_error which we would explicitly never retry right?
There was a problem hiding this comment.
I'd be more explicit here and list the exact errors we do don't retry on to reduce any confusion.
There was a problem hiding this comment.
to wit:
Automatic network retries can be enabled with
setMaxNetworkRetries. This will retry requestsntimes with exponential backoff if they fail due to connection errors, 409 (conflict) errors, 503 (availability) errors, and 500 (internal) errors on GET/DELETE. Idempotency keys are added where appropriate to prevent duplication.
400 (user) errors and 429 (rate limit exceeded) errors are not retried, nor are 500 errors which result from POST requests, as our idempotency framework would simply no-op and return a replayed 500 error.
eh?
There was a problem hiding this comment.
I would personally remove the last sentence, it seems quite confusing. Or we need to get into the weeds of what is retry-able and what isn't which seems out of scope from this small section in the readme
|
updated to match php/python, which I think expresses the intent better. r? @remi-stripe |
r? @remi-stripe
cc @paulasjes-stripe
cc @brandur-stripe
cc @stripe/api-libraries
Follows #566 which follows #559