Retry after certain Cloudflare errors #991
Conversation
readme.md
Outdated
| @@ -367,7 +367,7 @@ Default: | |||
| - limit: `2` | |||
| - calculateDelay: `(attemptCount, retryOptions, error, computedValue) => computedValue` | |||
| - methods: `GET` `PUT` `HEAD` `DELETE` `OPTIONS` `TRACE` | |||
| - statusCodes: [`408`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) [`413`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413) [`429`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) [`500`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) [`502`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) [`503`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) [`504`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) | |||
| - statusCodes: [`408`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) [`413`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413) [`429`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) [`500`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) [`502`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) [`503`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) [`504`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) [`520`](https://support.cloudflare.com/hc/en-us/articles/115003011431#520error) [`521`](https://support.cloudflare.com/hc/en-us/articles/115003011431#521error) [`522`](https://support.cloudflare.com/hc/en-us/articles/115003011431#522error) [`523`](https://support.cloudflare.com/hc/en-us/articles/115003011431#523error) [`524`](https://support.cloudflare.com/hc/en-us/articles/115003011431#524error) [`527`](https://support.cloudflare.com/hc/en-us/articles/115003011431#527error) | |||
There was a problem hiding this comment.
Only 522 and 524 should be retry-able.
There was a problem hiding this comment.
Other 5XX codes are not.
There was a problem hiding this comment.
Just so I understand why, is your reasoning that the other ones are unlikely to be intermittent?
There was a problem hiding this comment.
I'm glad you've asked 😃 Got retries on timeouts by default, so 522 and 524 are OK.
On the other hand, 520 is caused by a server error which is not likely to disappear:
521 is web server is down, it makes no sense to retry.
523 is origin is unreachable - CloudFlare cannot find a route to the server, it makes no sense to retry either.
527 is Railgun Listener to origin error and it has these common causes:
It isn't safe to retry on 527 as we don't know if the request timed out or not.
There was a problem hiding this comment.
Thanks for the explanation. I made the change.
There was a problem hiding this comment.
We retry on ECONNREFUSED and ECONNRESET though, so 521 is appriopriate here: https://community.cloudflare.com/t/community-tip-fixing-error-521-web-server-is-down/42461
Let me finish this for you :)
|
Don't forget to include some tests :) |
|
I didn't add a test because I figured a test would sort of mirror the code (e.g. effectively asserting that the array of status codes is what it is in the code). Would you like me to add a test anyway? What do you think would be a useful one? I could add one that loops through the array and makes sure all of those status codes generate a retry. |
Ah, you're right. I don't think more tests are necessary at this point. |
dguo
force-pushed
the
retry-cloudflare-errors
branch
from
ff421c8
to
c23ae1e
Compare
|
Good job! 🙌 |
Checklist
Many of the Cloudflare error codes seem appropriate for retry.
I omitted the SSL ones with the reasoning that those are unlikely to be intermittent. I also omitted 530 because it can refer to many errors, like hitting a rate limit.