[ELI-619] - switching approach to base the cache off the consumer id

Author: TOEL2

src/eligibility_signposting_api/config/constants.py

@@ -6,8 +6,9 @@
 CONSUMER_ID = "NHSE-Product-ID"
 ALLOWED_CONDITIONS = Literal["COVID", "FLU", "MMR", "RSV"]
 CONSUMER_MAPPING_FILE_NAME = "consumer_mapping_config.json"
+RESERVED_TEST_CONSUMER_IDS = {"test-consumer-1", "test-consumer-2", "test-consumer-3"}
 
-ttl = {
+TTL = {
     "local": 0,
     "test": 300,
     "dev": 300,

src/eligibility_signposting_api/repos/campaign_repo.py

@@ -10,7 +10,7 @@
 from wireup import Inject, service
 
 from eligibility_signposting_api.model.campaign_config import CampaignConfig, Rules
-from eligibility_signposting_api.config.constants import ttl
+from eligibility_signposting_api.config.constants import TTL, RESERVED_TEST_CONSUMER_IDS
 
 BucketName = NewType("BucketName", str)
 
@@ -32,14 +32,14 @@ def __init__(
         self.bucket_name = bucket_name
         self._campaign_configs_cache: list[CampaignConfig] | None = None
         self._cache_expiry_epoch: float = 0.0
-        self._cache_ttl_seconds: int = int(ttl.get(os.getenv("ENVIRONMENT"), 0))
+        self._cache_ttl_seconds: int = int(TTL.get(os.getenv("ENVIRONMENT"), 0))
 
-    def get_campaign_configs(self, bypass_cache: bool = False) -> Generator[CampaignConfig, None, None]:
+    def get_campaign_configs(self, consumer_id: str) -> Generator[CampaignConfig, None, None]:
         now = time.time()
         cache_enabled = self._cache_ttl_seconds > 0
         cache_valid = (
             cache_enabled
-            and not bypass_cache
+            and consumer_id not in RESERVED_TEST_CONSUMER_IDS
             and self._campaign_configs_cache is not None
             and now < self._cache_expiry_epoch
         )
@@ -51,13 +51,13 @@ def get_campaign_configs(self, bypass_cache: bool = False) -> Generator[Campaign
                 return
 
             logger.info(
-                "Refreshing campaign configs from S3 (bypass_cache=%s, ttl_seconds=%s)",
-                bypass_cache,
+                "Refreshing campaign configs from S3 (consumer_id=%s, ttl_seconds=%s)",
+                consumer_id,
                 self._cache_ttl_seconds,
             )
             campaign_configs = self._load_campaign_configs_from_s3()
 
-            if cache_enabled and not bypass_cache:
+            if cache_enabled and consumer_id not in RESERVED_TEST_CONSUMER_IDS:
                 self._campaign_configs_cache = campaign_configs
                 self._cache_expiry_epoch = now + self._cache_ttl_seconds
 

src/eligibility_signposting_api/services/eligibility_services.py

@@ -42,7 +42,6 @@ def get_eligibility_status(
         conditions: list[str],
         category: str,
         consumer_id: str,
-        bypass_campaign_config_cache: bool = False,
     ) -> eligibility_status.EligibilityStatus:
         """Calculate a person's eligibility for vaccination given an NHS number."""
         if nhs_number:
@@ -52,9 +51,7 @@ def get_eligibility_status(
                 raise UnknownPersonError from e
             else:
                 campaign_configs: list[CampaignConfig] = list(
-                    self.campaign_repo.get_campaign_configs(
-                        bypass_cache=bypass_campaign_config_cache
-                    )
+                    self.campaign_repo.get_campaign_configs(consumer_id)
                 )
                 permitted_campaign_configs = self.__collect_permitted_campaign_configs(
                     campaign_configs, ConsumerId(consumer_id)

src/eligibility_signposting_api/views/eligibility.py

@@ -27,9 +27,6 @@
     Status.not_actionable: eligibility_response.Status.not_actionable,
     Status.not_eligible: eligibility_response.Status.not_eligible,
 }
-
-BYPASS_CAMPAIGN_CONFIG_CACHE_HEADER = "X-Bypass-Campaign-Config-Cache"
-
 logger = logging.getLogger(__name__)
 
 eligibility_blueprint = Blueprint("eligibility", __name__)
@@ -55,7 +52,6 @@ def check_eligibility(
 
     query_params = _get_or_default_query_params()
     consumer_id = _get_consumer_id_from_headers()
-    bypass_campaign_config_cache = _should_bypass_campaign_config_cache()
 
     try:
         eligibility_status = eligibility_service.get_eligibility_status(
@@ -64,7 +60,6 @@ def check_eligibility(
             query_params["conditions"],
             query_params["category"],
             consumer_id,
-            bypass_campaign_config_cache=bypass_campaign_config_cache,
         )
     except UnknownPersonError:
         return handle_unknown_person_error(nhs_number)
@@ -81,11 +76,6 @@ def _get_consumer_id_from_headers() -> ConsumerId:
     return ConsumerId(request.headers.get(CONSUMER_ID, ""))
 
 
-def _should_bypass_campaign_config_cache() -> bool:
-    value = request.headers.get(BYPASS_CAMPAIGN_CONFIG_CACHE_HEADER, "")
-    return value.lower() == "true"
-
-
 def _get_or_default_query_params() -> dict[str, Any]:
     default_query_params = {"category": "ALL", "conditions": ["ALL"], "includeActions": "Y"}
 

tests/integration/repo/test_campaign_repo.py

@@ -27,7 +27,7 @@ def test_get_campaign_config(s3_client: BaseClient, rules_bucket: BucketName, ca
     repo = CampaignRepo(s3_client, rules_bucket)
 
     # When
-    actual = list(repo.get_campaign_configs())
+    actual = list(repo.get_campaign_configs("consumer_id"))
 
     # Then
     assert_that(

tests/unit/repos/test_campaign_repo.py

@@ -37,7 +37,7 @@ def test_get_campaign_configs_loads_from_s3(self, repo, mock_s3_client, rules_pa
         }
         mock_s3_client.get_object.return_value = make_s3_body(rules_payload)
 
-        result = list(repo.get_campaign_configs())
+        result = list(repo.get_campaign_configs("consumer_id"))
 
         assert len(result) == 1
         assert result[0].id == rules_payload["campaign_config"]["id"]
@@ -67,8 +67,8 @@ def test_get_campaign_configs_uses_cache_within_ttl(
 
         monkeypatch.setattr("time.time", lambda: 1000.0)
 
-        first = list(repo.get_campaign_configs())
-        second = list(repo.get_campaign_configs())
+        first = list(repo.get_campaign_configs("consumer_id"))
+        second = list(repo.get_campaign_configs("consumer_id"))
 
         assert first[0].version == 1
         assert second[0].version == 1
@@ -97,11 +97,11 @@ def test_get_campaign_configs_refreshes_after_ttl_expiry(
         current_time = {"value": 1000.0}
         monkeypatch.setattr("time.time", lambda: current_time["value"])
 
-        first = list(repo.get_campaign_configs())
+        first = list(repo.get_campaign_configs("consumer_id"))
         current_time["value"] = 1030.0
-        second = list(repo.get_campaign_configs())
+        second = list(repo.get_campaign_configs("consumer_id"))
         current_time["value"] = 1061.0
-        third = list(repo.get_campaign_configs())
+        third = list(repo.get_campaign_configs("test-consumer-1"))
 
         assert first[0].version == 1
         assert second[0].version == 1

tests/unit/views/test_eligibility.py

@@ -62,7 +62,6 @@ def get_eligibility_status(
         _conditions: list[str],
         _category: str,
         _consumer_id: str,
-        bypass_campaign_config_cache: bool = False,
     ) -> EligibilityStatus:
         return EligibilityStatusFactory.build()
 
@@ -78,7 +77,6 @@ def get_eligibility_status(
         _conditions: list[str],
         _category: str,
         _consumer_id: str,
-        bypass_campaign_config_cache: bool = False,
     ) -> EligibilityStatus:
         raise UnknownPersonError
 
@@ -94,7 +92,6 @@ def get_eligibility_status(
         _conditions: list[str],
         _category: str,
         _consumer_id: str,
-        bypass_campaign_config_cache: bool = False,
     ) -> EligibilityStatus:
         raise ValueError