CCM-9692: add primary status condition

Author: alexnuttall

frontend/src/__tests__/utils/form-actions.test.ts

@@ -491,7 +491,7 @@ describe('form-actions', () => {
       const responseData = {
         id: 'id',
         templateType: 'NHS_APP',
-        templateStatus: 'NOT_YET_SUBMITTED',
+        templateStatus: 'SUBMITTED',
         name: 'name',
         message: 'message',
         createdAt: '2025-01-13T10:19:25.579Z',

infrastructure/terraform/modules/backend-api/spec.tmpl.json

@@ -505,7 +505,8 @@
           "SUBMITTED",
           "DELETED",
           "PENDING_UPLOAD",
-          "PENDING_VALIDATION"
+          "PENDING_VALIDATION",
+          "VIRUS_SCAN_FAILED"
         ]
       },
       "Language": {

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

@@ -501,39 +501,55 @@ describe('templateRepository', () => {
       },
       {
         testName:
-          'Fails when user tries to update template when templateStatus is SUBMITTED',
-        Item: {
-          templateType: { S: 'EMAIL' },
-          templateStatus: { S: 'SUBMITTED' },
-        },
+          'Fails when user tries to submit template when templateStatus is SUBMITTED',
+        Item: marshall({
+          templateType: 'EMAIL',
+          templateStatus: 'SUBMITTED',
+        }),
         code: 400,
         message: 'Template with status SUBMITTED cannot be updated',
       },
       {
         testName:
-          'Fails when user tries to update template when templateStatus is DELETED',
-        Item: {
-          templateType: { S: 'EMAIL' },
-          templateStatus: { S: 'DELETED' },
-        },
+          'Fails when user tries to submit template when templateStatus is not NOT_YET_SUBMITTED',
+        Item: marshall({
+          templateType: 'LETTER',
+          templateStatus: 'PENDING_UPLOAD',
+        }),
+        code: 400,
+        message: 'Template cannot be submitted',
+      },
+      {
+        testName:
+          'Fails when user tries to submit template when templateStatus is DELETED',
+        Item: marshall({
+          templateType: 'EMAIL',
+          templateStatus: 'DELETED',
+        }),
         code: 404,
         message: 'Template not found',
       },
       {
         testName:
-          'Fails when user tries to update a letter template when any virusScanStatus is NOT PASSED',
-        Item: {
-          templateType: { S: 'LETTER' },
-          templateStatus: { S: 'NOT_YET_SUBMITTED' },
-          ...marshall({
-            files: {
-              pdfTemplate: { virusScanStatus: 'PASSED' },
-              testDataCsv: { virusScanStatus: 'FAILED' },
+          'Fails when user tries to submit a letter template when any virusScanStatus is not PASSED',
+        Item: marshall({
+          templateType: 'LETTER',
+          templateStatus: 'NOT_YET_SUBMITTED',
+          files: {
+            pdfTemplate: {
+              virusScanStatus: 'PASSED',
+              currentVersion: 'a',
+              fileName: 'pdf.pdf',
             },
-          }),
-        },
+            testDataCsv: {
+              virusScanStatus: 'FAILED',
+              currentVersion: 'a',
+              fileName: 'csv.csv',
+            },
+          },
+        }),
         code: 400,
-        message: 'Virus scan not complete cannot submit template.',
+        message: 'Template cannot be submitted',
       },
     ])(
       'should return error when, ConditionalCheckFailedException occurs and no Item is returned %p',

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

@@ -23,7 +23,6 @@ import {
 } from '@aws-sdk/lib-dynamodb';
 import { ApplicationResult, failure, success, calculateTTL } from '../../utils';
 import { DatabaseTemplate } from './template';
-import { unmarshall } from '@aws-sdk/util-dynamodb';
 
 type WithAttachments<T> = T extends { templateType: 'LETTER' }
   ? T & { files: LetterFiles }
@@ -209,12 +208,14 @@ export class TemplateRepository {
 
     const expressionAttributeValues: Record<string, string> = {
       ':newStatus': 'SUBMITTED' satisfies TemplateStatus,
+      ':expectedStatus': 'NOT_YET_SUBMITTED' satisfies TemplateStatus,
       ':passed': 'PASSED' satisfies VirusScanStatus,
     };
 
     const conditions = [
       '(attribute_not_exists(files.pdfTemplate) OR files.pdfTemplate.virusScanStatus = :passed)',
       '(attribute_not_exists(files.testDataCsv) OR files.testDataCsv.virusScanStatus = :passed)',
+      '#templateStatus = :notYetSubmitted',
     ];
 
     try {
@@ -230,20 +231,11 @@ export class TemplateRepository {
       return result;
     } catch (error) {
       if (error instanceof ConditionalCheckFailedException && error.Item) {
-        const template = unmarshall(error.Item);
-
-        const virusScanStatuses = [
-          String(template?.files?.pdfTemplate?.virusScanStatus),
-          String(template?.files?.testDataCsv?.virusScanStatus),
-        ];
-
-        if (virusScanStatuses.some((status) => status !== 'PASSED')) {
-          return failure(
-            ErrorCase.VIRUS_SCAN_NOT_COMPLETE,
-            'Virus scan not complete cannot submit template.',
-            error
-          );
-        }
+        return failure(
+          ErrorCase.CANNOT_SUBMIT,
+          'Template cannot be submitted',
+          error
+        );
       }
 
       return failure(ErrorCase.IO_FAILURE, 'Failed to update template', error);

lambdas/backend-client/src/schemas/union-lists.ts

@@ -41,6 +41,7 @@ export const TEMPLATE_STATUS_LIST = arrayOfAll<TemplateStatus>()([
   'DELETED',
   'PENDING_UPLOAD',
   'PENDING_VALIDATION',
+  'VIRUS_SCAN_FAILED',
 ]);
 
 export const LANGUAGE_LIST = arrayOfAll<Language>()([

lambdas/backend-client/src/types/error-cases.ts

@@ -6,5 +6,5 @@ export enum ErrorCase {
   IO_FAILURE = 500,
   TEMPLATE_ALREADY_SUBMITTED = 400,
   CANNOT_CHANGE_TEMPLATE_TYPE = 400,
-  VIRUS_SCAN_NOT_COMPLETE = 400,
+  CANNOT_SUBMIT = 400,
 }

lambdas/backend-client/src/types/generated/types.gen.ts

@@ -7,7 +7,8 @@ export type TemplateStatus =
   | 'SUBMITTED'
   | 'DELETED'
   | 'PENDING_UPLOAD'
-  | 'PENDING_VALIDATION';
+  | 'PENDING_VALIDATION'
+  | 'VIRUS_SCAN_FAILED';
 
 export type Language =
   | 'ar'

tests/test-team/helpers/use-cases/simulate-failed-virus-scan.ts

@@ -6,7 +6,7 @@ import { Template } from '../types';
 type Config = {
   templateId: string;
   templateOwner: string;
-  path:
+  filePath:
     | 'files.pdfTemplate.virusScanStatus'
     | 'files.testDataCsv.virusScanStatus';
 };
@@ -29,9 +29,10 @@ export class SimulateFailedVirusScan implements IUseCase<Template> {
           owner: this.#config.templateOwner,
           id: this.#config.templateId,
         },
-        UpdateExpression: `SET ${this.#config.path} = :virusScanStatus`,
+        UpdateExpression: `SET ${this.#config.filePath} = :virusScanStatus, templateStatus = :virusScanStatusFailedTemplateStatus`,
         ExpressionAttributeValues: {
           ':virusScanStatus': 'FAILED',
+          ':virusScanStatusFailedTemplateStatus': 'VIRUS_SCAN_FAILED',
         },
         ReturnValues: 'ALL_NEW',
       })

tests/test-team/helpers/use-cases/simulate-passed-virus-scan.ts

@@ -8,7 +8,7 @@ type Config = {
   templateOwner: string;
 };
 
-export class SimulatePassedVirusScan implements IUseCase<Template> {
+export class SimulatePassedValidation implements IUseCase<Template> {
   readonly #ddbDocClient: DynamoDBDocumentClient;
   readonly #config: Config;
 
@@ -26,9 +26,14 @@ export class SimulatePassedVirusScan implements IUseCase<Template> {
           owner: this.#config.templateOwner,
           id: this.#config.templateId,
         },
-        UpdateExpression: `SET files.pdfTemplate.virusScanStatus = :virusScanStatus, files.testDataCsv.virusScanStatus = :virusScanStatus`,
+        UpdateExpression: [
+          'SET files.pdfTemplate.virusScanStatus = :virusScanStatus',
+          'files.testDataCsv.virusScanStatus = :virusScanStatus',
+          'templateStatus = :readyForSubmissionStatus',
+        ].join(', '),
         ExpressionAttributeValues: {
           ':virusScanStatus': 'PASSED',
+          ':readyForSubmissionStatus': 'NOT_YET_SYBMITTED',
         },
         ReturnValues: 'ALL_NEW',
       })

tests/test-team/template-mgmt-api-tests/delete-template.api.spec.ts

@@ -9,7 +9,7 @@ import { TemplateAPIPayloadFactory } from '../helpers/factories/template-api-pay
 import { pdfUploadFixtures } from '../fixtures/pdf-upload/multipart-pdf-letter-fixtures';
 import {
   UseCaseOrchestrator,
-  SimulatePassedVirusScan,
+  SimulatePassedValidation,
 } from '../helpers/use-cases';
 
 test.describe('DELETE /v1/template/:templateId', () => {
@@ -143,13 +143,6 @@ test.describe('DELETE /v1/template/:templateId', () => {
 
       expect(response.status(), debug).toBe(201);
 
-      await orchestrator.send(
-        new SimulatePassedVirusScan({
-          templateId: createResult.template.id,
-          templateOwner: user1.userId,
-        })
-      );
-
       const deleteResponse = await request.delete(
         `${process.env.API_BASE_URL}/v1/template/${createResult.template.id}`,
         {
@@ -215,7 +208,7 @@ test.describe('DELETE /v1/template/:templateId', () => {
       expect(response.status(), debug).toBe(201);
 
       await orchestrator.send(
-        new SimulatePassedVirusScan({
+        new SimulatePassedValidation({
           templateId: createResult.template.id,
           templateOwner: user1.userId,
         })