Merge pull request #1726 from companieshouse/feature/ROECCT-631-create-paper-form-filing-page

ROECCT-631 Create paper form filing page

Author: amalviyach

src/config/index.ts

@@ -98,6 +98,7 @@ export const RELEVANT_PERIOD_REQUIRED_INFORMATION_CONFIRM_PAGE = "relevant-perio
 export const RELEVANT_PERIOD_SUBMIT_BY_PAPER_PAGE = "relevant-period-submit-by-paper";
 export const RELEVANT_PERIOD_COMBINED_STATEMENTS_PAGE = "provide-statements-for-the-pre-registration-period";
 export const RELEVANT_PERIOD_REVIEW_STATEMENTS_PAGE = "review-statements-for-the-pre-registration-period";
+export const RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_PAGE = "relevant-period-submit-year-by-paper";
 export const TRUST_DETAILS_PAGE = "trust-details";
 export const TRUST_INVOLVED_PAGE = "trust-involved";
 export const TRUST_HISTORICAL_BENEFICIAL_OWNER_PAGE = "trust-historical-beneficial-owner";
@@ -319,6 +320,7 @@ export const RELEVANT_PERIOD_SUBMIT_BY_PAPER_URL = UPDATE_AN_OVERSEAS_ENTITY_URL
 export const RELEVANT_PERIOD_INTERRUPT_URL = UPDATE_AN_OVERSEAS_ENTITY_URL + RELEVANT_PERIOD_INTERRUPT_PAGE;
 export const RELEVANT_PERIOD_COMBINED_STATEMENTS_PAGE_URL = UPDATE_AN_OVERSEAS_ENTITY_URL + RELEVANT_PERIOD_COMBINED_STATEMENTS_PAGE;
 export const RELEVANT_PERIOD_REVIEW_STATEMENTS_URL = UPDATE_AN_OVERSEAS_ENTITY_URL + RELEVANT_PERIOD_REVIEW_STATEMENTS_PAGE;
+export const RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_URL = UPDATE_AN_OVERSEAS_ENTITY_URL + RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_PAGE;
 
 // REMOVE overseas entity routes
 export const REMOVE_SECTION = "remove/";

src/controllers/index.ts

@@ -102,6 +102,7 @@ export * as relevantPeriodRequiredInformation from './update/relevant.period.req
 export * as relevantPeriodSubmitByPaper from './update/relevant.period.submit.by.paper.controller';
 export * as relevantPeriodCombinedStatements from './update/relevant.period.combined.statements.controller';
 export * as relevantPeriodReviewStatements from './update/relevant.period.review.statments.controller';
+export * as relevantPeriodSubmitYearByPaper from './update/relevant.period.submit.year.by.paper.controller';
 
 // REMOVE controllers
 export * as removeSoldAllLandFilter from './update/remove.sold.all.land.filter.controller';

src/controllers/update/relevant.period.submit.year.by.paper.controller.ts

@@ -0,0 +1,22 @@
+import { NextFunction, Request, Response } from "express";
+
+import { logger } from "../../utils/logger";
+import * as config from "../../config";
+import { ApplicationData } from "../../model";
+import { getApplicationData } from "../../utils/application.data";
+
+export const get = async (req: Request, res: Response, next: NextFunction) => {
+  try {
+    logger.debugRequest(req, `GET ${config.RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_PAGE}`);
+    const appData: ApplicationData = await getApplicationData(req.session);
+
+    return res.render(config.RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_PAGE, {
+      backLinkUrl: '',
+      templateName: config.RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_PAGE,
+      ...appData,
+    });
+  } catch (error) {
+    logger.errorRequest(req, error);
+    next(error);
+  }
+};

src/routes/index.ts

@@ -107,6 +107,7 @@ import {
   relevantPeriodSubmitByPaper,
   relevantPeriodCombinedStatements,
   relevantPeriodReviewStatements,
+  relevantPeriodSubmitYearByPaper
 } from "../controllers";
 
 import { serviceAvailabilityMiddleware } from "../middleware/service.availability.middleware";
@@ -604,6 +605,14 @@ router.route(config.RELEVANT_PERIOD_SUBMIT_BY_PAPER_URL)
     navigation.hasOverseasEntity)
   .get(relevantPeriodSubmitByPaper.get);
 
+router.route(config.RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_URL)
+  .all(
+    isFeatureEnabled(config.FEATURE_FLAG_ENABLE_RELEVANT_PERIOD),
+    authentication,
+    companyAuthentication,
+    navigation.hasOverseasEntity)
+  .get(relevantPeriodSubmitYearByPaper.get);
+
 router.route(config.RELEVANT_PERIOD_COMBINED_STATEMENTS_PAGE_URL)
   .all(
     isFeatureEnabled(config.FEATURE_FLAG_ENABLE_RELEVANT_PERIOD),

src/utils/navigation.ts

@@ -126,6 +126,11 @@ export const NAVIGATION: Navigation = {
     previousPage: () => config.RELEVANT_PERIOD_REQUIRED_INFORMATION_CONFIRM_URL,
     nextPage: []
   },
+  [config.RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_URL]: {
+    currentPage: config.RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_PAGE,
+    previousPage: () => "",
+    nextPage: []
+  },
   [config.RELEVANT_PERIOD_INTERRUPT_URL]: {
     currentPage: config.RELEVANT_PERIOD_INTERRUPT_PAGE,
     previousPage: () => "",

test/__mocks__/text.mock.ts

@@ -307,6 +307,7 @@ export const RELEVANT_SECURE_REGISTER_CHANGE_LINK = "/update-an-overseas-entity/
 export const RELEVANT_SECURE_FILTER_PAGE_HEADING = "Do any beneficial owners or managing officers have personal information protected at Companies House?";
 export const RELEVANT_PERIOD_OWNED_LAND_CHANGE_LINK = "/update-an-overseas-entity/registered-owner-during-pre-registration-period";
 export const IMPORTANT_BANNER_TEXT = "You need to provide some information about the overseas entity from the pre-registration period.";
+export const RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_TITLE = "You'll need to file this year's update statement using the paper form";
 
 // Remove journey
 export const REMOVE_SOLD_ALL_LAND_FILTER_PAGE_TITLE = "Has the overseas entity disposed of all relevant property or land in the UK?";

test/controllers/update/relevant.period.submit.year.by.paper.controller.spec.ts

@@ -0,0 +1,58 @@
+jest.mock("ioredis");
+jest.mock("../../../src/utils/logger");
+jest.mock('../../../src/middleware/authentication.middleware');
+jest.mock('../../../src/middleware/company.authentication.middleware');
+jest.mock('../../../src/utils/application.data');
+jest.mock('../../../src/middleware/navigation/update/has.presenter.middleware');
+jest.mock('../../../src/middleware/service.availability.middleware');
+jest.mock('../../../src/utils/feature.flag');
+
+import mockCsrfProtectionMiddleware from "../../__mocks__/csrfProtectionMiddleware.mock";
+import { NextFunction, Request, Response } from "express";
+import { beforeEach, expect, jest, test, describe } from "@jest/globals";
+import request from "supertest";
+
+import * as config from "../../../src/config";
+import app from "../../../src/app";
+import { RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_TITLE } from "../../__mocks__/text.mock";
+import { APPLICATION_DATA_MOCK } from "../../__mocks__/session.mock";
+import { getApplicationData } from "../../../src/utils/application.data";
+import { authentication } from "../../../src/middleware/authentication.middleware";
+import { companyAuthentication } from "../../../src/middleware/company.authentication.middleware";
+import { hasUpdatePresenter } from "../../../src/middleware/navigation/update/has.presenter.middleware";
+import { serviceAvailabilityMiddleware } from "../../../src/middleware/service.availability.middleware";
+import { isActiveFeature } from "../../../src/utils/feature.flag";
+
+mockCsrfProtectionMiddleware.mockClear();
+const mockHasUpdatePresenter = hasUpdatePresenter as jest.Mock;
+mockHasUpdatePresenter.mockImplementation((req: Request, res: Response, next: NextFunction) => next());
+
+const mockAuthenticationMiddleware = authentication as jest.Mock;
+mockAuthenticationMiddleware.mockImplementation((req: Request, res: Response, next: NextFunction) => next() );
+
+const mockCompanyAuthenticationMiddleware = companyAuthentication as jest.Mock;
+mockCompanyAuthenticationMiddleware.mockImplementation((req: Request, res: Response, next: NextFunction) => next());
+
+const mockServiceAvailabilityMiddleware = serviceAvailabilityMiddleware as jest.Mock;
+mockServiceAvailabilityMiddleware.mockImplementation((req: Request, res: Response, next: NextFunction) => next());
+
+const mockGetApplicationData = getApplicationData as jest.Mock;
+
+const mockIsActiveFeature = isActiveFeature as jest.Mock;
+mockIsActiveFeature.mockReturnValue(true);
+
+describe("Relevant period submit year by paper controller", () => {
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  describe("GET tests", () => {
+    test(`renders the ${config.RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_PAGE} page`, async () => {
+      mockGetApplicationData.mockReturnValue({ ...APPLICATION_DATA_MOCK });
+      const resp = await request(app).get(config.RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_URL);
+
+      expect(resp.status).toEqual(200);
+      expect(resp.text).toContain(RELEVANT_PERIOD_SUBMIT_YEAR_BY_PAPER_TITLE);
+    });
+  });
+});

views/update/relevant-period-submit-year-by-paper.html

@@ -0,0 +1,16 @@
+{% extends "submit-by-paper-template.html" %}
+
+{% set title = "You'll need to file this year's update statement using the paper form" %}
+
+{% block content %}
+
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      <h1 class="govuk-heading-xl">You'll need to file this year's update statement using the paper form</h1>
+      <p class="govuk-body">You've told us that you want to provide this overseas entity's pre-registration information as part of its next update statment.</p>
+      <p class="govuk-body">This means you need to file this year's update statement on paper.</p>
+      <p class="govuk-body">Contact us at <a href="mailto: [email protected]" class="govuk-link">[email protected]</a> if you need us to send you a paper form. </p>
+    </div>
+  </div>
+
+{% endblock %}

views/update/submit-by-paper-template.html

@@ -1,6 +1,8 @@
 {% extends "update-layout.html" %}
 
-{% set title = "You'll need to file an update statement using the paper form" %}
+{% if not title %}
+  {% set title = "You'll need to file an update statement using the paper form" %}
+{% endif %}
 
 {% block pageTitle %}
   {% include "includes/update-page-title.html" %}