check letter queue; fix lock file

Author: francisco-videira-nhs

package-lock.json

@@ -3,21 +3,23 @@ import { sendSnsEvent } from "tests/helpers/send-sns-event";
 import { createPreparedV1Event } from "tests/helpers/event-fixtures";
 import { randomUUID } from "node:crypto";
 import { logger } from "tests/helpers/pino-logger";
-import { createValidRequestHeaders } from "tests/constants/request-headers";
+// import { createValidRequestHeaders } from "tests/constants/request-headers";
 import getRestApiGatewayBaseUrl from "tests/helpers/aws-gateway-helper";
-import { SUPPLIER_LETTERS } from "tests/constants/api-constants";
+// import { SUPPLIER_LETTERS } from "tests/constants/api-constants";
 import { pollForLetterStatus } from "tests/helpers/poll-for-letters-helper";
 import { pollSupplierAllocatorLogForResolvedSpec } from "tests/helpers/aws-cloudwatch-helper";
-import {
-  GetLettersResponse,
-  GetLettersResponseSchema,
-} from "../../../lambdas/api-handler/src/contracts/letters";
+import { getLettersFromQueueViaIndex } from "tests/helpers/generate-fetch-test-data";
+// import {
+//   GetLettersResponse,
+//   GetLettersResponseSchema,
+// } from "../../../lambdas/api-handler/src/contracts/letters";
 import {
   AllocatedLetter,
   AllocatedLetterSchema,
 } from "../../../lambdas/upsert-letter/src/handler/schemas";
 
-// See group_nhs-notify-supplier-api-dev.tfvars in nhs-notify-internal
+// Values for CI/CD are kept in group_nhs-notify-supplier-api-dev.tfvars in the nhs-notify-internal repo
+// If running locally see default of variant_map in infrastructure/terraform/components/api/variables.tf
 const variantUrgencyMap: Record<string, number> = {
   "digitrials-aspiring": 0,
   "digitrials-dmapp": 1,
@@ -39,8 +41,6 @@ const variantUrgencyMap: Record<string, number> = {
   "notify-standard": 98,
   "notify-standard-colour": 99,
 };
-
-// See group_nhs-notify-supplier-api-dev.tfvars in nhs-notify-internal
 const supplier = "supplier1";
 
 let baseUrl: string;
@@ -68,6 +68,17 @@ test.describe("Urgent Letter Priority Tests", () => {
     await verifyAllocationLogsContainPriority(urgencyNineLetterIds, 9);
     await verifyAllocationLogsContainPriority(urgencyTenLetterIds, 10);
 
+    const lettersFromQueue = await getLettersFromQueueViaIndex(supplier);
+    const letterIdsFromQueue = lettersFromQueue.map(
+      (letter) => letter.letterId,
+    );
+
+    verifyIndexPositionOfLetterVariants(
+      letterIdsFromQueue,
+      urgencyNineLetterIds,
+      urgencyTenLetterIds,
+    );
+
     // TODO: CCM-15185 should call the endpoint directly to verify the order of letters
     // const header = createValidRequestHeaders(supplier);
     // const response = await request.get(`${baseUrl}/${SUPPLIER_LETTERS}`, {
@@ -81,6 +92,8 @@ test.describe("Urgent Letter Priority Tests", () => {
     // const getLettersResponse: GetLettersResponse =
     //   GetLettersResponseSchema.parse(responseBody);
 
+    // const letterIds = getLettersResponse.data.map((letter) => letter.id);
+
     // verifyIndexPositionOfLetterVariants(
     //   getLettersResponse,
     //   urgencyNineLetterIds,
@@ -120,11 +133,10 @@ async function sendEventsForVariants(variants: string[]) {
 }
 
 function verifyIndexPositionOfLetterVariants(
-  getLettersResponse: GetLettersResponse,
+  letterIds: string[],
   letterIdsLeastUrgency: string[],
   letterIdsHigherUrgency: string[],
 ) {
-  const letterIds = getLettersResponse.data.map((letter) => letter.id);
   for (const leastUrgencyLetterId of letterIdsLeastUrgency) {
     expect(letterIds).toContain(leastUrgencyLetterId); // in case limit param is hit
     const indexToTest = letterIds.indexOf(leastUrgencyLetterId);

tests/component-tests/integration-tests/urgent-letter-priority.spec.ts

@@ -13,10 +13,21 @@ import {
 } from "../constants/api-constants";
 import { createSupplierData, runCreateLetter } from "./pnpm-helpers";
 import { logger } from "./pino-logger";
+import z from "zod";
 
 const ddb = new DynamoDBClient({});
 const docClient = DynamoDBDocumentClient.from(ddb);
 
+export const PendingLetterSchema = z.object({
+  supplierId: z.string(),
+  letterId: z.string(),
+  queueTimestamp: z.string(),
+  visibilityTimestamp: z.string(),
+  queueSortOrderSk: z.string().describe("Secondary index SK"),
+    priority: z.int().min(0).max(99).optional(),
+});
+export type PendingLetter = z.infer<typeof PendingLetterSchema>;
+
 export interface SupplierApiLetters {
   supplierId: string;
   specificationId: string;
@@ -211,3 +222,78 @@ export async function checkLetterQueueTable(
     return [false];
   }
 }
+
+export async function getLettersFromQueueViaIndex(
+  supplierId: string,
+): Promise<PendingLetter[]> {
+  const MAX_ATTEMPTS = 5;
+  const RETRY_DELAY_MS = 10_000;
+
+  try {
+    const params = {
+      TableName: LETTERQUEUE_TABLENAME,
+      IndexName: "queueSortOrder-index",
+      KeyConditionExpression:
+        "supplierId = :supplierId",
+      ExpressionAttributeValues: {
+        ":supplierId": supplierId
+      },
+    };
+
+    for (let attempt = 1; attempt <= MAX_ATTEMPTS; attempt++) {
+      const { Items } = await docClient.send(new QueryCommand(params));
+
+      if (Items !== undefined && Items.length > 0) {
+        logger.info(
+          `Queried letter queue table to verify existence for supplier ${supplierId} and found items.`,
+        );
+
+        return z.array(PendingLetterSchema).parse(Items);
+      }
+      if (attempt < MAX_ATTEMPTS) {
+        logger.info(
+          `Retrying get letters from queue for supplierId ${supplierId} in ${RETRY_DELAY_MS}ms`,
+        );
+        await delay(RETRY_DELAY_MS);
+      }
+    }
+    return [];
+  } catch (error) {
+    logger.error({ supplierId, error }, "Letter queue query failed");
+    return [];
+  }
+}
+
+  // async getLetters(
+  //   supplierId: string,
+  //   limit: number,
+  // ): Promise<PendingLetter[]> {
+  //   const letters: PendingLetter[] = [];
+  //   let lastEvaluatedKey: Record<string, unknown> | undefined;
+
+  //   do {
+  //     const result = await this.ddbClient.send(
+  //       new QueryCommand({
+  //         TableName: this.config.letterQueueTableName,
+  //         IndexName: "queueSortOrder-index",
+  //         KeyConditionExpression: "supplierId = :supplierId",
+  //         FilterExpression: "visibilityTimestamp < :now",
+  //         ExpressionAttributeValues: {
+  //           ":supplierId": supplierId,
+  //           ":now": new Date().toISOString(),
+  //         },
+  //         // 1000 is a compromise - a smaller number might result in a lot of round trips, a larger one might
+  //         // entail fetching and then throwing away a lot of data
+  //         Limit: this.config.queryPageSize ?? 1000,
+  //         ExclusiveStartKey: lastEvaluatedKey,
+  //       }),
+  //     );
+
+  //     const page = z.array(PendingLetterSchema).parse(result.Items);
+  //     letters.push(...page);
+
+  //     lastEvaluatedKey = result.LastEvaluatedKey;
+  //   } while (lastEvaluatedKey !== undefined && letters.length < limit);
+
+  //   return letters.slice(0, limit);
+  // }