Initial idempotency test

Author: nhsd-david-wass

tests/component-tests/allocation-tests/supplier-allocation.spec.ts

@@ -0,0 +1,63 @@
+import { expect, test } from "@playwright/test";
+import {
+  getTotalAllocationForVolumeGroup,
+  getTotalDailyAllocation,
+} from "tests/helpers/supplier-quotas-helper";
+import { supplierIdFromSupplierAllocatorLog } from "tests/helpers/aws-cloudwatch-helper";
+import { logger } from "tests/helpers/pino-logger";
+import { format } from "date-fns";
+import { toZonedTime } from "date-fns-tz";
+import { randomUUID } from "node:crypto";
+import { createPreparedV1Event } from "tests/helpers/event-fixtures";
+import { sendSnsBatchEvent } from "tests/helpers/send-sns-event";
+import { domain } from "zod/v4/core/regexes.cjs";
+
+test.describe("Supplier Allocation Tests", () => {
+  test("Verify that supplier allocations are correctly updated for a volume group", async () => {
+    test.setTimeout(180_000);
+    const volumeGroupId = "volumeGroup-test3";
+    const originalTotalAllocation =
+      await getTotalAllocationForVolumeGroup(volumeGroupId);
+    logger.info(
+      `Total allocation for volume group ${volumeGroupId}: ${originalTotalAllocation}`,
+    );
+
+    const allocationDate = format(
+      toZonedTime(new Date(), "Europe/London"),
+      "yyyy-MM-dd",
+    );
+    const originalTotalDailyAllocation =
+      await getTotalDailyAllocation(allocationDate);
+    logger.info(
+      `Total daily allocation for date ${allocationDate}: ${originalTotalDailyAllocation}`,
+    );
+
+    // Create 2 messages with same domain id
+    const domainId = randomUUID();
+
+    const message1 = createPreparedV1Event({ domainId });
+    const message2 = createPreparedV1Event({ domainId });
+
+    const eventBatch = [message1, message2];
+    const response = await sendSnsBatchEvent(
+      eventBatch.map((event) => ({ id: event.id, message: event })),
+    );
+    expect(response.Successful).toHaveLength(eventBatch.length);
+
+    await supplierIdFromSupplierAllocatorLog(domainId);
+
+    const newTotalAllocation =
+      await getTotalAllocationForVolumeGroup(volumeGroupId);
+    logger.info(
+      `New total allocation for volume group ${volumeGroupId}: ${newTotalAllocation}`,
+    );
+    expect(newTotalAllocation).toBe(originalTotalAllocation + 1);
+
+    const newTotalDailyAllocation =
+      await getTotalDailyAllocation(allocationDate);
+    logger.info(
+      `New total daily allocation for date ${allocationDate}: ${newTotalDailyAllocation}`,
+    );
+    expect(newTotalDailyAllocation).toBe(originalTotalDailyAllocation + 1);
+  });
+});

tests/constants/api-constants.ts

@@ -16,3 +16,4 @@ export const EVENT_SUBSCRIPTION_TOPIC_ARN =
   process.env.EVENT_SUBSCRIPTION_TOPIC_ARN ??
   `arn:aws:sns:${AWS_REGION}:${AWS_ACCOUNT_ID}:${EVENT_SUBSCRIPTION_TOPIC_NAME}`;
 export const LETTERQUEUE_TABLENAME = `nhs-${envName}-supapi-letter-queue`;
+export const SUPPLIER_QUOTAS_TABLENAME = `nhs-${envName}-supapi-supplier-quotas`;

tests/helpers/supplier-quotas-helper.ts

@@ -0,0 +1,114 @@
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import {
+  GetCommand,
+  DynamoDBDocumentClient,
+  QueryCommand,
+} from "@aws-sdk/lib-dynamodb";
+import {
+  $Supplier,
+  $VolumeGroup,
+} from "@nhsdigital/nhs-notify-event-schemas-supplier-config";
+import z from "zod";
+import { SUPPLIER_QUOTAS_TABLENAME, envName } from "../constants/api-constants";
+import { logger } from "./pino-logger";
+import { id } from "zod/v4/locales";
+
+const ddb = new DynamoDBClient({});
+const docClient = DynamoDBDocumentClient.from(ddb);
+
+export const overallAllocationSchema = z.object({
+  id: z.string(),
+  volumeGroup: z.string(),
+  allocations: z.record(z.string(), z.number()),
+});
+
+export const dailyAllocationSchema = z.object({
+  id: z.string(),
+  date: z.string(),
+  allocations: z.record(z.string(), z.number()),
+});
+
+export async function getTotalAllocationForVolumeGroup(
+  volumeGroupId: string,
+): Promise<number> {
+  try {
+    const result = await docClient.send(
+      new GetCommand({
+        TableName: SUPPLIER_QUOTAS_TABLENAME,
+        Key: { pk: "ENTITY#overall-allocation", sk: `ID#${volumeGroupId}` },
+      }),
+    );
+    logger.info(`Selecting from table name: ${SUPPLIER_QUOTAS_TABLENAME}`);
+
+    if (!result.Item) {
+      logger.warn(
+        `No overall allocation found for volume group ${volumeGroupId}`,
+      );
+      return 0; // Default to 0 if no allocation record exists
+    }
+    // Strip DynamoDB keys before parsing
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { pk, sk, ...item } = result.Item;
+    const overallAllocation = overallAllocationSchema.parse(item);
+
+    logger.info(
+      `Fetched overall allocation for volume group ${volumeGroupId}: ${JSON.stringify(overallAllocation)}`,
+    );
+    const { allocations } = overallAllocation;
+
+    const totalAllocation = Object.values(allocations).reduce(
+      (sum, allocation) => sum + allocation,
+      0,
+    );
+    logger.info(
+      `Fetched overall allocation for volume group ${volumeGroupId}: ${totalAllocation}`,
+    );
+    return totalAllocation;
+  } catch (error) {
+    logger.error(
+      `Error fetching overall allocation for volume group ${volumeGroupId}: ${error}`,
+    );
+    throw error;
+  }
+}
+export async function getTotalDailyAllocation(
+  allocationDate: string,
+): Promise<number> {
+  try {
+    const result = await docClient.send(
+      new GetCommand({
+        TableName: SUPPLIER_QUOTAS_TABLENAME,
+        Key: { pk: "ENTITY#daily-allocation", sk: `ID#${allocationDate}` },
+      }),
+    );
+    logger.info(`Selecting from table name: ${SUPPLIER_QUOTAS_TABLENAME}`);
+
+    if (!result.Item) {
+      logger.warn(`No daily allocation found for date ${allocationDate}`);
+      return 0; // Default to 0 if no allocation record exists
+    }
+    // Strip DynamoDB keys before parsing
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { pk, sk, ...item } = result.Item;
+    const dailyAllocation = dailyAllocationSchema.parse(item);
+
+    logger.info(
+      `Fetched daily allocation for date ${allocationDate}: ${JSON.stringify(dailyAllocation)}`,
+    );
+    const { allocations } = dailyAllocation;
+
+    const totalAllocation = Object.values(allocations).reduce(
+      (sum, allocation) => sum + allocation,
+      0,
+    );
+    logger.info(
+      `Fetched daily allocation for date ${allocationDate}: ${totalAllocation}`,
+    );
+    return totalAllocation;
+  } catch (error) {
+    logger.error(
+      `Error fetching daily allocation for date ${allocationDate}: ${error}`,
+    );
+    throw error;
+  }
+}