feat(DTFS2-7733): post cancel amendment

gef-ui/api-tests/amendments/cancel-portal-facility-amendment.api-test.ts → gef-ui/api-tests/amendments/cancel-portal-facility-amendment.get.api-test.ts

@@ -10,6 +10,7 @@ import * as storage from '../test-helpers/storage/storage';
 import { MOCK_BASIC_DEAL } from '../../server/utils/mocks/mock-applications';
 import { MOCK_UNISSUED_FACILITY, MOCK_ISSUED_FACILITY } from '../../server/utils/mocks/mock-facilities';
 import { PortalFacilityAmendmentWithUkefIdMockBuilder } from '../../test-helpers/mock-amendment';
+import { PORTAL_AMENDMENT_PAGES } from '../../server/constants/amendments';
 import { withGetAmendmentPageErrorHandlingTests } from './with-get-amendment-page-error-handling.api-tests';
 
 const originalEnv = { ...process.env };
@@ -25,13 +26,13 @@ const mockGetFacility = jest.fn();
 const mockGetApplication = jest.fn();
 const mockGetAmendment = jest.fn();
 
-const dealId = '123';
-const facilityId = '111';
-const amendmentId = '111';
+const dealId = '6597dffeb5ef5ff4267e5044';
+const facilityId = '6597dffeb5ef5ff4267e5045';
+const amendmentId = '6597dffeb5ef5ff4267e5046';
 
 const mockDeal = { ...MOCK_BASIC_DEAL, submissionType: DEAL_SUBMISSION_TYPE.AIN, status: DEAL_STATUS.UKEF_ACKNOWLEDGED };
 
-const url = `/application-details/${dealId}/facilities/${facilityId}/amendments/${amendmentId}/cancel`;
+const url = `/application-details/${dealId}/facilities/${facilityId}/amendments/${amendmentId}/${PORTAL_AMENDMENT_PAGES.CANCEL}`;
 
 describe(`GET ${url}`, () => {
   let sessionCookie: string;

gef-ui/api-tests/amendments/cancel-portal-facility-amendment.post.api-test.ts

@@ -0,0 +1,162 @@
+import { Headers } from 'node-mocks-http';
+import { NextFunction, Request, Response } from 'express';
+import { HttpStatusCode } from 'axios';
+import { ROLES, API_ERROR_CODE } from '@ukef/dtfs2-common';
+import { withRoleValidationApiTests } from '../common-tests/role-validation-api-tests';
+import app from '../../server/createApp';
+import { createApi } from '../create-api';
+import api from '../../server/services/api';
+import * as storage from '../test-helpers/storage/storage';
+import { PORTAL_AMENDMENT_PAGES } from '../../server/constants/amendments';
+
+const originalEnv = { ...process.env };
+
+const { post } = createApi(app);
+
+jest.mock('csurf', () => () => (_req: Request, _res: Response, next: NextFunction) => next());
+jest.mock('../../server/middleware/csrf', () => ({
+  csrfToken: () => (_req: Request, _res: Response, next: NextFunction) => next(),
+}));
+
+const mockDeleteAmendment = jest.fn();
+
+const dealId = '6597dffeb5ef5ff4267e5044';
+const facilityId = '6597dffeb5ef5ff4267e5045';
+const amendmentId = '6597dffeb5ef5ff4267e5046';
+
+const validUrl = `/application-details/${dealId}/facilities/${facilityId}/amendments/${amendmentId}/${PORTAL_AMENDMENT_PAGES.CANCEL}`;
+
+describe(`POST ${validUrl}`, () => {
+  let sessionCookie: string;
+
+  beforeEach(async () => {
+    await storage.flush();
+    jest.resetAllMocks();
+
+    ({ sessionCookie } = await storage.saveUserSession([ROLES.MAKER]));
+    jest.spyOn(api, 'deleteAmendment').mockImplementation(mockDeleteAmendment);
+    jest.spyOn(console, 'error');
+  });
+
+  afterAll(async () => {
+    jest.resetAllMocks();
+    await storage.flush();
+    process.env = originalEnv;
+  });
+
+  describe('when FF_PORTAL_FACILITY_AMENDMENTS_ENABLED is disabled', () => {
+    beforeEach(() => {
+      process.env.FF_PORTAL_FACILITY_AMENDMENTS_ENABLED = 'false';
+    });
+
+    it('should redirect to /not-found', async () => {
+      // Act
+      const response = await postWithSessionCookie(sessionCookie, validUrl);
+
+      // Assert
+      expect(response.status).toEqual(HttpStatusCode.Found);
+      expect(response.headers.location).toEqual('/not-found');
+    });
+  });
+
+  describe('when FF_PORTAL_FACILITY_AMENDMENTS_ENABLED is not set', () => {
+    beforeEach(() => {
+      delete process.env.FF_PORTAL_FACILITY_AMENDMENTS_ENABLED;
+    });
+
+    it('should redirect to /not-found', async () => {
+      // Act
+      const response = await postWithSessionCookie(sessionCookie, validUrl);
+
+      // Assert
+      expect(response.status).toEqual(HttpStatusCode.Found);
+      expect(response.headers.location).toEqual('/not-found');
+    });
+  });
+
+  describe('when FF_PORTAL_FACILITY_AMENDMENTS_ENABLED is enabled', () => {
+    beforeEach(() => {
+      process.env.FF_PORTAL_FACILITY_AMENDMENTS_ENABLED = 'true';
+    });
+
+    withRoleValidationApiTests({
+      makeRequestWithHeaders: (headers: Headers) => post(headers).to(validUrl),
+      whitelistedRoles: [ROLES.MAKER],
+      successCode: HttpStatusCode.Found,
+    });
+
+    it(`should return ${HttpStatusCode.BadRequest} when the deal id is invalid`, async () => {
+      const invalidDealId = 'InvalidId';
+
+      const invalidUrl = `/application-details/${invalidDealId}/facilities/${facilityId}/amendments/${amendmentId}/${PORTAL_AMENDMENT_PAGES.CANCEL}`;
+      const response = await postWithSessionCookie(sessionCookie, invalidUrl);
+      expect(response.status).toEqual(HttpStatusCode.BadRequest);
+
+      expect(response.body).toEqual({
+        message: "Expected path parameter 'dealId' to be a valid mongo id",
+        code: API_ERROR_CODE.INVALID_MONGO_ID_PATH_PARAMETER,
+      });
+    });
+
+    it(`should return ${HttpStatusCode.BadRequest} when the facility id is invalid`, async () => {
+      const invalidFacilityId = 'InvalidId';
+
+      const invalidUrl = `/application-details/${dealId}/facilities/${invalidFacilityId}/amendments/${amendmentId}/${PORTAL_AMENDMENT_PAGES.CANCEL}`;
+      const response = await postWithSessionCookie(sessionCookie, invalidUrl);
+      expect(response.status).toEqual(HttpStatusCode.BadRequest);
+
+      expect(response.body).toEqual({
+        message: "Expected path parameter 'facilityId' to be a valid mongo id",
+        code: API_ERROR_CODE.INVALID_MONGO_ID_PATH_PARAMETER,
+      });
+    });
+
+    it(`should return ${HttpStatusCode.BadRequest} when the amendment id is invalid`, async () => {
+      const invalidAmendmentId = 'InvalidId';
+
+      const invalidUrl = `/application-details/${dealId}/facilities/${facilityId}/amendments/${invalidAmendmentId}/${PORTAL_AMENDMENT_PAGES.CANCEL}`;
+      const response = await postWithSessionCookie(sessionCookie, invalidUrl);
+      expect(response.status).toEqual(HttpStatusCode.BadRequest);
+
+      expect(response.body).toEqual({
+        message: "Expected path parameter 'amendmentId' to be a valid mongo id",
+        code: API_ERROR_CODE.INVALID_MONGO_ID_PATH_PARAMETER,
+      });
+    });
+
+    it('should not call console.error if the facility and amendment are valid', async () => {
+      // Act
+      await postWithSessionCookie(sessionCookie, validUrl);
+
+      // Assert
+      expect(console.error).not.toHaveBeenCalled();
+    });
+
+    it('should redirect to the applications details page, after the amendment has been deleted successfully', async () => {
+      // Act
+      const response = await postWithSessionCookie(sessionCookie, validUrl);
+
+      // Assert
+      expect(mockDeleteAmendment).toHaveBeenCalledTimes(1);
+      expect(response.status).toEqual(HttpStatusCode.Found);
+      expect(response.headers.location).toEqual(`/gef/application-details/${dealId}`);
+    });
+
+    it('should render `problem with service` if deleteAmendment throws an error', async () => {
+      // Arrange
+      mockDeleteAmendment.mockRejectedValue(new Error('test error'));
+
+      // Act
+      const response = await postWithSessionCookie(sessionCookie, validUrl);
+
+      // Assert
+      expect(mockDeleteAmendment).toHaveBeenCalledTimes(1);
+      expect(response.status).toEqual(HttpStatusCode.Ok);
+      expect(response.text).toContain('Problem with the service');
+    });
+  });
+});
+
+function postWithSessionCookie(sessionCookie: string, url: string) {
+  return post({}, { Cookie: [`dtfs-session=${encodeURIComponent(sessionCookie)}`] }).to(url);
+}

gef-ui/server/controllers/amendments/cancel-amendment/cancel-portal-facility-amendment.get.test.ts → gef-ui/server/controllers/amendments/cancel-amendment/get-cancel-portal-facility-amendment.test.ts

@@ -15,7 +15,7 @@ import { CancelAmendmentViewModel } from '../../../types/view-models/amendments/
 import { MOCK_BASIC_DEAL } from '../../../utils/mocks/mock-applications';
 import { MOCK_ISSUED_FACILITY } from '../../../utils/mocks/mock-facilities';
 import { PortalFacilityAmendmentWithUkefIdMockBuilder } from '../../../../test-helpers/mock-amendment';
-import { getCancelPortalFacilityAmendment, GetCancelPortalFacilityAmendmentRequest } from './cancel-portal-facility-amendment';
+import { getCancelPortalFacilityAmendment, GetCancelPortalFacilityAmendmentRequest } from './get-cancel-portal-facility-amendment';
 
 jest.mock('../../../services/api', () => ({
   getApplication: getApplicationMock,

gef-ui/server/controllers/amendments/cancel-amendment/post-cancel-portal-facility-amendment.test.ts

@@ -0,0 +1,85 @@
+/* eslint-disable import/first */
+const deleteAmendmentMock = jest.fn();
+
+import httpMocks from 'node-mocks-http';
+import * as dtfsCommon from '@ukef/dtfs2-common';
+import { aPortalSessionUser, PORTAL_LOGIN_STATUS } from '@ukef/dtfs2-common';
+import { postCancelPortalFacilityAmendment, PostCancelPortalFacilityAmendmentRequest } from './post-cancel-portal-facility-amendment';
+
+jest.mock('../../../services/api', () => ({
+  deleteAmendment: deleteAmendmentMock,
+}));
+
+const dealId = '6597dffeb5ef5ff4267e5044';
+const facilityId = '6597dffeb5ef5ff4267e5045';
+const amendmentId = '6597dffeb5ef5ff4267e5046';
+
+const aMockError = () => new Error();
+
+const mockUser = aPortalSessionUser();
+const userToken = 'userToken';
+
+const getHttpMocks = () =>
+  httpMocks.createMocks<PostCancelPortalFacilityAmendmentRequest>({
+    params: {
+      dealId,
+      facilityId,
+      amendmentId,
+    },
+    session: {
+      user: mockUser,
+      userToken,
+      loginStatus: PORTAL_LOGIN_STATUS.VALID_2FA,
+    },
+  });
+
+describe('postCancelPortalFacilityAmendment', () => {
+  beforeEach(() => {
+    jest.resetAllMocks();
+
+    jest.spyOn(dtfsCommon, 'isPortalFacilityAmendmentsFeatureFlagEnabled').mockReturnValue(true);
+    jest.spyOn(console, 'error');
+
+    deleteAmendmentMock.mockResolvedValue(undefined);
+  });
+
+  it('should call deleteAmendment with the correct facilityId, amendmentId, and userToken', async () => {
+    // Arrange
+    const { req, res } = getHttpMocks();
+
+    // Act
+    await postCancelPortalFacilityAmendment(req, res);
+
+    // Assert
+    expect(deleteAmendmentMock).toHaveBeenCalledTimes(1);
+    expect(deleteAmendmentMock).toHaveBeenCalledWith({ facilityId, amendmentId, userToken });
+  });
+
+  it('should redirect to details page after amendment has been deleted', async () => {
+    // Arrange
+    const { req, res } = getHttpMocks();
+
+    // Act
+    await postCancelPortalFacilityAmendment(req, res);
+
+    // Assert
+    expect(deleteAmendmentMock).toHaveBeenCalledTimes(1);
+    expect(res._getRedirectUrl()).toEqual(`/gef/application-details/${dealId}`);
+  });
+
+  it('should render `problem with service` if deleteAmendment throws an error', async () => {
+    // Arrange
+    const mockError = aMockError();
+    deleteAmendmentMock.mockRejectedValue(mockError);
+    const { req, res } = getHttpMocks();
+
+    // Act
+    await postCancelPortalFacilityAmendment(req, res);
+
+    // Assert
+    expect(deleteAmendmentMock).toHaveBeenCalledTimes(1);
+    expect(res._getRenderView()).toEqual('partials/problem-with-service.njk');
+    expect(console.error).toHaveBeenCalledTimes(1);
+    expect(console.error).toHaveBeenCalledWith('Error posting cancel amendments page %o', mockError);
+  });
+});

gef-ui/server/controllers/amendments/cancel-amendment/post-cancel-portal-facility-amendment.ts

@@ -0,0 +1,28 @@
+import { CustomExpressRequest } from '@ukef/dtfs2-common';
+import { Response } from 'express';
+import * as api from '../../../services/api';
+import { asLoggedInUserSession } from '../../../utils/express-session';
+
+export type PostCancelPortalFacilityAmendmentRequest = CustomExpressRequest<{
+  params: { dealId: string; facilityId: string; amendmentId: string };
+}>;
+
+/**
+ * controller to post the cancel amendment page
+ *
+ * @param req - The express request
+ * @param res - The express response
+ */
+export const postCancelPortalFacilityAmendment = async (req: PostCancelPortalFacilityAmendmentRequest, res: Response) => {
+  try {
+    const { dealId, facilityId, amendmentId } = req.params;
+    const { userToken } = asLoggedInUserSession(req.session);
+
+    await api.deleteAmendment({ facilityId, amendmentId, userToken });
+
+    return res.redirect(`/gef/application-details/${dealId}`);
+  } catch (error) {
+    console.error('Error posting cancel amendments page %o', error);
+    return res.render('partials/problem-with-service.njk');
+  }
+};

gef-ui/server/routes/facilities/amendments/index.ts

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/no-misused-promises */
 import express from 'express';
+import { validateMongoId } from '@ukef/dtfs2-common';
 import { validatePortalFacilityAmendmentsEnabled } from '../../../middleware/feature-flags/portal-facility-amendments';
 import { validateRole, validateToken, validateBank } from '../../../middleware';
 import { MAKER } from '../../../constants/roles';
@@ -11,7 +12,8 @@
 import { getCoverEndDate } from '../../../controllers/amendments/cover-end-date/get-cover-end-date';
 import { postCoverEndDate } from '../../../controllers/amendments/cover-end-date/post-cover-end-date';
 import { PORTAL_AMENDMENT_PAGES } from '../../../constants/amendments';
-import { getCancelPortalFacilityAmendment } from '../../../controllers/amendments/cancel-amendment/cancel-portal-facility-amendment';
+import { getCancelPortalFacilityAmendment } from '../../../controllers/amendments/cancel-amendment/get-cancel-portal-facility-amendment.ts';
+import { postCancelPortalFacilityAmendment } from '../../../controllers/amendments/cancel-amendment/post-cancel-portal-facility-amendment.ts';
 import { getDoYouHaveAFacilityEndDate } from '../../../controllers/amendments/do-you-have-a-facility-end-date/get-do-you-have-a-facility-end-date';
 import { postDoYouHaveAFacilityEndDate } from '../../../controllers/amendments/do-you-have-a-facility-end-date/post-do-you-have-a-facility-end-date';
 import { getFacilityEndDate } from '../../../controllers/amendments/facility-end-date/get-facility-end-date';
@@ -69,8 +71,17 @@
 
 router
   .route(`/application-details/:dealId/facilities/:facilityId/amendments/:amendmentId/${CANCEL}`)
-  .all([validatePortalFacilityAmendmentsEnabled, validateToken, validateBank, validateRole({ role: [MAKER] })])
-  .get(getCancelPortalFacilityAmendment);
+  .all([
+    validatePortalFacilityAmendmentsEnabled,
+    validateToken,
+    validateBank,
+    validateMongoId('dealId'),
+    validateMongoId('facilityId'),
+    validateMongoId('amendmentId'),
+    validateRole({ role: [MAKER] }),
+  ])
+  .get(getCancelPortalFacilityAmendment)
+  .post(postCancelPortalFacilityAmendment);
 
 router
   .route(`/application-details/:dealId/facilities/:facilityId/amendments/:amendmentId/${DO_YOU_HAVE_A_FACILITY_END_DATE}`)

libs/common/src/middleware/index.ts

@@ -1,3 +1,4 @@
 export * from './feature-flags';
 export * from './create-validation-middleware-for-schema';
 export * from './set-no-store-cache-control';
+export * from './validate-mongoId';

libs/common/src/middleware/validate-mongoId/index.ts

@@ -0,0 +1 @@
+export * from './validate-mongoId';