[NFDIV-4314] Use payment service requests created by case-api (Part 1) (

#3911) * Pass payment callback URL to backend * Remove unused import * Update tests * Formatting changes * Adjust backend PR reference * Remove references to backend PR
hmcts · Oct 4, 2024 · 2f75d71 · 2f75d71
1 parent d91e5e8
commit 2f75d71
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 18 deletions.
diff --git a/src/main/app/case/case.ts b/src/main/app/case/case.ts
@@ -169,6 +169,7 @@ export const formFieldsToCaseMapping: Partial<Record<keyof Case, keyof CaseData>
   applicant1CanIntendToSwitchToSoleFo: 'applicant1CanIntendToSwitchToSoleFo',
   applicant2CanIntendToSwitchToSoleFo: 'applicant2CanIntendToSwitchToSoleFo',
   isFinalOrderOverdue: 'isFinalOrderOverdue',
+  citizenPaymentCallbackUrl: 'citizenPaymentCallbackUrl',
 };
 
 export function formatCase<OutputFormat>(fields: FieldFormats, data: Partial<Case> | CaseData): OutputFormat {
@@ -397,6 +398,7 @@ export interface Case {
   applicant1CanIntendToSwitchToSoleFo: YesOrNo;
   applicant2CanIntendToSwitchToSoleFo: YesOrNo;
   isFinalOrderOverdue: YesOrNo;
+  citizenPaymentCallbackUrl: string;
 }
 
 export interface CaseWithId extends Case {

diff --git a/src/main/app/case/definition.ts b/src/main/app/case/definition.ts
@@ -1006,6 +1006,7 @@ export interface CaseData {
   evidenceHandled: YesOrNo;
   generalLetters: ListValue<GeneralLetterDetails>[];
   sentNotifications: SentNotifications;
+  citizenPaymentCallbackUrl: string;
 }
 
 export interface CaseDocuments {

diff --git a/src/main/app/controller/BasePaymentCallbackGetController.ts b/src/main/app/controller/BasePaymentCallbackGetController.ts
@@ -1,6 +1,5 @@
 import { Logger } from '@hmcts/nodejs-logging';
 import autobind from 'autobind-decorator';
-import config from 'config';
 import { Response } from 'express';
 
 import { CaseData, State } from '../case/definition';
@@ -18,11 +17,8 @@ export default abstract class BasePaymentCallbackGetController {
     if (req.session.userCase.state !== this.awaitingPaymentState()) {
       return res.redirect(this.noPaymentRequiredUrl(req));
     }
-    const protocol = req.app.locals.developmentMode ? 'http://' : 'https://';
-    const port = req.app.locals.developmentMode ? `:${config.get('port')}` : '';
-    const returnUrl = `${protocol}${res.locals.host}${port}${getPaymentCallbackUrl(req)}`;
 
-    const paymentClient = new PaymentClient(req.session, returnUrl);
+    const paymentClient = new PaymentClient(req.session, getPaymentCallbackUrl(req, res));
 
     const payments = new PaymentModel(req.session.userCase[this.paymentsCaseField()] || []);
     if (!payments.hasPayment) {

diff --git a/src/main/app/controller/BasePaymentPostController.ts b/src/main/app/controller/BasePaymentPostController.ts
@@ -30,18 +30,18 @@ export default abstract class BasePaymentPostController {
     if (req.session.userCase.state !== this.awaitingPaymentState()) {
       req.session.userCase = await req.locals.api.triggerEvent(
         req.session.userCase.id,
-        {},
+        { citizenPaymentCallbackUrl: getPaymentCallbackUrl(req, res) },
         this.awaitingPaymentEvent()
       );
     }
 
     const payments = new PaymentModel(req.session.userCase[this.paymentsCaseField()] || []);
 
     if (payments.isPaymentInProgress()) {
-      return this.saveAndRedirect(req, res, getPaymentCallbackUrl(req));
+      return this.saveAndRedirect(req, res, getPaymentCallbackPath(req));
     }
 
-    const paymentClient = this.getPaymentClient(req, res);
+    const paymentClient = this.getPaymentClient(req, getPaymentCallbackUrl(req, res));
     const payment = await this.createServiceRefAndTakePayment(req, paymentClient, payments);
 
     this.saveAndRedirect(req, res, payment.next_url);
@@ -57,12 +57,8 @@ export default abstract class BasePaymentPostController {
     });
   }
 
-  private getPaymentClient(req: AppRequest, res: Response) {
-    const protocol = req.app.locals.developmentMode ? 'http://' : 'https://';
-    const port = req.app.locals.developmentMode ? `:${config.get('port')}` : '';
-    const returnUrl = `${protocol}${res.locals.host}${port}${getPaymentCallbackUrl(req)}`;
-
-    return new PaymentClient(req.session, returnUrl);
+  private getPaymentClient(req: AppRequest, callbackUrl: string) {
+    return new PaymentClient(req.session, callbackUrl);
   }
 
   private async createServiceRefAndTakePayment(
@@ -115,7 +111,13 @@ export default abstract class BasePaymentPostController {
   protected abstract getResponsiblePartyName(req: AppRequest<AnyObject>): string | undefined;
 }
 
-export function getPaymentCallbackUrl(req: AppRequest): string {
+export function getPaymentCallbackUrl(req: AppRequest, res: Response): string {
+  const protocol = req.app.locals.developmentMode ? 'http://' : 'https://';
+  const port = req.app.locals.developmentMode ? `:${config.get('port')}` : '';
+  return `${protocol}${res.locals.host}${port}${getPaymentCallbackPath(req)}`;
+}
+
+export function getPaymentCallbackPath(req: AppRequest): string {
   const isRespondent: boolean =
     req.session.isApplicant2 && req.session.userCase.applicationType === ApplicationType.SOLE_APPLICATION;
 

diff --git a/src/main/app/controller/PostController.ts b/src/main/app/controller/PostController.ts
@@ -4,10 +4,11 @@ import { Response } from 'express';
 import { getNextStepUrl } from '../../steps';
 import { SAVE_AND_SIGN_OUT } from '../../steps/urls';
 import { Case, CaseWithId } from '../case/case';
-import { CITIZEN_APPLICANT2_UPDATE, CITIZEN_SAVE_AND_CLOSE, CITIZEN_UPDATE } from '../case/definition';
+import { CITIZEN_APPLICANT2_UPDATE, CITIZEN_SAVE_AND_CLOSE, CITIZEN_SUBMIT, CITIZEN_UPDATE } from '../case/definition';
 import { Form, FormFields, FormFieldsFn } from '../form/Form';
 
 import { AppRequest } from './AppRequest';
+import { getPaymentCallbackUrl } from './BasePaymentPostController';
 
 @autobind
 export class PostController<T extends AnyObject> {
@@ -75,6 +76,8 @@ export class PostController<T extends AnyObject> {
 
     if (req.session.errors.length === 0) {
       try {
+        this.setPaymentCallbackUrlIfPaymentRequired(req, res, formData);
+
         req.session.userCase = await this.save(req, formData, this.getEventName(req));
       } catch (err) {
         req.locals.logger.error('Error saving', err);
@@ -96,6 +99,12 @@ export class PostController<T extends AnyObject> {
       return CITIZEN_UPDATE;
     }
   }
+
+  private setPaymentCallbackUrlIfPaymentRequired(req: AppRequest<T>, res: Response, formData: Partial<Case>) {
+    if (this.getEventName(req) === CITIZEN_SUBMIT) {
+      formData.citizenPaymentCallbackUrl = getPaymentCallbackUrl(req, res);
+    }
+  }
 }
 
 export type AnyObject = Record<string, unknown>;
diff --git a/src/main/steps/applicant1/check-your-answers/post.test.ts b/src/main/steps/applicant1/check-your-answers/post.test.ts
@@ -31,6 +31,7 @@ describe('CheckYourAnswersPostController', () => {
       applicationType: ApplicationType.SOLE_APPLICATION,
       applicant1IConfirmPrayer: Checkbox.Checked,
       applicant1StatementOfTruth: Checkbox.Checked,
+      citizenPaymentCallbackUrl: 'https://undefined/payment-callback',
     };
     const checkYourAnswerPostController = new CheckYourAnswersPostController(mockFormContent.fields);
 
@@ -112,6 +113,7 @@ describe('CheckYourAnswersPostController', () => {
       state: State.Draft,
       applicant1IConfirmPrayer: Checkbox.Checked,
       applicant1StatementOfTruth: Checkbox.Checked,
+      citizenPaymentCallbackUrl: 'https://undefined/payment-callback',
     };
     const checkYourAnswerPostController = new CheckYourAnswersPostController(mockFormContent.fields);
 

diff --git a/src/main/steps/applicant1/confirm-your-joint-application/post.test.ts b/src/main/steps/applicant1/confirm-your-joint-application/post.test.ts
@@ -12,6 +12,7 @@ describe('Applicant1ConfirmYourJointApplicationPostController', () => {
     const body = {
       applicant1IConfirmPrayer: Checkbox.Checked,
       applicant1StatementOfTruth: Checkbox.Checked,
+      citizenPaymentCallbackUrl: 'https://undefined/payment-callback',
     };
     const mockFormContent = {
       fields: {
@@ -38,6 +39,7 @@ describe('Applicant1ConfirmYourJointApplicationPostController', () => {
     const body = {
       applicant1IConfirmPrayer: Checkbox.Checked,
       applicant1StatementOfTruth: Checkbox.Checked,
+      citizenPaymentCallbackUrl: 'https://undefined/payment-callback',
     };
     const mockFormContent = {
       fields: {

diff --git a/src/main/steps/applicant1/pay-your-fee/post.test.ts b/src/main/steps/applicant1/pay-your-fee/post.test.ts
@@ -82,7 +82,11 @@ describe('PaymentPostController', () => {
 
       await paymentController.post(req, res);
 
-      expect(req.locals.api.triggerEvent).toHaveBeenCalledWith('1234', {}, CITIZEN_SUBMIT);
+      expect(req.locals.api.triggerEvent).toHaveBeenCalledWith(
+        '1234',
+        { citizenPaymentCallbackUrl: 'https://undefined/payment-callback' },
+        CITIZEN_SUBMIT
+      );
     });
 
     it('redirects to the check your answers page if last payment is in progress', async () => {

diff --git a/src/main/steps/respondent/pay-your-final-order-fee/post.test.ts b/src/main/steps/respondent/pay-your-final-order-fee/post.test.ts
@@ -82,7 +82,11 @@ describe('PaymentPostController', () => {
 
       await paymentController.post(req, res);
 
-      expect(req.locals.api.triggerEvent).toHaveBeenCalledWith('1234', {}, RESPONDENT_APPLY_FOR_FINAL_ORDER);
+      expect(req.locals.api.triggerEvent).toHaveBeenCalledWith(
+        '1234',
+        { citizenPaymentCallbackUrl: 'https://undefined/payment-callback' },
+        RESPONDENT_APPLY_FOR_FINAL_ORDER
+      );
     });
 
     it('redirects to hub page if last payment is in progress', async () => {