Merge remote branch into VED-789-Schema-Validation

Author: Akol125

.github/dependabot.yml

@@ -8,7 +8,7 @@ updates:
   - package-ecosystem: "docker"
     directories:
       - "/lambdas/ack_backend"
-      - "/delta_backend"
+      - "/lambdas/delta_backend"
       - "/filenameprocessor"
       - "/infrastructure/grafana/non-prod/docker"
       - "/mesh_processor"
@@ -50,13 +50,13 @@ updates:
       - "/"
       - "/backend"
       - "/batch_processor_filter"
-      - "/delta_backend"
       - "/tests/e2e"
       - "/tests/e2e_batch"
       - "/filenameprocessor"
       - "/mesh_processor"
       - "/recordprocessor"
       - "/lambdas/ack_backend"
+      - "/lambdas/delta_backend"
       - "/lambdas/redis_sync"
       - "/lambdas/id_sync"
       - "/lambdas/mns_subscription"

.github/workflows/quality-checks.yml

@@ -19,7 +19,7 @@ jobs:
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
 
-      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444
+      - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903
         with:
           node-version: "23.11.0"
           cache: "npm"
@@ -140,17 +140,6 @@ jobs:
           poetry run coverage run -m unittest discover -p "*batch*.py" || echo "recordforwarder tests failed" >> ../failed_tests.txt
           poetry run coverage xml -o ../recordforwarder-coverage.xml
 
-      - name: Run unittest with coverage-delta
-        working-directory: delta_backend
-        id: delta
-        env:
-          PYTHONPATH: delta_backend/src:delta_backend/tests
-        continue-on-error: true
-        run: |
-          poetry install
-          poetry run coverage run -m unittest discover || echo "delta tests failed" >> ../failed_tests.txt
-          poetry run coverage xml -o ../delta-coverage.xml
-
       - name: Run unittest with coverage-fhir-api
         working-directory: backend
         env:
@@ -182,6 +171,17 @@ jobs:
           poetry run coverage run --source=src -m unittest discover || echo "ack-lambda tests failed" >> ../../failed_tests.txt
           poetry run coverage xml -o ../../ack-lambda-coverage.xml
 
+      - name: Run unittest with coverage-delta
+        working-directory: lambdas/delta_backend
+        id: delta
+        env:
+          PYTHONPATH: ${{ env.LAMBDA_PATH }}/delta_backend/src:${{ env.LAMBDA_PATH }}/delta_backend/tests:${{ env.SHARED_PATH }}/src
+        continue-on-error: true
+        run: |
+          poetry install
+          poetry run coverage run -m unittest discover || echo "delta tests failed" >> ../../failed_tests.txt
+          poetry run coverage xml -o ../../delta-coverage.xml
+
       - name: Run unittest with coverage-mns-subscription
         working-directory: lambdas/mns_subscription
         id: mns_subscription

Makefile

@@ -1,6 +1,6 @@
 SHELL=/usr/bin/env bash -euo pipefail
 
-PYTHON_PROJECT_DIRS_WITH_UNIT_TESTS = backend batch_processor_filter delta_backend filenameprocessor mesh_processor recordprocessor lambdas/ack_backend lambdas/redis_sync lambdas/id_sync lambdas/mns_subscription lambdas/shared
+PYTHON_PROJECT_DIRS_WITH_UNIT_TESTS = backend batch_processor_filter filenameprocessor mesh_processor recordprocessor lambdas/ack_backend lambdas/delta_backend lambdas/redis_sync lambdas/id_sync lambdas/mns_subscription lambdas/shared
 PYTHON_PROJECT_DIRS = tests/e2e tests/e2e_batch quality_checks $(PYTHON_PROJECT_DIRS_WITH_UNIT_TESTS)
 
 .PHONY: install lint format format-check clean publish build-proxy release initialise-all-python-venvs update-all-python-dependencies run-all-python-unit-tests build-all-docker-images

README.md

@@ -130,10 +130,17 @@ Steps:
     ```
 
 7. Install poetry
+
     ```
     pip install poetry
     ```
 
+8. Install pre-commit hooks. Ensure you have installed nodejs at the same version or later as per .tool-versions and
+   then, from the repo root, run:
+    ```
+    npm install
+    ```
+
 ### Setting up a virtual environment with poetry
 
 The steps below must be performed in each Lambda function folder and e2e folder to ensure the environment is correctly configured.

backend/poetry.lock

@@ -4,7 +4,7 @@
 from typing import Optional
 
 
-def create_response(status_code: int, body: Optional[dict | str] = None, headers: Optional[dict] = None):
+def create_response(status_code: int, body: Optional[dict | str] = None, headers: Optional[dict] = None) -> dict:
     """Creates response body as per Lambda -> API Gateway proxy integration"""
     if body is not None:
         if isinstance(body, dict):

backend/src/controller/aws_apig_response_utils.py

@@ -9,6 +9,7 @@
 from controller.aws_apig_response_utils import create_response
 from models.errors import (
     Code,
+    InvalidImmunizationId,
     ResourceNotFoundError,
     Severity,
     UnauthorizedError,
@@ -17,6 +18,7 @@
 )
 
 _CUSTOM_EXCEPTION_TO_STATUS_MAP: dict[Type[Exception], int] = {
+    InvalidImmunizationId: 400,
     UnauthorizedError: 403,
     UnauthorizedVaxError: 403,
     ResourceNotFoundError: 404,

backend/src/controller/fhir_api_exception_handler.py

@@ -19,8 +19,8 @@
 from models.errors import (
     Code,
     IdentifierDuplicationError,
+    InvalidImmunizationId,
     ParameterException,
-    ResourceNotFoundError,
     Severity,
     UnauthorizedError,
     UnauthorizedVaxError,
@@ -96,8 +96,8 @@ def get_immunization_by_identifier(self, aws_event) -> dict:
     def get_immunization_by_id(self, aws_event: APIGatewayProxyEventV1) -> dict:
         imms_id = get_path_parameter(aws_event, "id")
 
-        if id_error := self._validate_id(imms_id):
-            return create_response(400, id_error)
+        if not self._is_valid_immunization_id(imms_id):
+            raise InvalidImmunizationId()
 
         supplier_system = get_supplier_system_header(aws_event)
 
@@ -157,10 +157,20 @@ def update_immunization(self, aws_event):
 
         supplier_system = self._identify_supplier_system(aws_event)
 
-        # Validate the imms id - start
-        if id_error := self._validate_id(imms_id):
-            return create_response(400, json.dumps(id_error))
-        # Validate the imms id - end
+        # Refactor to raise InvalidImmunizationId when working on VED-747
+        if not self._is_valid_immunization_id(imms_id):
+            return create_response(
+                400,
+                json.dumps(
+                    create_operation_outcome(
+                        resource_id=str(uuid.uuid4()),
+                        severity=Severity.error,
+                        code=Code.invalid,
+                        diagnostics="Validation errors: the provided event ID is either missing or not in the expected "
+                        "format.",
+                    )
+                ),
+            )
 
         # Validate the body of the request - start
         try:
@@ -320,31 +330,18 @@ def update_immunization(self, aws_event):
         except UnauthorizedVaxError as unauthorized:
             return create_response(403, unauthorized.to_operation_outcome())
 
-    def delete_immunization(self, aws_event):
-        try:
-            if aws_event.get("headers"):
-                imms_id = aws_event["pathParameters"]["id"]
-            else:
-                raise UnauthorizedError()
-        except UnauthorizedError as unauthorized:
-            return create_response(403, unauthorized.to_operation_outcome())
+    @fhir_api_exception_handler
+    def delete_immunization(self, aws_event: APIGatewayProxyEventV1) -> dict:
+        imms_id = get_path_parameter(aws_event, "id")
 
-        # Validate the imms id
-        if id_error := self._validate_id(imms_id):
-            return create_response(400, json.dumps(id_error))
+        if not self._is_valid_immunization_id(imms_id):
+            raise InvalidImmunizationId()
 
-        supplier_system = self._identify_supplier_system(aws_event)
+        supplier_system = get_supplier_system_header(aws_event)
 
-        try:
-            self.fhir_service.delete_immunization(imms_id, supplier_system)
-            return create_response(204)
+        self.fhir_service.delete_immunization(imms_id, supplier_system)
 
-        except ResourceNotFoundError as not_found:
-            return create_response(404, not_found.to_operation_outcome())
-        except UnhandledResponseError as unhandled_error:
-            return create_response(500, unhandled_error.to_operation_outcome())
-        except UnauthorizedVaxError as unauthorized:
-            return create_response(403, unauthorized.to_operation_outcome())
+        return create_response(204)
 
     def search_immunizations(self, aws_event: APIGatewayProxyEventV1) -> dict:
         try:
@@ -406,17 +403,9 @@ def search_immunizations(self, aws_event: APIGatewayProxyEventV1) -> dict:
             result_json_dict["total"] = 0
         return create_response(200, json.dumps(result_json_dict))
 
-    def _validate_id(self, _id: str) -> Optional[dict]:
-        if not re.match(self.immunization_id_pattern, _id):
-            msg = "Validation errors: the provided event ID is either missing or not in the expected format."
-            return create_operation_outcome(
-                resource_id=str(uuid.uuid4()),
-                severity=Severity.error,
-                code=Code.invalid,
-                diagnostics=msg,
-            )
-
-        return None
+    def _is_valid_immunization_id(self, immunization_id: str) -> bool:
+        """Validates if the given unique Immunization ID is valid."""
+        return False if not re.match(self.immunization_id_pattern, immunization_id) else True
 
     def _validate_identifier_system(self, _id: str, _elements: str) -> Optional[dict]:
         if not _id:

backend/src/controller/fhir_controller.py

@@ -1,13 +1,9 @@
 import argparse
 import logging
 import pprint
-import uuid
 
-from constants import GENERIC_SERVER_ERROR_DIAGNOSTICS_MESSAGE
-from controller.aws_apig_response_utils import create_response
 from controller.fhir_controller import FhirController, make_controller
 from log_structure import function_info
-from models.errors import Code, Severity, create_operation_outcome
 
 logging.basicConfig(level="INFO")
 logger = logging.getLogger()
@@ -19,17 +15,7 @@ def delete_imms_handler(event, _context):
 
 
 def delete_immunization(event, controller: FhirController):
-    try:
-        return controller.delete_immunization(event)
-    except Exception:  # pylint: disable = broad-exception-caught
-        logger.exception("Unhandled exception")
-        exp_error = create_operation_outcome(
-            resource_id=str(uuid.uuid4()),
-            severity=Severity.error,
-            code=Code.server_error,
-            diagnostics=GENERIC_SERVER_ERROR_DIAGNOSTICS_MESSAGE,
-        )
-        return create_response(500, exp_error)
+    return controller.delete_immunization(event)
 
 
 if __name__ == "__main__":

backend/src/delete_imms_handler.py

@@ -127,6 +127,19 @@ def to_operation_outcome(self) -> dict:
         pass
 
 
+@dataclass
+class InvalidImmunizationId(ValidationError):
+    """Use this when the unique Immunization ID is invalid"""
+
+    def to_operation_outcome(self) -> dict:
+        return create_operation_outcome(
+            resource_id=str(uuid.uuid4()),
+            severity=Severity.error,
+            code=Code.invalid,
+            diagnostics="Validation errors: the provided event ID is either missing or not in the expected format.",
+        )
+
+
 @dataclass
 class InvalidPatientId(ValidationError):
     """Use this when NHS Number is invalid or doesn't exist"""