VED-457: Refactor backend to include e-tag Header

Author: Akol125

backend/src/fhir_controller.py

@@ -197,7 +197,8 @@ def create_immunization(self, aws_event):
                 return self.create_response(400, json.dumps(exp_error))
             else:
                 location = f"{get_service_url()}/Immunization/{resource.id}"
-                return self.create_response(201, None, {"Location": location})
+                version = "1"
+                return self.create_response(201, None, {"Location": location, "E-Tag": version})
         except ValidationError as error:
             return self.create_response(400, error.to_operation_outcome())
         except IdentifierDuplicationError as duplicate:
@@ -276,11 +277,12 @@ def update_immunization(self, aws_event):
         # Check vaccine type permissions on the existing record - end
 
         existing_resource_version = int(existing_record["Version"])
+
         try:
             # Validate if the imms resource to be updated is a logically deleted resource - start
             if existing_record["DeletedAt"] == True:
 
-                outcome, resource = self.fhir_service.reinstate_immunization(
+                outcome, resource, updated_version = self.fhir_service.reinstate_immunization(
                     imms_id, imms, existing_resource_version, imms_vax_type_perms, supplier_system)
             # Validate if the imms resource to be updated is a logically deleted resource-end
             else:
@@ -338,7 +340,7 @@ def update_immunization(self, aws_event):
                         supplier_system
                     )
                 else:
-                    outcome, resource = self.fhir_service.update_immunization(
+                    outcome, resource, updated_version = self.fhir_service.update_immunization(
                         imms_id,
                         imms,
                         existing_resource_version,
@@ -358,7 +360,7 @@ def update_immunization(self, aws_event):
                 )
                 return self.create_response(400, json.dumps(exp_error))
             if outcome == UpdateOutcome.UPDATE:
-                return self.create_response(200)
+                return self.create_response(200, {"E-Tag": updated_version}) #include e-tag here, is it not included in the response resource 
         except ValidationError as error:
             return self.create_response(400, error.to_operation_outcome())
         except IdentifierDuplicationError as duplicate:
@@ -667,5 +669,5 @@ def create_response(status_code, body=None, headers=None):
     def _identify_supplier_system(aws_event):
         supplier_system = aws_event["headers"]["SupplierSystem"]
         if not supplier_system:
-            return self.create_response(403, unauthorized.to_operation_outcome())
+            raise UnauthorizedError("SupplierSystem header is missing")
         return supplier_system

backend/src/fhir_repository.py

@@ -301,6 +301,7 @@ def _perform_dynamo_update(
         update_reinstated: bool,
     ) -> dict:
         try:
+            updated_version = existing_resource_version + 1
             condition_expression = Attr("PK").eq(attr.pk) & (
                 Attr("DeletedAt").exists()
                 if deleted_at_required
@@ -313,7 +314,7 @@ def _perform_dynamo_update(
                     ":patient_sk": attr.patient_sk,
                     ":imms_resource_val": json.dumps(attr.resource, use_decimal=True),
                     ":operation": "UPDATE",
-                    ":version": existing_resource_version + 1,
+                    ":version": updated_version,
                     ":supplier_system": supplier_system,
                     ":respawn": "reinstated",
                 }
@@ -324,7 +325,7 @@ def _perform_dynamo_update(
                     ":patient_sk": attr.patient_sk,
                     ":imms_resource_val": json.dumps(attr.resource, use_decimal=True),
                     ":operation": "UPDATE",
-                    ":version": existing_resource_version + 1,
+                    ":version": updated_version,
                     ":supplier_system": supplier_system,
                 }
 
@@ -338,7 +339,7 @@ def _perform_dynamo_update(
                 ReturnValues="ALL_NEW",
                 ConditionExpression=condition_expression,
             )
-            return self._handle_dynamo_response(response)
+            return self._handle_dynamo_response(response), updated_version
         except botocore.exceptions.ClientError as error:
             # Either resource didn't exist or it has already been deleted. See ConditionExpression in the request
             if error.response["Error"]["Code"] == "ConditionalCheckFailedException":

backend/src/fhir_service.py

@@ -142,7 +142,7 @@ def update_immunization(
         patient = self._validate_patient(immunization)
         if "diagnostics" in patient:
             return (None, patient)
-        imms = self.immunization_repo.update_immunization(
+        imms, updated_version = self.immunization_repo.update_immunization(
             imms_id,
             immunization,
             patient,
@@ -151,7 +151,7 @@ def update_immunization(
             supplier_system
         )
 
-        return UpdateOutcome.UPDATE, Immunization.parse_obj(imms)
+        return UpdateOutcome.UPDATE, Immunization.parse_obj(imms), updated_version
 
     def reinstate_immunization(
         self,

backend/tests/test_fhir_controller.py

@@ -1051,7 +1051,7 @@ def test_update_immunization(self,mock_get_permissions):
             "body": imms,
             "pathParameters": {"id": imms_id},
         }
-        self.service.update_immunization.return_value = UpdateOutcome.UPDATE, "value doesn't matter"
+        self.service.update_immunization.return_value = UpdateOutcome.UPDATE, "value doesn't matter", 2
         self.service.get_immunization_by_id_all.return_value = {
             "resource": "new_value",
             "Version": 1,
@@ -1066,7 +1066,7 @@ def test_update_immunization(self,mock_get_permissions):
         )
         mock_get_permissions.assert_called_once_with("Test")
         self.assertEqual(response["statusCode"], 200)
-        self.assertTrue("body" not in response)
+        self.assertEqual(json.loads(response["body"]), {"E-Tag": 2})
 
     @patch("fhir_controller.get_supplier_permissions")
     def test_update_immunization_etag_missing(self, mock_get_supplier_permissions):
@@ -1247,7 +1247,7 @@ def test_update_deletedat_immunization_with_version(self, mock_get_supplier_perm
             "body": imms,
             "pathParameters": {"id": imms_id},
         }
-        self.service.reinstate_immunization.return_value = UpdateOutcome.UPDATE, "value doesn't matter"
+        self.service.reinstate_immunization.return_value = UpdateOutcome.UPDATE, {}, 2
         self.service.get_immunization_by_id_all.return_value = {
             "resource": "new_value",
             "Version": 1,
@@ -1261,7 +1261,7 @@ def test_update_deletedat_immunization_with_version(self, mock_get_supplier_perm
             imms_id, json.loads(imms), 1, ["COVID19.CRUDS"], "Test"
         )
         self.assertEqual(response["statusCode"], 200)
-        self.assertTrue("body" not in response)
+        self.assertEqual(json.loads(response["body"]), {"E-Tag": 2})
 
     @patch("fhir_controller.get_supplier_permissions")
     def test_update_deletedat_immunization_without_version(self, mock_get_supplier_permissions):
@@ -1271,11 +1271,11 @@ def test_update_deletedat_immunization_without_version(self, mock_get_supplier_p
         imms = '{"id": "valid-id"}'
         imms_id = "valid-id"
         aws_event = {
-            "headers": {"SupplierSystem": "Test"},
+            "headers": {"SupplierSystem": "Test", "E-tag":1},
             "body": imms,
             "pathParameters": {"id": imms_id},
         }
-        self.service.reinstate_immunization.return_value = UpdateOutcome.UPDATE, "value doesn't matter"
+        self.service.reinstate_immunization.return_value = UpdateOutcome.UPDATE, {}, 2
         self.service.get_immunization_by_id_all.return_value = {
             "resource": "new_value",
             "Version": 1,
@@ -1290,7 +1290,7 @@ def test_update_deletedat_immunization_without_version(self, mock_get_supplier_p
         )
         mock_get_supplier_permissions.assert_called_once_with("Test")
         self.assertEqual(response["statusCode"], 200)
-        self.assertTrue("body" not in response)
+        self.assertEqual(json.loads(response["body"]), {"E-Tag": 2})
 
     @patch("fhir_controller.get_supplier_permissions")
     def test_update_record_exists(self, mock_get_supplier_permissions):
@@ -1376,7 +1376,7 @@ def test_validation_superseded_number_to_give_bad_request_for_update_immunizatio
         update_result = {
             "diagnostics": "Validation errors: contained[?(@.resourceType=='Patient')].identifier[0].value does not exists"
         }
-        self.service.update_immunization.return_value = None, update_result
+        self.service.update_immunization.return_value = None, update_result, 2
         req_imms = '{"id": "valid-id"}'
         path_id = "valid-id"
         aws_event = {
@@ -1396,7 +1396,7 @@ def test_validation_superseded_number_to_give_bad_request_for_update_immunizatio
 
         self.assertEqual(response["statusCode"], 400)
         body = json.loads(response["body"])
-        self.assertEqual(body["resourceType"], "OperationOutcome")
+        self.assertEqual(body["resourceType"], "OperationOutcome", 2)
 
     @patch("fhir_controller.get_supplier_permissions")
     def test_validation_identifier_to_give_bad_request_for_update_immunization(self, mock_get_supplier_permissions):

backend/tests/test_fhir_repository.py

@@ -405,7 +405,7 @@ def test_update1(self):
             mock_time.return_value = now_epoch
             # When
 
-            act_resource = self.repository.update_immunization(
+            act_resource, updated_version = self.repository.update_immunization(
                 imms_id, imms, self.patient, 1, ["COVID19.CRUD"], "Test"
             )
 
@@ -773,10 +773,11 @@ def run_update_immunization_test(self, imms_id, imms, resource, updated_dose_qua
         now_epoch = 123456
         with patch("time.time") as mock_time:
             mock_time.return_value = now_epoch
-            act_resource = self.repository.update_immunization(
+            act_resource, act_version = self.repository.update_immunization(
                 imms_id, imms, self.patient, 1, ["COVID19.CRUD"], "Test"
             )
         self.assertDictEqual(act_resource, resource)
+        self.assertEqual(act_version, 2)
 
         update_exp = (
             "SET UpdatedAt = :timestamp, PatientPK = :patient_pk, "

backend/tests/test_fhir_service.py

@@ -492,7 +492,7 @@ def test_update_immunization(self):
         """it should update Immunization and validate NHS number"""
         imms_id = "an-id"
         self.imms_repo.update_immunization.return_value = (
-            create_covid_19_immunization_dict(imms_id)
+            create_covid_19_immunization_dict(imms_id), 2
         )
         pds_patient = {"identifier": [{"system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9990548609"}]}
         self.fhir_service.pds_service.get_patient_details.return_value = pds_patient
@@ -501,7 +501,7 @@ def test_update_immunization(self):
         req_imms = create_covid_19_immunization_dict(imms_id, nhs_number)
 
         # When
-        outcome, _ = self.fhir_service.update_immunization(imms_id, req_imms, 1, ["COVID19.CRUD"], "Test")
+        outcome, _, _ = self.fhir_service.update_immunization(imms_id, req_imms, 1, ["COVID19.CRUD"], "Test")
 
         # Then
         self.assertEqual(outcome, UpdateOutcome.UPDATE)
@@ -511,7 +511,7 @@ def test_update_immunization(self):
     def test_id_not_present(self):
         """it should populate id in the message if it is not present"""
         req_imms_id = "an-id"
-        self.imms_repo.update_immunization.return_value = create_covid_19_immunization_dict(req_imms_id)
+        self.imms_repo.update_immunization.return_value = create_covid_19_immunization_dict(req_imms_id), 2
         self.fhir_service.pds_service.get_patient_details.return_value = {"identifier": [{"system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9990548609"}]}
 
         req_imms = create_covid_19_immunization_dict("we-will-remove-this-id")

backend/tests/utils/test_utils_for_batch.py

@@ -148,8 +148,8 @@ class MockFhirImmsResources:
                         "coding": [
                             {
                                 "system": "http://snomed.info/sct",
-                                "code": "55735004",
-                                "display": "Respiratory syncytial virus infection (disorder)",
+                                "code": "398102009",
+                                "display": "Acute poliomyelitis",
                             }
                         ]
                     }