Exui 837 cya fix (#1581)

* Revert "Revert "fix for exui-837 (#1559)" (#1576)" This reverts commit bb05e82. * Candidate fix for issues with 837 fix * updated fix and unit tests for exui-837 * lint --------- Co-authored-by: RiteshHMCTS <[email protected]> Co-authored-by: Ritesh Dsouza <[email protected]>
hmcts · Oct 16, 2023 · dbb0d17 · dbb0d17
1 parent bb05e82
commit dbb0d17
Show file tree

Hide file tree

Showing 10 changed files with 205 additions and 31 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@hmcts/ccd-case-ui-toolkit",
-  "version": "6.19.5",
+  "version": "6.19.8",
   "engines": {
     "yarn": "^3.5.0",
     "npm": "^8.10.0"

diff --git a/projects/ccd-case-ui-toolkit/package.json b/projects/ccd-case-ui-toolkit/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@hmcts/ccd-case-ui-toolkit",
-  "version": "6.19.5",
+  "version": "6.19.8",
   "engines": {
     "yarn": "^3.5.0",
     "npm": "^8.10.0"

diff --git a/...kit/src/lib/shared/components/case-editor/case-edit-page/case-edit-page.component.spec.ts b/...kit/src/lib/shared/components/case-editor/case-edit-page/case-edit-page.component.spec.ts
@@ -41,6 +41,7 @@ import {
   FormValueService,
   LoadingService,
 } from '../../../services';
+import { ValidPageListCaseFieldsService } from '../services/valid-page-list-caseFields.service';
 import { FieldsUtils } from '../../../services/fields/fields.utils';
 import { text } from '../../../test/helpers';
 import { MockRpxTranslatePipe } from '../../../test/mock-rpx-translate.pipe';
@@ -52,7 +53,7 @@ import { Wizard, WizardPage } from '../domain';
 import { PageValidationService } from '../services';
 import { CaseEditPageText } from './case-edit-page-text.enum';
 import { CaseEditPageComponent } from './case-edit-page.component';
-
+import { ShowCondition } from '../../../directives';
 import createSpyObj = jasmine.createSpyObj;
 
 describe('CaseEditPageComponent - creation and update event trigger tests', () => {
@@ -76,6 +77,7 @@ describe('CaseEditPageComponent - creation and update event trigger tests', () =
     caseFieldService = {},
     caseEditDataService = {},
     loadingService = {},
+    validPageListCaseFieldsService = {}
   }) =>
   new CaseEditPageComponent(
     caseEdit as CaseEditComponent,
@@ -87,7 +89,8 @@ describe('CaseEditPageComponent - creation and update event trigger tests', () =
     dialog as MatDialog,
     caseFieldService as CaseFieldService,
     caseEditDataService as CaseEditDataService,
-    loadingService as LoadingService
+    loadingService as LoadingService,
+    validPageListCaseFieldsService as ValidPageListCaseFieldsService
   );
 
   it('should create', () => {
@@ -294,15 +297,33 @@ describe('CaseEditPageComponent - all other tests', () => {
   let wizardPage = createWizardPage(
     [createCaseField('field1', 'field1Value')],
     false,
-    0
+    0,
+    1
+  );
+  const wizardPage1 = createWizardPage(
+    [createCaseField('field1', 'field1Value')],
+    false,
+    0,
+    2
   );
+  const wizardPage2 = createWizardPage(
+    [createCaseField('field3', 'field3Value')],
+    false,
+    0,
+    3
+  );
+  wizardPage1.parsedShowCondition = ShowCondition.getInstance(null);
+  wizardPage2.parsedShowCondition = ShowCondition.getInstance(null);
+  const pageList = [wizardPage1, wizardPage2];
   const readOnly = new CaseField();
   const fieldTypeSanitiser = new FieldTypeSanitiser();
   const formValueService = new FormValueService(fieldTypeSanitiser);
   const formErrorService = new FormErrorService();
   const firstPage = new WizardPage();
   const caseFieldService = new CaseFieldService();
   const pageValidationService = new PageValidationService(caseFieldService);
+  const fieldsUtils = new FieldsUtils();
+  const validPageListCaseFieldsService = new ValidPageListCaseFieldsService(fieldsUtils);
   let route: any;
   let snapshot: any;
   const FORM_GROUP_NO_JUDICIAL_USERS = new FormGroup({
@@ -352,6 +373,7 @@ describe('CaseEditPageComponent - all other tests', () => {
         firstPage.case_fields = [
           createCaseField('field1', 'SOME_VALUE')
         ];
+        firstPage.parsedShowCondition = ShowCondition.getInstance(null);
         cancelled = createSpyObj('cancelled', ['emit']);
         caseEditComponentStub = {
           form: FORM_GROUP,
@@ -373,7 +395,8 @@ describe('CaseEditPageComponent - all other tests', () => {
             metadataFields: [caseField2],
           },
           getNextPage: () => null,
-          callbackErrorsSubject: new Subject<any>()
+          callbackErrorsSubject: new Subject<any>(),
+          validPageList: pageList
         };
         snapshot = {
           queryParamMap: createSpyObj('queryParamMap', ['get']),
@@ -448,9 +471,10 @@ describe('CaseEditPageComponent - all other tests', () => {
             { provide: MatDialog, useValue: dialog },
             { provide: CaseFieldService, useValue: caseFieldService },
             { provide: CaseEditDataService, useValue: caseEditDataService },
-            FieldsUtils,
+            { provide: FieldsUtils, useValue: fieldsUtils },
             PlaceholderService,
-            { provide: LoadingService, useValue: loadingServiceMock }
+            { provide: LoadingService, useValue: loadingServiceMock },
+            { provide: ValidPageListCaseFieldsService, useValue: validPageListCaseFieldsService},
           ],
         }).compileComponents();
         fixture = TestBed.createComponent(CaseEditPageComponent);
@@ -766,7 +790,8 @@ describe('CaseEditPageComponent - all other tests', () => {
             metadataFields: [],
           },
           getNextPage: () => null,
-          callbackErrorsSubject: new Subject<any>()
+          callbackErrorsSubject: new Subject<any>(),
+          validPageList: pageList
         };
         snapshot = {
           queryParamMap: createSpyObj('queryParamMap', ['get']),
@@ -841,9 +866,10 @@ describe('CaseEditPageComponent - all other tests', () => {
             { provide: MatDialog, useValue: dialog },
             { provide: CaseFieldService, useValue: caseFieldService },
             { provide: CaseEditDataService, useValue: caseEditDataService },
-            FieldsUtils,
+            { provide: FieldsUtils, useValue: fieldsUtils },
             PlaceholderService,
             { provide: LoadingService, useValue: loadingServiceMock },
+            { provide: ValidPageListCaseFieldsService, useValue: validPageListCaseFieldsService},
           ],
         }).compileComponents();
       })
@@ -941,7 +967,8 @@ describe('CaseEditPageComponent - all other tests', () => {
               title_display: '# 1234567812345678: test',
             },
           },
-          getNextPage: () => null
+          getNextPage: () => null,
+          validPageList: pageList
         };
 
         route = {
@@ -1000,9 +1027,10 @@ describe('CaseEditPageComponent - all other tests', () => {
             { provide: MatDialog, useValue: dialog },
             { provide: CaseFieldService, useValue: caseFieldService },
             { provide: CaseEditDataService, useValue: caseEditDataService },
-            FieldsUtils,
+            { provide: FieldsUtils, useValue: fieldsUtils },
             PlaceholderService,
             { provide: LoadingService, useValue: loadingServiceMock },
+            { provide: ValidPageListCaseFieldsService, useValue: validPageListCaseFieldsService},
           ],
         }).compileComponents();
       })
@@ -1097,7 +1125,8 @@ describe('CaseEditPageComponent - all other tests', () => {
           },
           getNextPage: () => null,
           callbackErrorsSubject: new Subject<any>(),
-          ignoreWarning: true
+          ignoreWarning: true,
+          validPageList: pageList
         };
         snapshot = {
           queryParamMap: createSpyObj('queryParamMap', ['get']),
@@ -1125,6 +1154,7 @@ describe('CaseEditPageComponent - all other tests', () => {
           eventData
         );
         spyOn(formValueService, 'removeUnnecessaryFields');
+        spyOn(validPageListCaseFieldsService, 'deleteNonValidatedFields');
 
         caseEditDataService = createSpyObj('caseEditDataService',
           [
@@ -1166,9 +1196,10 @@ describe('CaseEditPageComponent - all other tests', () => {
             { provide: MatDialog, useValue: dialog },
             { provide: CaseFieldService, useValue: caseFieldService },
             { provide: CaseEditDataService, useValue: caseEditDataService },
-            FieldsUtils,
+            { provide: FieldsUtils, useValue: fieldsUtils },
             PlaceholderService,
             { provide: LoadingService, useValue: loadingServiceMock },
+            { provide: ValidPageListCaseFieldsService, useValue: validPageListCaseFieldsService},
           ],
         }).compileComponents();
       })
@@ -1185,7 +1216,8 @@ describe('CaseEditPageComponent - all other tests', () => {
           aCaseField('judicialUserField2', 'judicialUser2', 'JudicialUser', 'OPTIONAL', null),
         ],
         false,
-        0
+        0,
+        2
       );
       comp.wizard = new Wizard([wizardPage]);
       // Rebuild the FORM_GROUP object before use because it gets modified by the "should call validate" test
@@ -1219,6 +1251,7 @@ describe('CaseEditPageComponent - all other tests', () => {
       expect(formValueService.sanitise).toHaveBeenCalled();
       expect(formValueService.removeUnnecessaryFields).toHaveBeenCalled();
       expect(loadingServiceMock.register).toHaveBeenCalled();
+      expect(validPageListCaseFieldsService.deleteNonValidatedFields).toHaveBeenCalled();
 
       fixture.whenStable().then(() => {
         expect(comp.caseEdit.eventTrigger.case_id).toEqual(DRAFT_PREFIX + draft.id);
@@ -1422,7 +1455,8 @@ describe('CaseEditPageComponent - all other tests', () => {
             metadataFields: [caseField2],
           },
           getNextPage: () => null,
-          callbackErrorsSubject: new Subject<any>()
+          callbackErrorsSubject: new Subject<any>(),
+          validPageList: pageList
         };
         snapshot = {
           queryParamMap: createSpyObj('queryParamMap', ['get']),
@@ -1496,9 +1530,10 @@ describe('CaseEditPageComponent - all other tests', () => {
             { provide: MatDialog, useValue: dialog },
             { provide: CaseFieldService, useValue: caseFieldService },
             { provide: CaseEditDataService, useValue: caseEditDataService },
-            FieldsUtils,
+            { provide: FieldsUtils, useValue: fieldsUtils },
             PlaceholderService,
-            { provide: LoadingService, useValue: loadingServiceMock }
+            { provide: LoadingService, useValue: loadingServiceMock },
+            { provide: ValidPageListCaseFieldsService, useValue: validPageListCaseFieldsService},
           ],
         }).compileComponents();
       })
@@ -1621,7 +1656,8 @@ describe('CaseEditPageComponent - all other tests', () => {
             tabs: [],
             metadataFields: [],
           },
-          getNextPage: () => null
+          getNextPage: () => null,
+          validPageList: pageList
         };
         snapshot = {
           queryParamMap: createSpyObj('queryParamMap', ['get']),
@@ -1690,9 +1726,10 @@ describe('CaseEditPageComponent - all other tests', () => {
             { provide: MatDialog, useValue: dialog },
             { provide: CaseFieldService, useValue: caseFieldService },
             { provide: CaseEditDataService, useValue: caseEditDataService },
-            FieldsUtils,
+            { provide: FieldsUtils, useValue: fieldsUtils },
             PlaceholderService,
-            { provide: LoadingService, useValue: loadingServiceMock }
+            { provide: LoadingService, useValue: loadingServiceMock },
+            { provide: ValidPageListCaseFieldsService, useValue: validPageListCaseFieldsService},
           ],
         }).compileComponents();
       })
@@ -1939,7 +1976,8 @@ describe('CaseEditPageComponent - all other tests', () => {
   function createWizardPage(
     fields: CaseField[] = [],
     isMultiColumn = false,
-    order = 0
+    order = 0,
+    id = 1
   ): WizardPage {
     const wp: WizardPage = new WizardPage();
     wp.case_fields = fields;

diff --git a/...-toolkit/src/lib/shared/components/case-editor/case-edit-page/case-edit-page.component.ts b/...-toolkit/src/lib/shared/components/case-editor/case-edit-page/case-edit-page.component.ts
@@ -21,6 +21,7 @@ import { CaseEditComponent } from '../case-edit/case-edit.component';
 import { WizardPage } from '../domain/wizard-page.model';
 import { Wizard } from '../domain/wizard.model';
 import { PageValidationService } from '../services/page-validation.service';
+import { ValidPageListCaseFieldsService } from '../services/valid-page-list-caseFields.service';
 
 @Component({
   selector: 'ccd-case-edit-page',
@@ -72,7 +73,7 @@ export class CaseEditPageComponent implements OnInit, AfterViewChecked, OnDestro
   }
 
   constructor(
-    public readonly caseEdit: CaseEditComponent,
+    public caseEdit: CaseEditComponent,
     private readonly route: ActivatedRoute,
     private readonly formValueService: FormValueService,
     private readonly formErrorService: FormErrorService,
@@ -81,7 +82,8 @@ export class CaseEditPageComponent implements OnInit, AfterViewChecked, OnDestro
     private readonly dialog: MatDialog,
     private readonly caseFieldService: CaseFieldService,
     private readonly caseEditDataService: CaseEditDataService,
-    private readonly loadingService: LoadingService
+    private readonly loadingService: LoadingService,
+    private readonly validPageListCaseFieldsService: ValidPageListCaseFieldsService
   ) {
   }
 
@@ -276,6 +278,9 @@ export class CaseEditPageComponent implements OnInit, AfterViewChecked, OnDestro
     }
 
     if (!this.caseEdit.isSubmitting && !this.currentPageIsNotValid()) {
+      if (this.caseEdit.validPageList.findIndex(page=> page.id === this.currentPage.id) === -1) {
+        this.caseEdit.validPageList.push(this.currentPage);
+      }
       this.caseEdit.isSubmitting = true;
       this.caseEdit.error = null;
       const caseEventData: CaseEventData = this.buildCaseEventData();
@@ -566,6 +571,9 @@ export class CaseEditPageComponent implements OnInit, AfterViewChecked, OnDestro
     // Get hold of the CaseEventData.
     const caseEventData: CaseEventData = this.formValueService.sanitise(formFields) as CaseEventData;
 
+    // delete fields which are not part of the case event journey wizard pages case fields
+    this.validPageListCaseFieldsService.deleteNonValidatedFields(this.caseEdit.validPageList, caseEventData.data, this.eventTrigger.case_fields, fromPreviousPage);
+
     // Tidy it up before we return it.
     this.formValueService.removeUnnecessaryFields(caseEventData.data, caseFields, clearEmpty, clearNonCase,
       fromPreviousPage, this.currentPage.case_fields);

diff --git a/...se-ui-toolkit/src/lib/shared/components/case-editor/case-edit/case-edit.component.spec.ts b/...se-ui-toolkit/src/lib/shared/components/case-editor/case-edit/case-edit.component.spec.ts
@@ -17,6 +17,7 @@ import { PaletteUtilsModule } from '../../palette';
 import { Confirmation, Wizard, WizardPage, WizardPageField } from '../domain';
 import { CaseNotifier } from '../services';
 import { WizardFactoryService } from '../services/wizard-factory.service';
+import { ValidPageListCaseFieldsService } from '../services/valid-page-list-caseFields.service';
 import { CaseEditComponent } from './case-edit.component';
 import createSpyObj = jasmine.createSpyObj;
 
@@ -211,6 +212,7 @@ describe('CaseEditComponent', () => {
   const registrarService = new ConditionalShowRegistrarService();
   let route: any;
   let mockSessionStorageService: jasmine.SpyObj<SessionStorageService>;
+  const validPageListCaseFieldsService = new ValidPageListCaseFieldsService(fieldsUtils);
 
   describe('profile available in route', () => {
     routerStub = {
@@ -268,6 +270,7 @@ describe('CaseEditComponent', () => {
         'populateLinkedCasesDetailsFromCaseFields'
       ]);
       mockSessionStorageService = createSpyObj<SessionStorageService>('SessionStorageService', ['getItem', 'removeItem', 'setItem']);
+      spyOn(validPageListCaseFieldsService, 'deleteNonValidatedFields');
 
       route = {
         queryParams: of({Origin: 'viewDraft'}),
@@ -317,7 +320,8 @@ describe('CaseEditComponent', () => {
             {provide: ActivatedRoute, useValue: route},
             SessionStorageService,
             WindowService,
-            { provide: LoadingService, loadingServiceMock }
+            { provide: LoadingService, loadingServiceMock },
+            { provide: ValidPageListCaseFieldsService, useValue: validPageListCaseFieldsService},
           ]
         })
         .compileComponents();
@@ -1219,6 +1223,7 @@ describe('CaseEditComponent', () => {
         expect(formValueService.removeCaseFieldsOfType)
           .toHaveBeenCalledWith(jasmine.any(Object), jasmine.any(Array), ['FlagLauncher', 'ComponentLauncher']);
         expect(formValueService.repopulateFormDataFromCaseFieldValues).toHaveBeenCalled();
+        expect(validPageListCaseFieldsService.deleteNonValidatedFields).toHaveBeenCalled();
       });
 
       it('should NOT submit the case due to error', () => {
@@ -1395,7 +1400,8 @@ describe('CaseEditComponent', () => {
             {provide: Router, useValue: routerStub},
             {provide: ActivatedRoute, useValue: mockRouteNoProfile},
             SessionStorageService,
-            WindowService
+            WindowService,
+            { provide: ValidPageListCaseFieldsService, useValue: validPageListCaseFieldsService},
           ]
         })
         .compileComponents();