WIP - Pydantic AvailableActionMap.

Author: ayeshalshukri1-nhs

src/eligibility_signposting_api/model/rules.py

@@ -9,9 +9,9 @@
 from operator import attrgetter
 from typing import Literal, NewType
 
-from pydantic import BaseModel, Field, field_serializer, field_validator, model_validator
+from pydantic import BaseModel, Field, field_serializer, field_validator, model_validator, RootModel
 
-from eligibility_signposting_api.model.eligibility import Action
+#from eligibility_signposting_api.model.eligibility import Action
 
 if typing.TYPE_CHECKING:  # pragma: no cover
     from pydantic import SerializationInfo
@@ -129,6 +129,10 @@ class AvailableAction(BaseModel):
     urlLink: str | None = Field(None, alias="UrlLink")
     urlLabel: str | None = Field(None, alias="UrlLabel")
 
+class AvailableActionMap(RootModel[dict[str, AvailableAction]]):
+    def get(self, key, default=None):
+        return self.root.get(key, default)
+
 class Iteration(BaseModel):
     id: IterationID = Field(..., alias="ID")
     version: IterationVersion = Field(..., alias="Version")
@@ -141,7 +145,8 @@ class Iteration(BaseModel):
     default_comms_routing: str | None = Field(None, alias="DefaultCommsRouting")
     iteration_cohorts: list[IterationCohort] = Field(..., alias="IterationCohorts")
     iteration_rules: list[IterationRule] = Field(..., alias="IterationRules")
-    actions_mapper: dict[str, AvailableAction] | None = Field(default_factory=dict, alias="ActionsMapper")
+    #actions_mapper: dict[str, AvailableAction] | None = Field(default_factory=dict, alias="ActionsMapper")
+    actions_mapper: AvailableActionMap | None = Field(default_factory=lambda: AvailableActionMap({}), alias="ActionsMapper")
 
     model_config = {"populate_by_name": True, "arbitrary_types_allowed": True, "extra": "ignore"}
 

src/eligibility_signposting_api/services/calculators/eligibility_calculator.py

@@ -11,7 +11,7 @@
 #from pygments.lexer import default
 
 if TYPE_CHECKING:
-    from eligibility_signposting_api.model.rules import Iteration, IterationCohort, AvailableAction
+    from eligibility_signposting_api.model.rules import Iteration, IterationCohort, AvailableAction, AvailableActionMap
 
 from wireup import service
 
@@ -97,7 +97,7 @@ def get_rules_by_type(
     @staticmethod
     def get_redirect_rules(
         active_iteration: Iteration,
-    ) -> tuple[tuple[rules.IterationRule, ...], dict[str, AvailableAction], str]:
+    ) -> tuple[tuple[rules.IterationRule, ...], AvailableActionMap, str]:
         redirect_rules = tuple(
             rule for rule in active_iteration.iteration_rules if rule.type in rules.RuleType.redirect
         )
@@ -268,7 +268,7 @@ def evaluate_rules_priority_group(
         return best_status, inclusion_reasons, exclusion_reasons, is_rule_stop
 
     @staticmethod
-    def get_actions_from_comms(self, action_mapper: dict[str, AvailableAction], comms: str) -> list[Action]:
+    def get_actions_from_comms(self, action_mapper: AvailableActionMap, comms: str) -> list[Action]:
         actions: list[Action] = []
         for comm in comms.split("|"):
             actions.append(Action(

tests/unit/services/calculators/test_eligibility_calculator.py

@@ -17,6 +17,7 @@
     RuleResult,
     Status, Action,
 )
+from eligibility_signposting_api.model.rules import AvailableActionMap, AvailableAction
 from eligibility_signposting_api.services.calculators.eligibility_calculator import EligibilityCalculator
 from tests.fixtures.builders.model import rule as rule_builder
 from tests.fixtures.builders.repos.person import person_rows_builder
@@ -1073,19 +1074,22 @@ def test_correct_actions_determined_from_redirect_r_rules(faker: Faker):
                     rule_builder.IterationFactory.build(
                         iteration_cohorts=[rule_builder.IterationCohortFactory.build(cohort_label="cohort1")],
                         default_comms_routing="defaultcomms",
-                        actions_mapper={"ActionCode1": {"ExternalRoutingCode": "ActionCode1",
-                                                        "ActionDescription": "Action description",
-                                                        "ActionType": "ActionType",
-                                                        "UrlLink": "ActionLink",
-                                                        "UrlLabel": "Label",
-                                                        },
-                                        "defaultcomms": {"ExternalRoutingCode": "ActionCode1",
-                                                         "ActionDescription": "Action description",
-                                                         "ActionType": "ActionType",
-                                                         "UrlLink": "ActionLink",
-                                                         "UrlLabel": "Label",
-                                                         },
-                                        },
+                        actions_mapper=AvailableActionMap({
+                            "ActionCode1": AvailableAction(
+                                actionCode="ActionCode1",
+                                actionDescription="Action description",
+                                actionType="ActionType",
+                                urlLink="ActionLink",
+                                urlLabel="Label"
+                            ),
+                            "defaultcomms": AvailableAction(
+                                actionCode="ActionCode1",
+                                actionDescription="Action description",
+                                actionType="ActionType",
+                                urlLink="ActionLink",
+                                urlLabel="Label"
+                            ),
+                        }),
                         iteration_rules=[rule_builder.ICBRedirectRuleFactory.build()]
                     )
                 ],