lp-1013 - capital contribution validation

- move to application layer
- add translation

Author: lduranteau

locales/cy/errors.json

@@ -1,6 +1,7 @@
 {
     "errorMessages": {
         "capitalContribution": {
+            "valueRequired": "WELSH - Contribution currency type is required",
             "twoDecimalPlaces": "WELSH - Value must be a number with 2 decimal places",
             "moreThanZero": "WELSH - Value must be 0.01 or more",
             "noSymbols": "WELSH - Value must not include currency symbols like £, $ and €",

locales/en/errors.json

@@ -1,6 +1,7 @@
 {
     "errorMessages": {
         "capitalContribution": {
+            "valueRequired": "Contribution currency type is required",
             "twoDecimalPlaces": "Value must be a number with 2 decimal places",
             "moreThanZero": "Value must be 0.01 or more",
             "noSymbols": "Value must not include currency symbols like £, $ and €",

src/application/service/LimitedPartnerService.ts

@@ -4,6 +4,7 @@ import { logger } from "../../utils";
 import UIErrors from "../../domain/entities/UIErrors";
 import { extractAPIErrors, incompletePartnerErrorList } from "./utils";
 import { Tokens } from "../../domain/types";
+import { capitalContributionValidation } from "./utils/capitalContributionValidation";
 
 class LimitedPartnerService {
   i18n: any;
@@ -23,6 +24,10 @@ class LimitedPartnerService {
     errors?: UIErrors;
   }> {
     try {
+      if (data.contribution_currency_type || data.contribution_currency_value || data.contribution_sub_types) {
+        capitalContributionValidation(data, this.i18n);
+      }
+
       const limitedPartnerId = await this.limitedPartnerGateway.createLimitedPartner(opt, transactionId, data);
 
       return { limitedPartnerId };
@@ -88,6 +93,10 @@ class LimitedPartnerService {
     errors?: UIErrors;
   }> {
     try {
+      if (data.contribution_currency_type || data.contribution_currency_value || data.contribution_sub_types) {
+        capitalContributionValidation(data, this.i18n);
+      }
+
       await this.limitedPartnerGateway.sendPageData(opt, transactionId, limitedPartnerId, data);
     } catch (errors: any) {
       const { apiErrors, isValidationErrors } = extractAPIErrors(errors);

src/application/service/utils/capitalContributionValidation.ts

@@ -1,68 +1,37 @@
 import UIErrors from "../../../domain/entities/UIErrors";
 import { symbols } from "./currencies";
 
-const capitalContributionValidation = (
-  data: {
-    contribution_currency_type: string;
-    contribution_currency_value: string;
-    contribution_sub_types: string[];
-  },
-  i18n: any
-): void => {
+const capitalContributionValidation = (data: Record<string, string | string[]>, i18n: any): void => {
   const uiErrors = new UIErrors();
 
-  contributionCurrencyValueValidation(data, uiErrors, i18n);
-
-  if (!data.contribution_sub_types.length) {
-    uiErrors.formatValidationErrorToUiErrors({
-      errors: {
-        contribution_sub_types: i18n?.errorMessages?.capitalContribution?.atLeastOneType
-      }
-    });
+  if (!data.contribution_currency_type) {
+    uiErrors.setWebError("contribution_currency_type", i18n?.errorMessages?.capitalContribution?.currencyRequired);
   }
 
-  if (!data.contribution_currency_type) {
-    uiErrors.formatValidationErrorToUiErrors({
-      errors: {
-        contribution_currency_type: i18n?.errorMessages?.capitalContribution?.currencyRequired
-      }
-    });
+  if (!data.contribution_sub_types?.length) {
+    uiErrors.setWebError("contribution_sub_types", i18n?.errorMessages?.capitalContribution?.atLeastOneType);
   }
 
+  contributionCurrencyValueValidation(data, uiErrors, i18n);
+
   if (uiErrors.hasErrors()) {
     throw uiErrors;
   }
 };
 
-const contributionCurrencyValueValidation = (
-  data: { contribution_currency_type: string; contribution_currency_value: string; contribution_sub_types: string[] },
-  uiErrors: UIErrors,
-  i18n: any
-) => {
-  if (hasSymbol(data.contribution_currency_value, symbols)) {
-    uiErrors.formatValidationErrorToUiErrors({
-      errors: {
-        contribution_currency_value: i18n?.errorMessages?.capitalContribution?.noSymbols
-      }
-    });
+const contributionCurrencyValueValidation = (data: Record<string, any>, uiErrors: UIErrors, i18n: any) => {
+  const field = "contribution_currency_value";
+
+  if (!data.contribution_currency_value) {
+    uiErrors.setWebError(field, i18n?.errorMessages?.capitalContribution?.valueRequired);
+  } else if (hasSymbol(data.contribution_currency_value, symbols)) {
+    uiErrors.setWebError(field, i18n?.errorMessages?.capitalContribution?.noSymbols);
   } else if (hasComma(data.contribution_currency_value)) {
-    uiErrors.formatValidationErrorToUiErrors({
-      errors: {
-        contribution_currency_value: i18n?.errorMessages?.capitalContribution?.noComma
-      }
-    });
+    uiErrors.setWebError(field, i18n?.errorMessages?.capitalContribution?.noComma);
   } else if (!isNumber(data.contribution_currency_value) || !has2Decimal(data.contribution_currency_value)) {
-    uiErrors.formatValidationErrorToUiErrors({
-      errors: {
-        contribution_currency_value: i18n?.errorMessages?.capitalContribution?.twoDecimalPlaces
-      }
-    });
+    uiErrors.setWebError(field, i18n?.errorMessages?.capitalContribution?.twoDecimalPlaces);
   } else if (!isGreaterThanZero(data.contribution_currency_value)) {
-    uiErrors.formatValidationErrorToUiErrors({
-      errors: {
-        contribution_currency_value: i18n?.errorMessages?.capitalContribution?.moreThanZero
-      }
-    });
+    uiErrors.setWebError(field, i18n?.errorMessages?.capitalContribution?.moreThanZero);
   }
 };
 

src/domain/entities/UIErrors.ts

@@ -15,7 +15,7 @@ class UIErrors {
   apiErrors: ApiErrors;
   errors: UIValidationErrors = { errorList: [] } as any;
 
-  formatValidationErrorToUiErrors(apiErrors: ApiErrors) {
+  public formatValidationErrorToUiErrors(apiErrors: ApiErrors) {
     this.apiErrors = { ...this.apiErrors, ...apiErrors };
     const list = apiErrors?.errors ?? {};
 
@@ -33,6 +33,14 @@ class UIErrors {
     }
   }
 
+  public setWebError(field: string, message: string) {
+    this.formatValidationErrorToUiErrors({
+      errors: {
+        [field]: message
+      }
+    });
+  }
+
   public hasErrors(): boolean {
     return this.errors.errorList.length > 0;
   }

src/presentation/controller/common/PartnerController.ts

@@ -204,6 +204,9 @@ abstract class PartnerController extends AbstractController {
   createPartner(partner: PartnerType) {
     return async (request: Request, response: Response, next: NextFunction) => {
       try {
+        this.generalPartnerService.setI18n(response.locals.i18n);
+        this.limitedPartnerService.setI18n(response.locals.i18n);
+
         const routing = this.getJourneyPageRouting(request.url);
         const journeyPageType = this.getJourneyPageTypes(request.url);
 
@@ -383,6 +386,9 @@ abstract class PartnerController extends AbstractController {
   ) {
     return async (request: Request, response: Response, next: NextFunction) => {
       try {
+        this.generalPartnerService.setI18n(response.locals.i18n);
+        this.limitedPartnerService.setI18n(response.locals.i18n);
+
         const routing = this.getJourneyPageRouting(request.url);
         const journeyPageType = this.getJourneyPageTypes(request.url);
 

src/presentation/test/unit/registration/capital-contribution-validation.spec.ts

@@ -46,6 +46,12 @@ describe("Gateway capital contribition validation test suite", () => {
         dataKeys[1],
         "Value must not include a comma"
       ],
+      [
+        "contribution_currency_value empty",
+        { ...data, contribution_currency_value: "" },
+        dataKeys[1],
+        "Contribution currency type is required"
+      ],
       [
         "contribution_sub_types empty array",
         { ...data, contribution_sub_types: [] },

src/views/includes/capital-contribution.njk

@@ -4,7 +4,6 @@
 
   <p class="govuk-hint">{{ i18n.capitalContribution.hint }}</p>
 
-  {% set contributionCurrencyTypeId = "contribution_currency_type" %}
   {% set currencyField = props.data.limitedPartner.data.contribution_currency_type %}
   {% include "includes/currencies.njk" %}
 
@@ -34,10 +33,7 @@
     id: "contribution_currency_value",
     name: "contribution_currency_value",
     value: props.data.limitedPartner.data.contribution_currency_value,
-    errorMessage: props.errors.contribution_currency_value if props.errors.contribution_currency_value,
-    attributes: {
-      required: true
-    }
+    errorMessage: props.errors.contribution_currency_value if props.errors.contribution_currency_value
   }) }}
 
   {{ govukCheckboxes({

src/views/includes/currencies.njk

@@ -174,17 +174,13 @@
 ] %}
 
 {{ govukSelect({
-  id: contributionCurrencyTypeId,
-  name: contributionCurrencyTypeId,
-  value: contributionCurrencyValue,
+  id: "contribution_currency_type",
+  name: "contribution_currency_type",
   label: {
     text: i18n.capitalContribution.currencyTypeLabel,
     classes: "govuk-visually-hidden",
     isPageHeading: false
   },
-  errorMessage: currencyErrorMessage,
-  attributes : {
-    required: "true"
-  },
+  errorMessage: props.errors.contribution_currency_type if props.errors.contribution_currency_type,
   items: CURRENCIES
 }) }}