[NRL-1631] WIP - Add logs for create/upsert of unexpected dupe pointers

Author: mattdean3-nhs

api/producer/createDocumentReference/create_document_reference.py

@@ -4,6 +4,7 @@
 from nrlf.core.constants import (
     PERMISSION_AUDIT_DATES_FROM_PAYLOAD,
     PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL,
+    TYPES_WITH_MULTIPLES,
 )
 from nrlf.core.decorators import request_handler
 from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository
@@ -255,6 +256,23 @@ def handler(
         logger.log(LogReference.PROCREATE999)
         return NRLResponse.RESOURCE_SUPERSEDED(resource_id=result.resource.id)
 
+    pointer_type = core_model.type
+    if pointer_type not in TYPES_WITH_MULTIPLES:
+        patient_number = core_model.nhs_number
+        pointer_custodian = core_model.custodian
+        existing_pointers_count = repository.count_by_nhs_number(
+            patient_number, [pointer_type]
+        )
+
+        if existing_pointers_count > 0:
+            logger.log(
+                LogReference.PROCREATE012,
+                pointer_type=pointer_type,
+                patient_number=patient_number,
+                existing_pointers_count=existing_pointers_count,
+                pointer_custodian=pointer_custodian,
+            )
+
     logger.log(LogReference.PROCREATE009, pointer_id=result.resource.id)
     repository.create(core_model)
     logger.log(LogReference.PROCREATE999)

api/producer/upsertDocumentReference/tests/test_upsert_document_reference.py

@@ -1699,3 +1699,52 @@ def test__set_create_time_fields_when_no_date_but_perms():
         },
         "date": test_time,
     }
+
+
+@mock_aws
+@mock_repository
+def test_upsert_logs_for_unexpected_multi_pointer(
+    repository: DocumentPointerRepository,
+):
+    doc_ref = load_document_reference("Y05868-736253002-Valid")
+    doc_pointer = DocumentPointer.from_document_reference(doc_ref)
+    repository.create(doc_pointer)
+
+    event = create_test_api_gateway_event(
+        headers=create_headers(),
+        body=doc_ref.model_dump_json(exclude_none=True),
+    )
+
+    result = handler(event, create_mock_context())
+    body = result.pop("body")
+
+    assert result == {
+        "statusCode": "200",
+        "headers": {
+            "Location": "/producer/FHIR/R4/DocumentReference/Y05868-99999-99999-999999",
+            **default_response_headers(),
+        },
+        "isBase64Encoded": False,
+    }
+
+    parsed_body = json.loads(body)
+
+    assert parsed_body == {
+        "resourceType": "OperationOutcome",
+        "issue": [
+            {
+                "severity": "information",
+                "code": "informational",
+                "details": {
+                    "coding": [
+                        {
+                            "code": "RESOURCE_UPDATED",
+                            "display": "Resource updated",
+                            "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode",
+                        }
+                    ]
+                },
+                "diagnostics": "The document has been updated",
+            }
+        ],
+    }

api/producer/upsertDocumentReference/upsert_document_reference.py

@@ -2,6 +2,7 @@
 from nrlf.core.constants import (
     PERMISSION_AUDIT_DATES_FROM_PAYLOAD,
     PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL,
+    TYPES_WITH_MULTIPLES,
 )
 from nrlf.core.decorators import request_handler
 from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository
@@ -262,6 +263,23 @@ def handler(
         logger.log(LogReference.PROUPSERT999)
         return NRLResponse.RESOURCE_SUPERSEDED(resource_id=saved_model.id)
 
+    pointer_type = core_model.type
+    if pointer_type not in TYPES_WITH_MULTIPLES:
+        patient_number = core_model.nhs_number
+        pointer_custodian = core_model.custodian
+        existing_pointers_count = repository.count_by_nhs_number(
+            patient_number, [pointer_type]
+        )
+
+        if existing_pointers_count > 0:
+            logger.log(
+                LogReference.PROCREATE012,
+                pointer_type=pointer_type,
+                patient_number=patient_number,
+                existing_pointers_count=existing_pointers_count,
+                pointer_custodian=pointer_custodian,
+            )
+
     logger.log(LogReference.PROUPSERT009, pointer_id=result.resource.id)
     saved_model = repository.create(core_model)
     logger.log(LogReference.PROUPSERT999)

layer/nrlf/core/constants.py

@@ -200,6 +200,14 @@ def coding_value(self):
     PointerTypes.SHARED_CARE_RECORD.value: Categories.RECORD_HEADINGS.value,
 }
 
+#
+# Pointer types that can have multiple pointers for a single patient
+TYPES_WITH_MULTIPLES = [
+    PointerTypes.MRA_UPPER_LIMB_ARTERY.value,
+    PointerTypes.MRI_AXILLA_BOTH.value,
+    PointerTypes.APPOINTMENT.value,
+]
+
 PRACTICE_SETTING_VALUE_SET_URL = (
     "https://fhir.nhs.uk/England/ValueSet/England-PracticeSetting"
 )

layer/nrlf/core/log_references.py

@@ -270,6 +270,9 @@ class LogReference(Enum):
     PROCREATE011 = _Reference(
         "INFO", "Preserved .date field when creating new document reference"
     )
+    PROCREATE012 = _Reference(
+        "WARN", "Existing pointers found  for patient during create operation"
+    )
     PROCREATE999 = _Reference(
         "INFO", "Successfully completed producer createDocumentReference"
     )
@@ -329,6 +332,9 @@ class LogReference(Enum):
     PROUPSERT011 = _Reference(
         "INFO", "Preserved .date field when creating new document reference for upsert"
     )
+    PROUPSERT012 = _Reference(
+        "WARN", "Existing pointers found for patient during upsert operation"
+    )
     PROUPSERT999 = _Reference(
         "INFO", "Successfully completed producer upsertDocumentReference"
     )

layer/nrlf/core/logger.py

@@ -1,5 +1,6 @@
 import os
 from datetime import datetime
+from typing import Any
 
 from aws_lambda_powertools import Logger as PowertoolsLogger
 from aws_lambda_powertools.logging.formatter import LambdaPowertoolsFormatter
@@ -9,7 +10,7 @@
 
 
 class SplunkFormatter(LambdaPowertoolsFormatter):
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
         self.splunk_index = os.getenv("SPLUNK_INDEX", "aws_recordlocator_dev")
 
@@ -30,7 +31,7 @@ def serialize(self, log: LogRecord) -> str:
 
 
 class Logger(PowertoolsLogger):
-    def log(self, code: LogReference, **kwargs):
+    def log(self, code: LogReference, **kwargs: Any) -> None:
         kwargs["log_reference"] = code.name
         match code.value.level:
             case "DEBUG":
@@ -45,6 +46,11 @@ def log(self, code: LogReference, **kwargs):
                 self.critical(code.value.message, stacklevel=3, **kwargs)
             case "EXCEPTION":
                 self.exception(code.value.message, **kwargs)
+            case _:
+                self.warning(
+                    f"Unhandled log level: {code.value.level} - {code.value.message}",
+                    **kwargs,
+                )
 
 
 logger = Logger(logger_formatter=SplunkFormatter())

layer/nrlf/tests/events.py

@@ -1,5 +1,5 @@
 import json
-from typing import Dict, List, Optional
+from typing import Any, Dict, List, Optional
 from unittest.mock import Mock
 
 
@@ -46,7 +46,7 @@ def create_test_api_gateway_event(
     query_string_parameters: Optional[Dict[str, str]] = None,
     path_parameters: Optional[Dict[str, str]] = None,
     body: Optional[str] = None,
-):
+) -> Dict[str, Any]:
     return {
         "resource": "/",
         "path": "/",