Separate and cache services (#224)

* Split Jira and Bugzilla services into separate modules
* Use lru_cache(maxsize=1) for service getters, Settings class, and `version.json` read
We were already using `lru_cache` for the settings class getter, but this PR added the `maxsize=1` arg

Author: grahamalama

jbi/actions/README.md

@@ -31,6 +31,6 @@ Let's create a `new_action`!
 
 1. Use the `payload` to perform the desired processing!
 1. List the required Jira permissions to be set on projects that will use this action in the `JIRA_REQUIRED_PERMISSIONS` constant. The list of built-in permissions is [available on Atlanssian API docs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions).
-1. Use the available service calls from `jbi/services.py` (or make new ones)
+1. Use the available service calls from `jbi/services` (or make new ones)
 1. Update the `README.md` to document your action
 1. Now the action `jbi.actions.my_team_actions` can be used in the YAML configuration, under the `module` key.

jbi/actions/default.py

@@ -18,7 +18,7 @@
     BugzillaWebhookRequest,
     JiraContext,
 )
-from jbi.services import get_bugzilla, get_jira
+from jbi.services import bugzilla, jira
 
 settings = get_settings()
 
@@ -50,8 +50,8 @@ def __init__(self, jira_project_key, **kwargs):
         self.jira_project_key = jira_project_key
         self.sync_whiteboard_labels = kwargs.get("sync_whiteboard_labels", True)
 
-        self.bugzilla_client = get_bugzilla()
-        self.jira_client = get_jira()
+        self.bugzilla_client = bugzilla.get_client()
+        self.jira_client = jira.get_client()
 
     def __call__(  # pylint: disable=inconsistent-return-statements
         self, payload: BugzillaWebhookRequest

jbi/environment.py

@@ -55,13 +55,13 @@ class Config:
         env_file_encoding = "utf-8"
 
 
-@lru_cache()
+@lru_cache(maxsize=1)
 def get_settings() -> Settings:
     """Return the Settings object; use cache"""
     return Settings()
 
 
-@lru_cache()
+@lru_cache(maxsize=1)
 def get_version():
     """Return contents of version.json. This has generic data in repo, but gets the build details in CI."""
     info = {}

jbi/router.py

@@ -13,7 +13,7 @@
 from jbi.environment import Settings, get_settings, get_version
 from jbi.models import Actions, BugzillaWebhookRequest
 from jbi.runner import IgnoreInvalidRequestError, execute_action
-from jbi.services import jbi_service_health_map, jira_visible_projects
+from jbi.services import bugzilla, jira
 
 router = APIRouter()
 
@@ -37,8 +37,11 @@ def root(request: Request, settings: Settings = Depends(get_settings)):
 @router.head("/__heartbeat__")
 def heartbeat(response: Response, actions: Actions = Depends(get_actions)):
     """Return status of backing services, as required by Dockerflow."""
-    health_map = jbi_service_health_map(actions)
-    health_checks = []
+    health_map = {
+        "bugzilla": bugzilla.check_health(),
+        "jira": jira.check_health(actions),
+    }
+    health_checks: list = []
     for health in health_map.values():
         health_checks.extend(health.values())
     if not all(health_checks):
@@ -87,7 +90,7 @@ def get_whiteboard_tags(
 @router.get("/jira_projects/")
 def get_jira_projects():
     """API for viewing projects that are currently accessible by API"""
-    visible_projects: list[dict] = jira_visible_projects()
+    visible_projects: list[dict] = jira.fetch_visible_projects()
     return [project["key"] for project in visible_projects]
 
 

jbi/runner.py

@@ -9,7 +9,7 @@
 from jbi.environment import Settings
 from jbi.errors import ActionNotFoundError, IgnoreInvalidRequestError
 from jbi.models import Actions, BugzillaWebhookRequest, RunnerLogContext
-from jbi.services import get_bugzilla
+from jbi.services import bugzilla
 
 logger = logging.getLogger(__name__)
 
@@ -41,7 +41,7 @@ def execute_action(
         try:
             if request.bug.is_private:
                 request = request.copy(
-                    update={"bug": get_bugzilla().get_bug(request.bug.id)}
+                    update={"bug": bugzilla.get_client().get_bug(request.bug.id)}
                 )
         except Exception as err:
             logger.exception("Failed to get bug: %s", err, extra=log_context.dict())

jbi/services.py

@@ -0,0 +1,3 @@
+"""Exports the bugzilla and jira services modules for convenience"""
+
+from . import bugzilla, jira