GridStateService always clear row selections even though syncGridSelection is TRUE

I’m submitting a Bug report

Your Environment

Software	Version(s)
Angular	8
Angular-Slickgrid	2.x

Context

this.gridOptions = {
      enableFiltering: true,
      enableGrouping : true,
      enableCheckboxSelector: true,
      enableCellNavigation : false,
      dataView : {syncGridSelection : true}
    };

Setting syncGridSelection to TRUE does not preserve the row selections whenever I change the column filter. See #191

Expected Behavior

It should preserve the row selections if syncGridSelection is TRUE

Possible Solution

Probably can consider changing gridState.service.ts to something like below:

  // Check whether the row selection needs to be preserved
  private needToPreserveRowSelection(): boolean {
    let preservedRowSelection = false;
    if (this._gridOptions && this._gridOptions.dataView && this._gridOptions.dataView.hasOwnProperty('syncGridSelection')) {

      const syncGridSelection = this._gridOptions.dataView.syncGridSelection;
      if (typeof syncGridSelection === 'boolean') {
        preservedRowSelection = <boolean>this._gridOptions.dataView.syncGridSelection;
      } else {
        preservedRowSelection = syncGridSelection.preserveHidden;
      }
    }
    return preservedRowSelection;
  }

  /** if we use Row Selection or the Checkbox Selector, we need to reset any selection */
  resetRowSelection() {
    if (this._gridOptions.enableRowSelection || this._gridOptions.enableCheckboxSelector) {
      // this also requires the Row Selection Model to be registered as well
      const rowSelectionExtension = this.extensionService && this.extensionService.getExtensionByName && this.extensionService.getExtensionByName(ExtensionName.rowSelection);
      if (!this.needToPreserveRowSelection() && rowSelectionExtension && rowSelectionExtension.instance) {
        this._grid.setSelectedRows([]);
      }
    }
  }

Code Sample

[timhawkins1]

I confirm that it’s working perfectly now, thank you!

Point taken, I’m not very familiar with your code, but I was doing my best to be helpful by giving instructions to reproduce the problem. I’ll try to make more of a contribution next time.

[ghiscoding]

@timhawkins1 Another morning spent on this… it should be fixed now, you can test it in Example 12 where I added the row selection and some more Cypress E2E tests.

I have to say though that next time around I’d like to get a bit more help in troubleshooting and/or testing, even just adding some Cypress E2E tests would have been helpful. This is an Open Source project for a reason, I’d like to have contributions once in a while (at least that was the reason of why we decided to make it Open Source).