Merge pull request #4144 from flexion/devex-1187-batch

Devex 1187: Batch

Author: jimlerza

shared/src/business/entities/Batch.test.ts

@@ -1,8 +1,6 @@
 import { Batch } from './Batch';
 import { applicationContext } from '../test/createTestApplicationContext';
 
-const { VALIDATION_ERROR_MESSAGES } = Batch;
-
 describe('Batch entity', () => {
   it('adds a page', () => {
     const batch = new Batch({
@@ -27,8 +25,8 @@ describe('Batch entity', () => {
     it('validates minimum number of pages', () => {
       const batch = new Batch({ applicationContext, rawBatch: {} });
 
-      expect(batch.getFormattedValidationErrors()).toMatchObject({
-        pages: VALIDATION_ERROR_MESSAGES.pages,
+      expect(batch.getValidationErrors()).toMatchObject({
+        pages: 'At least one page is required',
       });
     });
 
@@ -41,8 +39,8 @@ describe('Batch entity', () => {
         },
       });
 
-      expect(batch.getFormattedValidationErrors()).toMatchObject({
-        batchIndex: VALIDATION_ERROR_MESSAGES.batchIndex,
+      expect(batch.getValidationErrors()).toMatchObject({
+        batchIndex: 'Invalid batch index',
       });
     });
   });

shared/src/business/entities/Batch.ts

@@ -1,9 +1,9 @@
 import { JoiValidationConstants } from './JoiValidationConstants';
-import { JoiValidationEntity } from './JoiValidationEntity';
+import { JoiValidationEntity_New } from '@shared/business/entities/joiValidationEntity/JoiValidationEntity_New';
 import { createISODateString } from '@shared/business/utilities/DateHandler';
 import joi from 'joi';
 
-export class Batch extends JoiValidationEntity {
+export class Batch extends JoiValidationEntity_New {
   public batchId: string;
   public batchIndex: string;
   public createdAt: string;
@@ -18,42 +18,33 @@ export class Batch extends JoiValidationEntity {
     this.pages = rawBatch.pages || [];
   }
 
-  /**
-   * adds a page to current Batch
-   *
-   * @param {object} page the page to add
-   * @returns {Batch} the batch entity after the page is added
-   */
-  addPage(page) {
+  static VALIDATION_RULES = joi.object().keys({
+    batchId: JoiValidationConstants.UUID.required(),
+    batchIndex: joi
+      .number()
+      .integer()
+      .min(0)
+      .required()
+      .messages({ '*': 'Invalid batch index' }),
+    createdAt: JoiValidationConstants.ISO_DATE.required(),
+    pages: joi
+      .array()
+      .min(1)
+      .required()
+      .messages({ '*': 'At least one page is required' }),
+  });
+
+  addPage(page): Batch {
     this.pages.push(page);
     return this;
   }
 
-  /**
-   * clears all pages within this Batch
-   *
-   * @returns {Batch} the batch entity after the pages are cleared
-   */
-  clear() {
+  clear(): Batch {
     this.pages = [];
     return this;
   }
 
-  static VALIDATION_ERROR_MESSAGES = {
-    batchIndex: 'Invalid batch index',
-    pages: 'At least one page is required',
-  };
-
   getValidationRules() {
-    return joi.object().keys({
-      batchId: JoiValidationConstants.UUID.required(),
-      batchIndex: joi.number().integer().min(0).required(),
-      createdAt: JoiValidationConstants.ISO_DATE.required(),
-      pages: joi.array().min(1).required(),
-    });
-  }
-
-  getErrorToMessageMap() {
-    return Batch.VALIDATION_ERROR_MESSAGES;
+    return Batch.VALIDATION_RULES;
   }
 }

shared/src/business/entities/joiValidationEntity/JoiValidationEntity_New.test.ts

@@ -127,6 +127,16 @@ describe('Joi Entity', () => {
         });
       });
 
+      it('should ONlY recursively validate items in an array when the list contains items which are instances of JoiValidationEntity', () => {
+        const testCaseEntity = new TestCaseEntity({
+          otherList: [{ aProperty: 'abc' }], // Other list is a plain list of objects
+        });
+
+        const errors = testCaseEntity.getValidationErrors();
+
+        expect(errors).toEqual(null);
+      });
+
       it('should return an object of errors when there is an error in a nested entity', () => {
         const testCaseEntity = new TestCaseEntity({
           nestedCase: { contactType: 'INVALID_1' },

shared/src/business/entities/joiValidationEntity/TestCaseEntity.ts

@@ -12,6 +12,7 @@ export const TEST_VALIDATION_RULES = joi.object().keys({
 export class TestCaseEntity extends JoiValidationEntity_New {
   public contactType: string;
   public caseList: TestCaseEntity[];
+  public otherList: { aProperty: string }[];
   public unhelpfulErrorMessage: string;
   public nestedCase: TestCaseEntity | undefined;
 
@@ -29,6 +30,13 @@ export class TestCaseEntity extends JoiValidationEntity_New {
         .messages({
           'any.only': 'invalid contact type',
         }),
+      otherList: joi
+        .array()
+        .items({ aProperty: joi.string().required() })
+        .optional()
+        .messages({
+          'any.only': 'invalid contact type',
+        }),
       unhelpfulErrorMessage: JoiValidationConstants.STRING.valid(
         'VALID_1',
         'VALID_2',
@@ -48,6 +56,7 @@ export class TestCaseEntity extends JoiValidationEntity_New {
     this.caseList = (rawTestCase.caseList || []).map(
       d => new TestCaseEntity(d),
     );
+    this.otherList = rawTestCase.otherList;
     this.unhelpfulErrorMessage = rawTestCase.unhelpfulErrorMessage;
     this.nestedCase = rawTestCase.nestedCase
       ? new TestCaseEntity(rawTestCase.nestedCase)

shared/src/business/entities/joiValidationEntity/helper.ts

@@ -24,8 +24,10 @@ export function appendNestedEntitiesErrors(
     } else if (Array.isArray(entityPropertyValue)) {
       const errorsForNestedEntitiesInArray = entityPropertyValue
         .map((item, index) => {
-          const itemErrors = item.getValidationErrors();
-          return itemErrors ? { ...itemErrors, index } : null;
+          if (item.getValidationErrors) {
+            const itemErrors = item.getValidationErrors();
+            return itemErrors ? { ...itemErrors, index } : null;
+          }
         })
         .filter(itemErrors => !!itemErrors) as (TValidationError & {
         index: number;