Fix #553: don't retry 4XX errors in Jira client

Author: leplatrem

jbi/services/common.py

@@ -20,7 +20,7 @@
 ServiceHealth = dict[str, bool]
 
 
-def instrument(prefix: str, exceptions: Sequence[Type[Exception]]):
+def instrument(prefix: str, exceptions: Sequence[Type[Exception]], **backoff_params):
     """This decorator wraps a function such that it increments a counter every
     time it is called and times its execution. It retries the function if the
     specified exceptions are raised.
@@ -32,6 +32,7 @@ def decorator(func):
             backoff.expo,
             exceptions,
             max_tries=settings.max_retries + 1,
+            **backoff_params,
         )
         def wrapper(*args, **kwargs):
             # Increment the call counter.

jbi/services/jira.py

@@ -30,12 +30,23 @@
 
 JIRA_DESCRIPTION_CHAR_LIMIT = 32767
 
+
+def fatal_code(e):
+    # Do not retry 4XX errors, mark them as fatal.
+    try:
+        return 400 <= e.response.status_code < 500
+    except AttributeError:
+        # `ApiError` or `ConnectionError` won't have response attribute.
+        return False
+
+
 instrumented_method = instrument(
     prefix="jira",
     exceptions=(
         atlassian_errors.ApiError,
         requests_exceptions.RequestException,
     ),
+    giveup=fatal_code,
 )
 
 

tests/unit/services/test_jira.py

@@ -87,6 +87,22 @@ def test_jira_retries_failing_connections_in_health_check(
     assert len(mocked_responses.calls) == 4
 
 
+@pytest.mark.no_mocked_jira
+def test_jira_does_not_retry_4XX(mocked_responses, context_create_example):
+    url = f"{get_settings().jira_base_url}rest/api/2/issue"
+    mocked_responses.add(
+        responses.POST,
+        url,
+        json={},
+        status=400,
+    )
+
+    with pytest.raises(requests.HTTPError):
+        jira.create_jira_issue(context=context_create_example, description="")
+
+    assert len(mocked_responses.calls) == 1
+
+
 @pytest.mark.parametrize(
     "jira_components, project_components, expected_result",
     [