Refactor PDS service caching logic and update coverage dependency

Author: amarauzoma

.github/workflows/quality-checks.yml

@@ -188,7 +188,7 @@ jobs:
         working-directory: lambdas/mock_pds
         id: mock_pds
         env:
-          PYTHONPATH: ${{ env.LAMBDA_PATH }}/mock_pds/src:${{ env.LAMBDA_PATH }}/mock_pds/tests
+          PYTHONPATH: ${{ env.LAMBDA_PATH }}/mock_pds/src
         continue-on-error: true
         run: |
           poetry install

lambdas/mock_pds/pyproject.toml

@@ -9,7 +9,7 @@ packages = [{include = "src"}]
 [tool.poetry.dependencies]
 python = "~3.11"
 redis = "^6.1.0"
-coverage = "^7.13.2"
+coverage = "^7.13.5"
 
 [build-system]
 requires = ["poetry-core >= 1.5.0"]

lambdas/shared/src/common/api_clients/get_pds_details.py

@@ -10,19 +10,23 @@
 from common.clients import get_secrets_manager_client, logger
 
 _pds_service: PdsService | None = None
+_pds_service_config: tuple[str, str | None] | None = None
 
 
 def get_pds_service() -> PdsService:
-    global _pds_service
-    if _pds_service is None:
-        environment = os.getenv("PDS_ENV", "int")
-        base_url = os.getenv("PDS_BASE_URL", "").strip() or None
+    global _pds_service, _pds_service_config
+    environment = os.getenv("PDS_ENV", "int")
+    base_url = os.getenv("PDS_BASE_URL", "").strip() or None
+    config = (environment, base_url)
+
+    if _pds_service is None or _pds_service_config != config:
         authenticator = (
             None
             if base_url
             else AppRestrictedAuth(secret_manager_client=get_secrets_manager_client(), environment=environment)
         )
         _pds_service = PdsService(authenticator, environment, base_url=base_url)
+        _pds_service_config = config
     return _pds_service
 
 

lambdas/shared/tests/test_common/api_clients/test_pds_details.py

@@ -9,6 +9,7 @@ class TestGetPdsPatientDetails(unittest.TestCase):
     def setUp(self):
         self.test_patient_id = "9912003888"
         get_pds_service.__globals__["_pds_service"] = None
+        get_pds_service.__globals__["_pds_service_config"] = None
 
         self.logger_patcher = patch("common.api_clients.get_pds_details.logger")
         self.mock_logger = self.logger_patcher.start()
@@ -25,6 +26,7 @@ def setUp(self):
 
     def tearDown(self):
         get_pds_service.__globals__["_pds_service"] = None
+        get_pds_service.__globals__["_pds_service_config"] = None
         patch.stopall()
 
     def test_pds_get_patient_details_success(self):
@@ -112,3 +114,46 @@ def test_whitespace_only_base_url_uses_authenticator(self):
             "ref",
             base_url=None,
         )
+
+    @patch.dict("os.environ", {"PDS_ENV": "ref", "PDS_BASE_URL": "https://mock-pds-v1.example/Patient"}, clear=False)
+    def test_rebuilds_cached_service_when_base_url_changes(self):
+        pds_get_patient_details(self.test_patient_id)
+
+        self.mock_pds_service_class.reset_mock()
+        self.mock_pds_service_instance.get_patient_details.reset_mock()
+        new_instance = MagicMock()
+        self.mock_pds_service_class.return_value = new_instance
+
+        with patch.dict("os.environ", {"PDS_BASE_URL": "https://mock-pds-v2.example/Patient"}, clear=False):
+            pds_get_patient_details("1234567890")
+
+        self.mock_auth_class.assert_not_called()
+        self.mock_pds_service_class.assert_called_once_with(
+            None,
+            "ref",
+            base_url="https://mock-pds-v2.example/Patient",
+        )
+        new_instance.get_patient_details.assert_called_once_with("1234567890")
+
+    @patch.dict("os.environ", {"PDS_ENV": "int", "PDS_BASE_URL": ""}, clear=False)
+    def test_rebuilds_cached_service_when_environment_changes(self):
+        pds_get_patient_details(self.test_patient_id)
+
+        self.mock_pds_service_class.reset_mock()
+        self.mock_auth_class.reset_mock()
+        self.mock_pds_service_instance.get_patient_details.reset_mock()
+        new_auth = MagicMock()
+        new_service = MagicMock()
+        self.mock_auth_class.return_value = new_auth
+        self.mock_pds_service_class.return_value = new_service
+
+        with patch.dict("os.environ", {"PDS_ENV": "ref", "PDS_BASE_URL": ""}, clear=False):
+            pds_get_patient_details("1234567890")
+
+        self.mock_auth_class.assert_called_once_with(secret_manager_client=unittest.mock.ANY, environment="ref")
+        self.mock_pds_service_class.assert_called_once_with(
+            new_auth,
+            "ref",
+            base_url=None,
+        )
+        new_service.get_patient_details.assert_called_once_with("1234567890")