Merge branch 'main' into feat/FN-3819

Author: Zain Kassam

.github/workflows/test.yml

@@ -169,6 +169,7 @@ env:
   ENTRA_ID_REDIRECT_URL: ${{ vars.ENTRA_ID_REDIRECT_URL }}
   DEAL_CANCELLATION_SCHEDULE: ${{ vars.DEAL_CANCELLATION_SCHEDULE }}
   RECORD_CORRECTION_TRANSIENT_FORM_DATA_DELETE_SCHEDULE: ${{ vars.RECORD_CORRECTION_TRANSIENT_FORM_DATA_DELETE_SCHEDULE }}
+  UKEF_GEF_REPORTING_EMAIL_RECIPIENT: ${{ secrets.UKEF_GEF_REPORTING_EMAIL_RECIPIENT }}
 
 jobs:
   # 1. Setup test infrastructure

docker-compose.yml

@@ -89,6 +89,8 @@ services:
       - FF_TFM_DEAL_CANCELLATION_ENABLED
       - DEAL_CANCELLATION_SCHEDULE
       - FF_PORTAL_FACILITY_AMENDMENTS_ENABLED
+      - UKEF_GEF_REPORTING_EMAIL_RECIPIENT
+      - TFM_UI_URL=http://localhost:5003
       - RECORD_CORRECTION_TRANSIENT_FORM_DATA_DELETE_SCHEDULE
 
   trade-finance-manager-ui:

dtfs-central-api/api-tests/v1/utilisation-reports/fee-record-corrections/get-completed-fee-record-corrections.api-test.ts

@@ -0,0 +1,109 @@
+import { HttpStatusCode } from 'axios';
+import {
+  Bank,
+  FEE_RECORD_STATUS,
+  FeeRecordCorrectionEntityMockBuilder,
+  FeeRecordEntityMockBuilder,
+  RECONCILIATION_IN_PROGRESS,
+  RECORD_CORRECTION_REASON,
+  UtilisationReportEntityMockBuilder,
+} from '@ukef/dtfs2-common';
+import { testApi } from '../../../test-api';
+import { SqlDbHelper } from '../../../sql-db-helper';
+import { aBank } from '../../../../test-helpers';
+import { mongoDbClient } from '../../../../src/drivers/db-client';
+import { wipe } from '../../../wipeDB';
+import { replaceUrlParameterPlaceholders } from '../../../../test-helpers/replace-url-parameter-placeholders';
+
+console.error = jest.fn();
+
+const BASE_URL = '/v1/bank/:bankId/utilisation-reports/completed-corrections';
+
+describe(`GET ${BASE_URL}`, () => {
+  const bankId = '123';
+  const bank: Bank = {
+    ...aBank(),
+    id: bankId,
+  };
+
+  const report = UtilisationReportEntityMockBuilder.forStatus(RECONCILIATION_IN_PROGRESS).withBankId(bankId).build();
+  const feeRecord = FeeRecordEntityMockBuilder.forReport(report).withExporter('An exporter').withStatus(FEE_RECORD_STATUS.TO_DO_AMENDED).build();
+  report.feeRecords = [feeRecord];
+
+  beforeAll(async () => {
+    await SqlDbHelper.initialize();
+    await SqlDbHelper.deleteAllEntries('UtilisationReport');
+    await wipe(['banks']);
+
+    const banksCollection = await mongoDbClient.getCollection('banks');
+    await banksCollection.insertOne(bank);
+
+    await SqlDbHelper.saveNewEntries('UtilisationReport', [report]);
+  });
+
+  afterEach(async () => {
+    await SqlDbHelper.deleteAllEntries('FeeRecordCorrection');
+  });
+
+  afterAll(async () => {
+    await SqlDbHelper.deleteAllEntries('UtilisationReport');
+    await wipe(['banks']);
+  });
+
+  it(`should return '${HttpStatusCode.Ok}' and the completed fee record corrections response`, async () => {
+    // Arrange
+    const dateCorrectionReceived = new Date('2024-01-01');
+    const oldFacilityId = feeRecord.facilityId;
+    const newFacilityId = '12345678';
+
+    const feeRecordCorrection = FeeRecordCorrectionEntityMockBuilder.forFeeRecordAndIsCompleted(feeRecord, true)
+      .withId(1)
+      .withDateReceived(dateCorrectionReceived)
+      .withReasons([RECORD_CORRECTION_REASON.FACILITY_ID_INCORRECT, RECORD_CORRECTION_REASON.OTHER])
+      .withPreviousValues({
+        facilityId: oldFacilityId,
+      })
+      .withCorrectedValues({
+        facilityId: newFacilityId,
+      })
+      .withBankCommentary('Some bank commentary')
+      .build();
+
+    await SqlDbHelper.saveNewEntry('FeeRecordCorrection', feeRecordCorrection);
+
+    // Act
+    const response = await testApi.get(replaceUrlParameterPlaceholders(BASE_URL, { bankId }));
+
+    // Assert
+    expect(response.status).toEqual(HttpStatusCode.Ok);
+
+    const expectedMappedCompletedCorrections = [
+      {
+        id: feeRecordCorrection.id,
+        dateSent: dateCorrectionReceived.toISOString(),
+        exporter: feeRecord.exporter,
+        formattedReasons: 'Facility ID is incorrect, Other',
+        formattedPreviousValues: `${oldFacilityId}, -`,
+        formattedCorrectedValues: `${newFacilityId}, -`,
+        bankCommentary: feeRecordCorrection.bankCommentary,
+      },
+    ];
+
+    expect(response.body).toEqual(expectedMappedCompletedCorrections);
+  });
+
+  it(`should return '${HttpStatusCode.Ok}' and an empty array when no completed fee record corrections with the supplied bank id can be found`, async () => {
+    // Arrange
+    const feeRecordCorrection = FeeRecordCorrectionEntityMockBuilder.forFeeRecordAndIsCompleted(feeRecord, true).build();
+
+    await SqlDbHelper.saveNewEntry('FeeRecordCorrection', feeRecordCorrection);
+
+    // Act
+    const response = await testApi.get(replaceUrlParameterPlaceholders(BASE_URL, { bankId: `${bankId}123` }));
+
+    // Assert
+    expect(response.status).toEqual(HttpStatusCode.Ok);
+
+    expect(response.body).toEqual([]);
+  });
+});

dtfs-central-api/api-tests/v1/utilisation-reports/fee-record-corrections/put-fee-record-correction.api-test.ts

@@ -2,11 +2,14 @@ import { HttpStatusCode } from 'axios';
 import { Response } from 'supertest';
 import {
   FEE_RECORD_STATUS,
+  FeeRecordCorrectionEntity,
   FeeRecordCorrectionEntityMockBuilder,
   FeeRecordCorrectionTransientFormDataEntity,
   FeeRecordCorrectionTransientFormDataEntityMockBuilder,
+  FeeRecordEntity,
   FeeRecordEntityMockBuilder,
   RECONCILIATION_IN_PROGRESS,
+  RECORD_CORRECTION_REASON,
   ReportPeriod,
   UtilisationReportEntityMockBuilder,
 } from '@ukef/dtfs2-common';
@@ -33,12 +36,13 @@ const BASE_URL = '/v1/bank/:bankId/fee-record-corrections/:correctionId';
 
 describe(`PUT ${BASE_URL}`, () => {
   const bankId = '1';
+  const feeRecordId = 1;
   const correctionId = 2;
   const userId = new ObjectId().toString();
 
   const reportPeriod = { start: { month: 3, year: 2023 }, end: { month: 4, year: 2023 } };
 
-  const paymentOfficerTeamEmails = ['email1@ukexportfinance.gov.uk'];
+  const paymentOfficerTeamEmails = ['payment-officer1@ukexportfinance.gov.uk'];
 
   const mockBank = {
     ...aBank(),
@@ -53,6 +57,11 @@ describe(`PUT ${BASE_URL}`, () => {
     user: { _id: userId },
   });
 
+  const reasons = [RECORD_CORRECTION_REASON.FACILITY_ID_INCORRECT];
+
+  const incorrectFacilityId = '11111111';
+  const correctFacilityId = '22222222';
+
   beforeAll(async () => {
     await SqlDbHelper.initialize();
     await wipeDB.wipe(['banks']);
@@ -68,16 +77,24 @@ describe(`PUT ${BASE_URL}`, () => {
 
     const report = UtilisationReportEntityMockBuilder.forStatus(RECONCILIATION_IN_PROGRESS).withBankId(bankId).withReportPeriod(reportPeriod).build();
 
-    const feeRecord = FeeRecordEntityMockBuilder.forReport(report).withStatus(FEE_RECORD_STATUS.PENDING_CORRECTION).build();
+    const feeRecord = FeeRecordEntityMockBuilder.forReport(report)
+      .withId(feeRecordId)
+      .withStatus(FEE_RECORD_STATUS.PENDING_CORRECTION)
+      .withFacilityId(incorrectFacilityId)
+      .build();
 
-    const correction = FeeRecordCorrectionEntityMockBuilder.forFeeRecordAndIsCompleted(feeRecord, false).withId(correctionId).build();
+    const correction = FeeRecordCorrectionEntityMockBuilder.forFeeRecordAndIsCompleted(feeRecord, false).withId(correctionId).withReasons(reasons).build();
 
     feeRecord.corrections = [correction];
     report.feeRecords = [feeRecord];
 
     await SqlDbHelper.saveNewEntry('UtilisationReport', report);
 
-    const formData = new FeeRecordCorrectionTransientFormDataEntityMockBuilder().withCorrectionId(correctionId).withUserId(userId).build();
+    const formData = new FeeRecordCorrectionTransientFormDataEntityMockBuilder()
+      .withCorrectionId(correctionId)
+      .withUserId(userId)
+      .withFormData({ facilityId: correctFacilityId })
+      .build();
 
     await SqlDbHelper.saveNewEntry('FeeRecordCorrectionTransientFormData', formData);
   });
@@ -149,6 +166,50 @@ describe(`PUT ${BASE_URL}`, () => {
     expect(status).toEqual(HttpStatusCode.Ok);
   });
 
+  it(`should update the fee record with corrected values and set status to ${FEE_RECORD_STATUS.TO_DO_AMENDED}`, async () => {
+    // Arrange
+    const requestBody = aValidRequestBody();
+
+    // Act
+    await testApi.put(requestBody).to(replaceUrlParameterPlaceholders(BASE_URL, { bankId, correctionId }));
+
+    // Assert
+    const feeRecord = await SqlDbHelper.manager.findOneBy(FeeRecordEntity, { id: feeRecordId });
+    expect(feeRecord?.facilityId).toEqual(correctFacilityId);
+    expect(feeRecord?.status).toEqual(FEE_RECORD_STATUS.TO_DO_AMENDED);
+  });
+
+  it('should save the previous and corrected values on the correction and complete it', async () => {
+    // Arrange
+    const requestBody = aValidRequestBody();
+
+    // Act
+    await testApi.put(requestBody).to(replaceUrlParameterPlaceholders(BASE_URL, { bankId, correctionId }));
+
+    // Assert
+    const correction = await SqlDbHelper.manager.findOneBy(FeeRecordCorrectionEntity, { id: correctionId });
+
+    const expectedPreviousValues = {
+      facilityId: incorrectFacilityId,
+      feesPaidToUkefForThePeriod: null,
+      feesPaidToUkefForThePeriodCurrency: null,
+      facilityUtilisation: null,
+    };
+
+    expect(correction?.previousValues).toEqual(expectedPreviousValues);
+
+    const expectedCorrectedValues = {
+      facilityId: correctFacilityId,
+      feesPaidToUkefForThePeriod: null,
+      feesPaidToUkefForThePeriodCurrency: null,
+      facilityUtilisation: null,
+    };
+
+    expect(correction?.correctedValues).toEqual(expectedCorrectedValues);
+
+    expect(correction?.isCompleted).toEqual(true);
+  });
+
   it('should delete the transient form data', async () => {
     // Arrange
     const requestBody = aValidRequestBody();

dtfs-central-api/src/constants/email-template-ids.ts

@@ -1,5 +1,13 @@
 const REPORT_RECONCILED = 'f6a10d2f-a1bb-4640-9bf0-0699ef442551';
 const FEE_RECORD_CORRECTION_REQUEST = 'c32528aa-4e12-43c1-9ff0-11f327513b9e';
+const FEE_RECORD_CORRECTION_RECEIVED_BANK_NOTIFICATION = 'c60489c5-a2e8-4100-a63a-3f5e691bdb20';
+const FEE_RECORD_CORRECTION_RECEIVED_UKEF_NOTIFICATION = '2af491e6-2968-4476-8db9-74202138dfad';
 const REPORT_INSERTION_CRON_FAILURE = 'a8a2b0db-67a8-409b-b8b7-7104b137acfd';
 
-export default { REPORT_RECONCILED, FEE_RECORD_CORRECTION_REQUEST, REPORT_INSERTION_CRON_FAILURE };
+export default {
+  REPORT_RECONCILED,
+  FEE_RECORD_CORRECTION_REQUEST,
+  FEE_RECORD_CORRECTION_RECEIVED_BANK_NOTIFICATION,
+  FEE_RECORD_CORRECTION_RECEIVED_UKEF_NOTIFICATION,
+  REPORT_INSERTION_CRON_FAILURE,
+};

dtfs-central-api/src/helpers/index.ts

@@ -12,4 +12,5 @@ export { calculateUkefShareOfUtilisation } from './calculate-ukef-share-of-utili
 export { getKeyingSheetCalculationFacilityValues } from './get-keying-sheet-calculation-facility-values';
 export { getCorrectionPreviousValuesFromFeeRecord } from './get-correction-previous-values-from-fee-record';
 export { getCorrectionCorrectedValuesFromFormData } from './get-correction-corrected-values-from-form-data';
+export { validateRequiredCorrectionField } from './validate-required-correction-field';
 export * from './amendments';