review fix

Author: Namitha-Prabhu

tests/component-tests/events-tests/event-subscription.spec.ts

@@ -11,6 +11,7 @@ import {
   pollUpsertLetterLogForError,
 } from "tests/helpers/aws-cloudwatch-helper";
 import { supplierDataSetup } from "tests/helpers/suppliers-setup-helper";
+import { pollForLettersInDb } from "tests/helpers/poll-for-letters-helper";
 
 let baseUrl: string;
 
@@ -27,7 +28,6 @@ test.describe("Event Subscription SNS Tests", () => {
     logger.info(`Testing event subscription with domainId: ${domainId}`);
     const preparedEvent = createPreparedV1Event({ domainId });
     const response = await sendSnsEvent(preparedEvent);
-    const RETRY_DELAY_MS = 30_000;
 
     expect(response.MessageId).toBeTruthy();
 
@@ -48,40 +48,14 @@ test.describe("Event Subscription SNS Tests", () => {
     // check if supplier exists in suppliers table
     await supplierDataSetup(supplierId);
 
-    const headers = createValidRequestHeaders(supplierId);
-    let statusCode = 0;
-    let letterStatus: string | undefined;
-
-    for (let attempt = 1; attempt <= 3; attempt++) {
-      const getLetterResponse = await request.get(
-        `${baseUrl}/${SUPPLIER_LETTERS}/${domainId}`,
-        {
-          headers,
-        },
-      );
-
-      statusCode = getLetterResponse.status();
-      const responseBody = (await getLetterResponse.json()) as {
-        data?: { attributes?: { status?: string } };
-      };
-      letterStatus = responseBody.data?.attributes?.status;
-
-      if (statusCode === 200 && letterStatus === "PENDING") {
-        logger.info(
-          `Attempt ${attempt}: Received status code ${statusCode} for domainId: ${domainId}`,
-        );
-        break;
-      }
-
-      if (attempt < 3) {
-        logger.info(
-          `Attempt ${attempt}: Received status code ${statusCode} for domainId: ${domainId}. Retrying after ${RETRY_DELAY_MS / 1000} seconds...`,
-        );
-        await new Promise((resolve) => {
-          setTimeout(resolve, RETRY_DELAY_MS); // Wait for 30 seconds before the next attempt
-        });
-      }
-    }
+    // poll for letter to be inserted in db with status PENDING
+    const { letterStatus, statusCode } = await pollForLettersInDb(
+      request,
+      supplierId,
+      domainId,
+      baseUrl,
+    );
+
     expect(statusCode).toBe(200);
     expect(letterStatus).toBe("PENDING");
   });

tests/helpers/aws-cloudwatch-helper.ts

@@ -10,7 +10,7 @@ const sleep = (ms: number) =>
   });
 
 export async function pollSupplierAllocatorLogForResolvedSpec(
-  domainId?: string,
+  domainId: string,
 ): Promise<string> {
   const intervalMs = 5000;
   const startTimeMs = Date.now() - 5 * 60_000;
@@ -27,9 +27,7 @@ export async function pollSupplierAllocatorLogForResolvedSpec(
         startTime: startTimeMs,
         interleaved: true,
         limit: 100,
-        filterPattern: domainId
-          ? `"Sending message to upsert letter queue" "${domainId}"`
-          : `"Sending message to upsert letter queue"`,
+        filterPattern: `"Sending message to upsert letter queue" "${domainId}"`,
       }),
     );
 

tests/helpers/poll-for-letters-helper.ts

@@ -0,0 +1,49 @@
+import type { APIRequestContext } from "@playwright/test";
+import { createValidRequestHeaders } from "tests/constants/request-headers";
+import { SUPPLIER_LETTERS } from "tests/constants/api-constants";
+import { logger } from "./pino-logger";
+
+export async function pollForLettersInDb(
+  request: APIRequestContext,
+  supplierId: string,
+  domainId: string,
+  baseUrl: string,
+): Promise<{ letterStatus: string | undefined; statusCode: number }> {
+  const headers = createValidRequestHeaders(supplierId);
+  let statusCode = 0;
+  let letterStatus: string | undefined;
+  const RETRY_DELAY_MS = 10_000;
+  const MAX_ATTEMPTS = 5;
+
+  for (let attempt = 1; attempt <= MAX_ATTEMPTS; attempt++) {
+    const getLetterResponse = await request.get(
+      `${baseUrl}/${SUPPLIER_LETTERS}/${domainId}`,
+      {
+        headers,
+      },
+    );
+
+    statusCode = getLetterResponse.status();
+    const responseBody = (await getLetterResponse.json()) as {
+      data?: { attributes?: { status?: string } };
+    };
+    letterStatus = responseBody.data?.attributes?.status;
+
+    if (statusCode === 200 && letterStatus === "PENDING") {
+      logger.info(
+        `Attempt ${attempt}: Received status code ${statusCode} for domainId: ${domainId}`,
+      );
+      break;
+    }
+
+    if (attempt < MAX_ATTEMPTS) {
+      logger.info(
+        `Attempt ${attempt}: Received status code ${statusCode} for domainId: ${domainId}. Retrying after ${RETRY_DELAY_MS / 1000} seconds...`,
+      );
+      await new Promise((resolve) => {
+        setTimeout(resolve, RETRY_DELAY_MS); // Wait for 30 seconds before the next attempt
+      });
+    }
+  }
+  return { letterStatus, statusCode };
+}