feat(DTFS2-7049): test unknown Gov.UK Notify responses

UK-Export-Finance · May 31, 2024 · 41d314c · 41d314c
1 parent 8acb0e9
commit 41d314c
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 8 deletions.
diff --git a/src/helper-modules/govuk-notify/govuk-notify.service.test.ts b/src/helper-modules/govuk-notify/govuk-notify.service.test.ts
@@ -36,7 +36,7 @@ describe('GovukNotifyService', () => {
   });
 
   describe('sendEmail', () => {
-    const generateNotifyError = (status: number, message: string) => {
+    const generateNotifyError = (status: number, message?: string) => {
       const response = {
         data: {
           status_code: status,
@@ -96,8 +96,15 @@ describe('GovukNotifyService', () => {
         error: 'Internal Server Error',
         status: 500,
       },
+      {
+        exceptionClass: InternalServerErrorException,
+        exceptionName: 'Internal Server Error Exception',
+        error: 'Internal Server Error',
+        status: 500,
+      },
     ])('throws exception $exceptionName for unexpected $status', async ({ exceptionClass, exceptionName, error, status }) => {
-      jest.mocked(sendEmailMethodMock).mockImplementation(() => Promise.reject(generateNotifyError(status, errorMessage)));
+      const notifyError = generateNotifyError(status, errorMessage);
+      jest.mocked(sendEmailMethodMock).mockImplementation(() => Promise.reject(notifyError));
 
       const resultPromise = service.sendEmail(govUkNotifyKey, { sendToEmailAddress, templateId, personalisation });
 
@@ -106,18 +113,37 @@ describe('GovukNotifyService', () => {
       await expect(resultPromise).rejects.toThrow(exceptionName);
       await expect(resultPromise).rejects.toHaveProperty('status', status);
       await expect(resultPromise).rejects.toHaveProperty('response', { message: [errorMessage], error, statusCode: status });
+      expect(loggerError).toHaveBeenCalledTimes(1);
+      expect(loggerError).toHaveBeenCalledWith(notifyError);
     });
 
     it('throws generic Error exception for unexpected status', async () => {
       const unexpectedStatus = valueGenerator.integer({ min: 900, max: 999 });
-      jest.mocked(sendEmailMethodMock).mockImplementation(() => Promise.reject(generateNotifyError(unexpectedStatus, errorMessage)));
+      const notifyError = generateNotifyError(unexpectedStatus, errorMessage);
+      jest.mocked(sendEmailMethodMock).mockImplementation(() => Promise.reject(notifyError));
 
       const resultPromise = service.sendEmail(govUkNotifyKey, { sendToEmailAddress, templateId, personalisation });
 
       expect(sendEmailMethodMock).toHaveBeenCalledTimes(1);
       await expect(resultPromise).rejects.toBeInstanceOf(Error);
       await expect(resultPromise).rejects.toThrow(errorMessage);
       await expect(resultPromise).rejects.toHaveProperty('message', errorMessage);
+      expect(loggerError).toHaveBeenCalledTimes(1);
+      expect(loggerError).toHaveBeenCalledWith(notifyError);
+    });
+
+    it('throws generic Error exception for error without error message', async () => {
+      const notifyError = generateNotifyError(400);
+      jest.mocked(sendEmailMethodMock).mockImplementation(() => Promise.reject(notifyError));
+
+      const resultPromise = service.sendEmail(govUkNotifyKey, { sendToEmailAddress, templateId, personalisation });
+
+      expect(sendEmailMethodMock).toHaveBeenCalledTimes(1);
+      await expect(resultPromise).rejects.toBeInstanceOf(Error);
+      await expect(resultPromise).rejects.toThrow('NotifyClient failed with unexpected error %o');
+      await expect(resultPromise).rejects.toHaveProperty('message', 'NotifyClient failed with unexpected error %o');
+      expect(loggerError).toHaveBeenCalledTimes(1);
+      expect(loggerError).toHaveBeenCalledWith(notifyError);
     });
 
     it('throws exception UnprocessableEntityException for empty response from GOV.UK Notify client', async () => {
@@ -128,6 +154,8 @@ describe('GovukNotifyService', () => {
       expect(sendEmailMethodMock).toHaveBeenCalledTimes(1);
       await expect(resultPromise).rejects.toBeInstanceOf(UnprocessableEntityException);
       await expect(resultPromise).rejects.toThrow('No GOV.UK Notify response');
+      expect(loggerError).toHaveBeenCalledTimes(1);
+      expect(loggerError).toHaveBeenCalledWith('Empty response from GOV.UK Notify');
     });
   });
 });
diff --git a/src/helper-modules/govuk-notify/govuk-notify.service.ts b/src/helper-modules/govuk-notify/govuk-notify.service.ts
@@ -56,7 +56,7 @@ export class GovukNotifyService {
               throw new Error(err.response.data.errors[0].message);
           }
         } else {
-          throw new Error(JSON.stringify(err.response.data));
+          throw new Error('NotifyClient failed with unexpected error %o', err);
         }
       });
 

diff --git a/src/modules/emails/emails.controller.test.ts b/src/modules/emails/emails.controller.test.ts
@@ -29,7 +29,7 @@ describe('EmailsController', () => {
     const govUkNotifyKey = valueGenerator.string({ length: 10 });
 
     it('returns receipt response for sent email', async () => {
-      when(emailsServiceSendEmail).calledWith(govUkNotifyKey, request[0]).mockResolvedValueOnce(postEmailsResponse[0]);
+      when(emailsServiceSendEmail).calledWith(govUkNotifyKey, request).mockResolvedValueOnce(postEmailsResponse[0]);
 
       const response = await controller.postEmail(govUkNotifyKey, request);
 

diff --git a/test/emails/post-emails.api-test.ts b/test/emails/post-emails.api-test.ts
@@ -136,13 +136,26 @@ describe('POST /emails', () => {
     });
   });
 
-  it('returns a 500 response if the Notify client responds with status 500', async () => {
-    jest.mocked(sendEmailMethodMock).mockImplementation(() => Promise.reject(generateNotifyError(500)));
+  it('returns a 500 response if the Notify client responds with unexpected status', async () => {
+    const unexpectedStatus = valueGenerator.integer({ min: 900, max: 999 });
+    jest.mocked(sendEmailMethodMock).mockImplementation(() => Promise.reject(generateNotifyError(unexpectedStatus, errorMessage)));
 
     const { status, body } = await api.post(mdmPath, request, { govUkNotifyKey });
 
     expect(status).toBe(500);
-    expect(body).toStrictEqual({
+    expect(body).toMatchObject({
+      statusCode: 500,
+      message: 'Internal server error',
+    });
+  });
+
+  it("returns a 500 response if the Notify client error doesn't have message attribute", async () => {
+    jest.mocked(sendEmailMethodMock).mockImplementation(() => Promise.reject(generateNotifyError(400)));
+
+    const { status, body } = await api.post(mdmPath, request, { govUkNotifyKey });
+
+    expect(status).toBe(500);
+    expect(body).toMatchObject({
       statusCode: 500,
       message: 'Internal server error',
     });