Merge pull request #178 from NHSDigital/feature/CCM-5630_add-template-status

CCM-5630: use one database table

Author: chris-elliott-nhsd

amplify/backend.ts

@@ -20,9 +20,3 @@ const attachPolicy = new PolicyStatement({
 });
 
 sendEmailLambda.addToRolePolicy(attachPolicy);
-
-backend.data.resources.cfnResources.amplifyDynamoDbTables.SessionStorage.timeToLiveAttribute =
-  {
-    attributeName: 'ttl',
-    enabled: true,
-  };

amplify/data/resource.ts

@@ -1,30 +1,27 @@
 import { type ClientSchema, a, defineData } from '@aws-amplify/backend';
 import { sendEmail } from '../functions/send-email/resource';
 
-const templateTypes = ['NHS_APP', 'SMS', 'EMAIL', 'LETTER'] as const;
+enum TemplateType {
+  NHS_APP = 'NHS_APP',
+  SMS = 'SMS',
+  EMAIL = 'EMAIL',
+  LETTER = 'LETTER',
+}
 
-const SessionStorageModel = {
-  id: a.string().required(),
-  templateType: a.enum([...templateTypes, 'UNKNOWN']),
-  nhsAppTemplateName: a.string().required(),
-  nhsAppTemplateMessage: a.string().required(),
-  emailTemplateName: a.string(),
-  emailTemplateSubjectLine: a.string(),
-  emailTemplateMessage: a.string(),
-  smsTemplateName: a.string(),
-  smsTemplateMessage: a.string(),
-  ttl: a.integer().required(),
-};
+const templateTypes = [
+  TemplateType.NHS_APP,
+  TemplateType.SMS,
+  TemplateType.EMAIL,
+  TemplateType.LETTER,
+] as const;
 
 const TemplateStorageModel = {
   id: a.string().required(),
-  name: a.string().required(),
-  type: a.enum(templateTypes),
+  templateType: a.ref('TemplateType').required(),
   version: a.integer().required(),
-  fields: a.customType({
-    subjectLine: a.string(),
-    content: a.string().required(),
-  }),
+  name: a.string().required(),
+  subject: a.string(),
+  message: a.string().required(),
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -34,7 +31,7 @@ const authPermission = (allow: any) =>
     : [allow.guest()];
 
 const schema = a.schema({
-  SessionStorage: a.model(SessionStorageModel).authorization(authPermission),
+  TemplateType: a.enum(templateTypes),
   TemplateStorage: a.model(TemplateStorageModel).authorization(authPermission),
   sendEmail: a
     .query()

infrastructure/terraform/components/branch/module_amplify_branch.tf

@@ -20,6 +20,5 @@ module "amplify_branch" {
   environment_variables = {
     NOTIFY_SUBDOMAIN              = var.environment
     NEXT_PUBLIC_BASE_PATH         = "/templates~${local.normalised_branch_name}"
-    MAX_SESSION_LENGTH_IN_SECONDS = 432000 # 5 days in seconds
   }
 }

next.config.js

@@ -6,8 +6,6 @@ const nextConfig = {
   basePath,
   env: {
     basePath,
-    MAX_SESSION_LENGTH_IN_SECONDS:
-      process.env.MAX_SESSION_LENGTH_IN_SECONDS ?? '432000', // 5 days in seconds
   },
 
   experimental: {

src/__tests__/app/choose-a-template-type/page.test.tsx

@@ -1,21 +1,11 @@
 import { render } from '@testing-library/react';
-import ChooseATemplateTypePage from '@app/choose-a-template-type/[sessionId]/page';
+import ChooseATemplateTypePage from '@app/choose-a-template-type/page';
 import { TemplateFormState } from '@utils/types';
-import nav from 'next/navigation';
-
-const mockSessionSupplier = {
-  mockSession: {} as unknown,
-};
-
-jest.mock('@utils/form-actions', () => ({
-  getSession: () => Promise.resolve(mockSessionSupplier.mockSession),
-}));
 
 jest.mock('next/navigation', () => ({
   redirect: () => {
     throw new Error('Simulated redirect');
   },
-  useRouter: () => {},
 
   RedirectType: {
     push: 'push',
@@ -39,35 +29,9 @@ jest.mock('react-dom', () => {
 });
 
 test('ChooseATemplateTypePage', async () => {
-  mockSessionSupplier.mockSession = {
-    id: 'session-id',
-    templateType: 'UNKNOWN',
-    nhsAppTemplateName: '',
-    nhsAppTemplateMessage: '',
-  };
-
-  const page = await ChooseATemplateTypePage({
-    params: {
-      sessionId: 'session-id',
-    },
-  });
+  const page = await ChooseATemplateTypePage();
 
   const container = render(page);
 
   expect(container.asFragment()).toMatchSnapshot();
 });
-
-test('ChooseATemplateTypePage - should handle invalid session', async () => {
-  mockSessionSupplier.mockSession = undefined;
-  const redirectSpy = jest.spyOn(nav, 'redirect');
-
-  await expect(
-    ChooseATemplateTypePage({
-      params: {
-        sessionId: 'session-id',
-      },
-    })
-  ).rejects.toThrow('Simulated redirect');
-
-  expect(redirectSpy).toHaveBeenCalledWith('/invalid-session', 'replace');
-});

src/__tests__/app/create-email-template/__snapshots__/page.test.tsx.snap

@@ -0,0 +1,15 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CreateEmailTemplatePage should render CreateEmailTemplatePage 1`] = `
+<EmailTemplateForm
+  initialState={
+    {
+      "message": "",
+      "name": "",
+      "subject": "",
+      "templateType": "EMAIL",
+      "version": 1,
+    }
+  }
+/>
+`;

src/__tests__/app/create-email-template/page.test.tsx

@@ -1,58 +1,16 @@
-import CreateEmailTemplatePage from '@app/create-email-template/[sessionId]/page';
-import { getSession } from '@utils/form-actions';
-import { Session, TemplateType } from '@utils/types';
-import { redirect } from 'next/navigation';
-import { CreateEmailTemplate } from '@forms/CreateEmailTemplate/CreateEmailTemplate';
+/**
+ * @jest-environment node
+ */
+import CreateEmailTemplatePage from '@app/create-email-template/page';
 
-jest.mock('@utils/form-actions');
-jest.mock('next/navigation');
-jest.mock('@forms/CreateEmailTemplate/CreateEmailTemplate');
-
-const getSessionMock = jest.mocked(getSession);
-const redirectMock = jest.mocked(redirect);
-
-const initialState: Session = {
-  id: 'session-id',
-  templateType: TemplateType.EMAIL,
-  nhsAppTemplateName: '',
-  nhsAppTemplateMessage: '',
-};
+jest.mock('@forms/EmailTemplateForm/EmailTemplateForm');
 
 describe('CreateEmailTemplatePage', () => {
   beforeEach(jest.resetAllMocks);
 
-  it('should redirect to invalid-session when no session is found', async () => {
-    getSessionMock.mockResolvedValueOnce(undefined);
-
-    await CreateEmailTemplatePage({ params: { sessionId: 'session-id' } });
-
-    expect(getSessionMock).toHaveBeenCalledWith('session-id');
-
-    expect(redirectMock).toHaveBeenCalledWith('/invalid-session', 'replace');
-  });
-
-  it('should redirect to invalid-session when sessions template type is not EMAIL', async () => {
-    getSessionMock.mockResolvedValueOnce({
-      ...initialState,
-      templateType: TemplateType.NHS_APP,
-    });
-
-    await CreateEmailTemplatePage({ params: { sessionId: 'session-id' } });
-
-    expect(getSessionMock).toHaveBeenCalledWith('session-id');
-
-    expect(redirectMock).toHaveBeenCalledWith('/invalid-session', 'replace');
-  });
-
-  it('should render CreateEmailTemplatePage component when session is found', async () => {
-    getSessionMock.mockResolvedValueOnce(initialState);
-
-    const page = await CreateEmailTemplatePage({
-      params: { sessionId: 'session-id' },
-    });
-
-    expect(getSessionMock).toHaveBeenCalledWith('session-id');
+  it('should render CreateEmailTemplatePage', async () => {
+    const page = await CreateEmailTemplatePage();
 
-    expect(page).toEqual(<CreateEmailTemplate initialState={initialState} />);
+    expect(page).toMatchSnapshot();
   });
 });

src/__tests__/app/create-letter-template/page.test.tsx

@@ -1,4 +1,4 @@
-import CreateLetterTemplatePage from '@app/create-letter-template/[sessionId]/page';
+import CreateLetterTemplatePage from '@app/create-letter-template/[templateId]/page';
 import { render } from '@testing-library/react';
 
 test('CreateLetterTemplatePage', async () => {

src/__tests__/app/create-nhs-app-template/__snapshots__/page.test.tsx.snap

@@ -0,0 +1,14 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CreateNHSAppTemplatePage should render CreateNHSAppTemplatePage 1`] = `
+<NhsAppTemplateForm
+  initialState={
+    {
+      "message": "",
+      "name": "",
+      "templateType": "NHS_APP",
+      "version": 1,
+    }
+  }
+/>
+`;

src/__tests__/app/create-nhs-app-template/page.test.tsx

@@ -1,70 +1,16 @@
-import { redirect } from 'next/navigation';
-import { TemplateType } from '@utils/types';
-import { getSession } from '@utils/form-actions';
-import { CreateNhsAppTemplate } from '@forms/CreateNhsAppTemplate/CreateNhsAppTemplate';
-import CreateNhsAppTemplatePage from '@app/create-nhs-app-template/[sessionId]/page';
+/**
+ * @jest-environment node
+ */
+import CreateNHSAppTemplatePage from '@app/create-nhs-app-template/page';
 
-jest.mock('@forms/CreateNhsAppTemplate/CreateNhsAppTemplate');
-jest.mock('@utils/form-actions');
-jest.mock('next/navigation');
+jest.mock('@forms/NhsAppTemplateForm/NhsAppTemplateForm');
 
-const getSessionMock = jest.mocked(getSession);
-const redirectMock = jest.mocked(redirect);
-
-describe('CreateNhsAppTemplatePage', () => {
+describe('CreateNHSAppTemplatePage', () => {
   beforeEach(jest.resetAllMocks);
 
-  test('page loads', async () => {
-    const state = {
-      id: 'session-id',
-      templateType: TemplateType.NHS_APP,
-      nhsAppTemplateName: '',
-      nhsAppTemplateMessage: '',
-    };
-
-    getSessionMock.mockResolvedValueOnce(state);
-
-    const page = await CreateNhsAppTemplatePage({
-      params: { sessionId: 'session-id' },
-    });
-
-    expect(page).toEqual(<CreateNhsAppTemplate initialState={state} />);
-  });
-
-  test('should render invalid session, when session is not found', async () => {
-    getSessionMock.mockResolvedValueOnce(undefined);
-
-    await CreateNhsAppTemplatePage({
-      params: {
-        sessionId: 'session-id',
-      },
-    });
+  it('should render CreateNHSAppTemplatePage', async () => {
+    const page = await CreateNHSAppTemplatePage();
 
-    expect(redirectMock).toHaveBeenCalledWith('/invalid-session', 'replace');
+    expect(page).toMatchSnapshot();
   });
-
-  test.each([
-    TemplateType.EMAIL,
-    TemplateType.SMS,
-    TemplateType.LETTER,
-    'UNKNOWN',
-  ])(
-    'should render invalid session, when session template type is %p',
-    async (templateType) => {
-      getSessionMock.mockResolvedValueOnce({
-        id: 'session-id',
-        templateType: templateType as TemplateType,
-        nhsAppTemplateName: '',
-        nhsAppTemplateMessage: '',
-      });
-
-      await CreateNhsAppTemplatePage({
-        params: {
-          sessionId: 'session-id',
-        },
-      });
-
-      expect(redirectMock).toHaveBeenCalledWith('/invalid-session', 'replace');
-    }
-  );
 });