Log message Ids when sending

Author: stevebux

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

@@ -68,16 +68,17 @@ export default function createPatchLetterHandler(
         );
       }
 
-      await enqueueLetterUpdateRequests(
+      const messageIds = await enqueueLetterUpdateRequests(
         [updateLetterCommand],
         commonIds.value.correlationId,
         deps,
       );
       deps.logger.info({
-        description: "Enqueued letter update requests",
+        description: "Enqueued letter update request",
         supplierId: commonIds.value.supplierId,
         letterId,
         correlationId: commonIds.value.correlationId,
+        messageId: messageIds[0],
       });
 
       return {

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

@@ -71,7 +71,7 @@ export default function createPostLettersHandler(
         );
       }
 
-      await enqueueLetterUpdateRequests(
+      const messageIds = await enqueueLetterUpdateRequests(
         mapToUpdateCommands(postLettersRequest, commonIds.value.supplierId),
         commonIds.value.correlationId,
         deps,
@@ -82,6 +82,7 @@ export default function createPostLettersHandler(
         supplierId: commonIds.value.supplierId,
         letterIds: postLettersRequest.data.map((letter) => letter.id),
         correlationId: commonIds.value.correlationId,
+        messageIds,
       });
 
       return {

lambdas/api-handler/src/services/__tests__/letter-operations.test.ts

@@ -218,15 +218,25 @@ describe("enqueueLetterUpdateRequests function", () => {
     );
 
     const sqsClientSendMock = sqsClient.send as jest.Mock;
-    sqsClientSendMock.mockResolvedValue({ Failed: [] });
-
+    sqsClientSendMock.mockResolvedValueOnce({
+      Successful: [{ Id: "id1" }, { Id: "id2" }, { Id: "id3" }],
+      Failed: [],
+    });
+    sqsClientSendMock.mockResolvedValueOnce({
+      Successful: [{ Id: "id4" }, { Id: "id5" }],
+      Failed: [],
+    });
+    sqsClientSendMock.mockResolvedValueOnce({
+      Successful: [{ Id: "id6" }],
+      Failed: [],
+    });
     const result = await enqueueLetterUpdateRequests(
       updateLetterCommands,
       "correlationId1",
       deps,
     );
 
-    expect(result).toBeUndefined();
+    expect(result).toEqual(["id1", "id2", "id3", "id4", "id5", "id6"]);
 
     // processes 10 at a time (25 -> 10+10+5)
     expect(sqsClientSendMock).toHaveBeenCalledTimes(3);
@@ -277,14 +287,12 @@ describe("enqueueLetterUpdateRequests function", () => {
       makeUpdateLetterCommand(i),
     );
 
-    const result = await enqueueLetterUpdateRequests(
+    await enqueueLetterUpdateRequests(
       updateLetterCommands,
       "correlationId1",
       deps,
     );
 
-    expect(result).toBeUndefined();
-
     // 12 = 10 + 2
     expect(deps.sqsClient.send).toHaveBeenCalledTimes(2);
 

lambdas/api-handler/src/services/letter-operations.ts

@@ -1,7 +1,7 @@
 import { LetterBase, LetterRepository } from "@internal/datastore";
 import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
 import { GetObjectCommand, S3Client } from "@aws-sdk/client-s3";
-import { SendMessageBatchCommand } from "@aws-sdk/client-sqs";
+import { MessageSystemAttributeNameForSends, SendMessageBatchCommand } from "@aws-sdk/client-sqs";
 import NotFoundError from "../errors/not-found-error";
 import { UpdateLetterCommand } from "../contracts/letters";
 import { ApiErrorDetail } from "../contracts/errors";
@@ -95,18 +95,19 @@ export async function enqueueLetterUpdateRequests(
   updateLetterCommands: UpdateLetterCommand[],
   correlationId: string,
   deps: Deps,
-) {
+): Promise<string[]> {
   const BATCH_SIZE = 10; // SQS SendMessageBatch max
   const CONCURRENCY = 5; // number of parallel batch API calls
 
   const batches = chunk(updateLetterCommands, BATCH_SIZE);
 
   // send batches in groups with limited concurrency
   // BATCH_SIZE * CONCURRENCY is the number of total updates / db calls in-flight
+  const messageIds: string[] = [];
   for (let i = 0; i < batches.length; i += CONCURRENCY) {
     const window = batches.slice(i, i + CONCURRENCY);
 
-    await Promise.all(
+    const batchMessageIds: string[][] = await Promise.all(
       window.map(async (batch, batchIdx) => {
         const entries = batch.map((request, idx) => ({
           Id: `${i + batchIdx}-${idx}`, // unique per batch entry
@@ -130,14 +131,18 @@ export async function enqueueLetterUpdateRequests(
               correlationId,
             });
           }
+          return (result.Successful || []).map((message) => message.Id);
         } catch (error) {
           deps.logger.error({
             err: error,
             description: "Error enqueuing letter status updates",
             correlationId,
           });
+          return [];
         }
       }),
     );
+    messageIds.push(...batchMessageIds.flat());
   }
+  return messageIds;
 }