Update date ignore option

Author: Vox-Ben

gateway-api/src/gateway_api/pds_search.py

@@ -103,6 +103,7 @@ def __init__(
         base_url: str = SANDBOX_URL,
         nhsd_session_urid: str | None = None,
         timeout: int = 10,
+        ignore_dates: bool = False,
     ) -> None:
         """
         Create a PDS client.
@@ -113,12 +114,15 @@ def __init__(
             :attr:`INT_URL`, :attr:`PROD_URL`). Trailing slashes are stripped.
         :param nhsd_session_urid: Optional ``NHSD-Session-URID`` header value.
         :param timeout: Default timeout in seconds for HTTP calls.
+        :param ignore_dates: If ``True`` just get the most recent name or GP record,
+            ignoring the date ranges.
         """
         self.auth_token = auth_token
         self.end_user_org_ods = end_user_org_ods
         self.base_url = base_url.rstrip("/")
         self.nhsd_session_urid = nhsd_session_urid
         self.timeout = timeout
+        self.ignore_dates = ignore_dates
 
     def _build_headers(
         self,
@@ -134,12 +138,15 @@ def _build_headers(
         :return: Dictionary of HTTP headers for the outbound request.
         """
         headers = {
-            "Authorization": f"Bearer {self.auth_token}",
             "X-Request-ID": request_id or str(uuid.uuid4()),
             "NHSD-End-User-Organisation-ODS": self.end_user_org_ods,
             "Accept": "application/fhir+json",
         }
 
+        # Trying to pass an auth token to the sandbox makes PDS unhappy
+        if self.base_url != self.SANDBOX_URL:
+            headers["Authorization"] = f"Bearer {self.auth_token}"
+
         # NHSD-Session-URID is required in some flows; include only if configured.
         if self.nhsd_session_urid:
             headers["NHSD-Session-URID"] = self.nhsd_session_urid
@@ -200,8 +207,7 @@ def search_patient_by_nhs_number(
 
     # --------------- internal helpers for result extraction -----------------
 
-    @staticmethod
-    def _get_gp_ods_code(general_practitioners: ResultList) -> str | None:
+    def _get_gp_ods_code(self, general_practitioners: ResultList) -> str | None:
         """
         Extract the current GP ODS code from ``Patient.generalPractitioner``.
 
@@ -221,7 +227,7 @@ def _get_gp_ods_code(general_practitioners: ResultList) -> str | None:
         if len(general_practitioners) == 0:
             return None
 
-        gp = find_current_gp(general_practitioners)
+        gp = self.find_current_gp(general_practitioners)
         if gp is None:
             return None
 
@@ -272,7 +278,7 @@ def _extract_single_search_result(
 
         # Select current name record and extract names.
         names = cast("ResultList", patient.get("name", []))
-        current_name = find_current_name_record(names)
+        current_name = self.find_current_name_record(names)
         if current_name is None:
             raise RuntimeError("PDS patient has no current name record")
 
@@ -291,79 +297,88 @@ def _extract_single_search_result(
             gp_ods_code=gp_ods_code,
         )
 
+    def find_current_gp(
+        self, records: ResultList, today: date | None = None
+    ) -> ResultStructureDict | None:
+        """
+        Select the current record from a ``generalPractitioner`` list.
 
-def find_current_gp(
-    records: ResultList, today: date | None = None
-) -> ResultStructureDict | None:
-    """
-    Select the current record from a ``generalPractitioner`` list.
+        A record is "current" if its ``identifier.period`` covers ``today`` (inclusive):
 
-    A record is "current" if its ``identifier.period`` covers ``today`` (inclusive):
+        ``start <= today <= end``
 
-    ``start <= today <= end``
+        Or else if self.ignore_dates is True, the last record in the list is returned.
 
-    The list may be in any of the following states:
+        The list may be in any of the following states:
 
-    * empty
-    * contains one or more records, none current
-    * contains one or more records, exactly one current
+        * empty
+        * contains one or more records, none current
+        * contains one or more records, exactly one current
 
-    :param records: List of ``generalPractitioner`` records.
-    :param today: Optional override date, intended for deterministic tests.
-        If not supplied, the current UTC date is used.
-    :return: The first record whose ``identifier.period`` covers ``today``, or ``None``
-        if no record is current.
-    :raises KeyError: If required keys are missing for a record being evaluated.
-    :raises ValueError: If ``start`` or ``end`` are not valid ISO date strings.
-    """
-    if today is None:
-        today = datetime.now(timezone.utc).date()
+        :param records: List of ``generalPractitioner`` records.
+        :param today: Optional override date, intended for deterministic tests.
+            If not supplied, the current UTC date is used.
+        :return: The first record whose ``identifier.period`` covers ``today``, or
+            ``None`` if no record is current.
+        :raises KeyError: If required keys are missing for a record being evaluated.
+        :raises ValueError: If ``start`` or ``end`` are not valid ISO date strings.
+        """
+        if today is None:
+            today = datetime.now(timezone.utc).date()
 
-    for record in records:
-        identifier = cast("ResultStructureDict", record["identifier"])
-        periods = cast("dict[str, str]", identifier["period"])
-        start_str = periods["start"]
-        end_str = periods["end"]
+        if self.ignore_dates:
+            return records[-1]
 
-        start = date.fromisoformat(start_str)
-        end = date.fromisoformat(end_str)
+        for record in records:
+            identifier = cast("ResultStructureDict", record["identifier"])
+            periods = cast("dict[str, str]", identifier["period"])
+            start_str = periods["start"]
+            end_str = periods["end"]
 
-        if start <= today <= end:
-            return record
+            start = date.fromisoformat(start_str)
+            end = date.fromisoformat(end_str)
 
-    return None
+            if start <= today <= end:
+                return record
 
+        return None
 
-def find_current_name_record(
-    records: ResultList, today: date | None = None
-) -> ResultStructureDict | None:
-    """
-    Select the current record from a ``Patient.name`` list.
+    def find_current_name_record(
+        self, records: ResultList, today: date | None = None
+    ) -> ResultStructureDict | None:
+        """
+        Select the current record from a ``Patient.name`` list.
 
-    A record is "current" if its ``period`` covers ``today`` (inclusive):
+        A record is "current" if its ``period`` covers ``today`` (inclusive):
 
-    ``start <= today <= end``
+        ``start <= today <= end``
 
-    :param records: List of ``Patient.name`` records.
-    :param today: Optional override date, intended for deterministic tests.
-        If not supplied, the current UTC date is used.
-    :return: The first name record whose ``period`` covers ``today``, or ``None`` if no
-        record is current.
-    :raises KeyError: If required keys (``period.start`` / ``period.end``) are missing.
-    :raises ValueError: If ``start`` or ``end`` are not valid ISO date strings.
-    """
-    if today is None:
-        today = datetime.now(timezone.utc).date()
+        Or else if self.ignore_dates is True, the last record in the list is returned.
+
+        :param records: List of ``Patient.name`` records.
+        :param today: Optional override date, intended for deterministic tests.
+            If not supplied, the current UTC date is used.
+        :return: The first name record whose ``period`` covers ``today``, or ``None`` if
+            no record is current.
+        :raises KeyError: If required keys (``period.start`` / ``period.end``) are
+            missing.
+        :raises ValueError: If ``start`` or ``end`` are not valid ISO date strings.
+        """
+        if today is None:
+            today = datetime.now(timezone.utc).date()
+
+        if self.ignore_dates:
+            return records[-1]
 
-    for record in records:
-        periods = cast("dict[str, str]", record["period"])
-        start_str = periods["start"]
-        end_str = periods["end"]
+        for record in records:
+            periods = cast("dict[str, str]", record["period"])
+            start_str = periods["start"]
+            end_str = periods["end"]
 
-        start = date.fromisoformat(start_str)
-        end = date.fromisoformat(end_str)
+            start = date.fromisoformat(start_str)
+            end = date.fromisoformat(end_str)
 
-        if start <= today <= end:
-            return record
+            if start <= today <= end:
+                return record
 
-    return None
+        return None

gateway-api/src/gateway_api/test_pds_search.py

@@ -18,8 +18,6 @@
     ExternalServiceError,
     PdsClient,
     ResultList,
-    find_current_gp,
-    find_current_name_record,
 )
 
 
@@ -449,6 +447,9 @@ def test_find_current_gp_with_today_override() -> None:
 
     :return: ``None``.
     """
+    pds = PdsClient("test-token", "A12345")
+    pds_ignore_dates = PdsClient("test-token", "A12345", ignore_dates=True)
+
     records = cast(
         "ResultList",
         [
@@ -467,9 +468,10 @@ def test_find_current_gp_with_today_override() -> None:
         ],
     )
 
-    assert find_current_gp(records, today=date(2020, 6, 1)) == records[0]
-    assert find_current_gp(records, today=date(2021, 6, 1)) == records[1]
-    assert find_current_gp(records, today=date(2019, 6, 1)) is None
+    assert pds.find_current_gp(records, today=date(2020, 6, 1)) == records[0]
+    assert pds.find_current_gp(records, today=date(2021, 6, 1)) == records[1]
+    assert pds.find_current_gp(records, today=date(2019, 6, 1)) is None
+    assert pds_ignore_dates.find_current_gp(records, today=date(2019, 6, 1)) is not None
 
 
 def test_find_current_name_record_no_current_name() -> None:
@@ -479,6 +481,9 @@ def test_find_current_name_record_no_current_name() -> None:
 
     :return: ``None``.
     """
+    pds = PdsClient("test-token", "A12345")
+    pds_ignore_date = PdsClient("test-token", "A12345", ignore_dates=True)
+
     records = cast(
         "ResultList",
         [
@@ -497,7 +502,8 @@ def test_find_current_name_record_no_current_name() -> None:
         ],
     )
 
-    assert find_current_name_record(records) is None
+    assert pds.find_current_name_record(records) is None
+    assert pds_ignore_date.find_current_name_record(records) is not None
 
 
 def test_extract_single_search_result_invalid_body_raises_runtime_error() -> None: