CCM-15148 - Add BillingId to variant map

Author: nhsd-david-wass

infrastructure/terraform/components/api/variables.tf

@@ -136,11 +136,11 @@ variable "eventpub_control_plane_bus_arn" {
 }
 
 variable "letter_variant_map" {
-  type = map(object({ supplierId = string, specId = string, priority = number }))
+  type = map(object({ supplierId = string, specId = string, priority = number, billingId = string }))
   default = {
-    "lv1" = { supplierId = "supplier1", specId = "spec1", priority = 10 },
-    "lv2" = { supplierId = "supplier1", specId = "spec2", priority = 10 },
-    "lv3" = { supplierId = "supplier2", specId = "spec3", priority = 10 }
+    "lv1" = { supplierId = "supplier1", specId = "spec1", priority = 10, billingId = "billing1" },
+    "lv2" = { supplierId = "supplier1", specId = "spec2", priority = 10, billingId = "billing1" },
+    "lv3" = { supplierId = "supplier2", specId = "spec3", priority = 10, billingId = "billing1" }
   }
 }
 

lambdas/supplier-allocator/src/config/__tests__/deps.test.ts

@@ -6,6 +6,7 @@ describe("createDependenciesContainer", () => {
       lv1: {
         supplierId: "supplier1",
         specId: "spec1",
+        billingId: "billing1",
       },
     },
   };

lambdas/supplier-allocator/src/config/__tests__/env.test.ts

@@ -19,7 +19,8 @@ describe("lambdaEnv", () => {
       "lv1": {
         "supplierId": "supplier1",
         "specId": "spec1",
-        "priority": 10
+        "priority": 10,
+        "billingId": "billing1"
       }
     }`;
 
@@ -31,6 +32,7 @@ describe("lambdaEnv", () => {
           supplierId: "supplier1",
           specId: "spec1",
           priority: 10,
+          billingId: "billing1",
         },
       },
     });

lambdas/supplier-allocator/src/config/env.ts

@@ -6,6 +6,7 @@ const LetterVariantSchema = z.record(
     supplierId: z.string(),
     specId: z.string(),
     priority: z.int().min(0).max(99), // Lower number represents a higher priority
+    billingId: z.string(),
   }),
 );
 export type LetterVariant = z.infer<typeof LetterVariantSchema>;

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

@@ -8,7 +8,7 @@ import { Unit } from "aws-embedded-metrics";
 import { MetricEntry, MetricStatus, buildEMFObject } from "@internal/helpers";
 import { Deps } from "../config/deps";
 
-type SupplierSpec = { supplierId: string; specId: string; priority: number };
+type SupplierSpec = { supplierId: string; specId: string; priority: number; billingId: string };
 type PreparedEvents = LetterRequestPreparedEventV2 | LetterRequestPreparedEvent;
 
 // small envelope that must exist in all inputs

lambdas/upsert-letter/src/handler/__tests__/upsert-handler.test.ts

@@ -213,11 +213,21 @@ describe("createUpsertLetterHandler", () => {
   test("processes all records successfully and returns no batch failures", async () => {
     const v2message = {
       letterEvent: createPreparedV2Event(),
-      supplierSpec: { supplierId: "supplier1", specId: "spec1", priority: 10 },
+      supplierSpec: {
+        supplierId: "supplier1",
+        specId: "spec1",
+        priority: 10,
+        billingId: "billing1",
+      },
     };
     const v1message = {
       letterEvent: createPreparedV1Event(),
-      supplierSpec: { supplierId: "supplier1", specId: "spec1", priority: 10 },
+      supplierSpec: {
+        supplierId: "supplier1",
+        specId: "spec1",
+        priority: 10,
+        billingId: "billing1",
+      },
     };
 
     const evt: SQSEvent = createSQSEvent([
@@ -251,20 +261,20 @@ describe("createUpsertLetterHandler", () => {
     expect(insertedV2Letter.status).toBe("PENDING");
     expect(insertedV2Letter.groupId).toBe("client1campaign1template1");
     expect(insertedV2Letter.source).toBe("/data-plane/letter-rendering/test");
-    expect(insertedV2Letter.specificationBillingId).toBe("spec1");
+    expect(insertedV2Letter.specificationBillingId).toBe("billing1");
     expect(insertedV2Letter.priority).toBe(10);
 
     const insertedV1Letter = (mockedDeps.letterRepo.putLetter as jest.Mock).mock
       .calls[1][0];
     expect(insertedV1Letter.id).toBe("letter1");
-    expect(insertedV1Letter.supplierId).toBe("supplier1");
-    expect(insertedV1Letter.specificationId).toBe("spec1");
-    expect(insertedV1Letter.billingRef).toBe("spec1");
+    expect(insertedV1Letter.supplierId).toBe("supplier2");
+    expect(insertedV1Letter.specificationId).toBe("spec2");
+    expect(insertedV1Letter.billingRef).toBe("spec2");
     expect(insertedV1Letter.url).toBe("s3://letterDataBucket/letter1.pdf");
     expect(insertedV1Letter.status).toBe("PENDING");
     expect(insertedV1Letter.groupId).toBe("client1campaign1template1");
     expect(insertedV1Letter.source).toBe("/data-plane/letter-rendering/test");
-    expect(insertedV1Letter.specificationBillingId).toBe("spec1");
+    expect(insertedV1Letter.specificationBillingId).toBe("billing2");
     expect(insertedV1Letter.priority).toBe(10);
 
     const updatedLetter = (
@@ -281,7 +291,12 @@ describe("createUpsertLetterHandler", () => {
     });
     expect(mockMetrics.putMetric).toHaveBeenCalledWith(
       "MessagesProcessed",
-      3,
+      2,
+      "Count",
+    );
+    expect(mockMetrics.putMetric).toHaveBeenCalledWith(
+      "MessagesProcessed",
+      1,
       "Count",
     );
   });
@@ -478,14 +493,24 @@ describe("createUpsertLetterHandler", () => {
         id: "7b9a03ca-342a-4150-b56b-989109c45615",
         domainId: "ok",
       }),
-      supplierSpec: { supplierId: "supplier1", specId: "spec1", priority: 10 },
+      supplierSpec: {
+        supplierId: "supplier1",
+        specId: "spec1",
+        priority: 10,
+        billingId: "billing1",
+      },
     };
     const message2 = {
       letterEvent: createPreparedV2Event({
         id: "7b9a03ca-342a-4150-b56b-989109c45616",
         domainId: "fail",
       }),
-      supplierSpec: { supplierId: "supplier1", specId: "spec1", priority: 10 },
+      supplierSpec: {
+        supplierId: "supplier1",
+        specId: "spec1",
+        priority: 10,
+        billingId: "billing1",
+      },
     };
     const evt: SQSEvent = createSQSEvent([
       createSqsRecord("ok-msg", JSON.stringify(message1)),

lambdas/upsert-letter/src/handler/upsert-handler.ts

@@ -16,12 +16,14 @@ import z from "zod";
 import { MetricsLogger, Unit, metricScope } from "aws-embedded-metrics";
 import { Deps } from "../config/deps";
 
+type SupplierSpec = { supplierId: string; specId: string; priority: number; billingId: string };
 type PreparedEvents = LetterRequestPreparedEventV2 | LetterRequestPreparedEvent;
 
 const SupplierSpecSchema = z.object({
   supplierId: z.string().min(1),
   specId: z.string().min(1),
   priority: z.int().min(0).max(99).default(10),
+  billingId: z.string().min(1),
 });
 
 type SupplierSpec = z.infer<typeof SupplierSpecSchema>;
@@ -66,6 +68,7 @@ function getOperationFromType(type: string): UpsertOperation {
           supplierSpec.specId,
           supplierSpec.specId, // use specId for now
           supplierSpec.priority,
+          supplierSpec.billingId, // use billingId for now
         );
         await deps.letterRepo.putLetter(letterToInsert);
 
@@ -103,6 +106,7 @@ function mapToInsertLetter(
   spec: string,
   billingRef: string,
   priority: number,
+  billingId: string,
 ): InsertLetter {
   const now = new Date().toISOString();
   return {
@@ -122,7 +126,7 @@ function mapToInsertLetter(
     createdAt: now,
     updatedAt: now,
     billingRef,
-    specificationBillingId: spec,
+    specificationBillingId: billingId,
   };
 }
 
@@ -245,6 +249,7 @@ export default function createUpsertLetterHandler(deps: Deps): SQSHandler {
               supplierId: "unknown",
               specId: "unknown",
               priority: 10,
+              billingId: "unknown",
             },
             deps,
           );