CCM-11148: hook up count and list API routes for Message plans --no-verify

Author: bhansell1

frontend/src/__tests__/app/message-plans/page.test.tsx

@@ -1,7 +1,7 @@
 /**
  * @jest-environment node
  */
-import { getRoutingConfigs } from '@utils/form-actions';
+import { getRoutingConfigs, countRoutingConfigs } from '@utils/form-actions';
 import {
   type MessagePlansProps,
   MessagePlans,
@@ -10,15 +10,30 @@ import { serverIsFeatureEnabled } from '@utils/server-features';
 import MessagePlansPage, { generateMetadata } from '@app/message-plans/page';
 import { redirect } from 'next/navigation';
 import { ReactElement } from 'react';
+import { RoutingConfig } from 'nhs-notify-backend-client';
 
 jest.mock('next/navigation');
 jest.mock('@utils/form-actions');
 jest.mock('@utils/server-features');
 
+const countRoutingConfigsMock = jest.mocked(countRoutingConfigs);
 const serverIsFeatureEnabledMock = jest.mocked(serverIsFeatureEnabled);
 const getRoutingConfigsMock = jest.mocked(getRoutingConfigs);
 const redirectMock = jest.mocked(redirect);
 
+const buildRoutingConfig = (rc: Partial<RoutingConfig>): RoutingConfig => ({
+  campaignId: 'abc',
+  cascade: [],
+  cascadeGroupOverrides: [],
+  clientId: 'client-a',
+  createdAt: '2025-09-09T10:00:00Z',
+  status: 'DRAFT',
+  id: '',
+  name: '',
+  updatedAt: '',
+  ...rc,
+});
+
 describe('MessagePlansPage', () => {
   beforeEach(() => {
     jest.clearAllMocks();
@@ -44,26 +59,28 @@ describe('MessagePlansPage', () => {
 
   test('renders the page with drafts and production routing plans', async () => {
     getRoutingConfigsMock.mockResolvedValueOnce([
-      {
+      buildRoutingConfig({
         id: '1',
         name: 'Draft A',
-        lastUpdated: '2025-09-10T10:00:00Z',
+        updatedAt: '2025-09-10T10:00:00Z',
         status: 'DRAFT',
-      },
-      {
+      }),
+      buildRoutingConfig({
         id: '2',
         name: 'Prod X',
-        lastUpdated: '2025-09-09T11:00:00Z',
-        status: 'PRODUCTION',
-      },
-      {
+        updatedAt: '2025-09-09T11:00:00Z',
+        status: 'COMPLETED',
+      }),
+      buildRoutingConfig({
         id: '3',
         name: 'Prod Y',
-        lastUpdated: '2025-09-08T12:00:00Z',
-        status: 'PRODUCTION',
-      },
+        updatedAt: '2025-09-08T12:00:00Z',
+        status: 'COMPLETED',
+      }),
     ]);
 
+    countRoutingConfigsMock.mockResolvedValueOnce(1).mockResolvedValueOnce(2);
+
     const page = (await MessagePlansPage()) as ReactElement<
       MessagePlansProps,
       typeof MessagePlans
@@ -75,6 +92,10 @@ describe('MessagePlansPage', () => {
 
     expect(getRoutingConfigsMock).toHaveBeenCalledTimes(1);
 
+    expect(countRoutingConfigsMock).toHaveBeenNthCalledWith(1, 'DRAFT');
+
+    expect(countRoutingConfigsMock).toHaveBeenNthCalledWith(2, 'COMPLETED');
+
     expect(page.props.draft).toEqual({
       plans: [
         {
@@ -93,37 +114,16 @@ describe('MessagePlansPage', () => {
           id: '2',
           name: 'Prod X',
           lastUpdated: '2025-09-09T11:00:00Z',
-          status: 'PRODUCTION',
+          status: 'COMPLETED',
         },
         {
           id: '3',
           name: 'Prod Y',
           lastUpdated: '2025-09-08T12:00:00Z',
-          status: 'PRODUCTION',
+          status: 'COMPLETED',
         },
       ],
       count: 2,
     });
   });
-
-  test('renders the page with no items', async () => {
-    getRoutingConfigsMock.mockResolvedValueOnce([]);
-
-    const page = (await MessagePlansPage()) as ReactElement<
-      MessagePlansProps,
-      typeof MessagePlans
-    >;
-
-    expect(page.props).toBeDefined();
-
-    expect(page.props.draft).toEqual({
-      plans: [],
-      count: 0,
-    });
-
-    expect(page.props.production).toEqual({
-      plans: [],
-      count: 0,
-    });
-  });
 });

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

@@ -46,7 +46,7 @@ exports[`MessagePlans matches snapshot 1`] = `
                   rel="noopener noreferrer"
                   target="_blank"
                 >
-                  API integration environment
+                  API integration environment (opens in a new tab)
                 </a>
               </li>
               <li>
@@ -55,7 +55,7 @@ exports[`MessagePlans matches snapshot 1`] = `
                   rel="noopener noreferrer"
                   target="_blank"
                 >
-                  Integration MESH mailbox
+                  Integration MESH mailbox (opens in a new tab)
                 </a>
               </li>
             </ul>
@@ -71,15 +71,15 @@ exports[`MessagePlans matches snapshot 1`] = `
                 rel="noopener noreferrer"
                 target="_blank"
               >
-                NHS Notify API
+                NHS Notify API (opens in a new tab)
               </a>
                or 
               <a
                 href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh/"
                 rel="noopener noreferrer"
                 target="_blank"
               >
-                NHS Notify MESH.
+                NHS Notify MESH (opens in a new tab).
               </a>
             </p>
           </div>

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

@@ -128,34 +128,9 @@ exports[`MessagePlansList matches snapshot when no data is available 1`] = `
     <div
       class="nhsuk-details__text"
     >
-      <table
-        class="nhsuk-table-responsive"
-      >
-        <thead
-          class="nhsuk-table__head"
-          role="rowgroup"
-        />
-        <tbody
-          class="nhsuk-table__body"
-        >
-          <tr
-            class="nhsuk-table__row"
-          >
-            <td
-              class="nhsuk-table__cell"
-              role="cell"
-            >
-              <span
-                aria-hidden="true"
-                class="nhsuk-table-responsive__heading"
-              >
-                 
-              </span>
-              You do not have any message plans in draft yet.
-            </td>
-          </tr>
-        </tbody>
-      </table>
+      <p>
+        You do not have any message plans in draft yet.
+      </p>
     </div>
   </details>
 </DocumentFragment>

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

@@ -16,16 +16,25 @@ import {
   setTemplateToSubmitted,
   requestTemplateProof,
   getRoutingConfigs,
+  countRoutingConfigs,
 } from '@utils/form-actions';
 import { getSessionServer } from '@utils/amplify-utils';
-import { TemplateDto } from 'nhs-notify-backend-client';
+import {
+  RoutingConfig,
+  TemplateDto,
+  routingConfigurationApiClient,
+} from 'nhs-notify-backend-client';
 import { templateApiClient } from 'nhs-notify-backend-client/src/template-api-client';
 
 const mockedTemplateClient = jest.mocked(templateApiClient);
 const authIdTokenServerMock = jest.mocked(getSessionServer);
+const routingConfigurationApiClientMock = jest.mocked(
+  routingConfigurationApiClient
+);
 
 jest.mock('@utils/amplify-utils');
 jest.mock('nhs-notify-backend-client/src/template-api-client');
+jest.mock('nhs-notify-backend-client/src/routing-config-api-client');
 
 describe('form-actions', () => {
   beforeEach(() => {
@@ -708,29 +717,114 @@ describe('form-actions', () => {
       );
     });
 
-    test('should return a list of routing configs', async () => {
-      const configs = await getRoutingConfigs();
-
-      expect(configs).toEqual([
-        {
-          name: 'Static routing plan 1',
-          id: expect.anything(),
-          lastUpdated: new Date().toString(),
-          status: 'DRAFT',
-        },
-        {
-          name: 'Static routing plan 2',
-          id: expect.anything(),
-          lastUpdated: new Date().toString(),
-          status: 'DRAFT',
+    test('should return empty array when calling the API fails', async () => {
+      routingConfigurationApiClientMock.list.mockResolvedValueOnce({
+        error: {
+          errorMeta: { code: 400, description: 'Bad request' },
         },
-        {
-          name: 'Static routing plan 3',
-          id: expect.anything(),
-          lastUpdated: new Date('2025-09-14').toString(),
-          status: 'DRAFT',
+      });
+
+      const response = await getRoutingConfigs();
+
+      expect(response.length).toBe(0);
+    });
+
+    test('should return a list of routing configs - order by createdAt and then id', async () => {
+      const fields = {
+        status: 'DRAFT',
+        name: 'Routing config',
+        updatedAt: '2021-01-01T00:00:00.000Z',
+        campaignId: 'campaignId',
+        clientId: 'clientId',
+        cascade: [],
+        cascadeGroupOverrides: [],
+      } satisfies Partial<RoutingConfig>;
+
+      const routingConfigs = [
+        { ...fields, id: '06', createdAt: '2022-01-01T00:00:00.000Z' },
+        { ...fields, id: '08', createdAt: '2020-01-01T00:00:00.000Z' },
+        { ...fields, id: '05', createdAt: '2021-01-01T00:00:00.000Z' },
+        { ...fields, id: '02', createdAt: '2021-01-01T00:00:00.000Z' },
+        { ...fields, id: '01', createdAt: '2021-01-01T00:00:00.000Z' },
+        { ...fields, id: '03', createdAt: '2021-01-01T00:00:00.000Z' },
+        { ...fields, id: '04', createdAt: '2021-01-01T00:00:00.000Z' },
+      ];
+
+      // 06 is the newest, 08 is the oldest.
+      // 01 - 05 all have the same createdAt.
+      const expectedOrder = ['06', '01', '02', '03', '04', '05', '08'];
+
+      routingConfigurationApiClientMock.list.mockResolvedValueOnce({
+        data: routingConfigs,
+      });
+
+      const response = await getRoutingConfigs();
+
+      const actualOrder = [];
+      for (const routingConfig of response) {
+        actualOrder.push(routingConfig.id);
+      }
+
+      expect(actualOrder).toEqual(expectedOrder);
+    });
+  });
+
+  describe('countRoutingConfigs', () => {
+    test('should throw error when no token', async () => {
+      authIdTokenServerMock.mockReset();
+      authIdTokenServerMock.mockResolvedValueOnce({
+        accessToken: undefined,
+        clientId: undefined,
+      });
+
+      await expect(countRoutingConfigs('DRAFT')).rejects.toThrow(
+        'Failed to get access token'
+      );
+    });
+
+    test('should return 0 when calling the API fails', async () => {
+      routingConfigurationApiClientMock.count.mockResolvedValueOnce({
+        error: {
+          errorMeta: { code: 400, description: 'Bad request' },
         },
-      ]);
+      });
+
+      const response = await countRoutingConfigs('DRAFT');
+
+      expect(response).toBe(0);
+    });
+
+    test('should return count of routing configurations for status', async () => {
+      // Note: we're doing this here because we call `getSessionServer` twice
+      // and it's only mocked-out once by default.
+      authIdTokenServerMock.mockResolvedValue({
+        accessToken: 'token',
+        clientId: 'client1',
+      });
+
+      routingConfigurationApiClientMock.count
+        .mockResolvedValueOnce({
+          data: { count: 1 },
+        })
+        .mockResolvedValueOnce({
+          data: { count: 5 },
+        });
+
+      const draftCount = await countRoutingConfigs('DRAFT');
+      const completedCount = await countRoutingConfigs('COMPLETED');
+
+      expect(draftCount).toEqual(1);
+      expect(routingConfigurationApiClientMock.count).toHaveBeenNthCalledWith(
+        1,
+        'token',
+        'DRAFT'
+      );
+      expect(completedCount).toEqual(5);
+      expect(routingConfigurationApiClientMock.count).toHaveBeenNthCalledWith(
+        2,
+        'token',
+        'COMPLETED'
+      );
     });
   });
 });