ELI-427: Allows dynamic status text (#319)

* ELI-427: Allows dynamic status text

* Fixed formatting.

---------

Co-authored-by: ayeshalshukri1-nhs <[email protected]>

Author: shweta-nhs

src/eligibility_signposting_api/audit/audit_context.py

@@ -99,7 +99,7 @@ def append_audit_condition(
             iteration_version=best_active_iteration.version if best_active_iteration else None,
             condition_name=condition_name,
             status=best_candidate.status.name if best_candidate and best_candidate.status else None,
-            status_text=best_candidate.status.get_status_text(condition_name) if best_candidate else None,
+            status_text=best_candidate.status_text if best_candidate else None,
             eligibility_cohorts=audit_eligibility_cohorts,
             eligibility_cohort_groups=audit_eligibility_cohort_groups,
             filter_rules=audit_filter_rule,

src/eligibility_signposting_api/model/campaign_config.py

@@ -145,6 +145,14 @@ def get(self, key: str, default: AvailableAction | None = None) -> AvailableActi
         return self.root.get(key, default)
 
 
+class StatusText(BaseModel):
+    not_eligible: str | None = Field(None, alias="NotEligible")
+    not_actionable: str | None = Field(None, alias="NotActionable")
+    actionable: str | None = Field(None, alias="Actionable")
+
+    model_config = {"populate_by_name": True, "extra": "ignore"}
+
+
 class Iteration(BaseModel):
     id: IterationID = Field(..., alias="ID")
     version: IterationVersion = Field(..., alias="Version")
@@ -160,6 +168,7 @@ class Iteration(BaseModel):
     iteration_cohorts: list[IterationCohort] = Field(..., alias="IterationCohorts")
     iteration_rules: list[IterationRule] = Field(..., alias="IterationRules")
     actions_mapper: ActionsMapper = Field(..., alias="ActionsMapper")
+    status_text: StatusText | None = Field(None, alias="StatusText")
 
     model_config = {"populate_by_name": True, "arbitrary_types_allowed": True, "extra": "ignore"}
 

src/eligibility_signposting_api/model/eligibility_status.py

@@ -73,7 +73,7 @@ def best(*statuses: Status) -> Status:
         """
         return max(statuses)
 
-    def get_status_text(self, condition_name: ConditionName) -> StatusText:
+    def get_default_status_text(self, condition_name: ConditionName) -> StatusText:
         status_to_text_mapping = {
             self.not_eligible: lambda: StatusText("We do not believe you can have it"),
             self.not_actionable: lambda: StatusText(f"You should have the {condition_name} vaccine"),
@@ -130,6 +130,7 @@ class CohortGroupResult:
 @dataclass
 class IterationResult:
     status: Status
+    status_text: StatusText
     cohort_results: list[CohortGroupResult]
     actions: list[SuggestedAction] | None
 

src/eligibility_signposting_api/services/calculators/eligibility_calculator.py

@@ -9,7 +9,7 @@
 from wireup import service
 
 from eligibility_signposting_api.audit.audit_context import AuditContext
-from eligibility_signposting_api.model import eligibility_status
+from eligibility_signposting_api.model import campaign_config, eligibility_status
 from eligibility_signposting_api.model.eligibility_status import (
     BestIterationResult,
     CohortGroupResult,
@@ -19,6 +19,7 @@
     IterationResult,
     Reason,
     Status,
+    StatusText,
 )
 from eligibility_signposting_api.services.processors.action_rule_handler import ActionRuleHandler
 from eligibility_signposting_api.services.processors.campaign_evaluator import CampaignEvaluator
@@ -153,11 +154,34 @@ def get_iteration_results(self, campaign_group: list[CampaignConfig]) -> dict[It
 
             # Determine Result between cohorts - get the best
             status, best_cohorts = self.get_the_best_cohort_memberships(cohort_results)
+            status_text = self.get_status_text(active_iteration.status_text, ConditionName(cc.target), status)
+
             iteration_results[active_iteration.name] = BestIterationResult(
-                IterationResult(status, best_cohorts, []), active_iteration, cc.id, cc.version, cohort_results
+                IterationResult(status, status_text, best_cohorts, []),
+                active_iteration,
+                cc.id,
+                cc.version,
+                cohort_results,
             )
         return iteration_results
 
+    @staticmethod
+    def get_status_text(
+        status_text: campaign_config.StatusText | None, condition_name: ConditionName, status: Status
+    ) -> StatusText:
+        if status_text is None:
+            status_text_or_default = status.get_default_status_text(condition_name)
+        else:
+            status_to_text = {
+                Status.not_eligible: status_text.not_eligible
+                or Status.not_eligible.get_default_status_text(condition_name),
+                Status.not_actionable: status_text.not_actionable
+                or Status.not_actionable.get_default_status_text(condition_name),
+                Status.actionable: status_text.actionable or Status.actionable.get_default_status_text(condition_name),
+            }
+            status_text_or_default = StatusText(status_to_text[status])
+        return status_text_or_default
+
     @staticmethod
     def build_condition(iteration_result: IterationResult, condition_name: ConditionName) -> Condition:
         grouped_cohort_results = defaultdict(list)
@@ -180,7 +204,7 @@ def build_condition(iteration_result: IterationResult, condition_name: Condition
             cohort_results=list(deduplicated_cohort_results),
             suitability_rules=list(overall_deduplicated_reasons_for_condition),
             actions=iteration_result.actions,
-            status_text=iteration_result.status.get_status_text(condition_name),
+            status_text=iteration_result.status_text,
         )
 
     @staticmethod

tests/fixtures/builders/model/rule.py

@@ -24,6 +24,7 @@
     RuleOperator,
     RulePriority,
     RuleType,
+    StatusText,
 )
 
 
@@ -60,6 +61,12 @@ class ActionsMapperFactory(ModelFactory[ActionsMapper]):
     root = Use(lambda: {"defaultcomms": AvailableActionDetailFactory.build()})
 
 
+class StatusTextFactory(ModelFactory[StatusText]):
+    not_eligible = "Not eligible status text"
+    not_actionable = "Not actionable status text"
+    actionable = "Actionable status text"
+
+
 class IterationFactory(ModelFactory[Iteration]):
     iteration_cohorts = Use(IterationCohortFactory.batch, size=2)
     iteration_rules = Use(IterationRuleFactory.batch, size=2)
@@ -80,7 +87,7 @@ class CampaignConfigFactory(RawCampaignConfigFactory):
     def build(cls, **kwargs) -> CampaignConfig:
         """Ensure invariants are met:
         * no iterations with duplicate iteration dates
-        * must have iteration active from campaign start date"""
+        * must have iteration active from the campaign start date"""
         processed_kwargs = cls.process_kwargs(**kwargs)
         start_date: date = processed_kwargs["start_date"]
         iterations: list[Iteration] = processed_kwargs["iterations"]

tests/integration/conftest.py

@@ -24,6 +24,7 @@
     EndDate,
     RuleType,
     StartDate,
+    StatusText,
 )
 from eligibility_signposting_api.repos.campaign_repo import BucketName
 from eligibility_signposting_api.repos.person_repo import TableName
@@ -528,6 +529,7 @@ def campaign_config(s3_client: BaseClient, rules_bucket: BucketName) -> Generato
                         negative_description="negative_description",
                     )
                 ],
+                status_text=None,
             )
         ],
     )
@@ -607,6 +609,7 @@ def campaign_config_with_and_rule(s3_client: BaseClient, rules_bucket: BucketNam
                         negative_description="negative_description",
                     ),
                 ],
+                status_text=None,
             )
         ],
     )
@@ -762,6 +765,11 @@ def multiple_campaign_configs(s3_client: BaseClient, rules_bucket: BucketName) -
                             negative_description="negative_desc_4",
                         ),
                     ],
+                    status_text=StatusText(
+                        NotEligible=f"You are not eligible to take {targets[i]} vaccines.",
+                        NotActionable=f"You have taken {targets[i]} vaccine in the last 90 days",
+                        Actionable=f"You can take {targets[i]} vaccine.",
+                    ),
                 )
             ],
         )
@@ -790,6 +798,7 @@ def campaign_config_with_magic_cohort(s3_client: BaseClient, rules_bucket: Bucke
                     rule.PersonAgeSuppressionRuleFactory.build(),
                 ],
                 iteration_cohorts=[rule.MagicCohortFactory.build(cohort_label="elid_all_people")],
+                status_text=None,
             )
         ],
     )
@@ -822,6 +831,7 @@ def campaign_config_with_missing_descriptions_missing_rule_text(
                         negative_description="",
                     )
                 ],
+                status_text=None,
             )
         ],
     )

tests/integration/lambda/test_app_running_as_lambda.py

@@ -460,7 +460,7 @@ def test_given_person_has_unique_status_for_different_conditions_with_audit(  #
             "iterationVersion": rsv_campaign.iterations[0].version,
             "conditionName": rsv_campaign.target,
             "status": "not_eligible",
-            "statusText": "We do not believe you can have it",
+            "statusText": f"You are not eligible to take {rsv_campaign.target} vaccines.",
             "eligibilityCohorts": [
                 {"cohortCode": "cohort_label1", "cohortStatus": "not_eligible"},
                 {"cohortCode": "cohort_label4", "cohortStatus": "not_eligible"},
@@ -484,7 +484,7 @@ def test_given_person_has_unique_status_for_different_conditions_with_audit(  #
             "iterationVersion": covid_campaign.iterations[0].version,
             "conditionName": covid_campaign.target,
             "status": "not_actionable",
-            "statusText": f"You should have the {covid_campaign.target} vaccine",
+            "statusText": f"You have taken {covid_campaign.target} vaccine in the last 90 days",
             "eligibilityCohorts": [
                 {"cohortCode": "cohort_label2", "cohortStatus": "not_actionable"},
                 {"cohortCode": "cohort_label4", "cohortStatus": "not_actionable"},
@@ -516,7 +516,7 @@ def test_given_person_has_unique_status_for_different_conditions_with_audit(  #
             "iterationVersion": flu_campaign.iterations[0].version,
             "conditionName": flu_campaign.target,
             "status": "actionable",
-            "statusText": f"You should have the {flu_campaign.target} vaccine",
+            "statusText": f"You can take {flu_campaign.target} vaccine.",
             "eligibilityCohorts": [
                 {"cohortCode": "cohort_label3", "cohortStatus": "actionable"},
                 {"cohortCode": "cohort_label4", "cohortStatus": "actionable"},

tests/unit/audit/test_audit_context.py

@@ -26,6 +26,7 @@
     RuleName,
     RulePriority,
     Status,
+    StatusText,
     SuggestedAction,
     UrlLabel,
     UrlLink,
@@ -132,7 +133,10 @@ def test_append_audit_condition_adds_condition_to_audit_log_on_g_for_actionable_
         reasons=audit_rules,
     )
     iteration_result = IterationResult(
-        status=Status.actionable, cohort_results=[cohort_group_result], actions=suggested_actions
+        status=Status.actionable,
+        status_text=StatusText("You should have the Condition1 vaccine"),
+        cohort_results=[cohort_group_result],
+        actions=suggested_actions,
     )
     campaign_details = (CampaignID("CampaignID1"), CampaignVersion(123))
     matched_action_detail = MatchedActionDetail(
@@ -210,7 +214,12 @@ def test_should_append_audit_suppression_rules_for_actionable_status(app):
         audit_rules=audit_rules,
         reasons=audit_rules,
     )
-    iteration_result = IterationResult(status=Status.actionable, cohort_results=[cohort_group_result], actions=[])
+    iteration_result = IterationResult(
+        status=Status.actionable,
+        status_text=StatusText("You should have the Condition1 vaccine"),
+        cohort_results=[cohort_group_result],
+        actions=[],
+    )
     campaign_details = (CampaignID("CampaignID1"), CampaignVersion(123))
 
     best_iteration_results = BestIterationResult(
@@ -265,7 +274,12 @@ def test_should_append_audit_filter_rules_for_not_actionable_status(app):
         audit_rules=audit_rules,
         reasons=audit_rules,
     )
-    iteration_result = IterationResult(status=Status.not_actionable, cohort_results=[cohort_group_result], actions=[])
+    iteration_result = IterationResult(
+        status=Status.not_actionable,
+        status_text=StatusText("You should have the Condition1 vaccine"),
+        cohort_results=[cohort_group_result],
+        actions=[],
+    )
     campaign_details = (CampaignID("CampaignID1"), CampaignVersion(123))
 
     best_iteration_results = BestIterationResult(

tests/unit/model/test_status.py

@@ -27,15 +27,15 @@ def test_best_status(self):
         assert Status.best(Status.not_eligible) == Status.not_eligible
 
     def test_get_status_text(self):
-        assert Status.not_eligible.get_status_text(ConditionName("COVID")) == StatusText(
+        assert Status.not_eligible.get_default_status_text(ConditionName("COVID")) == StatusText(
             "We do not believe you can have it"
         )
 
-        assert Status.not_actionable.get_status_text(ConditionName("FLU")) == StatusText(
+        assert Status.not_actionable.get_default_status_text(ConditionName("FLU")) == StatusText(
             "You should have the FLU vaccine"
         )
 
-        assert Status.actionable.get_status_text(ConditionName("COVID")) == StatusText(
+        assert Status.actionable.get_default_status_text(ConditionName("COVID")) == StatusText(
             "You should have the COVID vaccine"
         )