Fix #345: Retry ConnectionError in Jira client (#507)

Fix #345: Retry ConnectionError in Jira client

Author: leplatrem

jbi/services/jira.py

@@ -10,7 +10,9 @@
 from functools import lru_cache
 from typing import TYPE_CHECKING, Any
 
-from atlassian import Jira, errors
+from atlassian import Jira
+from atlassian import errors as atlassian_errors
+from requests import exceptions as requests_exceptions
 
 from jbi import Operation, environment
 from jbi.models import ActionContext, BugzillaBug
@@ -27,14 +29,24 @@
 
 JIRA_DESCRIPTION_CHAR_LIMIT = 32767
 
-instrumented_method = instrument(prefix="jira", exceptions=(errors.ApiError,))
+instrumented_method = instrument(
+    prefix="jira",
+    exceptions=(
+        atlassian_errors.ApiError,
+        requests_exceptions.RequestException,
+    ),
+)
 
 
 class JiraClient(Jira):
     """Adapted Atlassian Jira client that wraps methods in our instrumentation
     decorator.
     """
 
+    get_server_info = instrumented_method(Jira.get_server_info)
+    get_permissions = instrumented_method(Jira.get_permissions)
+    get_project_components = instrumented_method(Jira.get_project_components)
+    projects = instrumented_method(Jira.projects)
     update_issue_field = instrumented_method(Jira.update_issue_field)
     set_issue_status = instrumented_method(Jira.set_issue_status)
     issue_add_comment = instrumented_method(Jira.issue_add_comment)

tests/unit/services/test_jira.py

@@ -2,6 +2,7 @@
 
 import pytest
 import responses
+from requests.exceptions import ConnectionError
 
 from jbi.environment import get_settings
 from jbi.services import jira
@@ -89,3 +90,23 @@ def test_create_issue_with_components(mocked_responses, context_create_example):
     posted_data = json.loads(mocked_responses.calls[-1].request.body)
 
     assert posted_data["fields"]["components"] == [{"id": "42"}]
+
+
+@pytest.mark.no_mocked_jira
+def test_jira_retries_failing_connections_in_health_check(
+    mocked_responses, actions_example
+):
+    url = f"{get_settings().jira_base_url}rest/api/2/serverInfo?doHealthCheck=True"
+
+    # When the request does not match any mocked URL, we also obtain
+    # a `ConnectionError`, but let's mock it explicitly.
+    mocked_responses.add(
+        responses.GET,
+        url,
+        body=ConnectionError(),
+    )
+
+    with pytest.raises(ConnectionError):
+        jira.check_health(actions_example)
+
+    assert len(mocked_responses.calls) == 4