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-33891 Retries also on 504 #316

Merged
merged 2 commits into from
Dec 19, 2023
Merged

SG-33891 Retries also on 504 #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
effbb40
Retries also on 504
carlos-villavicencio-adsk Dec 15, 2023
0e25e90
Use assertEqual instead
carlos-villavicencio-adsk Dec 18, 2023
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
4 changes: 2 additions & 2 deletions shotgun_api3/shotgun.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3443,8 +3443,8 @@ def _call_rpc(self, method, params, include_auth_params=True, first=False):
# We've seen some rare instances of SG returning 502 for issues that
# appear to be caused by something internal to SG. We're going to
# allow for limited retries for those specifically.
if attempt != max_attempts and e.errcode == 502:
LOG.debug("Got a 502 response. Waiting and retrying...")
if attempt != max_attempts and e.errcode in [502, 504]:
Copy link
Contributor

Choose a reason for hiding this comment

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

You might want to use HTTPStatus constants instead: http.HTTPStatus.SERVICE_UNAVAILABLE and http.HTTPStatus.GATEWAY_TIMEOUT

Not a blocker but it's usually better to use constants.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I know. However, this would imply a full rewrite of the python-api and we can address that in the future.

LOG.debug("Got a 502 or 504 response. Waiting and retrying...")
time.sleep(float(attempt) * backoff)
attempt += 1
continue
Expand Down
21 changes: 19 additions & 2 deletions tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,12 +430,29 @@ def test_call_rpc(self):
expected = "rpc response with list result"
self.assertEqual(d["results"], rv, expected)

# Test that we raise on a 502. This is ensuring the retries behavior
# in place specific to 502 responses still eventually ends up raising.
# Test that we raise on a 5xx. This is ensuring the retries behavior
# in place specific to 5xx responses still eventually ends up raising.
# 502
d = {"results": ["foo", "bar"]}
a = {"some": "args"}
self._mock_http(d, status=(502, "bad gateway"))
self.assertRaises(api.ProtocolError, self.sg._call_rpc, "list", a)
self.assertEqual(
4,
self.sg._http_request.call_count,
"Call is repeated up to 3 times",
)

# 504
d = {"results": ["foo", "bar"]}
a = {"some": "args"}
self._mock_http(d, status=(504, "gateway timeout"))
self.assertRaises(api.ProtocolError, self.sg._call_rpc, "list", a)
self.assertEqual(
4,
self.sg._http_request.call_count,
"Call is repeated up to 3 times",
)

def test_upload_s3(self):
"""
Expand Down
Loading