Add wait to patch tests

Author: francisco-videira-nhs

tests/component-tests/apiGateway-tests/update-letter-status.spec.ts

@@ -11,6 +11,7 @@ import {
 import {
   createTestData,
   getLettersBySupplier,
+  waitForLetterStatus,
 } from "../../helpers/generate-fetch-test-data";
 import { createInvalidRequestHeaders } from "../../constants/request-headers";
 import {
@@ -53,6 +54,13 @@ test.describe("API Gateway Tests to Verify Patch Status Endpoint", () => {
     );
 
     expect(response.status()).toBe(202);
+
+    const updated = await waitForLetterStatus(
+      SUPPLIERID,
+      letter.id,
+      "ACCEPTED",
+    );
+    expect(updated.status).toBe("ACCEPTED");
   });
 
   test(`Patch /letters returns 202 and status is updated to REJECTED`, async ({
@@ -71,6 +79,13 @@ test.describe("API Gateway Tests to Verify Patch Status Endpoint", () => {
     );
 
     expect(response.status()).toBe(202);
+
+    const updated = await waitForLetterStatus(
+      SUPPLIERID,
+      letter.id,
+      "REJECTED",
+    );
+    expect(updated.status).toBe("REJECTED");
   });
 
   test(`Patch /letters returns 400 if request Body is invalid`, async ({

tests/helpers/generate-fetch-test-data.ts

@@ -2,11 +2,11 @@ import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
 import {
   DeleteCommand,
   DynamoDBDocumentClient,
+  GetCommand,
   QueryCommand,
 } from "@aws-sdk/lib-dynamodb";
 import {
   LETTERSTABLENAME,
-  SUPPLIERID,
   SUPPLIERTABLENAME,
   envName,
 } from "../constants/api-constants";
@@ -74,6 +74,50 @@ export const getLettersBySupplier = async (
   return Items as SupplierApiLetters[];
 };
 
+const delay = (ms: number) =>
+  new Promise((resolve) => {
+    setTimeout(resolve, ms);
+  });
+
+export async function waitForLetterStatus(
+  supplierId: string,
+  id: string,
+  status: string,
+  options?: {
+    timeoutMs?: number;
+    intervalMs?: number;
+  },
+): Promise<SupplierApiLetters> {
+  const timeoutMs = options?.timeoutMs ?? 60_000;
+  const intervalMs = options?.intervalMs ?? 5000;
+  const startedAt = Date.now();
+
+  while (Date.now() - startedAt < timeoutMs) {
+    const { Item } = await docClient.send(
+      new GetCommand({
+        TableName: LETTERSTABLENAME,
+        Key: { id, supplierId },
+        ProjectionExpression: "id, #status, supplierId",
+        ExpressionAttributeNames: {
+          "#status": "status",
+        },
+      }),
+    );
+
+    const letter = Item as SupplierApiLetters | undefined;
+
+    if (letter && letter.status === status) {
+      return letter;
+    }
+
+    await delay(intervalMs);
+  }
+
+  throw new Error(
+    `Timed out waiting for letter ${id} to reach status ${status} for supplier ${supplierId}.`,
+  );
+}
+
 export const deleteLettersBySupplier = async (
   supplierId: string,
   id: string,