CCM-10424 Error page, removed preview error message and added playwright test

nicki-nhs · nicki-nhs · commit 4e34bfd17dc4 · 2025-07-14T16:04:25.000+01:00
diff --git a/frontend/src/__tests__/app/create-letter-template/client-id-and-campaign-id-required/__snapshots__/page.test.tsx.snap b/frontend/src/__tests__/app/create-letter-template/client-id-and-campaign-id-required/__snapshots__/page.test.tsx.snap
diff --git a/frontend/src/__tests__/app/create-letter-template/client-id-and-campaign-id-required/page.test.tsx b/frontend/src/__tests__/app/create-letter-template/client-id-and-campaign-id-required/page.test.tsx
diff --git a/frontend/src/__tests__/app/create-letter-template/page.test.tsx b/frontend/src/__tests__/app/create-letter-template/page.test.tsx
@@ -2,15 +2,102 @@
  * @jest-environment node
  */
 import CreateLetterTemplatePage from '@app/create-letter-template/page';
+import { getSessionServer } from '@utils/amplify-utils';
+import { fetchClient } from '@utils/server-features';
+import { redirect, RedirectType } from 'next/navigation';
+
+jest.mock('next/navigation');
+jest.mock('@utils/amplify-utils');
+jest.mock('@utils/server-features');
+
+const mockGetSessionServer = jest.mocked(getSessionServer);
+const mockFetchClient = jest.mocked(fetchClient);
 
 describe('CreateLetterTemplatePage', () => {
   beforeEach(() => {
     jest.resetAllMocks();
   });
 
   it('should render CreateLetterTemplatePage', async () => {
+    mockGetSessionServer.mockResolvedValueOnce({
+      accessToken: 'mocktoken',
+      clientId: 'client1',
+      userSub: 'sub',
+    });
+    mockFetchClient.mockResolvedValueOnce({
+      data: {
+        campaignId: 'campaign2',
+        features: {},
+      },
+    });
+
     const page = await CreateLetterTemplatePage();
 
     expect(page).toMatchSnapshot();
   });
+
+  it('should check client ID and campaign ID', async () => {
+    mockGetSessionServer.mockResolvedValueOnce({
+      accessToken: 'mocktoken',
+      clientId: 'client1',
+      userSub: 'sub',
+    });
+    mockFetchClient.mockResolvedValueOnce({
+      data: {
+        campaignId: 'campaign2',
+        features: {},
+      },
+    });
+
+    await CreateLetterTemplatePage();
+
+    expect(mockGetSessionServer).toHaveBeenCalled();
+    expect(mockFetchClient).toHaveBeenCalled();
+  });
+
+  it('should redirect to error page when client ID is not present', async () => {
+    const mockRedirect = jest.mocked(redirect);
+
+    mockGetSessionServer.mockResolvedValueOnce({
+      accessToken: 'mocktoken',
+      clientId: undefined,
+      userSub: 'sub',
+    });
+    mockFetchClient.mockResolvedValueOnce({
+      data: {
+        campaignId: 'campaign2',
+        features: {},
+      },
+    });
+
+    await CreateLetterTemplatePage();
+
+    expect(mockRedirect).toHaveBeenCalledWith(
+      '/create-letter-template/client-id-and-campaign-id-required',
+      RedirectType.push
+    );
+  });
+
+  it('should redirect to error page when campaign ID is not present', async () => {
+    const mockRedirect = jest.mocked(redirect);
+
+    mockGetSessionServer.mockResolvedValueOnce({
+      accessToken: 'mocktoken',
+      clientId: 'client2',
+      userSub: 'sub',
+    });
+    mockFetchClient.mockResolvedValueOnce({
+      data: {
+        campaignId: undefined,
+        features: {},
+      },
+    });
+
+    await CreateLetterTemplatePage();
+
+    expect(mockRedirect).toHaveBeenCalledWith(
+      '/create-letter-template/client-id-and-campaign-id-required',
+      RedirectType.push
+    );
+  });
 });
diff --git a/frontend/src/__tests__/components/forms/ChooseTemplate/server-action.test.ts b/frontend/src/__tests__/components/forms/ChooseTemplate/server-action.test.ts
@@ -6,6 +6,10 @@ jest.mock('next/navigation');
 
 jest.mock('@utils/amplify-utils');
 
+beforeEach(() => {
+  jest.resetAllMocks();
+});
+
 test('submit form - validation error', async () => {
   const response = await chooseTemplateAction(
     {},
diff --git a/frontend/src/__tests__/middleware.test.ts b/frontend/src/__tests__/middleware.test.ts
@@ -35,6 +35,7 @@ describe('middleware function', () => {
 
     getTokenMock.mockResolvedValueOnce({
       accessToken: undefined,
+      clientId: undefined,
       userSub: undefined,
     });
 
@@ -53,6 +54,7 @@ describe('middleware function', () => {
   it('if request path is protected, and access token is obtained, respond with CSP', async () => {
     getTokenMock.mockResolvedValueOnce({
       accessToken: 'token',
+      clientId: 'client1',
       userSub: 'sub',
     });
 
diff --git a/frontend/src/__tests__/utils/form-actions.test.ts b/frontend/src/__tests__/utils/form-actions.test.ts
@@ -31,6 +31,7 @@ describe('form-actions', () => {
     jest.resetAllMocks();
     authIdTokenServerMock.mockResolvedValueOnce({
       accessToken: 'token',
+      clientId: 'client1',
       userSub: 'sub',
     });
   });
@@ -94,6 +95,7 @@ describe('form-actions', () => {
     authIdTokenServerMock.mockReset();
     authIdTokenServerMock.mockResolvedValueOnce({
       accessToken: undefined,
+      clientId: undefined,
       userSub: undefined,
     });
 
@@ -257,6 +259,7 @@ describe('form-actions', () => {
     authIdTokenServerMock.mockReset();
     authIdTokenServerMock.mockResolvedValueOnce({
       accessToken: undefined,
+      clientId: undefined,
       userSub: undefined,
     });
 
@@ -348,6 +351,7 @@ describe('form-actions', () => {
     authIdTokenServerMock.mockReset();
     authIdTokenServerMock.mockResolvedValueOnce({
       accessToken: undefined,
+      clientId: undefined,
       userSub: undefined,
     });
 
@@ -414,6 +418,7 @@ describe('form-actions', () => {
     authIdTokenServerMock.mockReset();
     authIdTokenServerMock.mockResolvedValueOnce({
       accessToken: undefined,
+      clientId: undefined,
       userSub: undefined,
     });
 
@@ -462,6 +467,7 @@ describe('form-actions', () => {
     authIdTokenServerMock.mockReset();
     authIdTokenServerMock.mockResolvedValueOnce({
       accessToken: undefined,
+      clientId: undefined,
       userSub: undefined,
     });
 
@@ -553,6 +559,7 @@ describe('form-actions', () => {
       authIdTokenServerMock.mockReset();
       authIdTokenServerMock.mockResolvedValueOnce({
         accessToken: undefined,
+        clientId: undefined,
         userSub: undefined,
       });
 
@@ -600,6 +607,7 @@ describe('form-actions', () => {
       authIdTokenServerMock.mockReset();
       authIdTokenServerMock.mockResolvedValueOnce({
         accessToken: undefined,
+        clientId: undefined,
         userSub: undefined,
       });
 
@@ -665,6 +673,7 @@ describe('form-actions', () => {
       authIdTokenServerMock.mockReset();
       authIdTokenServerMock.mockResolvedValueOnce({
         accessToken: undefined,
+        clientId: undefined,
         userSub: undefined,
       });
 
diff --git a/frontend/src/__tests__/utils/server-features.test.ts b/frontend/src/__tests__/utils/server-features.test.ts
@@ -19,6 +19,7 @@ describe('serverIsFeatureEnabled', () => {
   it('should return false when no accessToken', async () => {
     getSessionServerMock.mockResolvedValueOnce({
       accessToken: undefined,
+      clientId: undefined,
       userSub: undefined,
     });
 
@@ -30,6 +31,7 @@ describe('serverIsFeatureEnabled', () => {
   it('should return false when no client', async () => {
     getSessionServerMock.mockResolvedValueOnce({
       accessToken: 'token',
+      clientId: 'client1',
       userSub: 'user',
     });
 
@@ -49,6 +51,7 @@ describe('serverIsFeatureEnabled', () => {
   it('returns false if fetching configuration fails unexpectedly', async () => {
     getSessionServerMock.mockResolvedValueOnce({
       accessToken: 'token',
+      clientId: 'client1',
       userSub: 'user',
     });
 
@@ -74,6 +77,7 @@ describe('serverIsFeatureEnabled', () => {
 
     getSessionServerMock.mockResolvedValueOnce({
       accessToken: 'token',
+      clientId: 'client1',
       userSub: 'user',
     });
 
@@ -95,6 +99,7 @@ describe('serverIsFeatureEnabled', () => {
 
     getSessionServerMock.mockResolvedValueOnce({
       accessToken: 'token',
+      clientId: 'client1',
       userSub: 'user',
     });
 
diff --git a/frontend/src/app/create-letter-template/page.tsx b/frontend/src/app/create-letter-template/page.tsx
@@ -1,5 +1,8 @@
 import { CreateLetterTemplate } from 'nhs-notify-web-template-management-utils';
 import { LetterTemplateForm } from '@forms/LetterTemplateForm/LetterTemplateForm';
+import { getSessionServer } from '@utils/amplify-utils';
+import { redirect, RedirectType } from 'next/navigation';
+import { fetchClient } from '@utils/server-features';
 
 const CreateLetterTemplatePage = async () => {
   const initialState: CreateLetterTemplate = {
@@ -9,6 +12,25 @@ const CreateLetterTemplatePage = async () => {
     language: 'en',
   };
 
+  const sessionServer = await getSessionServer();
+  const { accessToken, clientId } = sessionServer;
+
+  if (!accessToken || !clientId)
+    return redirect(
+      '/create-letter-template/client-id-and-campaign-id-required',
+      RedirectType.push
+    );
+
+  const clientConfiguration = await fetchClient(accessToken);
+
+  const campaignId = clientConfiguration?.data?.campaignId;
+
+  if (!clientConfiguration || clientConfiguration.error || !campaignId)
+    return redirect(
+      '/create-letter-template/client-id-and-campaign-id-required',
+      RedirectType.push
+    );
+
   return <LetterTemplateForm initialState={initialState} />;
 };
 
diff --git a/frontend/src/components/forms/ChooseTemplate/server-action.ts b/frontend/src/components/forms/ChooseTemplate/server-action.ts
@@ -27,7 +27,7 @@ export async function chooseTemplateAction(
     };
   }
 
-  redirect(
+  return redirect(
     `/create-${templateTypeToUrlTextMappings(parsedForm.data.templateType)}-template`,
     RedirectType.push
   );
diff --git a/frontend/src/content/content.ts b/frontend/src/content/content.ts
@@ -264,6 +264,8 @@ const previewLetterTemplate = {
     'The personalisation fields in your files are missing or do not match.',
   validationErrorAction:
     'Check that the personalisation fields in your template file match the fields in your test personalisation file',
+  missingClientOrCampaignIdError: 'You cannot proof this letter template.',
+  missingClientOrCampaignIdErrorAction: 'To get access, contact your onboarding manager and give them this error message: letter template missing client ID and campaign ID.',
   preSubmissionText: previewLetterPreSubmissionText,
 };
 
diff --git a/frontend/src/utils/server-features.ts b/frontend/src/utils/server-features.ts
@@ -11,7 +11,7 @@ import { logger } from 'nhs-notify-web-template-management-utils/logger';
 /*
  * Caches at the request context level. Not a global cache.
  */
-const fetchClient = cache(async (accessToken: string) =>
+export const fetchClient = cache(async (accessToken: string) =>
   clientConfigurationApiClient.fetch(accessToken)
 );
 
diff --git a/tests/test-team/helpers/auth/cognito-auth-helper.ts b/tests/test-team/helpers/auth/cognito-auth-helper.ts
@@ -77,6 +77,13 @@ export const testUsers: Record<string, TestUserStaticDetails> = {
     userId: 'User6',
     clientKey: 'NONE',
   },
+  /**
+   * User7 has configuration but no campaignId
+   */
+  User7: {
+    userId: 'User7',
+    clientKey: 'Client4',
+  },
 };
 
 export type TestUser = TestUserStaticDetails &
diff --git a/tests/test-team/helpers/client/client-helper.ts b/tests/test-team/helpers/client/client-helper.ts
@@ -11,7 +11,7 @@ type ClientConfiguration = {
   campaignId?: string;
 };
 
-export type ClientKey = `Client${1 | 2 | 3}` | 'NONE';
+export type ClientKey = `Client${1 | 2 | 3 | 4}` | 'NONE';
 
 type TestClients = Record<
   Exclude<ClientKey, 'NONE'>,
@@ -41,6 +41,15 @@ export const testClients = {
    * Client3 has no configuration
    */
   Client3: undefined,
+  /**
+   * Client 4 has configuration but no campaignId set
+   */
+  Client4: {
+    campaignId: undefined,
+    features: {
+      proofing: false,
+    },
+  },
 } satisfies TestClients as TestClients & { NONE: undefined };
 
 export class ClientConfigurationHelper {
diff --git a/tests/test-team/pages/letter/template-mgmt-create-letter-missing-campaign-client-id-page.ts b/tests/test-team/pages/letter/template-mgmt-create-letter-missing-campaign-client-id-page.ts
@@ -0,0 +1,19 @@
+import { Locator, Page } from '@playwright/test';
+import { TemplateMgmtBasePageNonDynamic } from '../template-mgmt-base-page-non-dynamic';
+
+export class TemplateMgmtCreateLetterMissingCampaignClientIdPage extends TemplateMgmtBasePageNonDynamic {
+  static readonly pageUrlSegment =
+    'create-letter-template/client-id-and-campaign-id-required';
+
+  public readonly errorDetailsInsetText: Locator;
+  public readonly goBackLink: Locator;
+  public readonly heading: Locator;
+
+  constructor(page: Page) {
+    super(page);
+
+    this.errorDetailsInsetText = page.locator('[class="nhsuk-inset-text"] > p');
+    this.goBackLink = page.getByTestId('back-to-choose-template-type-link');
+    this.heading = page.getByTestId('page-heading');
+  }
+}
diff --git a/tests/test-team/template-mgmt-component-tests/letter/template-mgmt-create-letter-template-page.component.spec.ts b/tests/test-team/template-mgmt-component-tests/letter/template-mgmt-create-letter-template-page.component.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ export async function chooseTemplateAction(`
`27`	`27`	`};`
`28`	`28`	`}`
`29`	`29`
`30`		`- redirect(`
	`30`	`+ return redirect(`
`31`	`31`	`/create-${templateTypeToUrlTextMappings(parsedForm.data.templateType)}-template`,
`32`	`32`	`RedirectType.push`
`33`	`33`	`);`