Merge pull request #807 from ghiscoding/bugfix/refresh-tree-data-filter-only-when-enabled

fix(filter): refreshTreeDataFilters only when Tree is enabled fixes #806

Author: ghiscoding

src/app/modules/angular-slickgrid/services/__tests__/filter.service.spec.ts

@@ -1679,7 +1679,7 @@ describe('FilterService', () => {
         expect(preFilterSpy).toHaveReturnedWith([21, 4, 5]);
       });
 
-      it('should return False when item is not found in the dataset', () => {
+      it('should return False also when called when item is not found in the dataset', () => {
         const spyRxjs = jest.spyOn(service.onFilterChanged, 'next');
         const preFilterSpy = jest.spyOn(service, 'preFilterTreeData');
         jest.spyOn(dataViewStub, 'getItemById').mockReturnValueOnce({ ...dataset[4] as any })
@@ -1694,7 +1694,31 @@ describe('FilterService', () => {
         gridStub.onHeaderRowCellRendered.notify(mockArgs2 as any, new Slick.EventData(), gridStub);
 
         const columnFilters = { file: { columnDef: mockColumn1, columnId: 'file', searchTerms: ['unknown'], type: FieldType.string } } as ColumnFilters;
-        service.updateFilters([{ columnId: 'file', operator: '', searchTerms: ['unknown'] }], true, true, true);
+        service.updateFilters([{ columnId: 'file', operator: 'Contains', searchTerms: ['unknown'] }], true, true, true);
+        const output = service.customLocalFilter(mockItem1, { dataView: dataViewStub, grid: gridStub, columnFilters });
+
+        expect(spyRxjs).toHaveBeenCalledWith([{ columnId: 'file', operator: 'Contains', searchTerms: ['unknown'] }]);
+        expect(output).toBe(false);
+        expect(preFilterSpy).toHaveBeenCalledWith(dataset, { ...columnFilters, file: { ...columnFilters.file, operator: 'Contains', parsedSearchTerms: ['unknown'], type: 'string' } }); // it will use Contains by default
+        expect(preFilterSpy).toHaveReturnedWith([]);
+      });
+
+      it('should return False also when called by "updateSingleFilter" and when item is not found in the dataset', () => {
+        const spyRxjs = jest.spyOn(service.onFilterChanged, 'next');
+        const preFilterSpy = jest.spyOn(service, 'preFilterTreeData');
+        jest.spyOn(dataViewStub, 'getItemById').mockReturnValueOnce({ ...dataset[4] as any })
+          .mockReturnValueOnce(dataset[5])
+          .mockReturnValueOnce(dataset[6]);
+
+        const mockItem1 = { __parentId: 4, id: 5, file: 'unknown.pdf', dateModified: '2015-05-21T10:22:00.123Z', size: 3.1 };
+
+        service.init(gridStub);
+        service.bindLocalOnFilter(gridStub);
+        gridStub.onHeaderRowCellRendered.notify(mockArgs1 as any, new Slick.EventData(), gridStub);
+        gridStub.onHeaderRowCellRendered.notify(mockArgs2 as any, new Slick.EventData(), gridStub);
+
+        const columnFilters = { file: { columnDef: mockColumn1, columnId: 'file', searchTerms: ['unknown'], type: FieldType.string } } as ColumnFilters;
+        service.updateSingleFilter({ columnId: 'file', operator: 'Contains', searchTerms: ['unknown'] }, true, true);
         const output = service.customLocalFilter(mockItem1, { dataView: dataViewStub, grid: gridStub, columnFilters });
 
         expect(spyRxjs).toHaveBeenCalledWith([{ columnId: 'file', operator: 'Contains', searchTerms: ['unknown'] }]);

src/app/modules/angular-slickgrid/services/filter.service.ts

@@ -686,7 +686,9 @@ export class FilterService {
       });
 
       // when we have a Filter Presets on a Tree Data View grid, we need to call the pre-filtering of tree data
-      this.refreshTreeDataFilters();
+      if (this._gridOptions?.enableTreeData) {
+        this.refreshTreeDataFilters();
+      }
     }
     return this._columnDefinitions;
   }
@@ -697,7 +699,7 @@ export class FilterService {
    * @param {Array<Object>} [items] - optional flat array of parent/child items to use while redoing the full sort & refresh
    */
   refreshTreeDataFilters(items?: any[]) {
-    const inputItems = items ?? this._dataView.getItems() ?? [];
+    const inputItems = items ?? this._dataView?.getItems?.() ?? [];
 
     if (this._dataView && this._gridOptions?.enableTreeData && inputItems.length > 0) {
       this._tmpPreFilteredData = this.preFilterTreeData(inputItems, this._columnFilters);
@@ -874,7 +876,9 @@ export class FilterService {
         });
 
         // when using Tree Data, we also need to refresh the filters because of the tree structure with recursion
-        this.refreshTreeDataFilters();
+        if (this._gridOptions?.enableTreeData) {
+          this.refreshTreeDataFilters();
+        }
 
         this._dataView.refresh();
       }