CCM-13372 - Select Preferred Pack

nhsd-david-wass · nhsd-david-wass · commit 3208f3d87232 · 2026-03-26T08:40:58.000Z
diff --git a/infrastructure/terraform/components/api/ddb_table_supplier_configuration.tf b/infrastructure/terraform/components/api/ddb_table_supplier_configuration.tf
@@ -30,6 +30,11 @@ resource "aws_dynamodb_table" "supplier-configuration" {
     type = "S"
   }
 
+  attribute {
+    name = "packSpecificationId"
+    type = "S"
+  }
+
   // The type-index GSI allows us to query for all supplier configurations of a given type (e.g. all letter supplier configurations)
   global_secondary_index {
     name            = "EntityTypeIndex"
@@ -45,6 +50,13 @@ resource "aws_dynamodb_table" "supplier-configuration" {
     projection_type = "ALL"
   }
 
+  global_secondary_index {
+    name            = "packSpecificationId-index"
+    hash_key        = "PK"
+    range_key       = "packSpecificationId"
+    projection_type = "ALL"
+  }
+
   point_in_time_recovery {
     enabled = true
   }
diff --git a/infrastructure/terraform/components/api/module_lambda_supplier_allocator.tf b/infrastructure/terraform/components/api/module_lambda_supplier_allocator.tf
@@ -94,8 +94,7 @@ data "aws_iam_policy_document" "supplier_allocator_lambda" {
 
     resources = [
       aws_dynamodb_table.supplier-configuration.arn,
-      "${aws_dynamodb_table.supplier-configuration.arn}/index/volumeGroup-index"
-
+      "${aws_dynamodb_table.supplier-configuration.arn}/index/*"
     ]
   }
 }
diff --git a/internal/datastore/src/__test__/db.ts b/internal/datastore/src/__test__/db.ts
@@ -165,11 +165,22 @@ const createSupplierConfigTableCommand = new CreateTableCommand({
         ProjectionType: "ALL",
       },
     },
+    {
+      IndexName: "packSpecificationId-index",
+      KeySchema: [
+        { AttributeName: "PK", KeyType: "HASH" }, // Partition key for GSI
+        { AttributeName: "packSpecificationId", KeyType: "RANGE" }, // Sort key for GSI
+      ],
+      Projection: {
+        ProjectionType: "ALL",
+      },
+    },
   ],
   AttributeDefinitions: [
     { AttributeName: "PK", AttributeType: "S" },
     { AttributeName: "SK", AttributeType: "S" },
     { AttributeName: "volumeGroup", AttributeType: "S" },
+    { AttributeName: "packSpecificationId", AttributeType: "S" },
   ],
 });
 
diff --git a/internal/datastore/src/__test__/supplier-config-repository.test.ts b/internal/datastore/src/__test__/supplier-config-repository.test.ts
@@ -263,4 +263,89 @@ describe("SupplierConfigRepository", () => {
       `Supplier with id ${supplierId} not found`,
     );
   });
+
+  test("getSupplierPacksForPackSpecification returns correct supplier packs", async () => {
+    const packSpecId = "pack-spec-123";
+    const supplierId = "supplier-123";
+    const supplierPackId = "supplier-pack-123";
+
+    await dbContext.docClient.send(
+      new PutCommand({
+        TableName: dbContext.config.supplierConfigTableName,
+        Item: {
+          PK: "SUPPLIER_PACK",
+          SK: supplierPackId,
+          id: supplierPackId,
+          packSpecificationId: packSpecId,
+          supplierId,
+          status: "PROD",
+          approval: "APPROVED",
+        },
+      }),
+    );
+
+    const result =
+      await repository.getSupplierPacksForPackSpecification(packSpecId);
+    expect(result).toEqual([
+      {
+        approval: "APPROVED",
+        id: supplierPackId,
+        packSpecificationId: packSpecId,
+        supplierId,
+        status: "PROD",
+      },
+    ]);
+  });
+
+  test("getSupplierPacksForPackSpecification throws error for non-existent pack specification", async () => {
+    const packSpecId = "non-existent-pack-spec";
+
+    await expect(
+      repository.getSupplierPacksForPackSpecification(packSpecId),
+    ).rejects.toThrow(
+      `No supplier packs found for pack specification id ${packSpecId}`,
+    );
+  });
+
+  test("getPackSpecification returns correct pack specification details", async () => {
+    const packSpecId = "pack-spec-123";
+
+    await dbContext.docClient.send(
+      new PutCommand({
+        TableName: dbContext.config.supplierConfigTableName,
+        Item: {
+          PK: "PACK_SPECIFICATION",
+          SK: packSpecId,
+          id: packSpecId,
+          name: `Pack Specification ${packSpecId}`,
+          createdAt: new Date().toISOString(),
+          updatedAt: new Date().toISOString(),
+          version: 1,
+          billingId: `billing-${packSpecId}`,
+          postage: { id: "postageId", size: "STANDARD" },
+          status: "PROD",
+        },
+      }),
+    );
+
+    const result = await repository.getPackSpecification(packSpecId);
+    expect(result).toEqual({
+      billingId: `billing-${packSpecId}`,
+      createdAt: expect.any(String),
+      id: packSpecId,
+      name: `Pack Specification ${packSpecId}`,
+      postage: { id: "postageId", size: "STANDARD" },
+      updatedAt: expect.any(String),
+      version: 1,
+      status: "PROD",
+    });
+  });
+
+  test("getPackSpecification throws error for non-existent pack specification", async () => {
+    const packSpecId = "non-existent-pack-spec";
+
+    await expect(repository.getPackSpecification(packSpecId)).rejects.toThrow(
+      `No pack specification found for id ${packSpecId}`,
+    );
+  });
 });
diff --git a/internal/datastore/src/supplier-config-repository.ts b/internal/datastore/src/supplier-config-repository.ts
@@ -5,12 +5,16 @@ import {
 } from "@aws-sdk/lib-dynamodb";
 import {
   $LetterVariant,
+  $PackSpecification,
   $Supplier,
   $SupplierAllocation,
+  $SupplierPack,
   $VolumeGroup,
   LetterVariant,
+  PackSpecification,
   Supplier,
   SupplierAllocation,
+  SupplierPack,
   VolumeGroup,
 } from "@nhsdigital/nhs-notify-event-schemas-supplier-config";
 
@@ -97,4 +101,44 @@ export class SupplierConfigRepository {
     }
     return suppliers;
   }
+
+  async getSupplierPacksForPackSpecification(
+    packSpecId: string,
+  ): Promise<SupplierPack[]> {
+    const result = await this.ddbClient.send(
+      new QueryCommand({
+        TableName: this.config.supplierConfigTableName,
+        IndexName: "packSpecificationId-index",
+        KeyConditionExpression: "#pk = :pk AND #packSpecId = :packSpecId",
+        ExpressionAttributeNames: {
+          "#pk": "PK",
+          "#packSpecId": "packSpecificationId",
+        },
+        ExpressionAttributeValues: {
+          ":pk": "SUPPLIER_PACK",
+          ":packSpecId": packSpecId,
+        },
+      }),
+    );
+    if (!result.Items || result.Items.length === 0) {
+      throw new Error(
+        `No supplier packs found for pack specification id ${packSpecId}`,
+      );
+    }
+
+    return $SupplierPack.array().parse(result.Items);
+  }
+
+  async getPackSpecification(packSpecId: string): Promise<PackSpecification> {
+    const result = await this.ddbClient.send(
+      new GetCommand({
+        TableName: this.config.supplierConfigTableName,
+        Key: { PK: "PACK_SPECIFICATION", SK: packSpecId },
+      }),
+    );
+    if (!result.Item) {
+      throw new Error(`No pack specification found for id ${packSpecId}`);
+    }
+    return $PackSpecification.parse(result.Item);
+  }
 }
diff --git a/lambdas/supplier-allocator/src/handler/__tests__/allocate-handler.test.ts b/lambdas/supplier-allocator/src/handler/__tests__/allocate-handler.test.ts
@@ -1,6 +1,6 @@
+import { SQSClient, SendMessageCommand } from "@aws-sdk/client-sqs";
 import { SQSEvent, SQSRecord } from "aws-lambda";
 import pino from "pino";
-import { SQSClient, SendMessageCommand } from "@aws-sdk/client-sqs";
 import { LetterRequestPreparedEventV2 } from "@nhsdigital/nhs-notify-event-schemas-letter-rendering";
 import { LetterRequestPreparedEvent } from "@nhsdigital/nhs-notify-event-schemas-letter-rendering-v1";
 import {
@@ -153,6 +153,17 @@ function setupDefaultMocks() {
     priority: 1,
     billingId: "billing-1",
   });
+  (supplierConfig.getPreferredSupplierPacks as jest.Mock).mockResolvedValue([
+    {
+      packSpecificationId: "pack-spec-1",
+    },
+  ]);
+  (supplierConfig.getPackSpecification as jest.Mock).mockResolvedValue({
+    id: "pack-spec-1",
+    type: "A4",
+    colour: false,
+    duplex: false,
+  });
 }
 
 describe("createSupplierAllocatorHandler", () => {
diff --git a/lambdas/supplier-allocator/src/handler/allocate-handler.ts b/lambdas/supplier-allocator/src/handler/allocate-handler.ts
@@ -3,15 +3,19 @@ import { SendMessageCommand } from "@aws-sdk/client-sqs";
 import { LetterRequestPreparedEvent } from "@nhsdigital/nhs-notify-event-schemas-letter-rendering-v1";
 import {
   LetterVariant,
+  PackSpecification,
   Supplier,
   SupplierAllocation,
+  SupplierPack,
   VolumeGroup,
 } from "@nhsdigital/nhs-notify-event-schemas-supplier-config";
 import { LetterRequestPreparedEventV2 } from "@nhsdigital/nhs-notify-event-schemas-letter-rendering";
 import z from "zod";
 import { Unit } from "aws-embedded-metrics";
 import { MetricEntry, MetricStatus, buildEMFObject } from "@internal/helpers";
 import {
+  getPackSpecification,
+  getPreferredSupplierPacks,
   getSupplierAllocationsForVolumeGroup,
   getSupplierDetails,
   getVariantDetails,
@@ -83,19 +87,34 @@ async function getSupplierFromConfig(letterEvent: PreparedEvents, deps: Deps) {
         variantDetails.supplierId,
       );
 
-    const supplierDetails: Supplier[] = await getSupplierDetails(
+    const allocatedSuppliers: Supplier[] = await getSupplierDetails(
       supplierAllocations,
       deps,
     );
+
+    const preferredSupplierPacks: SupplierPack[] =
+      await getPreferredSupplierPacks(
+        variantDetails.packSpecificationIds,
+        allocatedSuppliers,
+        deps,
+      );
+
+    const preferredPack: PackSpecification = await getPackSpecification(
+      preferredSupplierPacks[0].packSpecificationId,
+      deps,
+    );
+
     deps.logger.info({
       description: "Fetched supplier details for supplier allocations",
       variantId: letterEvent.data.letterVariantId,
       volumeGroupId: volumeGroupDetails.id,
       supplierAllocationIds: supplierAllocations.map((a) => a.id),
-      supplierDetails,
+      allocatedSuppliers,
+      preferredSupplierPacks,
+      preferredPack,
     });
 
-    return supplierDetails;
+    return allocatedSuppliers;
   } catch (error) {
     deps.logger.error({
       description: "Error fetching supplier from config",
diff --git a/lambdas/supplier-allocator/src/services/__tests__/supplier-config.test.ts b/lambdas/supplier-allocator/src/services/__tests__/supplier-config.test.ts
@@ -1,4 +1,6 @@
 import {
+  getPackSpecification,
+  getPreferredSupplierPacks,
   getSupplierAllocationsForVolumeGroup,
   getSupplierDetails,
   getVariantDetails,
@@ -31,7 +33,7 @@ describe("supplier-config service", () => {
   afterEach(() => jest.resetAllMocks());
 
   describe("getVariantDetails", () => {
-    it("returns variant details", async () => {
+    it("returns variant details for valid id", async () => {
       const variant = { id: "v1", volumeGroupId: "g1" } as any;
       const deps = makeDeps();
       deps.supplierConfigRepo.getLetterVariant = jest
@@ -336,4 +338,67 @@ describe("supplier-config service", () => {
     expect(result).toEqual([suppliers[0], suppliers[2]]);
     expect(result.every((s) => s.status === "PROD")).toBe(true);
   });
+  describe("getPreferredSupplierPacks", () => {
+    it("returns preferred supplier packs when found", async () => {
+      const suppliers = [
+        { id: "s1", name: "Supplier 1", status: "PROD" },
+        { id: "s2", name: "Supplier 2", status: "PROD" },
+      ] as any[];
+      const supplierPacks = [
+        { id: "p1", supplierId: "s1", packSpecificationId: "spec1" },
+        { id: "p2", supplierId: "s2", packSpecificationId: "spec1" },
+        { id: "p3", supplierId: "s3", packSpecificationId: "spec1" },
+      ] as any[];
+      const deps = makeDeps();
+      deps.supplierConfigRepo.getSupplierPacksForPackSpecification = jest
+        .fn()
+        .mockResolvedValue(supplierPacks);
+
+      const result = await getPreferredSupplierPacks(
+        ["spec1"],
+        suppliers,
+        deps,
+      );
+
+      expect(result).toEqual([
+        { id: "p1", supplierId: "s1", packSpecificationId: "spec1" },
+        { id: "p2", supplierId: "s2", packSpecificationId: "spec1" },
+      ]);
+    });
+
+    it("throws when no preferred supplier packs found", async () => {
+      const suppliers = [
+        { id: "s1", name: "Supplier 1", status: "PROD" },
+        { id: "s2", name: "Supplier 2", status: "PROD" },
+      ] as any[];
+      const deps = makeDeps();
+      deps.supplierConfigRepo.getSupplierPacksForPackSpecification = jest
+        .fn()
+        .mockResolvedValue([]);
+
+      await expect(
+        getPreferredSupplierPacks(["spec1"], suppliers, deps),
+      ).rejects.toThrow(/No preferred supplier packs found/);
+      expect(deps.logger.error).toHaveBeenCalledWith(
+        expect.objectContaining({
+          description:
+            "No preferred supplier packs found for pack specification ids and suppliers",
+        }),
+      );
+    });
+  });
+
+  describe("getPackSpecification", () => {
+    it("returns pack specification when found", async () => {
+      const packSpec = { id: "spec1", name: "Pack Spec 1" } as any;
+      const deps = makeDeps();
+      deps.supplierConfigRepo.getPackSpecification = jest
+        .fn()
+        .mockResolvedValue(packSpec);
+
+      const result = await getPackSpecification("spec1", deps);
+
+      expect(result).toBe(packSpec);
+    });
+  });
 });
diff --git a/lambdas/supplier-allocator/src/services/supplier-config.ts b/lambdas/supplier-allocator/src/services/supplier-config.ts

Original file line number	Diff line number	Diff line change
`@@ -94,8 +94,7 @@ data "aws_iam_policy_document" "supplier_allocator_lambda" {`
`94`	`94`
`95`	`95`	`resources = [`
`96`	`96`	`aws_dynamodb_table.supplier-configuration.arn,`
`97`		`- "${aws_dynamodb_table.supplier-configuration.arn}/index/volumeGroup-index"`
`98`		`-`
	`97`	`+ "${aws_dynamodb_table.supplier-configuration.arn}/index/*"`
`99`	`98`	`]`
`100`	`99`	`}`
`101`	`100`	`}`