[PRMP-808] Review - POST request for uploading review items (#937)

Author: steph-torres-nhs

.github/workflows/base-lambdas-reusable-deploy-all.yml

@@ -766,3 +766,17 @@ jobs:
       lambda_layer_names: "core_lambda_layer"
     secrets:
       AWS_ASSUME_ROLE: ${{ secrets.AWS_ASSUME_ROLE }}
+
+  deploy_post_document_review_lambda:
+    name: Deploy PostDocumentReview lambda
+    uses: ./.github/workflows/base-lambdas-reusable-deploy.yml
+    with:
+      environment: ${{ inputs.environment }}
+      python_version: ${{ inputs.python_version }}
+      build_branch: ${{ inputs.build_branch }}
+      sandbox: ${{ inputs.sandbox }}
+      lambda_handler_name: post_document_review_handler
+      lambda_aws_name: PostDocumentReview
+      lambda_layer_names: "core_lambda_layer"
+    secrets:
+      AWS_ASSUME_ROLE: ${{ secrets.AWS_ASSUME_ROLE }}

lambdas/enums/document_review_status.py

@@ -10,3 +10,9 @@ class DocumentReviewStatus(StrEnum):
     REASSIGNED = "REASSIGNED"
     REASSIGNED_PATIENT_UNKNOWN = "REASSIGNED_PATIENT_UNKNOWN"
     NEVER_REVIEWED = "NEVER_REVIEWED"
+    REVIEW_PENDING_UPLOAD = "REVIEW_PENDING_UPLOAD"
+    VIRUS_SCAN_FAILED = "VIRUS_SCAN_FAILED"
+
+
+class DocumentReviewReason(StrEnum):
+    REVIEW_FROM_DATA_CONTROLLER = "Needs review from data controller"

lambdas/enums/lambda_error.py

@@ -661,17 +661,17 @@ def create_error_body(self, params: Optional[dict] = None, **kwargs) -> str:
         Errors for DocumentReview exceptions
     """
     DocumentReviewDB = {
-        "err_code": "SDR_5001",
+        "err_code": "UDR_5001",
         "message": RETRIEVE_DOCUMENTS,
     }
 
     DocumentReviewValidation = {
-        "err_code": "SDR_5002",
+        "err_code": "UDR_5002",
         "message": "Review document model error",
     }
 
     DocumentReviewMissingODS = {
-        "err_code": "SDR_4011",
+        "err_code": "UDR_4001",
         "message": "Missing ODS code in request context",
     }
 
@@ -680,13 +680,17 @@ def create_error_body(self, params: Optional[dict] = None, **kwargs) -> str:
         "message": "Invalid query string passed",
     }
 
-    DocumentReviewStatusMissingId = {
-        "err_code": "SDR_4003",
-        "message": "Missing path parameters"
+    DocumentReviewUploadInvalidRequest = {
+        "err_code": "UDR_4003",
+        "message": "Invalid request",
     }
 
-    DocumentReviewForbidden = {
-        "err_code": "SDR_4031",
-        "message": "User is not permitted to review document"
+    DocumentReviewUploadForbidden = {
+        "err_code": "UDR_4031",
+        "message": "Forbidden"
     }
 
+    DocumentReviewPresignedFailure = {
+        "err_code": "UDR_5003",
+        "message": "Presign creation process failure",
+    }

lambdas/handlers/post_document_review_handler.py

@@ -0,0 +1,62 @@
+import json
+
+from enums.feature_flags import FeatureFlags
+from enums.lambda_error import LambdaError
+from models.document_review import DocumentReviewUploadEvent
+from pydantic import ValidationError
+from services.feature_flags_service import FeatureFlagService
+from services.post_document_review_service import PostDocumentReviewService
+from utils.audit_logging_setup import LoggingService
+from utils.decorators.ensure_env_var import ensure_environment_variables
+from utils.decorators.handle_lambda_exceptions import handle_lambda_exceptions
+from utils.decorators.set_audit_arg import set_request_context_for_logging
+from utils.exceptions import InvalidNhsNumberException
+from utils.lambda_exceptions import DocumentReviewLambdaException
+from utils.lambda_response import ApiGatewayResponse
+
+logger = LoggingService("__name__")
+
+
+@set_request_context_for_logging
+@ensure_environment_variables(
+    names=[
+        "STAGING_STORE_BUCKET_NAME",
+        "PRESIGNED_ASSUME_ROLE",
+        "EDGE_REFERENCE_TABLE",
+        "CLOUDFRONT_URL",
+    ]
+)
+@handle_lambda_exceptions
+def lambda_handler(event, context):
+    feature_flag_service = FeatureFlagService()
+    feature_flag_service.validate_feature_flag(
+        FeatureFlags.UPLOAD_DOCUMENT_ITERATION_3_ENABLED
+    )
+
+    try:
+        validated_event_body = validate_event_body(event["body"])
+    except KeyError as e:
+        logger.error(e)
+        raise DocumentReviewLambdaException(
+            400, LambdaError.DocumentReviewUploadInvalidRequest
+        )
+
+    post_document_review_service = PostDocumentReviewService()
+    logger.info(f"Processing event: {event}.")
+    response = post_document_review_service.process_event(event=validated_event_body)
+
+    return ApiGatewayResponse(
+        status_code=200, body=json.dumps(response), methods="POST"
+    ).create_api_gateway_response()
+
+
+def validate_event_body(body):
+    try:
+        event_body = DocumentReviewUploadEvent.model_validate_json(body)
+
+        return event_body
+    except (ValidationError, InvalidNhsNumberException) as e:
+        logger.error(e)
+        raise DocumentReviewLambdaException(
+            400, LambdaError.DocumentReviewUploadInvalidRequest
+        )

lambdas/handlers/review_document_status_check_handler.py

@@ -11,7 +11,7 @@
 from utils.decorators.handle_lambda_exceptions import handle_lambda_exceptions
 from utils.decorators.set_audit_arg import set_request_context_for_logging
 from utils.exceptions import OdsErrorException
-from utils.lambda_exceptions import DocumentReviewException
+from utils.lambda_exceptions import DocumentReviewLambdaException
 from utils.lambda_handler_utils import validate_review_path_parameters
 from utils.lambda_response import ApiGatewayResponse
 from utils.ods_utils import extract_ods_code_from_request_context
@@ -68,4 +68,4 @@ def lambda_handler(event, context):
 
     except OdsErrorException:
         logger.error("Missing ODS code in request context.")
-        raise DocumentReviewException(401, LambdaError.DocumentReviewMissingODS)
+        raise DocumentReviewLambdaException(401, LambdaError.DocumentReviewMissingODS)

lambdas/handlers/search_document_review_handler.py

@@ -13,7 +13,7 @@
 from utils.decorators.override_error_check import override_error_check
 from utils.decorators.set_audit_arg import set_request_context_for_logging
 from utils.exceptions import OdsErrorException
-from utils.lambda_exceptions import DocumentReviewException
+from utils.lambda_exceptions import DocumentReviewLambdaException
 from utils.lambda_response import ApiGatewayResponse
 from utils.request_context import request_context
 
@@ -54,7 +54,7 @@ def lambda_handler(event, context):
             FeatureFlags.UPLOAD_DOCUMENT_ITERATION_3_ENABLED
         ]:
             logger.info("Feature flag not enabled, event will not be processed")
-            raise DocumentReviewException(403, LambdaError.FeatureFlagDisabled)
+            raise DocumentReviewLambdaException(403, LambdaError.FeatureFlagDisabled)
 
         ods_code = get_ods_code_from_request_context()
 
@@ -99,7 +99,7 @@ def get_ods_code_from_request_context():
 
     except AttributeError as e:
         logger.error(e)
-        raise DocumentReviewException(401, LambdaError.DocumentReviewMissingODS)
+        raise DocumentReviewLambdaException(401, LambdaError.DocumentReviewMissingODS)
 
 
 def parse_querystring_parameters(event):

lambdas/models/document_review.py

@@ -1,9 +1,10 @@
 import uuid
+from datetime import datetime, timezone
 
 from enums.document_review_status import DocumentReviewStatus
 from enums.metadata_field_names import DocumentReferenceMetadataFields
 from enums.snomed_codes import SnomedCodes
-from pydantic import BaseModel, ConfigDict, Field, model_validator
+from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
 from pydantic.alias_generators import to_camel, to_pascal
 from utils.exceptions import InvalidNhsNumberException
 from utils.utilities import validate_nhs_number
@@ -17,7 +18,7 @@ class DocumentReviewFileDetails(BaseModel):
     )
 
     file_name: str
-    file_location: str
+    file_location: str | None = None
     presigned_url: str | None = None
 
 
@@ -37,10 +38,12 @@ class DocumentUploadReviewReference(BaseModel):
     review_status: DocumentReviewStatus = Field(
         default=DocumentReviewStatus.PENDING_REVIEW
     )
-    review_reason: str
+    review_reason: str | None = None
     review_date: int | None = Field(default=None)
     reviewer: str | None = Field(default=None)
-    upload_date: int
+    upload_date: int = Field(
+        default_factory=lambda: int(datetime.now(timezone.utc).timestamp()),
+    )
     files: list[DocumentReviewFileDetails] = Field(min_length=1)
     nhs_number: str
     version: int = Field(default=1)
@@ -126,3 +129,29 @@ def validate_reassign_nhs_number(self):
             except InvalidNhsNumberException:
                 raise ValueError("Invalid NHS number")
         return self
+
+
+class DocumentReviewUploadEvent(BaseModel):
+    model_config = ConfigDict(
+        validate_by_alias=True,
+        populate_by_name=True,
+        validate_by_name=True,
+        alias_generator=to_camel,
+        use_enum_values=True,
+        extra="forbid",
+    )
+
+    nhs_number: str
+    snomed_code: SnomedCodes
+    documents: list = Field(min_length=1, max_length=1)
+
+    @field_validator("snomed_code", mode="before")
+    @classmethod
+    def check_snomed_code(cls, value) -> SnomedCodes | None:
+        return SnomedCodes.find_by_code(value)
+
+    @field_validator("nhs_number", mode="before")
+    @classmethod
+    def verify_nhs_number(cls, value) -> str | None:
+        if validate_nhs_number(value):
+            return value

lambdas/services/base/dynamo_service.py

@@ -1,9 +1,9 @@
+import operator
 import time
-from typing import Optional, Sequence
 from functools import reduce
+from typing import Optional, Sequence
 
 import boto3
-import operator
 from boto3.dynamodb.conditions import Attr, ConditionBase, Key
 from botocore.exceptions import ClientError
 from utils.audit_logging_setup import LoggingService

lambdas/services/document_service.py

@@ -3,6 +3,7 @@
 from typing import Optional
 
 from boto3.dynamodb.conditions import Attr, ConditionBase
+from botocore.exceptions import ClientError
 from enums.metadata_field_names import DocumentReferenceMetadataFields
 from enums.supported_document_types import SupportedDocumentTypes
 from models.document_reference import DocumentReference
@@ -279,3 +280,20 @@ def get_batch_document_references_by_id(
 
         found_docs = [model_class.model_validate(item) for item in response]
         return found_docs
+
+    def create_dynamo_entry(
+        self,
+        item: BaseModel,
+        table_name: str | None = None,
+        model_class: BaseModel | None = None,
+    ):
+        try:
+            table_name = table_name or self.table_name
+            model_class = model_class or self.model_class
+
+            model_class.model_validate(item)
+            entry = item.model_dump(by_alias=True, exclude_none=True)
+            self.dynamo_service.create_item(table_name=table_name, item=entry)
+        except (ValidationError, ClientError) as e:
+            logger.error(e)
+            raise e