CCM-10048: clean up

Author: bhansell1

infrastructure/terraform/modules/backend-api/README.md

@@ -16,7 +16,7 @@ No requirements.
 | <a name="input_csi"></a> [csi](#input\_csi) | CSI from the parent component | `string` | n/a | yes |
 | <a name="input_enable_backup"></a> [enable\_backup](#input\_enable\_backup) | Enable Backups for the DynamoDB table? | `bool` | `true` | no |
 | <a name="input_enable_event_stream"></a> [enable\_event\_stream](#input\_enable\_event\_stream) | Enable DynamoDB streaming to SQS? | `bool` | `false` | no |
-| <a name="input_enable_guardduty"></a> [enable\_guardduty](#input\_enable\_guardduty) | Enable GuardDuty | `bool` | `false` | no |
+| <a name="input_enable_guardduty"></a> [enable\_guardduty](#input\_enable\_guardduty) | Enable GuardDuty | `bool` | `true` | no |
 | <a name="input_enable_proofing"></a> [enable\_proofing](#input\_enable\_proofing) | Enable proofing feature flag | `bool` | n/a | yes |
 | <a name="input_environment"></a> [environment](#input\_environment) | The name of the tfscaffold environment | `string` | n/a | yes |
 | <a name="input_function_s3_bucket"></a> [function\_s3\_bucket](#input\_function\_s3\_bucket) | Name of S3 bucket to upload lambda artefacts to | `string` | n/a | yes |

infrastructure/terraform/modules/backend-api/variables.tf

@@ -74,7 +74,7 @@ variable "enable_backup" {
 variable "enable_guardduty" {
   type        = bool
   description = "Enable GuardDuty"
-  default     = false
+  default     = true
 }
 
 variable "enable_proofing" {

lambdas/backend-api/src/templates/infra/template-repository.ts

@@ -500,10 +500,7 @@ export class TemplateRepository {
     );
 
     if (dbResponse.Items?.length !== 1) {
-      throw new Error(
-        `Could not identify item by id ${id}. Items found: ${dbResponse.Items?.length || 0}`,
-        { cause: dbResponse }
-      );
+      throw new Error(`Could not identify item by id ${id}`);
     }
 
     return dbResponse.Items[0].owner;

run-e2e.sh

@@ -13,7 +13,6 @@ declare global {
       TEMPLATES_INTERNAL_BUCKET_NAME: string;
       TEMPLATES_QUARANTINE_BUCKET_NAME: string;
       TEMPLATES_DOWNLOAD_BUCKET_NAME: string;
-      TEMPLATES_GUARDDUTY_RESOURCE_ARN: string;
     }
   }
 

tests/test-team/global.d.ts

@@ -12,7 +12,7 @@ export const templateTypeToUrlTextMappings: Record<string, string> = {
   LETTER: 'letter',
 };
 
-export type TemplateFile = {
+export type File = {
   fileName: string;
   currentVersion: string;
   virusScanStatus: string;
@@ -24,9 +24,9 @@ type TypeSpecificProperties = {
   letterType?: string;
   language?: string;
   files?: {
-    pdfTemplate?: TemplateFile;
-    testDataCsv?: TemplateFile;
-    proofs?: Record<string, Pick<TemplateFile, 'fileName' | 'virusScanStatus'>>;
+    pdfTemplate?: File;
+    testDataCsv?: File;
+    proofs?: Record<string, Pick<File, 'fileName' | 'virusScanStatus'>>;
   };
   personalisationParameters?: string[];
   testDataCsvHeaders?: string[];

tests/test-team/helpers/types.ts

@@ -13,7 +13,8 @@ import {
   assertTestDataGuardDutyEvent,
 } from './template-mgmt-letter-guardduty.steps';
 
-test.describe('letter file validation', () => {
+// eslint-disable-next-line playwright/no-skipped-test
+test.describe.skip('letter file validation', () => {
   const templateStorageHelper = new TemplateStorageHelper();
   let user: TestUser;
 

tests/test-team/template-mgmt-e2e-tests/template-mgmt-letter-file-validation.e2e.spec.ts

@@ -21,7 +21,7 @@ import {
 const lambdaClient = new LambdaClient({ region: 'eu-west-2' });
 
 // eslint-disable-next-line playwright/no-skipped-test
-test.describe('letter complete e2e journey', () => {
+test.describe.skip('letter complete e2e journey', () => {
   const templateStorageHelper = new TemplateStorageHelper();
 
   let user: TestUser;

tests/test-team/template-mgmt-e2e-tests/template-mgmt-letter-full.e2e.spec.ts

@@ -4,7 +4,7 @@ import {
   GuardDutyScanResult,
 } from '../helpers/eventbridge/eventbridge-helper';
 import { TemplateStorageHelper } from '../helpers/db/template-storage-helper';
-import { Template, TemplateFile } from '../helpers/types';
+import { Template, File } from '../helpers/types';
 
 type EventConfig = {
   key: { id: string; owner: string };
@@ -13,8 +13,8 @@ type EventConfig = {
 
 type FileConfig = {
   pathPrefix: 'pdf-template' | 'test-data' | 'proofs';
-  getFile: (template: Template) => TemplateFile | undefined;
-  getPath: (template: Template, file?: TemplateFile) => string;
+  getFile: (template: Template) => File | undefined;
+  getPath: (template: Template, file?: File) => string;
 };
 
 const templateStorageHelper = new TemplateStorageHelper();
@@ -33,7 +33,7 @@ function assertGuardDutyEventForFile(
 
       const file = getFile(template);
 
-      const path = getPath(template, file);
+      const path = `${pathPrefix}/${getPath(template, file)}`;
 
       const metadata = await templateStorageHelper.getS3Metadata(
         process.env.TEMPLATES_QUARANTINE_BUCKET_NAME,
@@ -60,7 +60,7 @@ export function assertPdfTemplateGuardDutyEvent(props: EventConfig) {
     pathPrefix: 'pdf-template',
     getFile: (template) => template.files?.pdfTemplate,
     getPath: (template, file) =>
-      `pdf-template/${template.owner}/${template.id}/${file?.currentVersion}.pdf`,
+      `${template.owner}/${template.id}/${file?.currentVersion}.pdf`,
   });
 }
 
@@ -69,7 +69,7 @@ export function assertTestDataGuardDutyEvent(props: EventConfig) {
     pathPrefix: 'test-data',
     getFile: (template) => template.files?.testDataCsv,
     getPath: (template, file) =>
-      `test-data/${template.owner}/${template.id}/${file?.currentVersion}.csv`,
+      `${template.owner}/${template.id}/${file?.currentVersion}.csv`,
   });
 }
 
@@ -85,6 +85,6 @@ export function assertProofGuardDutyEvent(
         return { ...file, currentVersion: 'unknown' };
       }
     },
-    getPath: () => `proofs/${props.key.id}/${props.fileName}`,
+    getPath: () => `${props.key.id}/${props.fileName}`,
   });
 }

tests/test-team/template-mgmt-e2e-tests/template-mgmt-letter-guardduty.steps.ts

@@ -1,5 +1,3 @@
-/* eslint-disable sonarjs/no-dead-store */
-/* eslint-disable @typescript-eslint/no-unused-vars */
 import { readFileSync } from 'node:fs';
 import { expect, test } from '@playwright/test';
 import {
@@ -11,7 +9,6 @@ import { TemplateStorageHelper } from '../helpers/db/template-storage-helper';
 import { pdfUploadFixtures } from '../fixtures/pdf-upload/multipart-pdf-letter-fixtures';
 import { SftpHelper } from '../helpers/sftp/sftp-helper';
 import { InvokeCommand, LambdaClient } from '@aws-sdk/client-lambda';
-import { assertProofGuardDutyEvent } from './template-mgmt-letter-guardduty.steps';
 
 const templateStorageHelper = new TemplateStorageHelper();
 const authHelper = createAuthHelper();
@@ -70,32 +67,12 @@ test.describe('Letter Proofing', () => {
       })
     );
 
-    const key = {
-      id: templateId,
-      owner: user.userId,
-    };
-
-    await assertProofGuardDutyEvent({
-      key,
-      scanResult: 'NO_THREATS_FOUND',
-      fileName: `proof-1.pdf`,
-    });
-
-    await assertProofGuardDutyEvent({
-      key,
-      scanResult: 'NO_THREATS_FOUND',
-      fileName: `proof-2.pdf`,
-    });
-
-    await assertProofGuardDutyEvent({
-      key,
-      scanResult: 'NO_THREATS_FOUND',
-      fileName: `proof-3.pdf`,
-    });
-
     // check for expected results
     await expect(async () => {
-      const template = await templateStorageHelper.getTemplate(key);
+      const template = await templateStorageHelper.getTemplate({
+        owner: user.userId,
+        id: templateId,
+      });
 
       expect(template.files?.proofs).toEqual({
         'proof-1.pdf': {
@@ -187,19 +164,12 @@ test.describe('Letter Proofing', () => {
       })
     );
 
-    const key = {
-      owner: user.userId,
-      id: templateId,
-    };
-
-    await assertProofGuardDutyEvent({
-      key,
-      scanResult: 'THREATS_FOUND',
-      fileName: `proof.pdf`,
-    });
-
+    // check for expected results
     await expect(async () => {
-      const template = await templateStorageHelper.getTemplate(key);
+      const template = await templateStorageHelper.getTemplate({
+        owner: user.userId,
+        id: templateId,
+      });
 
       expect(template.files?.proofs).toEqual({
         'proof.pdf': {