feat(DTFS2-7498): fetch amendments eligibility criteria from db

dtfs-central-api/api-tests/v1/portal-facility-amendments/amendment-get.api-test.ts

@@ -18,6 +18,8 @@ import aDeal from '../deal-builder';
 import { aPortalUser } from '../../mocks/test-users/portal-user';
 import { createPortalUser } from '../../helpers/create-portal-user';
 import { createPortalFacilityAmendment } from '../../helpers/create-portal-facility-amendment';
+import { mongoDbClient as db } from '../../../src/drivers/db-client';
+import { amendmentsEligibilityCriteria } from '../../../test-helpers/test-data/eligibility-criteria-amendments';
 
 const originalEnv = { ...process.env };
 
@@ -40,7 +42,10 @@ describe('GET /v1/portal/facilities/:facilityId/amendments/:amendmentId', () =>
   let portalUserId: string;
 
   beforeAll(async () => {
-    await wipeDB.wipe([MONGO_DB_COLLECTIONS.FACILITIES, MONGO_DB_COLLECTIONS.TFM_FACILITIES]);
+    await wipeDB.wipe([MONGO_DB_COLLECTIONS.FACILITIES, MONGO_DB_COLLECTIONS.TFM_FACILITIES, MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS]);
+    await db
+      .getCollection(MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS)
+      .then((collection) => collection.insertOne(amendmentsEligibilityCriteria(1, [FACILITY_TYPE.CASH, FACILITY_TYPE.CONTINGENT])));
 
     portalUserId = (await createPortalUser())._id;
   });

dtfs-central-api/api-tests/v1/portal-facility-amendments/amendment-patch.api-test.ts

@@ -11,6 +11,8 @@ import aDeal from '../deal-builder';
 import { aPortalUser } from '../../mocks/test-users/portal-user';
 import { createPortalUser } from '../../helpers/create-portal-user';
 import { createPortalFacilityAmendment } from '../../helpers/create-portal-facility-amendment';
+import { mongoDbClient as db } from '../../../src/drivers/db-client';
+import { amendmentsEligibilityCriteria } from '../../../test-helpers/test-data/eligibility-criteria-amendments';
 
 const originalEnv = { ...process.env };
 
@@ -33,7 +35,10 @@ describe('PATCH /v1/portal/facilities/:facilityId/amendments/', () => {
   let portalUserId: string;
 
   beforeAll(async () => {
-    await wipeDB.wipe([MONGO_DB_COLLECTIONS.FACILITIES, MONGO_DB_COLLECTIONS.TFM_FACILITIES]);
+    await wipeDB.wipe([MONGO_DB_COLLECTIONS.FACILITIES, MONGO_DB_COLLECTIONS.TFM_FACILITIES, MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS]);
+    await db
+      .getCollection(MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS)
+      .then((collection) => collection.insertOne(amendmentsEligibilityCriteria(1, [FACILITY_TYPE.CASH, FACILITY_TYPE.CONTINGENT])));
 
     portalUserId = (await createPortalUser())._id;
   });

dtfs-central-api/api-tests/v1/portal-facility-amendments/amendment-put.api-test.ts

@@ -11,6 +11,8 @@ import aDeal from '../deal-builder';
 import { aPortalUser } from '../../mocks/test-users/portal-user';
 import { createPortalUser } from '../../helpers/create-portal-user';
 import { createPortalFacilityAmendment } from '../../helpers/create-portal-facility-amendment';
+import { amendmentsEligibilityCriteria } from '../../../test-helpers/test-data/eligibility-criteria-amendments';
+import { mongoDbClient as db } from '../../../src/drivers/db-client';
 
 const originalEnv = { ...process.env };
 
@@ -22,18 +24,29 @@ const generateUrl = (facilityId: string): string => {
   return `/v1/portal/facilities/${facilityId}/amendments/`;
 };
 
+console.error = jest.fn();
+
 const newDeal = aDeal({
   dealType: DEAL_TYPE.GEF,
   submissionType: DEAL_SUBMISSION_TYPE.AIN,
 }) as AnyObject;
 
+const draftCashEligibilityCriteria = amendmentsEligibilityCriteria(1.5, [FACILITY_TYPE.CASH, FACILITY_TYPE.CONTINGENT], true);
+const latestCashEligibilityCriteria = amendmentsEligibilityCriteria(1.2, [FACILITY_TYPE.CASH, FACILITY_TYPE.CONTINGENT]);
+const legacyCashEligibilityCriteria = amendmentsEligibilityCriteria(1, [FACILITY_TYPE.CASH, FACILITY_TYPE.CONTINGENT]);
+const otherEligibilityCriteria = amendmentsEligibilityCriteria(2, [FACILITY_TYPE.LOAN]);
+
+const eligibilityCriteriaList = [draftCashEligibilityCriteria, legacyCashEligibilityCriteria, latestCashEligibilityCriteria, otherEligibilityCriteria];
+
 describe('PUT /v1/portal/facilities/:facilityId/amendments/', () => {
   let dealId: string;
   let facilityId: string;
+
   let portalUserId: string;
 
   beforeAll(async () => {
-    await wipeDB.wipe([MONGO_DB_COLLECTIONS.FACILITIES, MONGO_DB_COLLECTIONS.TFM_FACILITIES]);
+    await wipeDB.wipe([MONGO_DB_COLLECTIONS.FACILITIES, MONGO_DB_COLLECTIONS.TFM_FACILITIES, MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS]);
+    await db.getCollection(MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS).then((collection) => collection.insertMany(eligibilityCriteriaList));
 
     portalUserId = (await createPortalUser())._id;
   });
@@ -124,7 +137,13 @@ describe('PUT /v1/portal/facilities/:facilityId/amendments/', () => {
 
       // Assert
       expect(status).toEqual(HttpStatusCode.Ok);
-      expect(body).toEqual(expect.objectContaining({ amendmentId: expect.any(String) as string, facilityId, dealId }));
+      expect(body).toEqual(
+        expect.objectContaining({
+          amendmentId: expect.any(String) as string,
+          facilityId,
+          dealId,
+        }),
+      );
     });
 
     it('should overwrite any existing amendment', async () => {
@@ -150,5 +169,50 @@ describe('PUT /v1/portal/facilities/:facilityId/amendments/', () => {
         message: `Amendment not found: ${existingAmendmentId} on facility: ${facilityId}`,
       });
     });
+
+    it('should return the new amendment with the latest non-draft eligibility criteria for the facility type', async () => {
+      // Act
+      const { body, status } = (await testApi
+        .put({ dealId, amendment: aPortalFacilityAmendmentUserValues(), auditDetails: generatePortalAuditDetails(portalUserId) })
+        .to(generateUrl(facilityId))) as FacilityAmendmentResponse;
+
+      // Assert
+      const latestCriteriaForFacilityType = latestCashEligibilityCriteria.criteria.map((criterion) => ({ ...criterion, answer: null }));
+      const latestVersionForFacilityType = latestCashEligibilityCriteria.version;
+
+      expect(status).toEqual(HttpStatusCode.Ok);
+      expect(body).toEqual(
+        expect.objectContaining({
+          amendmentId: expect.any(String) as string,
+          facilityId,
+          dealId,
+          eligibilityCriteria: { version: latestVersionForFacilityType, criteria: latestCriteriaForFacilityType },
+        }),
+      );
+    });
+
+    it('should throw an error if no eligibility criteria exists in the db for the given facility type', async () => {
+      // Arrange
+      await wipeDB.wipe([MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS]);
+      const eligibilityCriteriaNoCash = [
+        amendmentsEligibilityCriteria(1, [FACILITY_TYPE.CONTINGENT]),
+        amendmentsEligibilityCriteria(2, [FACILITY_TYPE.CASH], true),
+        amendmentsEligibilityCriteria(1.5, [FACILITY_TYPE.BOND, FACILITY_TYPE.LOAN]),
+      ];
+      await db.getCollection(MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS).then((c) => c.insertMany(eligibilityCriteriaNoCash));
+
+      // Act
+      const { body, status } = (await testApi
+        .put({ dealId, amendment: aPortalFacilityAmendmentUserValues(), auditDetails: generatePortalAuditDetails(portalUserId) })
+        .to(generateUrl(facilityId))) as FacilityAmendmentResponse;
+
+      // Assert
+      expect(status).toEqual(HttpStatusCode.NotFound);
+      expect(body).toEqual({
+        status: HttpStatusCode.NotFound,
+        message: 'Eligibility criteria not found',
+      });
+      expect(console.error).toHaveBeenCalledWith('Unable to find latest eligibility criteria for facility type %s', FACILITY_TYPE.CASH);
+    });
   });
 });

dtfs-central-api/src/repositories/portal/eligibility-criteria-amendments.repo.test.ts

@@ -0,0 +1,59 @@
+import { AmendmentsEligibilityCriteria, FACILITY_TYPE, MONGO_DB_COLLECTIONS } from '@ukef/dtfs2-common';
+import { mongoDbClient } from '../../drivers/db-client';
+import { EligibilityCriteriaAmendmentsRepo } from './eligibility-criteria-amendments.repo';
+import { amendmentsEligibilityCriteria } from '../../../test-helpers/test-data/eligibility-criteria-amendments';
+
+describe('EligibilityCriteriaAmendmentsRepo', () => {
+  const findToArrayMock = jest.fn();
+  const findMock = jest.fn();
+  const getCollectionMock = jest.fn();
+
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  describe('findLatestEligibilityCriteria', () => {
+    const eligibilityCriteria: AmendmentsEligibilityCriteria = amendmentsEligibilityCriteria();
+
+    beforeEach(() => {
+      findToArrayMock.mockResolvedValue([eligibilityCriteria]);
+      findMock.mockReturnValue({ sort: () => ({ limit: () => ({ toArray: findToArrayMock }) }) });
+
+      getCollectionMock.mockResolvedValue({
+        find: findMock,
+      });
+
+      jest.spyOn(mongoDbClient, 'getCollection').mockImplementation(getCollectionMock);
+    });
+
+    it(`should call getCollection with ${MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS}`, async () => {
+      // Act
+      await EligibilityCriteriaAmendmentsRepo.findLatestEligibilityCriteria(FACILITY_TYPE.CASH);
+
+      // Assert
+      expect(getCollectionMock).toHaveBeenCalledTimes(1);
+      expect(getCollectionMock).toHaveBeenCalledWith(MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS);
+    });
+
+    it('should call find with the expected parameters', async () => {
+      // Act
+      const facilityType = FACILITY_TYPE.CASH;
+      await EligibilityCriteriaAmendmentsRepo.findLatestEligibilityCriteria(facilityType);
+
+      // Assert
+      const expectedFilter = { $and: [{ facilityType }, { isInDraft: { $eq: false } }] };
+
+      expect(findMock).toHaveBeenCalledTimes(1);
+      expect(findMock).toHaveBeenCalledWith(expectedFilter);
+    });
+
+    it('should return the found latest eligibility criteria', async () => {
+      // Act
+      const facilityType = FACILITY_TYPE.CASH;
+      const result = await EligibilityCriteriaAmendmentsRepo.findLatestEligibilityCriteria(facilityType);
+
+      // Assert
+      expect(result).toEqual(eligibilityCriteria);
+    });
+  });
+});

dtfs-central-api/src/repositories/portal/eligibility-criteria-amendments.repo.ts

@@ -0,0 +1,34 @@
+import { Collection, WithoutId } from 'mongodb';
+import { MONGO_DB_COLLECTIONS, AmendmentsEligibilityCriteria, EligibilityCriteriaNotFoundError, FacilityType } from '@ukef/dtfs2-common';
+import { mongoDbClient } from '../../drivers/db-client';
+
+/**
+ * Repository to handle database operations for amendments eligibility criteria
+ */
+export class EligibilityCriteriaAmendmentsRepo {
+  private static async getCollection(): Promise<Collection<WithoutId<AmendmentsEligibilityCriteria>>> {
+    return await mongoDbClient.getCollection(MONGO_DB_COLLECTIONS.ELIGIBILITY_CRITERIA_AMENDMENTS);
+  }
+
+  /**
+   * Finds the portal amendments eligibility criteria for the given facility type with the latest version number
+   * @param facilityType the facility type
+   * @returns The latest portal amendments eligibility criteria for the given facility type
+   */
+  public static async findLatestEligibilityCriteria(facilityType: FacilityType): Promise<AmendmentsEligibilityCriteria> {
+    const collection = await this.getCollection();
+
+    const [latestEligibilityCriteria] = await collection
+      .find({ $and: [{ facilityType }, { isInDraft: { $eq: false } }] })
+      .sort({ version: -1 })
+      .limit(1)
+      .toArray();
+
+    if (!latestEligibilityCriteria) {
+      console.error('Unable to find latest eligibility criteria for facility type %s', facilityType);
+      throw new EligibilityCriteriaNotFoundError();
+    }
+
+    return latestEligibilityCriteria;
+  }
+}

dtfs-central-api/src/services/portal/facility-amendment.service.ts

@@ -11,6 +11,8 @@
 import { ObjectId } from 'mongodb';
 import { findOneUser } from '../../v1/controllers/user/get-user.controller';
 import { TfmFacilitiesRepo } from '../../repositories/tfm-facilities-repo';
+import { EligibilityCriteriaAmendmentsRepo } from '../../repositories/portal/eligibility-criteria-amendments.repo';
+import { findOneFacility } from '../../v1/controllers/portal/facility/get-facility.controller';
 
 export class PortalFacilityAmendmentService {
   /**
@@ -39,6 +41,12 @@
       throw new InvalidAuditDetailsError(`Supplied auditDetails 'id' ${auditDetails.id.toString()} does not correspond to a valid user`);
     }
 
+    const { type: facilityType } = await findOneFacility(facilityId);
+
+    const { version, criteria } = await EligibilityCriteriaAmendmentsRepo.findLatestEligibilityCriteria(facilityType);
+
+    const updatedCriteria = criteria.map((criterion) => ({ ...criterion, answer: null }));
+
     const amendmentToInsert: PortalFacilityAmendment = {
       ...amendment,
       dealId: new ObjectId(dealId),
@@ -48,6 +56,7 @@
       status: PORTAL_AMENDMENT_STATUS.DRAFT,
       createdAt: getUnixTimestampSeconds(new Date()),
       updatedAt: getUnixTimestampSeconds(new Date()),
+      eligibilityCriteria: { version, criteria: updatedCriteria },
       createdBy: {
         username: user.username,
         name: `${user.firstname} ${user.surname}`,

dtfs-central-api/src/services/portal/facility-amendment.upsertPortalFacilityAmendmentDraft.service.test.ts

@@ -1,26 +1,42 @@
 /* eslint-disable import/first */
-const mockFindOneUser = jest.fn();
+import { PORTAL_AMENDMENT_STATUS, AMENDMENT_TYPES, InvalidAuditDetailsError, AmendmentsEligibilityCriteria } from '@ukef/dtfs2-common';
 
-jest.mock('../../v1/controllers/user/get-user.controller', () => ({
-  findOneUser: mockFindOneUser,
-}));
+const mockFindOneUser = jest.fn();
+const mockFindOneFacility = jest.fn();
+const mockFindLatestEligibilityCriteria = jest.fn() as jest.Mock<Promise<AmendmentsEligibilityCriteria>>;
 
 import { ObjectId } from 'mongodb';
 import { HttpStatusCode } from 'axios';
 import { getUnixTime } from 'date-fns';
 import { generatePortalAuditDetails } from '@ukef/dtfs2-common/change-stream';
-import { PORTAL_AMENDMENT_STATUS, AMENDMENT_TYPES, InvalidAuditDetailsError } from '@ukef/dtfs2-common';
 import { aPortalFacilityAmendmentUserValues } from '@ukef/dtfs2-common/mock-data-backend';
+import { amendmentsEligibilityCriteria } from '../../../test-helpers/test-data/eligibility-criteria-amendments';
 import { PortalFacilityAmendmentService } from './facility-amendment.service';
-import { aPortalUser } from '../../../test-helpers';
+import { aFacility, aPortalUser } from '../../../test-helpers';
 import { TfmFacilitiesRepo } from '../../repositories/tfm-facilities-repo';
 
+jest.mock('../../v1/controllers/user/get-user.controller', () => ({
+  findOneUser: mockFindOneUser,
+}));
+
+jest.mock('../../v1/controllers/portal/facility/get-facility.controller', () => ({
+  findOneFacility: mockFindOneFacility,
+}));
+
+jest.mock('../../repositories/portal/eligibility-criteria-amendments.repo', () => ({
+  EligibilityCriteriaAmendmentsRepo: {
+    findLatestEligibilityCriteria: (facilityType: string) => mockFindLatestEligibilityCriteria(facilityType),
+  },
+}));
+
 const mockUpsertPortalFacilityAmendmentDraft = jest.fn();
 
 const dealId = new ObjectId().toString();
 const facilityId = new ObjectId().toString();
 const amendment = aPortalFacilityAmendmentUserValues();
 const auditDetails = generatePortalAuditDetails(aPortalUser()._id);
+const facility = aFacility();
+const eligibilityCriteria = amendmentsEligibilityCriteria();
 
 describe('PortalFacilityAmendmentService', () => {
   beforeAll(() => {
@@ -33,7 +49,9 @@
     jest.spyOn(TfmFacilitiesRepo, 'upsertPortalFacilityAmendmentDraft').mockImplementation(mockUpsertPortalFacilityAmendmentDraft);
 
     mockFindOneUser.mockResolvedValue(aPortalUser());
-    mockUpsertPortalFacilityAmendmentDraft.mockResolvedValue({});
+    mockFindOneFacility.mockResolvedValue(facility);
+    mockFindOneFacility.mockResolvedValue(facility);
+    mockFindLatestEligibilityCriteria.mockResolvedValue(eligibilityCriteria);
   });
 
   afterAll(() => {
@@ -70,6 +88,34 @@
       ).rejects.toThrow(InvalidAuditDetailsError);
     });
 
+    it('should call findOneFacility with the facility id', async () => {
+      // Act
+      await PortalFacilityAmendmentService.upsertPortalFacilityAmendmentDraft({
+        dealId,
+        facilityId,
+        amendment,
+        auditDetails,
+      });
+
+      // Assert
+      expect(mockFindOneFacility).toHaveBeenCalledTimes(1);
+      expect(mockFindOneFacility).toHaveBeenCalledWith(facilityId);
+    });
+
+    it('should call findLatestEligibilityCriteria with the facility type', async () => {
+      // Act
+      await PortalFacilityAmendmentService.upsertPortalFacilityAmendmentDraft({
+        dealId,
+        facilityId,
+        amendment,
+        auditDetails,
+      });
+
+      // Assert
+      expect(mockFindLatestEligibilityCriteria).toHaveBeenCalledTimes(1);
+      expect(mockFindLatestEligibilityCriteria).toHaveBeenCalledWith(facility.type);
+    });
+
     it('should call TfmFacilitiesRepo.upsertPortalFacilityAmendmentDraft with correct params', async () => {
       // Act
       await PortalFacilityAmendmentService.upsertPortalFacilityAmendmentDraft({
@@ -89,6 +135,13 @@
         status: PORTAL_AMENDMENT_STATUS.DRAFT,
         createdAt: getUnixTime(new Date()),
         updatedAt: getUnixTime(new Date()),
+        eligibilityCriteria: {
+          version: eligibilityCriteria.version,
+          criteria: [
+            { ...eligibilityCriteria.criteria[0], answer: null },
+            { ...eligibilityCriteria.criteria[1], answer: null },
+          ],
+        },
         createdBy: {
           username: aPortalUser().username,
           name: `${aPortalUser().firstname} ${aPortalUser().surname}`,
@@ -119,6 +172,13 @@
         status: PORTAL_AMENDMENT_STATUS.DRAFT,
         createdAt: getUnixTime(new Date()),
         updatedAt: getUnixTime(new Date()),
+        eligibilityCriteria: {
+          version: eligibilityCriteria.version,
+          criteria: [
+            { ...eligibilityCriteria.criteria[0], answer: null },
+            { ...eligibilityCriteria.criteria[1], answer: null },
+          ],
+        },
         createdBy: {
           username: aPortalUser().username,
           name: `${aPortalUser().firstname} ${aPortalUser().surname}`,