fix: Context menu using stale selection (#2414)

Cherry-pick #2407 and
#2412 to `v0.85`

Author: ericlln

packages/grid/src/mouse-handlers/GridSelectionMouseHandler.test.ts

@@ -0,0 +1,53 @@
+import { GridRange } from '../GridRange';
+import GridSelectionMouseHandler from './GridSelectionMouseHandler';
+
+describe('getLatestSelection', () => {
+  it('should return the original selection if the clicked cell is within the original selection', () => {
+    const originalSelection = [new GridRange(1, 1, 2, 2)];
+    const result = GridSelectionMouseHandler.getLatestSelection(
+      originalSelection,
+      1,
+      1
+    );
+
+    expect(result).toBe(originalSelection);
+  });
+
+  it('should return a new selection with the clicked cell if it is outside the original selection', () => {
+    const originalSelection = [new GridRange(1, 1, 2, 2)];
+    const columnIndex = 3;
+    const rowIndex = 3;
+
+    const result = GridSelectionMouseHandler.getLatestSelection(
+      originalSelection,
+      columnIndex,
+      rowIndex
+    );
+
+    expect(result).toEqual([GridRange.makeCell(columnIndex, rowIndex)]);
+  });
+
+  it('should return the original selection if columnIndex is null', () => {
+    const originalSelection = [new GridRange(1, 1, 2, 2)];
+
+    const result = GridSelectionMouseHandler.getLatestSelection(
+      originalSelection,
+      null,
+      1
+    );
+
+    expect(result).toBe(originalSelection);
+  });
+
+  it('should return the original selection if rowIndex is null', () => {
+    const originalSelection = [new GridRange(1, 1, 2, 2)];
+
+    const result = GridSelectionMouseHandler.getLatestSelection(
+      originalSelection,
+      null,
+      1
+    );
+
+    expect(result).toBe(originalSelection);
+  });
+});

packages/grid/src/mouse-handlers/GridSelectionMouseHandler.ts

@@ -1,12 +1,37 @@
-import { EventHandlerResult } from '../EventHandlerResult';
-import Grid from '../Grid';
-import GridMouseHandler, { GridMouseEvent } from '../GridMouseHandler';
-import GridRange from '../GridRange';
-import GridUtils, { GridPoint } from '../GridUtils';
+import { type EventHandlerResult } from '../EventHandlerResult';
+import type Grid from '../Grid';
+import GridMouseHandler, { type GridMouseEvent } from '../GridMouseHandler';
+import GridRange, { type GridRangeIndex } from '../GridRange';
+import GridUtils, { type GridPoint } from '../GridUtils';
 
 const DEFAULT_INTERVAL_MS = 100;
 
 class GridSelectionMouseHandler extends GridMouseHandler {
+  /**
+   * Returns the latest grid selection based on the current grid selection and where the user clicked
+   * This code is dependent on the behavior of onContextMenu
+   * @param originalSelection The selection from the current grid state which may be stale
+   * @param columnIndex The column index where the user clicked
+   * @param rowIndex The row index where the user clicked
+   */
+  static getLatestSelection(
+    originalSelection: readonly GridRange[],
+    columnIndex: GridRangeIndex,
+    rowIndex: GridRangeIndex
+  ): readonly GridRange[] {
+    const clickedInOriginalSelection = GridRange.containsCell(
+      originalSelection,
+      columnIndex,
+      rowIndex
+    );
+
+    // If the user clicked in a valid cell outside of the original selection,
+    // the selection will be changed to just that cell.
+    return clickedInOriginalSelection || columnIndex == null || rowIndex == null
+      ? originalSelection
+      : [GridRange.makeCell(columnIndex, rowIndex)];
+  }
+
   private startPoint?: GridPoint;
 
   private hasExtendedFloating = false;
@@ -246,7 +271,7 @@ class GridSelectionMouseHandler extends GridMouseHandler {
     );
 
     // only change the selected range if the selected cell is not in the selected range
-    if (!isInRange && gridPoint.row !== null) {
+    if (!isInRange && gridPoint.row !== null && gridPoint.column !== null) {
       this.startPoint = undefined;
       this.stopTimer();
       grid.clearSelectedRanges();

packages/iris-grid/src/mousehandlers/IrisGridContextMenuHandler.tsx

@@ -23,6 +23,7 @@ import {
   GridPoint,
   GridRange,
   GridRenderer,
+  GridSelectionMouseHandler,
   isDeletableGridModel,
   isEditableGridModel,
   isExpandableGridModel,
@@ -818,9 +819,15 @@ class IrisGridContextMenuHandler extends GridMouseHandler {
       isFilterBarShown,
       quickFilters,
       advancedFilters,
-      selectedRanges,
+      selectedRanges: stateSelectedRanges,
     } = irisGrid.state;
 
+    const selectedRanges = GridSelectionMouseHandler.getLatestSelection(
+      stateSelectedRanges,
+      columnIndex,
+      rowIndex
+    );
+
     assertNotNull(metrics);
 
     const { columnHeaderHeight, gridY, columnHeaderMaxDepth } = metrics;