Merge pull request #588 from companieshouse/lp-1324-intro-pflp-designate-page

LP-1324 Post transition designate as private fund page

Author: mattch1

locales/cy/translations.json

@@ -656,6 +656,26 @@
         "title": "WELSH - What information we'll show on the public register"
     },
 
+    "redesignateToPflpPage": {
+       "title": "WELSH - Apply for designation as a private fund limited partnership (PFLP)",
+       "introduction1": "WELSH - A limited partnership can be designated as a PFLP if it is constituted by an agreement in writing and is a collective investment scheme.",
+       "introduction2": "WELSH - Once the designation has been made, the type of partnership cannot be changed again.",
+       "pflpMeaningsIntro": "WELSH - Becoming a PFLP means that:",
+       "pflpMeanings": {
+           "capital": "WELSH - imited partners will no longer be required to contribute capital",
+           "appoint": "WELSH - Limited partners can appoint a person to wind up the partnership if there is no general partner available to do so",
+           "agreement": "WELSH - Partners can make an agreement about winding up the partnership",
+           "risk": "WELSH - Limited partners may take more actions without risking losing their limited liability status",
+           "admin": "WELSH - Some administrative requirements will be removed",
+           "scheme": "WELSH - The partnership will no longer qualify as a ‘partnership scheme’, and therefore cannot be an authorised contractual scheme under section 235A(6)(aa) of the Financial Services and Markets Act 2000"
+        },
+        "information": "WELSH - For more information in the",
+        "informationLink": "WELSH - Legislative Reform (Private Fund Limited Partnerships) Order 2017",
+        "cost": "WELSH - It costs £XX to apply.",
+        "applicationCheck": "WELSH - I/We apply for this firm to be designated as a private fund limited partnership. For that purpose, I confirm that the partnership is constituted by an agreement in writing and is a collective investment scheme within the meaning of section 8D(4) of the Limited Partnerships Act 1907",
+        "confirmationCheck": "WELSH - I confirm that all general partners have agreed for this application to be made"
+    },
+
     "removePartnerPage": {
         "title": "WELSH - Are you sure you want to remove"
     },

locales/en/translations.json

@@ -657,6 +657,26 @@
         "title": "What information we'll show on the public register"
     },
 
+    "redesignateToPflpPage": {
+       "title": "Apply for designation as a private fund limited partnership (PFLP)",
+       "introduction1": "A limited partnership can be designated as a PFLP if it is constituted by an agreement in writing and is a collective investment scheme.",
+       "introduction2": "Once the designation has been made, the type of partnership cannot be changed again.",
+       "pflpMeaningsIntro": "Becoming a PFLP means that:",
+       "pflpMeanings": {
+           "capital": "Limited partners will no longer be required to contribute capital",
+           "appoint": "Limited partners can appoint a person to wind up the partnership if there is no general partner available to do so",
+           "agreement": "Partners can make an agreement about winding up the partnership",
+           "risk": "Limited partners may take more actions without risking losing their limited liability status",
+           "admin": "Some administrative requirements will be removed",
+           "scheme": "The partnership will no longer qualify as a ‘partnership scheme’, and therefore cannot be an authorised contractual scheme under section 235A(6)(aa) of the Financial Services and Markets Act 2000"
+        },
+        "information": "For more information in the",
+        "informationLink": "Legislative Reform (Private Fund Limited Partnerships) Order 2017",
+        "cost": "It costs £XX to apply.",
+        "applicationCheck": "I/We apply for this firm to be designated as a private fund limited partnership. For that purpose, I confirm that the partnership is constituted by an agreement in writing and is a collective investment scheme within the meaning of section 8D(4) of the Limited Partnerships Act 1907",
+        "confirmationCheck": "I confirm that all general partners have agreed for this application to be made"
+    },
+
     "removePartnerPage": {
         "title": "Are you sure you want to remove"
     },

package-lock.json

@@ -33,7 +33,7 @@
   "license": "MIT",
   "homepage": "https://github.com/companieshouse/limited-partnerships-web#readme",
   "dependencies": {
-    "@companieshouse/api-sdk-node": "^2.0.310",
+    "@companieshouse/api-sdk-node": "^2.0.315",
     "@companieshouse/ch-node-utils": "^2.1.8",
     "@companieshouse/node-session-handler": "^5.0.1",
     "@companieshouse/structured-logging-node": "^2.0.1",

package.json

@@ -424,6 +424,91 @@ class LimitedPartnershipController extends AbstractController {
     };
   }
 
+  postRedesignateToPFLP() {
+    return async (request: Request, response: Response, next: NextFunction) => {
+      try {
+        const { tokens, ids } = super.extract(request);
+        const pageType = super.extractPageTypeOrThrowError(request, PostTransitionPageType);
+        const pageRouting = super.getRouting(postTransitionRouting, pageType, request);
+        const { limitedPartnership } = await this.companyService.buildLimitedPartnershipFromCompanyProfile(
+          tokens,
+          ids.companyId
+        );
+
+        const errorData = this.makeErrorData(
+          limitedPartnership,
+          request.body
+        );
+
+        const resultTransaction = await this.createTransaction(limitedPartnership, tokens);
+        if (resultTransaction.errors) {
+          return response.render(
+            super.templateName(pageRouting.currentUrl),
+            super.makeProps(pageRouting, errorData, resultTransaction.errors)
+          );
+        }
+
+        const resultLimitedPartnershipCreate = await this.createPartnership(
+          request,
+          limitedPartnership,
+          resultTransaction.transactionId,
+          PartnershipKind.UPDATE_PARTNERSHIP_REDESIGNATE_TO_PFLP,
+          {
+            ...request.body,
+            date_of_update: new Date().toISOString().split('T')[0]
+          }
+        );
+        if (resultLimitedPartnershipCreate.errors) {
+          return response.render(
+            super.templateName(pageRouting.currentUrl),
+            super.makeProps(pageRouting, errorData, resultLimitedPartnershipCreate.errors)
+          );
+        }
+
+        const newIds = {
+          ...ids,
+          transactionId: resultTransaction.transactionId,
+          submissionId: resultLimitedPartnershipCreate.submissionId
+        };
+
+        let redirectUrl = super
+          .insertIdsInUrl(CONFIRMATION_POST_TRANSITION_URL, newIds, request.url)
+          .replace(JOURNEY_TYPE_PARAM, getJourneyTypes(request.url).journey);
+
+        const closeTransactionResponse = await this.limitedPartnershipService.closeTransaction(
+          tokens,
+          newIds.transactionId
+        );
+
+        const startPaymentSessionUrl: string = closeTransactionResponse.headers?.["x-payment-required"];
+        if (!startPaymentSessionUrl) {
+          throw new Error("No payment URL found in response header from closeTransaction");
+        }
+
+        const urlWithJourney = `${CHS_URL}${PAYMENT_RESPONSE_URL}`.replace(
+          JOURNEY_TYPE_PARAM,
+          getJourneyTypes(request.url).journey
+        );
+
+        const paymentReturnUri = super.insertIdsInUrl(urlWithJourney, newIds, request.url);
+
+        redirectUrl = await this.paymentService.startPaymentSession(
+          tokens,
+          startPaymentSessionUrl,
+          paymentReturnUri,
+          newIds.transactionId
+        );
+
+        if (!redirectUrl) {
+          throw new Error("No payment redirect URL returned from start payment session");
+        }
+        response.redirect(redirectUrl);
+      } catch (error) {
+        next(error);
+      }
+    };
+  }
+
   private validateAddress(
     request: Request,
     response: Response,

src/presentation/controller/postTransition/LimitedPartnershipController.ts

@@ -147,6 +147,13 @@ const postTransitionRoutingPrincipalPlaceOfBusinessAddressChangeCheckYourAnswers
   }
 };
 
+const postTransitionRoutingRedesignateToPFLP = {
+  previousUrl: url.LANDING_PAGE_URL,
+  currentUrl: url.REDESIGNATE_TO_PFLP_URL,
+  nextUrl: "/",
+  pageType: PostTransitionPageType.redesignateToPflp
+};
+
 const limitedPartnershipRouting = [
   postTransitionRoutingCompanyNumber,
   postTransitionRoutingConfirmLimitedPartnership,
@@ -166,7 +173,8 @@ const limitedPartnershipRouting = [
 
   postTransitionRoutingPrincipalPlaceOfBusinessAddress,
   postTransitionRoutingPrincipalPlaceOfBusinessAddressChange,
-  postTransitionRoutingPrincipalPlaceOfBusinessAddressChangeCheckYourAnswers
+  postTransitionRoutingPrincipalPlaceOfBusinessAddressChangeCheckYourAnswers,
+  postTransitionRoutingRedesignateToPFLP
 ];
 
 export default limitedPartnershipRouting;

src/presentation/controller/postTransition/routing/limitedPartnership.ts

@@ -44,6 +44,7 @@ export const TERM_URL = `${POST_TRANSITION_WITH_ID_URL}/${template.TERM_TEMPLATE
 export const TERM_WITH_IDS_URL = `${POST_TRANSITION_WITH_IDS_AND_SUBMISSION_URL}/${template.TERM_TEMPLATE}`;
 export const WHEN_DID_THE_TERM_CHANGE_URL = `${POST_TRANSITION_WITH_IDS_AND_SUBMISSION_URL}/${template.WHEN_DID_TERM_CHANGE_TEMPLATE}`;
 export const TERM_CHANGE_CHECK_YOUR_ANSWERS_URL = `${POST_TRANSITION_WITH_IDS_AND_SUBMISSION_URL}/${template.TERM_CHANGE_CHECK_YOUR_ANSWERS_TEMPLATE}`;
+export const REDESIGNATE_TO_PFLP_URL = `${POST_TRANSITION_WITH_ID_URL}/${template.REDESIGNATE_TO_PFLP_TEMPLATE}`;
 
 export const ENTER_PRINCIPAL_PLACE_OF_BUSINESS_ADDRESS_URL = `${POST_TRANSITION_WITH_ID_URL}/${template.ENTER_PRINCIPAL_PLACE_OF_BUSINESS_ADDRESS_TEMPLATE}`;
 export const ENTER_PRINCIPAL_PLACE_OF_BUSINESS_ADDRESS_WITH_IDS_URL = `${POST_TRANSITION_WITH_IDS_AND_SUBMISSION_URL}/${template.ENTER_PRINCIPAL_PLACE_OF_BUSINESS_ADDRESS_TEMPLATE}`;
@@ -64,5 +65,3 @@ export const REMOVE_LIMITED_PARTNER_PERSON_CHECK_YOUR_ANSWERS_URL = `${POST_TRAN
 export const WHEN_DID_THE_LIMITED_PARTNER_LEGAL_ENTITY_CEASE_URL = `${POST_TRANSITION_WITH_ID_URL}${APPOINTMENT_ID_URL}/${template.WHEN_DID_THE_LIMITED_PARTNER_LEGAL_ENTITY_CEASE_TEMPLATE}`;
 export const WHEN_DID_THE_LIMITED_PARTNER_LEGAL_ENTITY_CEASE_WITH_IDS_URL = `${POST_TRANSITION_WITH_IDS_URL}${LIMITED_PARTNER_WITH_ID_URL}/${template.WHEN_DID_THE_LIMITED_PARTNER_LEGAL_ENTITY_CEASE_TEMPLATE}`;
 export const REMOVE_LIMITED_PARTNER_LEGAL_ENTITY_CHECK_YOUR_ANSWERS_URL = `${POST_TRANSITION_WITH_IDS_URL}${LIMITED_PARTNER_WITH_ID_URL}/${template.REMOVE_LIMITED_PARTNER_LEGAL_ENTITY_CHECK_YOUR_ANSWERS_TEMPLATE}`;
-
-export const REDESIGNATE_TO_PFLP_URL = `${POST_TRANSITION_WITH_IDS_URL}${LIMITED_PARTNER_WITH_ID_URL}/${template.REDESIGNATE_TO_PFLP_TEMPLATE}`;

src/presentation/controller/postTransition/url.ts

@@ -0,0 +1,100 @@
+import request from "supertest";
+
+import enTranslationText from "../../../../../../locales/en/translations.json";
+import cyTranslationText from "../../../../../../locales/cy/translations.json";
+
+import app from "../../app";
+import { appDevDependencies } from "../../../../../config/dev-dependencies";
+import { getUrl, setLocalesEnabled, testTranslations } from "../../../utils";
+import { REDESIGNATE_TO_PFLP_URL } from "presentation/controller/postTransition/url";
+import CompanyProfileBuilder from "../../../builder/CompanyProfileBuilder";
+import PostTransitionPageType from "presentation/controller/postTransition/pageType";
+import { PartnershipType } from "@companieshouse/api-sdk-node/dist/services/limited-partnerships";
+import { TRANSACTION_DESCRIPTION_UPDATE_LIMITED_PARTNERSHIP } from "config";
+import LimitedPartnershipBuilder from "presentation/test/builder/LimitedPartnershipBuilder";
+import { ApiErrors } from "domain/entities/UIErrors";
+
+describe("Redesignate to pflp page", () => {
+  const URL = getUrl(REDESIGNATE_TO_PFLP_URL);
+  const PAYMENT_LINK_JOURNEY = "https://api-test-payments.chs.local:4001";
+  let companyProfile;
+
+  beforeEach(() => {
+    setLocalesEnabled(true);
+    companyProfile = new CompanyProfileBuilder().build();
+    appDevDependencies.companyGateway.feedCompanyProfile(companyProfile.data);
+    appDevDependencies.limitedPartnershipGateway.feedLimitedPartnerships([]);
+    appDevDependencies.limitedPartnershipGateway.feedErrors();
+    appDevDependencies.limitedPartnershipGateway.setError(false);
+  });
+
+  describe("GET page", () => {
+    it("should load the page with English text", async () => {
+      const res = await request(app).get(URL + "?lang=en");
+
+      expect(res.status).toBe(200);
+      testTranslations(res.text, enTranslationText.redesignateToPflpPage);
+      expect(res.text).toContain(
+        `${enTranslationText.redesignateToPflpPage.title} - ${enTranslationText.servicePostTransition} - GOV.UK`
+      );
+      expect(res.text).not.toContain("WELSH -");
+    });
+
+    it("should load the page with Welsh text", async () => {
+      const res = await request(app).get(URL + "?lang=cy");
+
+      expect(res.status).toBe(200);
+      expect(res.text).toContain(
+        `${cyTranslationText.redesignateToPflpPage.title} - ${cyTranslationText.servicePostTransition} - GOV.UK`
+      );
+      testTranslations(res.text, cyTranslationText.redesignateToPflpPage);
+    });
+  });
+
+  describe("POST page", () => {
+    it("should create a transaction, send data and navigate to payment", async () => {
+      const res = await request(app).post(URL).send({
+        pageType: PostTransitionPageType.redesignateToPflp,
+        redesignate_to_pflp_apply: true,
+        redesignate_to_pflp_confirm: true,
+        partnership_type: PartnershipType.LP
+      });
+
+      expect(res.status).toBe(302);
+      expect(res.text).toContain(`Redirecting to ${PAYMENT_LINK_JOURNEY}`);
+      expect(appDevDependencies.limitedPartnershipGateway.limitedPartnerships.length).toEqual(1);
+      expect(appDevDependencies.transactionGateway.transactions[0].description).toEqual(TRANSACTION_DESCRIPTION_UPDATE_LIMITED_PARTNERSHIP);
+    });
+
+    it("should return a validation error if api validation error occurs creating LimitedPartnership", async () => {
+      const limitedPartnership = new LimitedPartnershipBuilder().build();
+      appDevDependencies.limitedPartnershipGateway.feedLimitedPartnerships([limitedPartnership]);
+      const apiErrors: ApiErrors = {
+        errors: { something: "Something is invalid" }
+      };
+      appDevDependencies.limitedPartnershipGateway.feedErrors(apiErrors);
+
+      const res = await request(app)
+        .post(URL)
+        .send({
+          pageType: PostTransitionPageType.enterPrincipalPlaceOfBusinessAddress,
+          ...limitedPartnership.data?.principal_place_of_business_address
+        });
+
+      expect(res.status).toBe(200);
+      expect(res.text).toContain(enTranslationText.govUk.error.title);
+      expect(res.text).toContain(companyProfile.data.companyName.toUpperCase());
+      expect(res.text).toContain("Something is invalid");
+    });
+
+    it("should throw error when payment redirect url is missing", async () => {
+      appDevDependencies.paymentGateway.feedPaymentWithEmptyJourney();
+      const res = await request(app).post(URL).send({
+        pageType: PostTransitionPageType.redesignateToPflp
+      });
+
+      expect(res.status).toBe(500);
+      expect(res.text).not.toContain(`Redirecting to ${PAYMENT_LINK_JOURNEY}`);
+    });
+  });
+});

src/presentation/test/integration/postTransition/limitedPartnership/redesignate-to-pflp.test.ts

@@ -48,7 +48,8 @@ import {
   REMOVE_LIMITED_PARTNER_PERSON_CHECK_YOUR_ANSWERS_URL,
   WHEN_DID_THE_LIMITED_PARTNER_LEGAL_ENTITY_CEASE_WITH_IDS_URL,
   WHEN_DID_THE_LIMITED_PARTNER_LEGAL_ENTITY_CEASE_URL,
-  REMOVE_LIMITED_PARTNER_LEGAL_ENTITY_CHECK_YOUR_ANSWERS_URL
+  REMOVE_LIMITED_PARTNER_LEGAL_ENTITY_CHECK_YOUR_ANSWERS_URL,
+  REDESIGNATE_TO_PFLP_URL
 } from "../presentation/controller/postTransition/url";
 import {
   TRANSACTION_DESCRIPTION_ADD_GENERAL_PARTNER_LEGAL_ENTITY,
@@ -427,6 +428,17 @@ const postTransitionEndpoints = (router: Router, dependencies: IDependencies): v
     dependencies.limitedPartnershipPostTransitionController.postCheckYourAnswers()
   );
 
+  router.get(
+    REDESIGNATE_TO_PFLP_URL,
+    companyAuthentication,
+    dependencies.limitedPartnershipPostTransitionController.getPageRouting()
+  );
+  router.post(
+    REDESIGNATE_TO_PFLP_URL,
+    companyAuthentication,
+    dependencies.limitedPartnershipPostTransitionController.postRedesignateToPFLP()
+  );
+
   // Remove General Partner
   router.get(
     WHEN_DID_THE_GENERAL_PARTNER_PERSON_CEASE_URL,