CCM-8420: remove confirmation email (#274)

Author: mark-r-bjss

.github/workflows/stage-4-acceptance.yaml

@@ -106,9 +106,6 @@ jobs:
       - name: "Repo setup"
         run: |
           npm ci
-      - name: "Generate dependencies"
-        run: |
-          npm run generate-dependencies --workspaces --if-present
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@v4
         with:
@@ -144,9 +141,6 @@ jobs:
       - name: "Repo setup"
         run: |
           npm ci
-      - name: "Generate dependencies"
-        run: |
-          npm run generate-dependencies --workspaces --if-present
       - name: Install Playwright Browsers
         run: npx playwright install --with-deps
       - name: Configure AWS credentials

README.md

@@ -37,40 +37,27 @@
 
 ### Running the project locally
 
-1. Convert the email HTML template into a JSON file that can be packaged with the email sending lambda.
-
-   ```shell
-   npm run generate-dependencies
-   ```
-
-2. (Optional) If you want to test sending emails then you will need to set the following environment variables locally.
-
-   ```shell
-   export ACCOUNT_ID=<aws_account_id>
-   export NOTIFY_DOMAIN_NAME=<ses_verified_domain>
-   ```
-
-3. To create a Terraform backend sandbox, run:
+1. To create a Terraform backend sandbox, run:
 
    ```shell
    npm run create-backend-sandbox <environment-name>
    ```
 
-4. Then in a separate terminal, run the app locally:
+2. Then in a separate terminal, run the app locally:
 
    ```shell
    npm run dev
    ```
 
-5. Open your browser and go to `localhost:3000` to view the app.
+3. Open your browser and go to `localhost:3000` to view the app.
 
-6. To destroy a Terraform backend sandbox, run:
+4. To destroy a Terraform backend sandbox, run:
 
    ```shell
    npm run destroy-backend-sandbox <environment-name>
    ```
 
-7. (Optional) Create a `.env` file at `frontend/.env` and add `INCLUDE_AUTH_PAGES=true` to include the local auth pages when doing a production Next build
+5. (Optional) Create a `.env` file at `frontend/.env` and add `INCLUDE_AUTH_PAGES=true` to include the local auth pages when doing a production Next build
 
 ### Other commands
 

amplify.yml

@@ -9,7 +9,6 @@ applications:
             - nvm install 20.13.1
             - nvm use 20.13.1
             - npm ci --cache .npm --prefer-offline
-            - npm run generate-dependencies --workspaces --if-present
             - npm run create-amplify-outputs env
             - cd frontend
     frontend:

frontend/jest.config.ts

@@ -28,7 +28,6 @@ const config: Config = {
     '.snap',
     'resource.ts',
     'backend.ts',
-    'generate-dependencies.ts',
     'jest.config.ts',
     '.dev.tsx',
   ],

frontend/src/__tests__/components/forms/SubmitTemplate/server-action.test.ts

@@ -4,7 +4,7 @@
 import { submitTemplate } from '@forms/SubmitTemplate/server-action';
 import { getMockFormData } from '@testhelpers';
 import { redirect } from 'next/navigation';
-import { getTemplate, saveTemplate, sendEmail } from '@utils/form-actions';
+import { getTemplate, saveTemplate } from '@utils/form-actions';
 import {
   TemplateType,
   TemplateStatus,
@@ -18,7 +18,6 @@ jest.mock('@utils/amplify-utils');
 const redirectMock = jest.mocked(redirect);
 const getTemplateMock = jest.mocked(getTemplate);
 const saveTemplateMock = jest.mocked(saveTemplate);
-const sendEmailMock = jest.mocked(sendEmail);
 
 const mockNhsAppTemplate = {
   templateType: TemplateType.NHS_APP,
@@ -65,25 +64,23 @@ describe('submitTemplate', () => {
     expect(redirectMock).toHaveBeenCalledWith('/invalid-template', 'replace');
   });
 
-  it('should handle error when failing to send email', async () => {
+  it('should handle error when failing to save template', async () => {
     getTemplateMock.mockResolvedValueOnce(mockNhsAppTemplate);
 
-    saveTemplateMock.mockResolvedValueOnce(mockNhsAppTemplate);
-
-    sendEmailMock.mockImplementationOnce(() => {
-      throw new Error('failed to send email');
+    saveTemplateMock.mockImplementationOnce(() => {
+      throw new Error('failed to save template');
     });
 
     const formData = getMockFormData({
       templateId: '1',
     });
 
     await expect(submitTemplate('submit-route', formData)).rejects.toThrow(
-      'failed to send email'
+      'failed to save template'
     );
   });
 
-  it('should redirect when successfully sent email', async () => {
+  it('should redirect when successfully submitted', async () => {
     getTemplateMock.mockResolvedValueOnce(mockNhsAppTemplate);
 
     const formData = getMockFormData({
@@ -92,31 +89,17 @@ describe('submitTemplate', () => {
 
     await submitTemplate('submit-route', formData);
 
-    expect(sendEmailMock).toHaveBeenCalledWith(mockNhsAppTemplate.id);
-
+    expect(saveTemplateMock).toHaveBeenCalledWith(
+      expect.objectContaining({
+        createdAt: '2025-01-13T10:19:25.579Z',
+        id: '1',
+        message: 'body',
+        name: 'name',
+        templateStatus: 'SUBMITTED',
+        templateType: 'NHS_APP',
+        updatedAt: '2025-01-13T10:19:25.579Z',
+      })
+    );
     expect(redirectMock).toHaveBeenCalledWith('/submit-route/1', 'push');
   });
-
-  it('should send an email with the subject line when template type is EMAIL', async () => {
-    const mockEmailTemplate = {
-      id: 'template-id',
-      templateType: TemplateType.EMAIL,
-      templateStatus: TemplateStatus.NOT_YET_SUBMITTED,
-      name: 'name',
-      subject: 'subjectLine',
-      message: 'body',
-      createdAt: '2025-01-13T10:19:25.579Z',
-      updatedAt: '2025-01-13T10:19:25.579Z',
-    };
-
-    getTemplateMock.mockResolvedValueOnce(mockEmailTemplate);
-
-    const formData = getMockFormData({
-      templateId: 'template-id',
-    });
-
-    await submitTemplate('submit-route', formData);
-
-    expect(sendEmailMock).toHaveBeenCalledWith(mockEmailTemplate.id);
-  });
 });

frontend/src/__tests__/components/molecules/__snapshots__/TemplateSubmitted.test.tsx.snap

@@ -43,9 +43,6 @@ exports[`TemplateSubmitted component should render 1`] = `
       >
         What you need to do next
       </h2>
-      <p>
-        You'll receive a confirmation email, which contains the template name and ID.
-      </p>
       <h3>
         If you're currently onboarding
       </h3>

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

@@ -11,19 +11,18 @@ import {
   createTemplate,
   saveTemplate,
   getTemplate,
-  sendEmail,
   getTemplates,
 } from '@utils/form-actions';
 import { getAccessTokenServer } from '@utils/amplify-utils';
 import { mockDeep } from 'jest-mock-extended';
-import { IBackendClient } from 'nhs-notify-backend-client/src/types/backend-client';
+import { ITemplateClient } from 'nhs-notify-backend-client';
 
-const mockedBackendClient = mockDeep<IBackendClient>();
+const mockedTemplateClient = mockDeep<ITemplateClient>();
 const authIdTokenServerMock = jest.mocked(getAccessTokenServer);
 
 jest.mock('@utils/amplify-utils');
-jest.mock('nhs-notify-backend-client/src/backend-api-client', () => ({
-  BackendClient: () => mockedBackendClient,
+jest.mock('nhs-notify-backend-client/src/template-api-client', () => ({
+  TemplateClient: () => mockedTemplateClient,
 }));
 
 describe('form-actions', () => {
@@ -44,7 +43,7 @@ describe('form-actions', () => {
       updatedAt: '2025-01-13T10:19:25.579Z',
     };
 
-    mockedBackendClient.templates.createTemplate.mockResolvedValueOnce({
+    mockedTemplateClient.createTemplate.mockResolvedValueOnce({
       data: responseData,
     });
 
@@ -57,15 +56,15 @@ describe('form-actions', () => {
 
     const response = await createTemplate(createTemplateInput);
 
-    expect(mockedBackendClient.templates.createTemplate).toHaveBeenCalledWith(
+    expect(mockedTemplateClient.createTemplate).toHaveBeenCalledWith(
       createTemplateInput
     );
 
     expect(response).toEqual(responseData);
   });
 
   test('createTemplate - should thrown error when saving unexpectedly fails', async () => {
-    mockedBackendClient.templates.createTemplate.mockResolvedValueOnce({
+    mockedTemplateClient.createTemplate.mockResolvedValueOnce({
       error: {
         code: 400,
         message: 'Bad request',
@@ -83,7 +82,7 @@ describe('form-actions', () => {
       'Failed to create new template'
     );
 
-    expect(mockedBackendClient.templates.createTemplate).toHaveBeenCalledWith(
+    expect(mockedTemplateClient.createTemplate).toHaveBeenCalledWith(
       createTemplateInput
     );
   });
@@ -115,7 +114,7 @@ describe('form-actions', () => {
       updatedAt: '2025-01-13T10:19:25.579Z',
     };
 
-    mockedBackendClient.templates.updateTemplate.mockResolvedValueOnce({
+    mockedTemplateClient.updateTemplate.mockResolvedValueOnce({
       data: responseData,
     });
 
@@ -129,7 +128,7 @@ describe('form-actions', () => {
 
     const response = await saveTemplate(updateTemplateInput);
 
-    expect(mockedBackendClient.templates.updateTemplate).toHaveBeenCalledWith(
+    expect(mockedTemplateClient.updateTemplate).toHaveBeenCalledWith(
       updateTemplateInput.id,
       updateTemplateInput
     );
@@ -138,7 +137,7 @@ describe('form-actions', () => {
   });
 
   test('saveTemplate - should thrown error when saving unexpectedly fails', async () => {
-    mockedBackendClient.templates.updateTemplate.mockResolvedValueOnce({
+    mockedTemplateClient.updateTemplate.mockResolvedValueOnce({
       error: {
         code: 400,
         message: 'Bad request',
@@ -157,7 +156,7 @@ describe('form-actions', () => {
       'Failed to save template data'
     );
 
-    expect(mockedBackendClient.templates.updateTemplate).toHaveBeenCalledWith(
+    expect(mockedTemplateClient.updateTemplate).toHaveBeenCalledWith(
       updateTemplateInput.id,
       updateTemplateInput
     );
@@ -191,21 +190,19 @@ describe('form-actions', () => {
       updatedAt: '2025-01-13T10:19:25.579Z',
     };
 
-    mockedBackendClient.templates.getTemplate.mockResolvedValueOnce({
+    mockedTemplateClient.getTemplate.mockResolvedValueOnce({
       data: responseData,
     });
 
     const response = await getTemplate('id');
 
-    expect(mockedBackendClient.templates.getTemplate).toHaveBeenCalledWith(
-      'id'
-    );
+    expect(mockedTemplateClient.getTemplate).toHaveBeenCalledWith('id');
 
     expect(response).toEqual(responseData);
   });
 
   test('getTemplate - should return undefined when no data', async () => {
-    mockedBackendClient.templates.getTemplate.mockResolvedValueOnce({
+    mockedTemplateClient.getTemplate.mockResolvedValueOnce({
       data: undefined,
       error: {
         code: 404,
@@ -215,9 +212,7 @@ describe('form-actions', () => {
 
     const response = await getTemplate('id');
 
-    expect(mockedBackendClient.templates.getTemplate).toHaveBeenCalledWith(
-      'id'
-    );
+    expect(mockedTemplateClient.getTemplate).toHaveBeenCalledWith('id');
 
     expect(response).toEqual(undefined);
   });
@@ -242,19 +237,19 @@ describe('form-actions', () => {
       updatedAt: '2025-01-13T10:19:25.579Z',
     };
 
-    mockedBackendClient.templates.listTemplates.mockResolvedValueOnce({
+    mockedTemplateClient.listTemplates.mockResolvedValueOnce({
       data: [responseData],
     });
 
     const response = await getTemplates();
 
-    expect(mockedBackendClient.templates.listTemplates).toHaveBeenCalledWith();
+    expect(mockedTemplateClient.listTemplates).toHaveBeenCalledWith();
 
     expect(response).toEqual([responseData]);
   });
 
   test('getTemplates - should return empty array when fetching unexpectedly fails', async () => {
-    mockedBackendClient.templates.listTemplates.mockResolvedValueOnce({
+    mockedTemplateClient.listTemplates.mockResolvedValueOnce({
       data: undefined,
       error: {
         code: 500,
@@ -274,42 +269,6 @@ describe('form-actions', () => {
     await expect(getTemplates()).rejects.toThrow('Failed to get access token');
   });
 
-  test('sendEmail', async () => {
-    mockedBackendClient.functions.sendEmail.mockResolvedValueOnce({
-      data: undefined,
-      error: undefined,
-    });
-
-    const response = await sendEmail('id');
-
-    expect(mockedBackendClient.functions.sendEmail).toHaveBeenCalledWith('id');
-
-    expect(response).toEqual(undefined);
-  });
-
-  test('sendEmail - should thrown error when no token', async () => {
-    authIdTokenServerMock.mockReset();
-    authIdTokenServerMock.mockResolvedValueOnce(undefined);
-
-    await expect(sendEmail('id')).rejects.toThrow('Failed to get access token');
-  });
-
-  test('getTemplates - should return nothing when an error occurs', async () => {
-    mockedBackendClient.functions.sendEmail.mockResolvedValueOnce({
-      data: undefined,
-      error: {
-        code: 404,
-        message: 'Not found',
-      },
-    });
-
-    const response = await sendEmail('id');
-
-    expect(mockedBackendClient.functions.sendEmail).toHaveBeenCalledWith('id');
-
-    expect(response).toEqual(undefined);
-  });
-
   test('getTemplates - order by createdAt and then id', async () => {
     const baseTemplate = {
       templateType: TemplateType.SMS,
@@ -348,7 +307,7 @@ describe('form-actions', () => {
       '10',
     ];
 
-    mockedBackendClient.templates.listTemplates.mockResolvedValueOnce({
+    mockedTemplateClient.listTemplates.mockResolvedValueOnce({
       data: templates,
     });