CCM-12845 Structure logs

stevebux · stevebux · commit 04f92a55b24d · 2026-01-29T16:51:55.000Z
diff --git a/lambdas/api-handler/src/handlers/__tests__/letter-status-update.test.ts b/lambdas/api-handler/src/handlers/__tests__/letter-status-update.test.ts
@@ -143,14 +143,12 @@ describe("createLetterStatusUpdateHandler", () => {
     expect(mockedDeps.letterRepo.updateLetterStatus).toHaveBeenCalledWith(
       updateLetterCommands[0],
     );
-    expect(mockedDeps.logger.error).toHaveBeenCalledWith(
-      {
-        err: mockError,
-        messageId: "mid-id1",
-        correlationId: "correlationId-id1",
-        messageBody: '{"id":"id1","status":"ACCEPTED","supplierId":"s1"}',
-      },
-      "Error processing letter status update",
-    );
+    expect(mockedDeps.logger.error).toHaveBeenCalledWith({
+      description: "Error processing letter status update",
+      err: mockError,
+      messageId: "mid-id1",
+      correlationId: "correlationId-id1",
+      messageBody: '{"id":"id1","status":"ACCEPTED","supplierId":"s1"}',
+    });
   });
 });
diff --git a/lambdas/api-handler/src/handlers/get-letter-data.ts b/lambdas/api-handler/src/handlers/get-letter-data.ts
@@ -33,14 +33,23 @@ export default function createGetLetterDataHandler(
         ),
       );
 
+      const presignedUrl = await getLetterDataUrl(
+        commonIds.value.supplierId,
+        letterId,
+        deps,
+      );
+
+      deps.logger.info({
+        description: "Generated presigned URL",
+        supplierId: commonIds.value.supplierId,
+        letterId,
+        correlationId: commonIds.value.correlationId,
+      });
+
       return {
         statusCode: 303,
         headers: {
-          Location: await getLetterDataUrl(
-            commonIds.value.supplierId,
-            letterId,
-            deps,
-          ),
+          Location: presignedUrl,
         },
         body: "",
       };
diff --git a/lambdas/api-handler/src/handlers/get-letter.ts b/lambdas/api-handler/src/handlers/get-letter.ts
@@ -46,6 +46,7 @@ export default function createGetLetterHandler(
         description: "Letter successfully fetched by id",
         supplierId: commonIds.value.supplierId,
         letterId,
+        correlationId: commonIds.value.correlationId,
       });
 
       return {
diff --git a/lambdas/api-handler/src/handlers/get-letters.ts b/lambdas/api-handler/src/handlers/get-letters.ts
@@ -121,6 +121,7 @@ export default function createGetLettersHandler(
         limitNumber,
         status,
         lettersCount: letters.length,
+        correlationId: commonIds.value.correlationId,
       });
 
       return {
diff --git a/lambdas/api-handler/src/handlers/get-status.ts b/lambdas/api-handler/src/handlers/get-status.ts
@@ -26,10 +26,10 @@ export default function createGetStatusHandler(
         body: JSON.stringify({ code: 200 }, null, 2),
       };
     } catch (error) {
-      deps.logger.error(
-        { err: error },
-        "Status endpoint error, services not available",
-      );
+      deps.logger.error({
+        err: error,
+        description: "Status endpoint error, services not available",
+      });
       return {
         statusCode: 500,
         body: JSON.stringify({ code: 500 }, null, 2),
diff --git a/lambdas/api-handler/src/handlers/letter-status-update.ts b/lambdas/api-handler/src/handlers/letter-status-update.ts
@@ -17,16 +17,20 @@ export default function createLetterStatusUpdateHandler(
         await deps.letterRepo.updateLetterStatus(
           mapToUpdateLetter(letterToUpdate),
         );
+        deps.logger.info({
+          description: "Updated letter status",
+          letterId: letterToUpdate.id,
+          messageId: message.messageId,
+          correlationId: message.messageAttributes.CorrelationId.stringValue,
+        });
       } catch (error) {
-        deps.logger.error(
-          {
-            err: error,
-            messageId: message.messageId,
-            correlationId: message.messageAttributes.CorrelationId.stringValue,
-            messageBody: message.body,
-          },
-          "Error processing letter status update",
-        );
+        deps.logger.error({
+          description: "Error processing letter status update",
+          err: error,
+          messageId: message.messageId,
+          correlationId: message.messageAttributes.CorrelationId.stringValue,
+          messageBody: message.body,
+        });
       }
     });
 
diff --git a/lambdas/api-handler/src/handlers/patch-letter.ts b/lambdas/api-handler/src/handlers/patch-letter.ts
@@ -73,6 +73,12 @@ export default function createPatchLetterHandler(
         commonIds.value.correlationId,
         deps,
       );
+      deps.logger.info({
+        description: "Enqueued letter update requests",
+        supplierId: commonIds.value.supplierId,
+        letterId,
+        correlationId: commonIds.value.correlationId,
+      });
 
       return {
         statusCode: 202,
diff --git a/lambdas/api-handler/src/handlers/post-letters.ts b/lambdas/api-handler/src/handlers/post-letters.ts
@@ -77,6 +77,15 @@ export default function createPostLettersHandler(
         deps,
       );
 
+      deps.logger.info({
+        description: "Enqueued letter update requests",
+        supplierId: commonIds.value.supplierId,
+        letterIds: postLettersRequest.data
+          .map((letter) => letter.id)
+          .join(", "),
+        correlationId: commonIds.value.correlationId,
+      });
+
       return {
         statusCode: 202,
         body: "",
diff --git a/lambdas/api-handler/src/handlers/post-mi.ts b/lambdas/api-handler/src/handlers/post-mi.ts
@@ -53,6 +53,12 @@ export default function createPostMIHandler(
         deps.miRepo,
       );
 
+      deps.logger.info({
+        description: "Posted management information",
+        supplierId: commonIds.value.supplierId,
+        correlationId: commonIds.value.correlationId,
+      });
+
       return {
         statusCode: 201,
         body: JSON.stringify(result, null, 2),
diff --git a/lambdas/api-handler/src/mappers/error-mapper.ts b/lambdas/api-handler/src/mappers/error-mapper.ts
@@ -72,38 +72,33 @@ export function logAndMapToApiError(
   logger: Logger,
 ): ApiError {
   if (error instanceof ValidationError) {
-    logger.info(
-      { err: error },
-      `Validation error correlationId=${correlationId}`,
-    );
+    logger.info({ description: "Validation error", err: error, correlationId });
     return mapToApiError(
       ApiErrorCode.InvalidRequest,
       error.detail,
       correlationId,
     );
   }
   if (error instanceof NotFoundError) {
-    logger.info(
-      { err: error },
-      `Not found error correlationId=${correlationId}`,
-    );
+    logger.info({ description: "Not found error", err: error, correlationId });
     return mapToApiError(ApiErrorCode.NotFound, error.detail, correlationId);
   }
   if (error instanceof Error) {
-    logger.error(
-      { err: error },
-      `Internal server error correlationId=${correlationId}`,
-    );
+    logger.error({
+      description: "Internal server error",
+      err: error,
+      correlationId,
+    });
     return mapToApiError(
       ApiErrorCode.InternalServerError,
       "Unexpected error",
       correlationId,
     );
   }
-  logger.error(
-    { err: error },
-    `Internal server error (non-Error thrown) correlationId=${correlationId}`,
-  );
+  logger.error({
+    description: "Internal server error  (non-Error thrown)",
+    correlationId,
+  });
   return mapToApiError(
     ApiErrorCode.InternalServerError,
     "Unexpected error",
diff --git a/lambdas/api-handler/src/services/letter-operations.ts b/lambdas/api-handler/src/services/letter-operations.ts
@@ -124,19 +124,18 @@ export async function enqueueLetterUpdateRequests(
         try {
           const result = await deps.sqsClient.send(cmd);
           if (result.Failed && result.Failed.length > 0) {
-            deps.logger.error(
-              { failed: result.Failed },
-              "Some batch entries failed",
-            );
+            deps.logger.error({
+              failed: result.Failed,
+              description: "Some batch entries failed",
+              correlationId,
+            });
           }
         } catch (error) {
-          deps.logger.error(
-            {
-              err: error,
-              correlationId,
-            },
-            "Error enqueuing letter status updates",
-          );
+          deps.logger.error({
+            err: error,
+            description: "Error enqueuing letter status updates",
+            correlationId,
+          });
         }
       }),
     );
diff --git a/lambdas/authorizer/src/__tests__/index.test.ts b/lambdas/authorizer/src/__tests__/index.test.ts
@@ -10,7 +10,11 @@ import { EnvVars } from "../env";
 import createAuthorizerHandler from "../authorizer";
 
 const mockedDeps: jest.Mocked<Deps> = {
-  logger: { info: jest.fn(), error: jest.fn() } as unknown as pino.Logger,
+  logger: {
+    info: jest.fn(),
+    warn: jest.fn(),
+    error: jest.fn(),
+  } as unknown as pino.Logger,
   env: {
     CLOUDWATCH_NAMESPACE: "cloudwatch-namespace",
     CLIENT_CERTIFICATE_EXPIRATION_ALERT_DAYS: 14,
diff --git a/lambdas/authorizer/src/authorizer.ts b/lambdas/authorizer/src/authorizer.ts
@@ -18,17 +18,25 @@ export default function createAuthorizerHandler(
     context: Context,
     callback: Callback<APIGatewayAuthorizerResult>,
   ): void => {
-    deps.logger.info(event, "Received event");
+    deps.logger.info({ description: "Received authorizer event", event });
 
     checkCertificateExpiry(event.requestContext.identity.clientCert, deps);
 
     getSupplier(event.headers, deps)
       .then((supplier: Supplier) => {
-        deps.logger.info("Allow event");
+        deps.logger.info({
+          description: "Allowed event",
+          methodArn: event.methodArn,
+          supplierId: supplier.id,
+        });
         callback(null, generateAllow(event.methodArn, supplier.id));
       })
       .catch((error) => {
-        deps.logger.info(error, "Deny event");
+        deps.logger.warn({
+          description: "Denied event",
+          err: error,
+          methodArn: event.methodArn,
+        });
         callback(null, generateDeny(event.methodArn));
       });
   };
diff --git a/lambdas/letter-updates-transformer/src/__tests__/letter-updates-transformer.test.ts b/lambdas/letter-updates-transformer/src/__tests__/letter-updates-transformer.test.ts
@@ -205,7 +205,7 @@ describe("letter-updates-transformer Lambda", () => {
       expect(mockedDeps.logger.error).toHaveBeenCalledWith(
         expect.objectContaining({
           description: "Error extracting payload",
-          error: expect.any(Error),
+          err: expect.any(Error),
           record: expect.objectContaining({
             kinesis: expect.objectContaining({
               data: Buffer.from("invalid-json-data").toString("base64"),
diff --git a/lambdas/letter-updates-transformer/src/letter-updates-transformer.ts b/lambdas/letter-updates-transformer/src/letter-updates-transformer.ts
@@ -96,7 +96,7 @@ function extractPayload(
   } catch (error) {
     deps.logger.error({
       description: "Error extracting payload",
-      error,
+      err: error,
       record,
     });
     throw error;
diff --git a/lambdas/upsert-letter/src/handler/__tests__/upsert-handler.test.ts b/lambdas/upsert-letter/src/handler/__tests__/upsert-handler.test.ts
@@ -322,8 +322,11 @@ describe("createUpsertLetterHandler", () => {
     expect(result.batchItemFailures).toHaveLength(1);
     expect(result.batchItemFailures[0].itemIdentifier).toBe("bad-json");
 
-    expect((mockedDeps.logger.error as jest.Mock).mock.calls[0][1]).toBe(
-      "Error processing upsert of record bad-json",
+    expect((mockedDeps.logger.error as jest.Mock).mock.calls[0][0]).toEqual(
+      expect.objectContaining({
+        description: "Error processing upsert of record",
+        messageId: "bad-json",
+      }),
     );
     expect(mockedDeps.letterRepo.putLetter).not.toHaveBeenCalled();
   });
@@ -349,8 +352,11 @@ describe("createUpsertLetterHandler", () => {
       "bad-notification-schema",
     );
 
-    expect((mockedDeps.logger.error as jest.Mock).mock.calls[0][1]).toBe(
-      "Error processing upsert of record bad-notification-schema",
+    expect((mockedDeps.logger.error as jest.Mock).mock.calls[0][0]).toEqual(
+      expect.objectContaining({
+        description: "Error processing upsert of record",
+        messageId: "bad-notification-schema",
+      }),
     );
     expect(mockedDeps.letterRepo.putLetter).not.toHaveBeenCalled();
   });
@@ -378,8 +384,11 @@ describe("createUpsertLetterHandler", () => {
     expect(result.batchItemFailures[0].itemIdentifier).toBe("bad-event-type");
     expect(mockedDeps.letterRepo.putLetter).not.toHaveBeenCalled();
     expect(mockedDeps.letterRepo.updateLetterStatus).not.toHaveBeenCalled();
-    expect((mockedDeps.logger.error as jest.Mock).mock.calls[0][1]).toBe(
-      "Error processing upsert of record bad-event-type",
+    expect((mockedDeps.logger.error as jest.Mock).mock.calls[0][0]).toEqual(
+      expect.objectContaining({
+        description: "Error processing upsert of record",
+        messageId: "bad-event-type",
+      }),
     );
   });
 
@@ -406,8 +415,11 @@ describe("createUpsertLetterHandler", () => {
     expect(result.batchItemFailures[0].itemIdentifier).toBe("bad-event-type");
     expect(mockedDeps.letterRepo.putLetter).not.toHaveBeenCalled();
     expect(mockedDeps.letterRepo.updateLetterStatus).not.toHaveBeenCalled();
-    expect((mockedDeps.logger.error as jest.Mock).mock.calls[0][1]).toBe(
-      "Error processing upsert of record bad-event-type",
+    expect((mockedDeps.logger.error as jest.Mock).mock.calls[0][0]).toEqual(
+      expect.objectContaining({
+        description: "Error processing upsert of record",
+        messageId: "bad-event-type",
+      }),
     );
   });
 
@@ -437,8 +449,11 @@ describe("createUpsertLetterHandler", () => {
     expect(result.batchItemFailures[0].itemIdentifier).toBe("bad-event-schema");
     expect(mockedDeps.letterRepo.putLetter).not.toHaveBeenCalled();
     expect(mockedDeps.letterRepo.updateLetterStatus).not.toHaveBeenCalled();
-    expect((mockedDeps.logger.error as jest.Mock).mock.calls[0][1]).toBe(
-      "Error processing upsert of record bad-event-schema",
+    expect((mockedDeps.logger.error as jest.Mock).mock.calls[0][0]).toEqual(
+      expect.objectContaining({
+        description: "Error processing upsert of record",
+        messageId: "bad-event-schema",
+      }),
     );
   });
 
diff --git a/lambdas/upsert-letter/src/handler/upsert-handler.ts b/lambdas/upsert-letter/src/handler/upsert-handler.ts
