extra logging

Author: nhsd-david-wass

lambdas/supplier-allocator/src/handler/allocate-handler.ts

@@ -32,6 +32,7 @@ import {
 
 import { Deps } from "../config/deps";
 import { PreparedEventSchema, PreparedEvents, SupplierDetails } from "./types";
+import { domain } from "zod/v4/core/regexes.cjs";
 
 const idempotencyConfig = new IdempotencyConfig({
   eventKeyJmesPath: "id",
@@ -266,13 +267,13 @@ async function saveAllocations(
   }
 }
 
-type SupplierAllocationResult = [
-  supplier: string,
-  priority: string,
-  AllocationMetrics,
-  AllocationMetrics,
-  VolumeGroupAllocation,
-];
+type SupplierAllocationResult = {
+  supplier: string;
+  priority: string;
+  perAllocationSuccess: AllocationMetrics;
+  perAllocationFailure: AllocationMetrics;
+  volumeGroupAllocations: VolumeGroupAllocation;
+};
 
 async function processSupplierAllocation(
   letterEvent: PreparedEvents,
@@ -281,6 +282,12 @@ async function processSupplierAllocation(
   perAllocationFailure: AllocationMetrics,
   volumeGroupAllocations: VolumeGroupAllocation,
 ): Promise<SupplierAllocationResult> {
+  deps.logger.info({
+    description: "Processing supplier allocation for letter event",
+    eventId: letterEvent.id,
+    domainId: letterEvent.data.domainId,
+    letterVariantId: letterEvent.data.letterVariantId,
+  });
   const supplierDetails: SupplierDetails = await getSupplierFromConfig(
     letterEvent,
     deps,
@@ -332,13 +339,13 @@ async function processSupplierAllocation(
       MessageBody: JSON.stringify(queueMessage),
     }),
   );
-  return [
+  return {
     supplier,
     priority,
     perAllocationSuccess,
     perAllocationFailure,
     volumeGroupAllocations,
-  ];
+  };
 }
 
 export default function createSupplierAllocatorHandler(deps: Deps): SQSHandler {
@@ -362,28 +369,46 @@ export default function createSupplierAllocatorHandler(deps: Deps): SQSHandler {
         deps.logger.info({
           description: "Extracted letter event",
           messageId: record.messageId,
+          domainId: letterEvent.data.domainId,
+          letterVariantId: letterEvent.data.letterVariantId,
         });
 
         idempotencyConfig.registerLambdaContext(context);
 
-        const [
-          allocatedSupplier,
-          alocatedPriority,
-          updatedPerAllocationSuccess,
-          updatedPerAllocationFailure,
-          updatedVolumeGroupAllocations,
-        ] = await getSupplierIdempotently(
-          letterEvent,
-          deps,
-          perAllocationSuccess,
-          perAllocationFailure,
+        const supplierAllocationResult: SupplierAllocationResult =
+          await getSupplierIdempotently(
+            letterEvent,
+            deps,
+            perAllocationSuccess,
+            perAllocationFailure,
+            volumeGroupAllocations,
+          );
+        deps.logger.info({
+          description: "Completed supplier allocation for letter event",
+          eventId: letterEvent.id,
+          domainId: letterEvent.data.domainId,
+          letterVariantId: letterEvent.data.letterVariantId,
+          supplier: supplierAllocationResult.supplier,
+          priority: supplierAllocationResult.priority,
+          updatedVolumeGroupAllocations:
+            supplierAllocationResult.volumeGroupAllocations,
+        });
+        supplier = supplierAllocationResult.supplier;
+        priority = supplierAllocationResult.priority;
+        perAllocationSuccess = supplierAllocationResult.perAllocationSuccess;
+        perAllocationFailure = supplierAllocationResult.perAllocationFailure;
+        volumeGroupAllocations =
+          supplierAllocationResult.volumeGroupAllocations;
+        deps.logger.info({
+          description:
+            "Completed processing supplier allocation for letter event",
+          eventId: letterEvent.id,
+          domainId: letterEvent.data.domainId,
+          letterVariantId: letterEvent.data.letterVariantId,
+          supplier,
+          priority,
           volumeGroupAllocations,
-        );
-        supplier = allocatedSupplier;
-        priority = alocatedPriority;
-        perAllocationSuccess = updatedPerAllocationSuccess;
-        perAllocationFailure = updatedPerAllocationFailure;
-        volumeGroupAllocations = updatedVolumeGroupAllocations;
+        });
       } catch (error) {
         deps.logger.error({
           description: "Error processing allocation of record",