KeyError: "X-RateLimit-FillRate" fix (#1593)

Co-authored-by: i.myakotin <i.myakotin@tinkoff.ru>

jira/resilientsession.py

@@ -300,23 +300,39 @@ def __recoverable(
         if isinstance(response, Response):
             if response.status_code in [429]:
                 is_recoverable = True
-                number_of_tokens_issued_per_interval = response.headers[
+                number_of_tokens_issued_per_interval = response.headers.get(
                     "X-RateLimit-FillRate"
-                ]
-                token_issuing_rate_interval_seconds = response.headers[
+                )
+                token_issuing_rate_interval_seconds = response.headers.get(
                     "X-RateLimit-Interval-Seconds"
-                ]
-                maximum_number_of_tokens = response.headers["X-RateLimit-Limit"]
-                retry_after = response.headers["retry-after"]
+                )
+                maximum_number_of_tokens = response.headers.get("X-RateLimit-Limit")
+                retry_after = response.headers.get("retry-after")
                 msg = f"{response.status_code} {response.reason}"
-                LOG.warning(
-                    f"Request rate limited by Jira: request should be retried after {retry_after} seconds.\n"
-                    + f"{number_of_tokens_issued_per_interval} tokens are issued every {token_issuing_rate_interval_seconds} seconds. "
-                    + f"You can accumulate up to {maximum_number_of_tokens} tokens.\n"
+                warning_msg = "Request rate limited by Jira."
+
+                warning_msg += (
+                    f" Request should be retried after {retry_after} seconds.\n"
+                    if retry_after is not None
+                    else "\n"
+                )
+                if (
+                    number_of_tokens_issued_per_interval is not None
+                    and token_issuing_rate_interval_seconds is not None
+                ):
+                    warning_msg += f"{number_of_tokens_issued_per_interval} tokens are issued every {token_issuing_rate_interval_seconds} seconds.\n"
+                if maximum_number_of_tokens is not None:
+                    warning_msg += (
+                        f"You can accumulate up to {maximum_number_of_tokens} tokens.\n"
+                    )
+                warning_msg = (
+                    warning_msg
                     + "Consider adding an exemption for the user as explained in: "
                     + "https://confluence.atlassian.com/adminjiraserver/improving-instance-stability-with-rate-limiting-983794911.html"
                 )
 
+                LOG.warning(warning_msg)
+
         if is_recoverable:
             # Exponential backoff with full jitter.
             delay = min(self.max_retry_delay, 10 * 2**counter) * random.random()

tests/test_resilientsession.py

@@ -101,6 +101,31 @@ def test_status_codes_retries(
     assert mocked_sleep_method.call_count == expected_number_of_sleep_invocations
 
 
+@patch("requests.Session.request")
+@patch(f"{jira.resilientsession.__name__}.time.sleep")
+@pytest.mark.parametrize(
+    "status_code,expected_number_of_retries,expected_number_of_sleep_invocations",
+    status_codes_retries_test_data,
+)
+def test_status_codes_retries_no_headers(
+    mocked_sleep_method: Mock,
+    mocked_request_method: Mock,
+    status_code: int,
+    expected_number_of_retries: int,
+    expected_number_of_sleep_invocations: int,
+):
+    mocked_response: Response = Response()
+    mocked_response.status_code = status_code
+    mocked_request_method.return_value = mocked_response
+    session: jira.resilientsession.ResilientSession = (
+        jira.resilientsession.ResilientSession()
+    )
+    with pytest.raises(JIRAError):
+        session.get("mocked_url")
+    assert mocked_request_method.call_count == expected_number_of_retries
+    assert mocked_sleep_method.call_count == expected_number_of_sleep_invocations
+
+
 errors_parsing_test_data = [
     (403, {"x-authentication-denied-reason": "err1"}, "", ["err1"]),
     (500, {}, "err1", ["err1"]),