CCM-12915: Async Patch

infrastructure/terraform/components/api/module_lambda_patch_letter.tf

@@ -35,7 +35,9 @@ module "patch_letter" {
   log_destination_arn       = local.destination_arn
   log_subscription_role_arn = local.acct.log_subscription_role_arn
 
-  lambda_env_vars = merge(local.common_lambda_env_vars, {})
+  lambda_env_vars = merge(local.common_lambda_env_vars, {
+    QUEUE_URL = module.letter_status_updates_queue.sqs_queue_url
+  })
 }
 
 data "aws_iam_policy_document" "patch_letter_lambda" {
@@ -54,21 +56,16 @@ data "aws_iam_policy_document" "patch_letter_lambda" {
   }
 
   statement {
-    sid    = "AllowDynamoDBAccess"
+    sid    = "AllowQueueAccess"
     effect = "Allow"
 
     actions = [
-      "dynamodb:BatchGetItem",
-      "dynamodb:BatchWriteItem",
-      "dynamodb:GetItem",
-      "dynamodb:PutItem",
-      "dynamodb:Query",
-      "dynamodb:Scan",
-      "dynamodb:UpdateItem",
+      "sqs:SendMessage",
+      "sqs:GetQueueAttributes",
     ]
 
     resources = [
-      aws_dynamodb_table.letters.arn,
+      module.letter_status_updates_queue.sqs_queue_arn
     ]
   }
 }

lambdas/api-handler/src/handlers/__tests__/patch-letter.test.ts

@@ -1,7 +1,7 @@
 // mock service
 jest.mock('../../services/letter-operations');
 import * as letterService from '../../services/letter-operations';
-const mockedPatchLetterStatus = jest.mocked(letterService.patchLetterStatus);
+const mockedBatchUpdateStatus = jest.mocked(letterService.enqueueLetterUpdateRequests);
 
 // mock mapper
 jest.mock('../../mappers/error-mapper');
@@ -59,7 +59,7 @@ describe('patchLetter API Handler', () => {
       } as unknown as EnvVars
     } as Deps;
 
-  it('returns 200 OK with updated resource', async () => {
+  it('returns 202 Accepted', async () => {
     const event = makeApiGwEvent({
       path: '/letters/id1',
       body: requestBody,
@@ -86,14 +86,14 @@ describe('patchLetter API Handler', () => {
           }
         }
     };
-    mockedPatchLetterStatus.mockResolvedValue(updateLetterServiceResponse);
+    mockedBatchUpdateStatus.mockResolvedValue();
 
     const patchLetterHandler = createPatchLetterHandler(mockedDeps);
     const result = await patchLetterHandler(event, context, callback);
 
     expect(result).toEqual({
-      statusCode: 200,
-      body: JSON.stringify(updateLetterServiceResponse, null, 2)
+      statusCode: 202,
+      body: ''
     });
   });
 
@@ -137,16 +137,12 @@ describe('patchLetter API Handler', () => {
     expect(result).toEqual(expectedErrorResponse);
   });
 
-  it('returns error response when error is thrown by service', async () => {
-    const error = new Error('Service error');
-    mockedPatchLetterStatus.mockRejectedValue(error);
-
+  it('returns error when supplier id is missing', async () => {
     const event = makeApiGwEvent({
       path: '/letters/id1',
       body: requestBody,
       pathParameters: {id: 'id1'},
       headers: {
-        'nhsd-supplier-id': 'supplier1',
         'nhsd-correlation-id': 'correlationId',
         'x-request-id': 'requestId'
       }
@@ -157,16 +153,17 @@ describe('patchLetter API Handler', () => {
     const patchLetterHandler = createPatchLetterHandler(mockedDeps);
     const result = await patchLetterHandler(event, context, callback);
 
-    expect(mockedProcessError).toHaveBeenCalledWith(error, 'correlationId', mockedDeps.logger);
+    expect(mockedProcessError).toHaveBeenCalledWith(new Error('The supplier ID is missing from the request'), 'correlationId', mockedDeps.logger);
     expect(result).toEqual(expectedErrorResponse);
   });
 
-  it('returns error when supplier id is missing', async () => {
+  it('returns error when request body does not have correct shape', async () => {
     const event = makeApiGwEvent({
       path: '/letters/id1',
-      body: requestBody,
+      body: "{test: 'test'}",
       pathParameters: {id: 'id1'},
       headers: {
+        'nhsd-supplier-id': 'supplier1',
         'nhsd-correlation-id': 'correlationId',
         'x-request-id': 'requestId'
       }
@@ -177,14 +174,14 @@ describe('patchLetter API Handler', () => {
     const patchLetterHandler = createPatchLetterHandler(mockedDeps);
     const result = await patchLetterHandler(event, context, callback);
 
-    expect(mockedProcessError).toHaveBeenCalledWith(new Error('The supplier ID is missing from the request'), 'correlationId', mockedDeps.logger);
+    expect(mockedProcessError).toHaveBeenCalledWith(new ValidationError(errors.ApiErrorDetail.InvalidRequestBody), 'correlationId', mockedDeps.logger);
     expect(result).toEqual(expectedErrorResponse);
   });
 
-  it('returns error when request body does not have correct shape', async () => {
+  it('returns error when request body is not json', async () => {
     const event = makeApiGwEvent({
       path: '/letters/id1',
-      body: "{test: 'test'}",
+      body: '{#invalidJSON',
       pathParameters: {id: 'id1'},
       headers: {
         'nhsd-supplier-id': 'supplier1',
@@ -202,11 +199,11 @@ describe('patchLetter API Handler', () => {
     expect(result).toEqual(expectedErrorResponse);
   });
 
-  it('returns error when request body is not json', async () => {
+  it('returns error if path letterId and body letterId do not match', async () => {
     const event = makeApiGwEvent({
-      path: '/letters/id1',
-      body: '{#invalidJSON',
-      pathParameters: {id: 'id1'},
+      path: '/letters/id2',
+      body: requestBody,
+      pathParameters: {id: 'id2'},
       headers: {
         'nhsd-supplier-id': 'supplier1',
         'nhsd-correlation-id': 'correlationId',
@@ -219,7 +216,7 @@ describe('patchLetter API Handler', () => {
     const patchLetterHandler = createPatchLetterHandler(mockedDeps);
     const result = await patchLetterHandler(event, context, callback);
 
-    expect(mockedProcessError).toHaveBeenCalledWith(new ValidationError(errors.ApiErrorDetail.InvalidRequestBody), 'correlationId', mockedDeps.logger);
+    expect(mockedProcessError).toHaveBeenCalledWith(new ValidationError(errors.ApiErrorDetail.InvalidRequestLetterIdsMismatch), 'correlationId', mockedDeps.logger);
     expect(result).toEqual(expectedErrorResponse);
   });
 

lambdas/api-handler/src/handlers/patch-letter.ts

@@ -1,6 +1,6 @@
 import { APIGatewayProxyHandler } from 'aws-lambda';
-import { patchLetterStatus } from '../services/letter-operations';
-import { PatchLetterRequest, PatchLetterRequestSchema } from '../contracts/letters';
+import { enqueueLetterUpdateRequests } from '../services/letter-operations';
+import { LetterDto, PatchLetterRequest, PatchLetterRequestSchema } from '../contracts/letters';
 import { ApiErrorDetail } from '../contracts/errors';
 import { ValidationError } from '../errors';
 import { processError } from '../mappers/error-mapper';
@@ -35,11 +35,17 @@ export function createPatchLetterHandler(deps: Deps): APIGatewayProxyHandler {
         else throw error;
       }
 
-      const updatedLetter = await patchLetterStatus(mapPatchLetterToDto(patchLetterRequest, commonHeadersResult.value.supplierId), letterId, deps.letterRepo);
+      const letterToUpdate: LetterDto = mapPatchLetterToDto(patchLetterRequest, commonHeadersResult.value.supplierId);
+
+      if (letterToUpdate.id !== letterId) {
+        throw new ValidationError(ApiErrorDetail.InvalidRequestLetterIdsMismatch);
+      }
+
+      await enqueueLetterUpdateRequests([letterToUpdate], commonHeadersResult.value.correlationId, deps);
 
       return {
-        statusCode: 200,
-        body: JSON.stringify(updatedLetter, null, 2)
+        statusCode: 202,
+        body: ''
       };
 
     } catch (error) {

lambdas/api-handler/src/handlers/post-letters.ts

@@ -6,6 +6,7 @@ import { ValidationError } from '../errors';
 import { processError } from '../mappers/error-mapper';
 import { assertNotEmpty, requireEnvVar, validateCommonHeaders } from '../utils/validation';
 import type { Deps } from "../config/deps";
+import { mapPostLetterRequestToLetterDtoArray } from '../mappers/letter-mapper';
 
 export function createPostLettersHandler(deps: Deps): APIGatewayProxyHandler {
 
@@ -42,7 +43,11 @@ export function createPostLettersHandler(deps: Deps): APIGatewayProxyHandler {
         throw new ValidationError(ApiErrorDetail.InvalidRequestDuplicateLetterId);
       }
 
-      await enqueueLetterUpdateRequests(postLettersRequest, commonHeadersResult.value.supplierId, commonHeadersResult.value.correlationId, deps);
+      await enqueueLetterUpdateRequests(
+        mapPostLetterRequestToLetterDtoArray(postLettersRequest, commonHeadersResult.value.supplierId),
+        commonHeadersResult.value.correlationId,
+        deps
+      );
 
       return {
         statusCode: 202,

lambdas/api-handler/src/mappers/letter-mapper.ts

@@ -11,14 +11,14 @@ export function mapPatchLetterToDto(request: PatchLetterRequest, supplierId: str
   };
 }
 
-export function mapPostLetterResourceToDto(request: PostLettersRequestResource, supplierId: string): LetterDto {
-  return {
-    id: request.id,
+export function mapPostLetterRequestToLetterDtoArray(request: PostLettersRequest, supplierId: string): LetterDto[] {
+  return request.data.map( (letterToUpdate: PostLettersRequestResource) => ({
+    id: letterToUpdate.id,
     supplierId,
-    status: LetterStatus.parse(request.attributes.status),
-    reasonCode: request.attributes.reasonCode,
-    reasonText: request.attributes.reasonText,
-  };
+    status: LetterStatus.parse(letterToUpdate.attributes.status),
+    reasonCode: letterToUpdate.attributes.reasonCode,
+    reasonText: letterToUpdate.attributes.reasonText,
+  }));
 }
 
 export function mapToPatchLetterResponse(letter: LetterBase): PatchLetterResponse {