CCM-11352: pr comments

Author: bhansell1

infrastructure/terraform/components/sandbox/sns_topic_events.tf

@@ -1,5 +1,5 @@
 
-# this is not sued for anything other than to keep the eventpub module happy
+# this is not used for anything other than to keep the eventpub module happy
 resource "aws_sns_topic" "events" {
   name = "${local.csi}-events-sns"
 

tests/test-team/config/event/event.teardown.ts

@@ -1,6 +1,6 @@
-import { test as setup } from '@playwright/test';
+import { test as teardown } from '@playwright/test';
 import { createAuthHelper } from '../../helpers/auth/cognito-auth-helper';
 
-setup('event test teardown', async () => {
+teardown('event test teardown', async () => {
   await createAuthHelper().teardown();
 });

tests/test-team/helpers/events/event-cache-helper.ts

@@ -1,9 +1,5 @@
 import { z } from 'zod';
-import {
-  S3Client,
-  SelectObjectContentCommand,
-  SelectObjectContentEventStream,
-} from '@aws-sdk/client-s3';
+import { SelectObjectContentEventStream } from '@aws-sdk/client-s3';
 import {
   $TemplateCompletedEventV1,
   $TemplateDeletedEventV1,
@@ -26,7 +22,6 @@ const $NHSNotifyTemplateEvent = z.discriminatedUnion('type', [
 type NHSNotifyTemplateEvent = z.infer<typeof $NHSNotifyTemplateEvent>;
 
 export class EventCacheHelper {
-  private readonly s3 = new S3Client({ region: 'eu-west-2' });
   private readonly bucketName = process.env.EVENT_CACHE_BUCKET_NAME;
 
   async findEvents(
@@ -58,21 +53,13 @@ export class EventCacheHelper {
     fileName: string,
     templateIds: string[]
   ): Promise<NHSNotifyTemplateEvent[]> {
-    const command = new SelectObjectContentCommand({
-      Bucket: this.bucketName,
-      Key: fileName,
-      Expression: this.buildS3Query(templateIds),
-      ExpressionType: 'SQL',
-      InputSerialization: {
-        JSON: { Type: 'LINES' },
-        CompressionType: 'NONE',
-      },
-      OutputSerialization: {
-        JSON: { RecordDelimiter: '\n' },
-      },
-    });
+    const formattedIds = templateIds.map((r) => `'${r}'`);
 
-    const response = await this.s3.send(command);
+    const response = await S3Helper.queryJSONLFile(
+      this.bucketName,
+      fileName,
+      `SELECT * FROM S3Object s WHERE s.data.id IN (${formattedIds})`
+    );
 
     if (!response.Payload) {
       return [];
@@ -141,12 +128,6 @@ export class EventCacheHelper {
     return paths;
   }
 
-  private buildS3Query(templateIds: string[]): string {
-    const formattedIds = templateIds.map((r) => `'${r}'`);
-
-    return `SELECT * FROM S3Object s WHERE s.data.id IN (${formattedIds})`;
-  }
-
   private buildPathPrefix(date: Date): string {
     return date
       .toISOString()

tests/test-team/helpers/s3-helper.ts

@@ -1,4 +1,9 @@
-import { _Object, ListObjectsV2Command, S3Client } from '@aws-sdk/client-s3';
+import {
+  _Object,
+  ListObjectsV2Command,
+  S3Client,
+  SelectObjectContentCommand,
+} from '@aws-sdk/client-s3';
 
 export class S3Helper {
   private static readonly client = new S3Client({ region: 'eu-west-2' });
@@ -26,6 +31,24 @@ export class S3Helper {
     return allItems;
   }
 
+  static async queryJSONLFile(bucket: string, fileName: string, query: string) {
+    const command = new SelectObjectContentCommand({
+      Bucket: bucket,
+      Key: fileName,
+      Expression: query,
+      ExpressionType: 'SQL',
+      InputSerialization: {
+        JSON: { Type: 'LINES' },
+        CompressionType: 'NONE',
+      },
+      OutputSerialization: {
+        JSON: { RecordDelimiter: '\n' },
+      },
+    });
+
+    return S3Helper.client.send(command);
+  }
+
   static filterAndSort(files: _Object[], from: Date): _Object[] {
     return S3Helper.sort(S3Helper.filter([...files], from));
   }

tests/test-team/template-mgmt-event-tests/letter-templates.event.spec.ts

@@ -12,21 +12,12 @@ import { readFileSync } from 'node:fs';
 import { SftpHelper } from '../helpers/sftp/sftp-helper';
 import { InvokeCommand, LambdaClient } from '@aws-sdk/client-lambda';
 
-const sleep = (delaySeconds: number) =>
-  new Promise((resolve) => setTimeout(resolve, delaySeconds * 1000));
-
 test.describe('Event publishing - Letters', () => {
   const authHelper = createAuthHelper();
   const templateStorageHelper = new TemplateStorageHelper();
   const eventCacheHelper = new EventCacheHelper();
   const sftpHelper = new SftpHelper();
   const lambdaClient = new LambdaClient({ region: 'eu-west-2' });
-  const NON_PUBLISHABLE_LETTER_STATUSES = [
-    'PENDING_UPLOAD',
-    'PENDING_VALIDATION',
-    'VIRUS_SCAN_FAILED',
-    'VALIDATION_FAILED',
-  ] as const;
 
   let userProofingEnabled: TestUser;
   let userProofingDisabled: TestUser;
@@ -42,40 +33,12 @@ test.describe('Event publishing - Letters', () => {
     await templateStorageHelper.deleteSeededTemplates();
   });
 
-  test(`Expect no events for AnyOf: ${NON_PUBLISHABLE_LETTER_STATUSES}`, async () => {
-    const templates = NON_PUBLISHABLE_LETTER_STATUSES.map((status) => {
-      const templateId = randomUUID();
-
-      return {
-        ...TemplateFactory.uploadLetterTemplate(
-          templateId,
-          userProofingEnabled,
-          `user-event-${status}-fails`,
-          status
-        ),
-      };
-    });
-
-    const start = new Date();
-
-    await templateStorageHelper.seedTemplateData(templates);
-
-    // Note: not ideal - but we are expecting 0 events and there can be a delay
-    // in events arriving. We should wait for a moment
-    // 5 seconds seems to largest delay when testing locally
-    await sleep(5);
-
-    const events = await eventCacheHelper.findEvents(
-      start,
-      templates.map((r) => r.id)
-    );
-
-    expect(events).toHaveLength(0);
-  });
-
   test('Expect no events when proofingEnabled is false', async ({
     request,
   }) => {
+    const sleep = (delaySeconds: number) =>
+      new Promise((resolve) => setTimeout(resolve, delaySeconds * 1000));
+
     const templateId = randomUUID();
 
     const start = new Date();