Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SG-34197 Retry S3 uploads on error 500 #324

Merged
merged 4 commits into from
Jan 29, 2024
Merged

SG-34197 Retry S3 uploads on error 500 #324

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
365c51c
Retry S3 uploads on error 500
carlos-villavicencio-adsk Jan 26, 2024
46bc26b
Remove context manager variable
carlos-villavicencio-adsk Jan 26, 2024
d9e2952
Merge branch 'master' into ticket/SG-34197_retry_s3_upload_on_500
carlos-villavicencio-adsk Jan 26, 2024
ab880a2
Improve conditional logic
carlos-villavicencio-adsk Jan 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions shotgun_api3/shotgun.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4145,16 +4145,14 @@ def _upload_data_to_storage(self, data, content_type, size, storage_url):
LOG.debug("Completed request to %s" % request.get_method())

except urllib.error.HTTPError as e:
if e.code == 500:
raise ShotgunError("Server encountered an internal error.\n%s\n%s\n\n" % (storage_url, e))
elif attempt != max_attempts and e.code == 503:
LOG.debug("Got a 503 response. Waiting and retrying...")
if attempt != max_attempts and e.code in [500, 503]:
LOG.debug("Got a %s response. Waiting and retrying..." % e.code)
time.sleep(float(attempt) * backoff)
attempt += 1
continue
else:
if e.code == 503:
raise ShotgunError("Got a 503 response when uploading to %s: %s" % (storage_url, e))
if e.code in [500, 503]:
raise ShotgunError("Got a %s response when uploading to %s: %s" % (e.code, storage_url, e))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor non-blocking point, the code could be easier to read this way IMO:

if attempt != max_attempts and e.code in [500, 503]:
    LOG.debug("Got a %s response. Waiting and retrying..." % e.code)
    time.sleep(float(attempt) * backoff)
    attempt += 1
    continue
elif e.code in [500, 503]:
    raise ShotgunError("Got a %s response when uploading to %s: %s" % (e.code, storage_url, e))
else:
    raise ShotgunError("Unanticipated error occurred uploading to %s: %s" % (storage_url, e))

raise ShotgunError("Unanticipated error occurred uploading to %s: %s" % (storage_url, e))

else:
Expand Down
4 changes: 2 additions & 2 deletions tests/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ def setUp(self):
self._setup_mock()
self._setup_mock_data()

def _setup_mock(self):
def _setup_mock(self, s3_status_code_error=503):
"""Setup mocking on the ShotgunClient to stop it calling a live server
"""
# Replace the function used to make the final call to the server
Expand All @@ -131,7 +131,7 @@ def _setup_mock(self):
self.sg._make_upload_request = mock.Mock(spec=api.Shotgun._make_upload_request,
side_effect = urllib.error.HTTPError(
"url",
503,
s3_status_code_error,
"The server is currently down or to busy to reply."
"Please try again later.",
{},
Expand Down
26 changes: 25 additions & 1 deletion tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ def test_call_rpc(self):
"Call is repeated up to 3 times",
)

def test_upload_s3(self):
def test_upload_s3_503(self):
"""
Test 503 response is retried when uploading to S3.
"""
Expand All @@ -476,6 +476,30 @@ def test_upload_s3(self):
self.assertTrue(
max_attempts == self.sg._make_upload_request.call_count,
"Call is repeated up to 3 times")

def test_upload_s3_500(self):
"""
Test 500 response is retried when uploading to S3.
"""
self._setup_mock(s3_status_code_error=500)
this_dir, _ = os.path.split(__file__)
storage_url = "http://foo.com/"
path = os.path.abspath(os.path.expanduser(
os.path.join(this_dir, "sg_logo.jpg")))
max_attempts = 4 # Max retries to S3 server attempts
# Expected HTTPError exception error message
expected = "The server is currently down or to busy to reply." \
"Please try again later."

# Test the Internal function that is used to upload each
# data part in the context of multi-part uploads to S3, we
# simulate the HTTPError exception raised with 503 status errors
with self.assertRaises(api.ShotgunError, msg=expected):
self.sg._upload_file_to_storage(path, storage_url)
# Test the max retries attempt
self.assertTrue(
max_attempts == self.sg._make_upload_request.call_count,
"Call is repeated up to 3 times")

def test_transform_data(self):
"""Outbound data is transformed"""
Expand Down