errors

Author: JamesW1-NHS

lambdas/backend/src/controller/aws_apig_event_utils.py

@@ -4,9 +4,8 @@
 
 from aws_lambda_typing.events import APIGatewayProxyEventV1
 
-from common.models.api_errors import UnauthorizedError
-from common.models.errors import ResourceVersionNotProvided
 from controller.constants import E_TAG_HEADER_NAME, SUPPLIER_SYSTEM_HEADER_NAME
+from models.errors import ResourceVersionNotProvided, UnauthorizedError
 from utils import dict_utils
 
 

lambdas/backend/src/controller/fhir_api_exception_handler.py

@@ -5,28 +5,28 @@
 from typing import Callable, Type
 
 from common.clients import logger
-from common.models.api_errors import (
-    Code,
+from common.models.constants import GENERIC_SERVER_ERROR_DIAGNOSTICS_MESSAGE
+from common.models.errors import (
+    CustomValidationError,
+    IdentifierDuplicationError,
     InconsistentIdentifierError,
-    InconsistentIdError,
     InconsistentResourceVersion,
+    ResourceNotFoundError,
+)
+from controller.aws_apig_response_utils import create_response
+from models.errors import (
+    Code,
+    InconsistentIdError,
     InvalidImmunizationId,
     InvalidJsonError,
     InvalidResourceVersion,
+    ResourceVersionNotProvided,
     Severity,
     UnauthorizedError,
     UnauthorizedVaxError,
     UnhandledResponseError,
     create_operation_outcome,
 )
-from common.models.constants import GENERIC_SERVER_ERROR_DIAGNOSTICS_MESSAGE
-from common.models.errors import (
-    CustomValidationError,
-    IdentifierDuplicationError,
-    ResourceNotFoundError,
-    ResourceVersionNotProvided,
-)
-from controller.aws_apig_response_utils import create_response
 
 _CUSTOM_EXCEPTION_TO_STATUS_MAP: dict[Type[Exception], int] = {
     InconsistentResourceVersion: 400,

lambdas/backend/src/controller/fhir_controller.py

@@ -10,29 +10,27 @@
 
 from aws_lambda_typing.events import APIGatewayProxyEventV1
 
-from common.models.api_errors import (
+from common.models.utils.generic_utils import check_keys_in_sources
+from controller.aws_apig_event_utils import (
+    get_path_parameter,
+    get_resource_version_header,
+    get_supplier_system_header,
+)
+from controller.aws_apig_response_utils import create_response
+from controller.constants import E_TAG_HEADER_NAME
+from controller.fhir_api_exception_handler import fhir_api_exception_handler
+from models.errors import (
     Code,
     InconsistentIdError,
     InvalidImmunizationId,
     InvalidJsonError,
     InvalidResourceVersion,
+    ParameterException,
     Severity,
     UnauthorizedError,
     UnauthorizedVaxError,
     create_operation_outcome,
 )
-from common.models.errors import (
-    ParameterException,
-)
-from common.models.utils.generic_utils import check_keys_in_sources
-from controller.aws_apig_event_utils import (
-    get_path_parameter,
-    get_resource_version_header,
-    get_supplier_system_header,
-)
-from controller.aws_apig_response_utils import create_response
-from controller.constants import E_TAG_HEADER_NAME
-from controller.fhir_api_exception_handler import fhir_api_exception_handler
 from parameter_parser import create_query_string, process_params, process_search_params
 from repository.fhir_repository import ImmunizationRepository, create_table
 from service.fhir_service import FhirService, get_service_url

…s/shared/src/common/models/api_errors.py lambdas/backend/src/models/errors.pylambdas/shared/src/common/models/api_errors.py renamed to lambdas/backend/src/models/errors.py lambdas/shared/src/common/models/api_errors.py renamed to lambdas/backend/src/models/errors.py

@@ -66,51 +66,41 @@ def to_operation_outcome() -> dict:
 
 
 @dataclass
-class UnauthorizedVaxOnRecordError(RuntimeError):
-    @staticmethod
-    def to_operation_outcome() -> dict:
-        msg = "Unauthorized request for vaccine type present in the stored immunization resource"
-        return create_operation_outcome(
-            resource_id=str(uuid.uuid4()),
-            severity=Severity.error,
-            code=Code.forbidden,
-            diagnostics=msg,
-        )
-
-
-class MandatoryError(Exception):
-    def __init__(self, message=None):
-        self.message = message
+class ResourceVersionNotProvided(RuntimeError):
+    """Return this error when client has failed to provide the FHIR resource version where required"""
 
+    resource_type: str
 
-@dataclass
-class InvalidImmunizationId(ApiValidationError):
-    """Use this when the unique Immunization ID is invalid"""
+    def __str__(self):
+        return f"Validation errors: {self.resource_type} resource version not specified in the request headers"
 
     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.",
+            code=Code.invariant,
+            diagnostics=self.__str__(),
         )
 
 
 @dataclass
-class InvalidPatientId(ApiValidationError):
-    """Use this when NHS Number is invalid or doesn't exist"""
-
-    patient_identifier: str
+class ParameterException(RuntimeError):
+    message: str
 
     def __str__(self):
-        return f"NHS Number: {self.patient_identifier} is invalid or it doesn't exist."
+        return self.message
+
+
+@dataclass
+class InvalidImmunizationId(ApiValidationError):
+    """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.server_error,
-            diagnostics=self.__str__(),
+            code=Code.invalid,
+            diagnostics="Validation errors: the provided event ID is either missing or not in the expected format.",
         )
 
 
@@ -130,18 +120,6 @@ def to_operation_outcome(self) -> dict:
         )
 
 
-@dataclass
-class InconsistentIdentifierError(ApiValidationError):
-    """Use this when the local identifier in the payload does not match the existing identifier for the update."""
-
-    msg: str
-
-    def to_operation_outcome(self) -> dict:
-        return create_operation_outcome(
-            resource_id=str(uuid.uuid4()), severity=Severity.error, code=Code.invariant, diagnostics=self.msg
-        )
-
-
 @dataclass
 class InconsistentIdError(ApiValidationError):
     """Use this when the specified id in the message is inconsistent with the path
@@ -164,21 +142,6 @@ def to_operation_outcome(self) -> dict:
         )
 
 
-@dataclass
-class InconsistentResourceVersion(ApiValidationError):
-    """Use this when the resource version in the request and actual resource version do not match"""
-
-    message: str
-
-    def to_operation_outcome(self) -> dict:
-        return create_operation_outcome(
-            resource_id=str(uuid.uuid4()),
-            severity=Severity.error,
-            code=Code.invariant,
-            diagnostics=self.message,
-        )
-
-
 @dataclass
 class InvalidJsonError(RuntimeError):
     """Raised when client provides an invalid JSON payload"""

lambdas/backend/src/parameter_parser.py

@@ -7,9 +7,9 @@
 from aws_lambda_typing.events import APIGatewayProxyEventV1
 
 from common.models.constants import Constants
-from common.models.errors import ParameterException
 from common.models.utils.generic_utils import nhs_number_mod11_check
 from common.redis_client import get_redis_client
+from models.errors import ParameterException
 
 ERROR_MESSAGE_DUPLICATED_PARAMETERS = 'Parameters may not be duplicated. Use commas for "or".'
 

lambdas/backend/src/repository/fhir_repository.py

@@ -13,14 +13,14 @@
 from mypy_boto3_dynamodb.service_resource import DynamoDBServiceResource, Table
 from responses import logger
 
-from common.models.api_errors import UnhandledResponseError
 from common.models.constants import Constants
 from common.models.errors import ResourceNotFoundError
 from common.models.immunization_record_metadata import ImmunizationRecordMetadata
 from common.models.utils.generic_utils import get_contained_patient
 from common.models.utils.validation_utils import (
     get_vaccine_type,
 )
+from models.errors import UnhandledResponseError
 
 
 def create_table(table_name=None, endpoint_url=None, region_name="eu-west-2"):

lambdas/backend/src/search_imms_handler.py

@@ -9,11 +9,11 @@
 from aws_lambda_typing import context as context_
 from aws_lambda_typing import events
 
-from common.models.api_errors import Code, Severity, create_operation_outcome
 from common.models.constants import GENERIC_SERVER_ERROR_DIAGNOSTICS_MESSAGE, MAX_RESPONSE_SIZE_BYTES
 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()

lambdas/backend/src/service/fhir_service.py

@@ -20,13 +20,10 @@
 import parameter_parser
 from authorisation.api_operation_code import ApiOperationCode
 from authorisation.authoriser import Authoriser
-from common.models.api_errors import (
-    MandatoryError,
-    UnauthorizedVaxError,
-)
 from common.models.errors import (
     CustomValidationError,
     IdentifierDuplicationError,
+    MandatoryError,
     ResourceNotFoundError,
 )
 from common.models.fhir_immunization import ImmunizationValidator
@@ -41,6 +38,7 @@
     validate_resource_versions_match,
 )
 from filter import Filter
+from models.errors import UnauthorizedVaxError
 from repository.fhir_repository import ImmunizationRepository
 
 logging.basicConfig(level="INFO")

lambdas/backend/tests/controller/test_fhir_api_exception_handler.py

@@ -2,23 +2,23 @@
 import unittest
 from unittest.mock import patch
 
-from common.models.api_errors import (
+from common.models.errors import (
+    CustomValidationError,
+    IdentifierDuplicationError,
     InconsistentIdentifierError,
-    InconsistentIdError,
     InconsistentResourceVersion,
+    ResourceNotFoundError,
+)
+from controller.fhir_api_exception_handler import fhir_api_exception_handler
+from models.errors import (
+    InconsistentIdError,
     InvalidJsonError,
     InvalidResourceVersion,
+    ResourceVersionNotProvided,
     UnauthorizedError,
     UnauthorizedVaxError,
     UnhandledResponseError,
 )
-from common.models.errors import (
-    CustomValidationError,
-    IdentifierDuplicationError,
-    ResourceNotFoundError,
-    ResourceVersionNotProvided,
-)
-from controller.fhir_api_exception_handler import fhir_api_exception_handler
 
 
 class TestFhirApiExceptionHandler(unittest.TestCase):

lambdas/backend/tests/controller/test_fhir_controller.py

@@ -10,17 +10,17 @@
 from fhir.resources.R4B.bundle import Bundle
 from fhir.resources.R4B.immunization import Immunization
 
-from common.models.api_errors import (
-    UnauthorizedVaxError,
-    UnhandledResponseError,
-)
 from common.models.errors import (
     CustomValidationError,
-    ParameterException,
     ResourceNotFoundError,
 )
 from controller.aws_apig_response_utils import create_response
 from controller.fhir_controller import FhirController
+from models.errors import (
+    ParameterException,
+    UnauthorizedVaxError,
+    UnhandledResponseError,
+)
 from parameter_parser import patient_identifier_system, process_search_params
 from repository.fhir_repository import ImmunizationRepository
 from service.fhir_service import FhirService