Merge pull request #632 from NHSDigital/feature/eema1-NRL-703-ignoreSupersedeDeleteSyncPerm

eesa456 · web-flow · commit fff7efed77bd · 2024-05-30T21:10:49.000+01:00
NRL-703 add perm check to upsert
diff --git a/api/producer/upsertDocumentReference/tests/test_upsert_document_reference.py b/api/producer/upsertDocumentReference/tests/test_upsert_document_reference.py
@@ -8,6 +8,7 @@
     _set_upsert_time_fields,
     handler,
 )
+from nrlf.core.constants import PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL
 from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository
 from nrlf.producer.fhir.r4.model import (
     DocumentReferenceRelatesTo,
@@ -603,6 +604,63 @@ def test_create_document_reference_invalid_relatesto_not_exists(repository):
     }
 
 
+@mock_aws
+@mock_repository
+def test_create_document_reference_invalid_relatesto_not_exists_still_creates_with_ignore_perm(
+    repository,
+):
+    doc_ref = load_document_reference("Y05868-736253002-Valid")
+    doc_ref.relatesTo = [
+        DocumentReferenceRelatesTo(
+            code="transforms",
+            target=Reference(
+                reference=None,
+                identifier=Identifier(value="Y05868-99999-99999-999999"),
+            ),
+        )
+    ]
+
+    event = create_test_api_gateway_event(
+        headers=create_headers(
+            nrl_permissions=[PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL]
+        ),
+        body=doc_ref.json(exclude_none=True),
+    )
+
+    result = handler(event, create_mock_context())
+    body = result.pop("body")
+
+    assert result == {
+        "statusCode": "201",
+        "headers": {
+            "Location": "/nrl-producer-api/FHIR/R4/DocumentReference/Y05868-99999-99999-999999"
+        },
+        "isBase64Encoded": False,
+    }
+
+    parsed_body = json.loads(body)
+
+    assert parsed_body == {
+        "resourceType": "OperationOutcome",
+        "issue": [
+            {
+                "severity": "information",
+                "code": "informational",
+                "details": {
+                    "coding": [
+                        {
+                            "code": "RESOURCE_CREATED",
+                            "display": "Resource created",
+                            "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode",
+                        }
+                    ]
+                },
+                "diagnostics": "The document has been created",
+            }
+        ],
+    }
+
+
 @mock_aws
 @mock_repository
 def test_create_document_reference_invalid_relatesto_nhs_number(
diff --git a/api/producer/upsertDocumentReference/upsert_document_reference.py b/api/producer/upsertDocumentReference/upsert_document_reference.py
@@ -1,4 +1,7 @@
-from nrlf.core.constants import PERMISSION_AUDIT_DATES_FROM_PAYLOAD
+from nrlf.core.constants import (
+    PERMISSION_AUDIT_DATES_FROM_PAYLOAD,
+    PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL,
+)
 from nrlf.core.decorators import request_handler
 from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository
 from nrlf.core.logger import LogReference, logger
@@ -105,6 +108,9 @@ def handler(
 
     if result.resource.relatesTo:
         logger.log(LogReference.PROUPSERT006, relatesTo=result.resource.relatesTo)
+        can_ignore_delete_fail = (
+            PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL in metadata.nrl_permissions
+        )
 
         for idx, relates_to in enumerate(result.resource.relatesTo):
             if not (identifier := getattr(relates_to.target.identifier, "value", None)):
@@ -125,27 +131,33 @@ def handler(
                     diagnostics="The relatesTo target identifier value does not include the expected ODS code for this organisation",
                     expression=f"relatesTo[{idx}].target.identifier.value",
                 )
-
-            if not (existing_pointer := repository.get_by_id(identifier)):
-                logger.log(LogReference.PROUPSERT007c, related_identifier=identifier)
-                return SpineErrorResponse.BAD_REQUEST(
-                    diagnostics="The relatesTo target document does not exist",
-                    expression=f"relatesTo[{idx}].target.identifier.value",
-                )
-
-            if existing_pointer.nhs_number != core_model.nhs_number:
-                logger.log(LogReference.PROUPSERT007d, related_identifier=identifier)
-                return SpineErrorResponse.BAD_REQUEST(
-                    diagnostics="The relatesTo target document NHS number does not match the NHS number in the request",
-                    expression=f"relatesTo[{idx}].target.identifier.value",
-                )
-
-            if existing_pointer.type != core_model.type:
-                logger.log(LogReference.PROUPSERT007e, related_identifier=identifier)
-                return SpineErrorResponse.BAD_REQUEST(
-                    diagnostics="The relatesTo target document type does not match the type in the request",
-                    expression=f"relatesTo[{idx}].target.identifier.value",
-                )
+            if not can_ignore_delete_fail:
+                if not (existing_pointer := repository.get_by_id(identifier)):
+                    logger.log(
+                        LogReference.PROCREATE007c, related_identifier=identifier
+                    )
+                    return SpineErrorResponse.BAD_REQUEST(
+                        diagnostics="The relatesTo target document does not exist",
+                        expression=f"relatesTo[{idx}].target.identifier.value",
+                    )
+
+                if existing_pointer.nhs_number != core_model.nhs_number:
+                    logger.log(
+                        LogReference.PROUPSERT007d, related_identifier=identifier
+                    )
+                    return SpineErrorResponse.BAD_REQUEST(
+                        diagnostics="The relatesTo target document NHS number does not match the NHS number in the request",
+                        expression=f"relatesTo[{idx}].target.identifier.value",
+                    )
+
+                if existing_pointer.type != core_model.type:
+                    logger.log(
+                        LogReference.PROUPSERT007e, related_identifier=identifier
+                    )
+                    return SpineErrorResponse.BAD_REQUEST(
+                        diagnostics="The relatesTo target document type does not match the type in the request",
+                        expression=f"relatesTo[{idx}].target.identifier.value",
+                    )
 
             if relates_to.code == "replaces":
                 logger.log(
@@ -161,7 +173,9 @@ def handler(
             pointer_id=result.resource.id,
             ids_to_delete=ids_to_delete,
         )
-        saved_model = repository.supersede(core_model, ids_to_delete)
+        saved_model = repository.supersede(
+            core_model, ids_to_delete, can_ignore_delete_fail
+        )
         logger.log(LogReference.PROUPSERT999)
         return NRLResponse.RESOURCE_SUPERSEDED(resource_id=saved_model.id)
 
diff --git a/layer/nrlf/core/dynamodb/repository.py b/layer/nrlf/core/dynamodb/repository.py
@@ -374,12 +374,16 @@ def save(self, item: DocumentPointer) -> DocumentPointer:
         return self.update(item)
 
     def supersede(
-        self, item: DocumentPointer, ids_to_delete: List[str]
+        self,
+        item: DocumentPointer,
+        ids_to_delete: List[str],
+        can_ignore_delete_fail: bool = False,
     ) -> DocumentPointer:
         """ """
         saved_item = self.create(item)
+
         for id_ in ids_to_delete:
-            self.delete_by_id(id_)
+            self.delete_by_id(id_, can_ignore_delete_fail)
 
         return saved_item
 
@@ -411,12 +415,22 @@ def delete(self, item: DocumentPointer) -> None:
                 details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"),
             ) from exc
 
-    def delete_by_id(self, id_: str):
+    def delete_by_id(self, id_: str, can_ignore_delete_fail: bool = False):
         """ """
         producer_id, document_id = id_.split("-", 1)
         ods_code_parts = producer_id.split(".")
         partition_key = "D#" + "#".join([*ods_code_parts, document_id])
-        self.table.delete_item(Key={"pk": partition_key, "sk": partition_key})
+        try:
+            self.table.delete_item(Key={"pk": partition_key, "sk": partition_key})
+        except ClientError as exc:
+            if can_ignore_delete_fail:
+                logger.log(
+                    LogReference.REPOSITORY026a,
+                    exc_info=sys.exc_info(),
+                    stacklevel=5,
+                    error=str(exc),
+                )
+                return
 
     def _query(self, **kwargs) -> Iterator[DocumentPointer]:
         """
diff --git a/layer/nrlf/core/log_references.py b/layer/nrlf/core/log_references.py
@@ -101,6 +101,9 @@ class LogReference(Enum):
 
     REPOSITORY025 = _Reference("DEBUG", "Deleting resource from DynamoDB")
     REPOSITORY026 = _Reference("EXCEPTION", "Failed to delete resource from DynamoDB")
+    REPOSITORY026a = _Reference(
+        "EXCEPTION", "Ignoring failure to delete resource from DynamoDB"
+    )
     REPOSITORY027 = _Reference("INFO", "Successfully deleted item from DynamoDB")
     REPOSITORY028 = _Reference("INFO", "Received page of search results")
     REPOSITORY028a = _Reference("DEBUG", "Received page of search results with result")
