Handle backoff on HTTP 503 error when pushing repeatedly #1038
Conversation
This file contains 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
|
The documentation is not available anymore as the PR was closed or merged. |
Codecov Report
@@ Coverage Diff @@
## main #1038 +/- ##
==========================================
+ Coverage 83.01% 83.20% +0.18%
==========================================
Files 36 37 +1
Lines 3822 3846 +24
==========================================
+ Hits 3173 3200 +27
+ Misses 649 646 -3
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
merveenoyan
approved these changes
Sep 8, 2022
SBrandeis
approved these changes
Sep 8, 2022
|
Thanks @SBrandeis and @merveenoyan for the review ! I'm merging once CI is happy :) |
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.
Fix #1027.
This PR adds a separate helper to perform HTTP requests with a backoff strategy. Retries can be made on specific exceptions or specific status codes. By default, we mainly target Connection timeout and HTTP 503 Service Unavailable. It is a slight variation of the existing backoff implementation in
_request_wrapperbut separated so that we can unit tests and document it properly.This PR adds backoff usage by default when pushing a LFS file to the Hub, which is the initial purpose of #1027. At the moment sleep times will increase as such: 1s, 2s, 4s, 8s, 8s, 8s...
I did not add the helper in the documentation since I'm not exactly sure yet if that's something we want to do at the moment. I think other HTTP-related helpers will come as user-agent handler (#1018) so maybe we can update documentation at that time. Docstring for
http_backoffis already ready.(for the record the excellent backoff package exists but is not used here to avoid an extra external dependency)