fix(APIM-611): notify, companies house bug fixes (#1113)

## Introduction ✏️
This PR aims to mitigate following bugs:

* Large payload entity too large exception (413) thrown when sending
`file` with Base64 buffer when invoking GovNotify endpoint.
* Company house response, where `due_on` property doest not exist for
certain companies.

## Resolution ✔️
* Increased `json` and `urlEncoded` payload size to `2MB`.
* Added optional chain to few `nextAccounts` and `accounts` object
properties.

## Miscellaneous ➕
* Dependencies updates.
* Minor documentation improvement.
* Minor lint fixes.

---------

Co-authored-by: Abhi Markan <amarkan>

src/app.ts

@@ -1,9 +1,11 @@
 import { INestApplication, ValidationPipe, VersioningType } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import { ApiKeyAuthGuard } from '@ukef/auth/guard/api-key.guard';
+import { GOVUK_NOTIFY } from '@ukef/constants';
 import { TransformInterceptor } from '@ukef/helpers';
 import { SwaggerDocs } from '@ukef/swagger';
 import compression from 'compression';
+import express from 'express';
 import { Logger } from 'nestjs-pino';
 
 export class App {
@@ -20,6 +22,7 @@ export class App {
     const globalPrefix: string = this.getConfig<string>('app.globalPrefix');
     const version: string = this.getConfig<string>('app.versioning.version');
     const versioningPrefix: string = this.getConfig<string>('app.versioning.prefix');
+
     app.enableVersioning({
       type: VersioningType.URI,
       defaultVersion: version,
@@ -54,6 +57,14 @@ export class App {
         },
       }),
     );
+
+    /**
+     * Payload request size
+     * Default is 100KB this has been increased to 2MB
+     * to allow GovNotify file inclusion.
+     */
+    app.use(express.json({ limit: GOVUK_NOTIFY.FILE.SIZE.MAX }));
+    app.use(express.urlencoded({ limit: GOVUK_NOTIFY.FILE.SIZE.MAX, extended: true }));
   }
 
   private getConfig<T = any>(key: string): T {

src/constants/govuk-notify.constant.ts

@@ -18,4 +18,9 @@ export const GOVUK_NOTIFY = {
     TRANSACTION_ID: 36,
     SERVICE_ID: 36,
   },
+  FILE: {
+    SIZE: {
+      MAX: '2mb',
+    },
+  },
 };

src/helper-modules/companies-house/dto/get-company-companies-house-response.dto.ts

@@ -16,14 +16,14 @@ export type GetCompanyCompaniesHouseResponse = {
       month: string;
       day: string;
     };
-    overdue: boolean;
-    next_made_up_to: string;
-    next_due: string;
+    overdue?: boolean;
+    next_made_up_to?: string;
+    next_due?: string;
     next_accounts: {
-      period_start_on: string;
-      due_on: string;
-      period_end_on: string;
-      overdue: boolean;
+      period_start_on?: string;
+      due_on?: string;
+      period_end_on?: string;
+      overdue?: boolean;
     };
   };
   company_name: string;

src/main.ts

@@ -16,6 +16,7 @@ const main = async () => {
   logger.log(`==========================================================`);
   logger.log(`Main app will serve on PORT ${app.port}`, 'MainApplication');
   logger.log(`==========================================================`);
+
   return app.listen();
 };
 

src/modules/companies/companies.service.ts

@@ -59,14 +59,14 @@ export class CompaniesService {
           type: company.accounts.last_accounts?.period_start_on,
         },
         nextAccounts: {
-          dueOn: company.accounts.next_accounts.due_on,
-          overdue: company.accounts.next_accounts.overdue,
-          periodEndOn: company.accounts.next_accounts.period_end_on,
-          periodStartOn: company.accounts.next_accounts.period_start_on,
+          dueOn: company.accounts.next_accounts?.due_on,
+          overdue: company.accounts.next_accounts?.overdue,
+          periodEndOn: company.accounts.next_accounts?.period_end_on,
+          periodStartOn: company.accounts.next_accounts?.period_start_on,
         },
-        nextDue: company.accounts.next_due,
-        nextMadeUpTo: company.accounts.next_made_up_to,
-        overdue: company.accounts.overdue,
+        nextDue: company.accounts?.next_due,
+        nextMadeUpTo: company.accounts?.next_made_up_to,
+        overdue: company.accounts?.overdue,
       },
       companiesHouseRegistrationNumber: company.company_number,
       companyName: company.company_name,

src/modules/companies/dto/get-company-response.dto.ts

@@ -11,10 +11,10 @@ class AccountsLastAccounts {
 }
 
 class AccountsNextAccounts {
-  dueOn: string;
-  overdue: boolean;
-  periodEndOn: string;
-  periodStartOn: string;
+  dueOn?: string;
+  overdue?: boolean;
+  periodEndOn?: string;
+  periodStartOn?: string;
 }
 
 class Accounts {

src/modules/emails/dto/post-emails-request.dto.ts

@@ -40,15 +40,14 @@ export class PostEmailsRequestDto {
   @IsString()
   @IsOptional()
   @MinLength(1)
-  // 100 characters is an arbitrary max limit. GOV.UK Notify can accept references at least 400 characters long.
-  @MaxLength(100)
+  @MaxLength(400)
   @ApiProperty({
     example: GOVUK_NOTIFY.EXAMPLES.REFERENCE,
     description: 'Reference for the email sent',
     required: false,
     nullable: true,
     minLength: 1,
-    maxLength: 100,
+    maxLength: 400,
   })
   readonly reference?: string | null;
 
@@ -58,7 +57,7 @@ export class PostEmailsRequestDto {
   @MaxLength(400)
   @ApiProperty({
     example: GOVUK_NOTIFY.EXAMPLES.FILE,
-    description: 'File for GovNotify to consume and generate a link to download',
+    description: `File for GovNotify to consume and generate a link to download with supported file types. The file size must be smaller than ${GOVUK_NOTIFY.FILE.SIZE.MAX}`,
     required: false,
     nullable: true,
     minLength: 1,