CCM-13135: Updated client to persist DL information

Author: nhsd-angel-pastor

.coverage

@@ -33,7 +33,7 @@ Clone the repository
 ```shell
 git clone https://github.com/NHSDigital/nhs-notify-digital-letters.git
 cd nhs-notify-digital-letters
-code protject.code-workspace
+code project.code-workspace
 ```
 
 Reopen with container

README.md

@@ -6,10 +6,11 @@ import { GetClientCommandParameters } from '../../app/get-client';
 function setup() {
   const client: Client = {
     clientId: 'test_client_id',
-    name: 'test_client_name',
-    meshMailboxId: 'test_client_mesh_mailbox_id',
-    meshWorkflowIdSuffix: 'test_client_mesh_workflow_id_suffix',
-    senderOdsCode: 'test_ods_code',
+    clientName: 'test_client_name',
+    meshMailboxSenderId: 'test_client_mesh_mailbox_sender_id',
+    meshMailboxReportsId: 'test_client_mesh_mailbox_reports_id',
+    fallbackWaitTimeSeconds: 300,
+    routingConfigId: '1234',
   };
 
   const mocks = mockDeep<AppDependencies>({

utils/client-management/src/__test__/app/get-client.test.ts

@@ -6,10 +6,11 @@ function setup() {
   const clients: Client[] = [
     {
       clientId: 'test_client_id',
-      name: 'test_client_name',
-      meshMailboxId: 'test_client_mesh_mailbox_id',
-      meshWorkflowIdSuffix: 'test_client_mesh_workflow_id_suffix',
-      senderOdsCode: 'test_ods_code',
+      clientName: 'test_client_name',
+      meshMailboxSenderId: 'test_client_mesh_mailbox_sender_id',
+      meshMailboxReportsId: 'test_client_mesh_mailbox_reports_id',
+      fallbackWaitTimeSeconds: 300,
+      routingConfigId: '1234',
     },
   ];
 

utils/client-management/src/__test__/app/list-clients.test.ts

@@ -2,39 +2,37 @@ import { mockDeep } from 'jest-mock-extended';
 import { Client } from 'utils';
 import { PutClientCommandParameters } from '../../app/put-client';
 import { AppDependencies, createApp } from '../../app';
+import { ConflictException, ValidationException } from 'domain/exceptions/';
+
+const input: PutClientCommandParameters = {
+      clientId: 'test_client_id',
+      clientName: 'test_client_name',
+      meshMailboxSenderId: 'test_client_mesh_mailbox_id',
+      meshMailboxReportsId: 'test_client_mesh_workflow_id_suffix',
+      fallbackWaitTimeSeconds: 300,
+      routingConfigId: '1234',
+    };
 
-function setup(clientSpec: 'min' | 'max') {
-  const minimumClient: Client = {
-    clientId: 'test_client_id',
-    name: 'test_client_name',
-    meshMailboxId: 'test_client_mesh_mailbox_id',
-    meshWorkflowIdSuffix: 'test_client_mesh_workflow_id_suffix',
-    allowOdsOverride: true,
-  };
-
-  const maximumClient: Client = {
+const client: Client = {
     clientId: 'test_client_id',
-    name: 'test_client_name',
-    meshMailboxId: 'test_client_mesh_mailbox_id',
-    meshWorkflowIdSuffix: 'test_client_mesh_workflow_id_suffix',
-    meshWorkflowIdReceiveRequestAck:
-      'test_client_mesh_workflow_id_receive_request_ack',
-    meshWorkflowIdCompletedRequestItemsReport:
-      'test_client_mesh_workflow_id_completed_items_report',
-    senderOdsCode: 'A12345',
-    allowAlternativeContactDetails: true,
-    unprefixedName: true,
-    allowAnonymousPatient: true,
-    ignoreSecurityFlag: true,
-    allowRfrOverride: true,
+      clientName: 'test_client_name',
+      meshMailboxSenderId: 'test_client_mesh_mailbox_id',
+      meshMailboxReportsId: 'test_client_mesh_workflow_id_suffix',
+      fallbackWaitTimeSeconds: 300,
+      routingConfigId: '1234',
   };
 
-  const client = clientSpec === 'min' ? minimumClient : maximumClient;
-
+function setup(existingClients: Client[] = [], createClientResponse = client) {
   const mocks = mockDeep<AppDependencies>({
     domain: {
       client: {
-        createClient: jest.fn(() => client),
+        createClient: jest.fn(() => createClientResponse),
+      },
+    },
+    infra: {
+      clientRepository: {
+        putClient: jest.fn(),
+        listClients: jest.fn().mockResolvedValue(existingClients),
       },
     },
   });
@@ -43,18 +41,11 @@ function setup(clientSpec: 'min' | 'max') {
 }
 
 describe('putClient', () => {
-  it('creates a new client with minimum data, stores it in the client repository and returns it', async () => {
-    const { data, mocks } = setup('min');
+  it('creates a new client when not existing clients, stores it in the client repository and returns it', async () => {
+    const { data, mocks } = setup([]);
 
     const app = createApp(mocks);
-
-    const input: PutClientCommandParameters = {
-      clientId: 'input_client_id',
-      name: 'input_client_name',
-      meshMailboxId: 'input_client_mesh_mailbox_id',
-      senderOdsCode: 'A12345',
-    };
-
+    delete(input.clientId); // simulate no clientId provided
     const result = await app.putClient(input);
 
     expect(mocks.domain.client.createClient).toHaveBeenCalledWith(input);
@@ -64,24 +55,16 @@ describe('putClient', () => {
     expect(result).toBe(data.client);
   });
 
-  it('creates a new client with maximum data, stores it in the client repository and returns it', async () => {
-    const { data, mocks } = setup('max');
+  it('creates a new client when existing clients, stores it in the client repository and returns it', async () => {
+    const existingClient: Client = {
+      ...client,
+      clientId: "existing_client_id",
+      meshMailboxSenderId: "existing_mesh_mailbox_sender_id",
+    };
+    const { data, mocks } = setup([existingClient]);
 
     const app = createApp(mocks);
 
-    const input: PutClientCommandParameters = {
-      clientId: 'input_client_id',
-      name: 'input_client_name',
-      meshMailboxId: 'input_client_mesh_mailbox_id',
-      senderOdsCode: 'A12345',
-      allowOdsOverride: true,
-      allowAlternativeContactDetails: true,
-      unprefixedName: true,
-      allowAnonymousPatient: true,
-      ignoreSecurityFlag: true,
-      allowRfrOverride: true,
-    };
-
     const result = await app.putClient(input);
 
     expect(mocks.domain.client.createClient).toHaveBeenCalledWith(input);
@@ -91,24 +74,15 @@ describe('putClient', () => {
     expect(result).toBe(data.client);
   });
 
-  it('Accepts a client that has a 3 character valid ODS code', async () => {
-    const { data, mocks } = setup('max');
+  it('Updates client when it exists, stores it in the client repository and returns it', async () => {
+    const existingClient: Client = {
+      ...client,
+      meshMailboxSenderId: "existing_mesh_mailbox_sender_id",
+    };
+    const { data, mocks } = setup([existingClient]);
 
     const app = createApp(mocks);
 
-    const input: PutClientCommandParameters = {
-      clientId: 'input_client_id',
-      name: 'input_client_name',
-      meshMailboxId: 'input_client_mesh_mailbox_id',
-      senderOdsCode: 'AB1',
-      allowOdsOverride: true,
-      allowAlternativeContactDetails: true,
-      unprefixedName: true,
-      allowAnonymousPatient: true,
-      ignoreSecurityFlag: true,
-      allowRfrOverride: true,
-    };
-
     const result = await app.putClient(input);
 
     expect(mocks.domain.client.createClient).toHaveBeenCalledWith(input);
@@ -117,4 +91,35 @@ describe('putClient', () => {
     );
     expect(result).toBe(data.client);
   });
+
+  it('throws an error when a different existing client has the same mailbox sender ID', async () => {
+    const existingClient: Client = {
+      ...client,
+      clientId: "existing_client_id",
+    };
+    const { mocks } = setup([existingClient]);
+
+    const app = createApp(mocks);
+
+    await expect(app.putClient(input)).rejects.toThrow(ConflictException);
+
+    expect(mocks.domain.client.createClient).toHaveBeenCalledWith(input);
+    expect(mocks.infra.clientRepository.putClient).toHaveBeenCalledTimes(0);
+  });
+
+  it('throws an error when the incoming client is not valid', async () => {
+    const newInvalidClient: Client = {
+      ...client,
+    };
+    delete (newInvalidClient.meshMailboxSenderId);
+
+    const { mocks } = setup([], newInvalidClient);
+
+    const app = createApp(mocks);
+
+    await expect(app.putClient(newInvalidClient)).rejects.toThrow(ValidationException);
+
+    expect(mocks.domain.client.createClient).toHaveBeenCalledWith(newInvalidClient);
+    expect(mocks.infra.clientRepository.putClient).toHaveBeenCalledTimes(0);
+  });
 });

utils/client-management/src/__test__/app/put-client.test.ts

@@ -9,38 +9,21 @@ jest.mock('node:crypto', () => ({
 describe('createClient', () => {
   it('creates a client entity with maximum fields', () => {
     const input: CreateClientParameters = {
-      clientId: 'input_client_id',
-      name: 'input_client_name',
-      meshMailboxId: 'input_mesh_mailbox_id',
-      allowOdsOverride: true,
-      senderOdsCode: 'input_client_ods_code',
-      allowAlternativeContactDetails: true,
-      allowRfrOverride: true,
+      clientId: 'test_client_id',
+      clientName: 'test_client_name',
+      meshMailboxSenderId: 'test_client_mesh_mailbox_sender_id',
+      meshMailboxReportsId: 'test_client_mesh_mailbox_reports_id',
+      fallbackWaitTimeSeconds: 300,
+      routingConfigId: '1234',
     };
 
     expect(createClient(input)).toEqual({
       clientId: input.clientId,
-      name: input.name,
-      meshMailboxId: input.meshMailboxId,
-      allowOdsOverride: input.allowOdsOverride,
-      senderOdsCode: input.senderOdsCode,
-      allowAlternativeContactDetails: input.allowAlternativeContactDetails,
-      allowRfrOverride: input.allowRfrOverride,
-    });
-  });
-
-  it('creates a client entity with minimum fields', () => {
-    const input: CreateClientParameters = {
-      name: 'input_client_name',
-      meshMailboxId: 'input_mesh_mailbox_id',
-      senderOdsCode: 'test_ods_code',
-    };
-
-    expect(createClient(input)).toEqual({
-      clientId: mockRandomUUID,
-      name: input.name,
-      meshMailboxId: input.meshMailboxId,
-      senderOdsCode: 'test_ods_code',
+      clientName: input.clientName,
+      meshMailboxSenderId: input.meshMailboxSenderId,
+      meshMailboxReportsId: input.meshMailboxReportsId,
+      fallbackWaitTimeSeconds: input.fallbackWaitTimeSeconds,
+      routingConfigId: input.routingConfigId,
     });
   });
 });