refactor!: improve TreeGridElement APIs for scrolling to rows (#8093)

vursen · web-flow · commit 3198f4ce81b4 · 2025-10-01T14:42:02.000+02:00
diff --git a/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/LazyLoadingTreeGridRefreshAllIT.java b/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/LazyLoadingTreeGridRefreshAllIT.java
@@ -38,7 +38,7 @@ public void setChildCountAndRefreshAll_resultIsNotEmpty() {
 
         // The row index should be larger than 100 in order to replicate the
         // issue.
-        treeGrid.scrollToRow(120);
+        treeGrid.scrollToRowByPath(120);
 
         // The count should be smaller than 100 in order to replicate the issue.
         IntegerFieldElement childCount = $(IntegerFieldElement.class)
diff --git a/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeComponentColumnsIT.java b/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeComponentColumnsIT.java
@@ -98,7 +98,7 @@ public void treegridComponentRenderer_expandScrollExpand_expectedRowHeights() {
         var rowHeight = compThenGrid.getRow(1).getSize().getHeight();
         compThenGrid.expandWithClick(0);
         compThenGrid.expandWithClick(1);
-        compThenGrid.scrollToRow(104);
+        compThenGrid.scrollToRowByPath(104);
 
         var visibleRows = compThenGrid.getVisibleRows();
         Assert.assertFalse(visibleRows.isEmpty());
diff --git a/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridDetachAttachIT.java b/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridDetachAttachIT.java
@@ -41,7 +41,7 @@ public void before() {
 
     @Test
     public void scrollDown_detach_attach_firstItemsRendered() {
-        grid.scrollToRow(150);
+        grid.scrollToRowByPath(150);
 
         toggleAttachedButton.click();
         toggleAttachedButton.click();
diff --git a/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridHugeTreeIT.java b/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridHugeTreeIT.java
@@ -39,24 +39,24 @@ public void toggle_expand_when_row_out_of_cache() {
 
         grid.expandWithClick(2);
         grid.expandWithClick(3);
-        grid.scrollToRow(300);
+        grid.scrollToRowByPath(300);
 
         expandSecondRowButton.click();
 
-        grid.scrollToRow(0);
+        grid.scrollToRowByPath(0);
         assertCellTexts(0, 0, new String[] { "Granddad 0", "Granddad 1",
                 "Dad 1/0", "Dad 1/1", "Dad 1/2", "Granddad 2", "Dad 2/0" });
 
-        grid.scrollToRow(300);
+        grid.scrollToRowByPath(300);
         collapseSecondRowButton.click();
-        grid.scrollToRow(0);
+        grid.scrollToRowByPath(0);
         assertCellTexts(0, 0, new String[] { "Granddad 0", "Granddad 1",
                 "Granddad 2", "Dad 2/0" });
 
-        grid.scrollToRow(300);
+        grid.scrollToRowByPath(300);
         expandSecondRowButton.click();
         collapseSecondRowButton.click();
-        grid.scrollToRow(0);
+        grid.scrollToRowByPath(0);
         assertCellTexts(0, 0, new String[] { "Granddad 0", "Granddad 1",
                 "Granddad 2", "Dad 2/0" });
     }
@@ -96,7 +96,7 @@ public void root_keys_dropped_from_keymapper_properly() {
 
         // Scroll first root item way out of viewport and check that the key was
         // dropped
-        grid.scrollToRow(200);
+        grid.scrollToRowByPath(200);
         checkFirstRootItemKey.click();
         Assert.assertEquals(
                 "First root key was in KeyMapper when it should not be",
@@ -127,7 +127,7 @@ public void collapsed_subtrees_outside_of_cache_stay_expanded() {
         for (int i = 0; i < assumedCachedSize; i++) {
             cellTexts[i] = grid.getCellWaitForRow(i, 0).getText();
         }
-        grid.scrollToRowAndWait(0);
+        grid.scrollToRowByPath(0);
         grid.collapseWithClick(1);
         grid.expandWithClick(1);
 
@@ -145,11 +145,11 @@ public void expanded_nodes_populate_after_scroll() {
         $("button").id("expand-recursively").click();
 
         // Scroll as far as possible
-        grid.scrollToRowAndWait(1000000);
+        grid.scrollToRowByPath(1000000);
         assertExpandedNodesPopulated(grid);
 
         // Repeat
-        grid.scrollToRowAndWait(1000000);
+        grid.scrollToRowByPath(1000000);
         assertExpandedNodesPopulated(grid);
     }
 
diff --git a/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridPreloadIT.java b/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridPreloadIT.java
@@ -128,7 +128,7 @@ public void firstExpanded_initiallySorted_shouldPreLoadDataForExpandedChildren()
     @Test
     public void expandedOnSecondPage_scrollToIndex_shouldHaveItemExpanded() {
         open(Arrays.asList(70), null, 100, 1, null);
-        getTreeGrid().scrollToRow(70);
+        getTreeGrid().scrollToRowByPath(70);
         verifyRow(71, "/0/70/1/0");
     }
 
@@ -137,7 +137,7 @@ public void expandedOnSecondPage_scrollToIndex_shouldPreLoadDataForExpandedChild
         open(Arrays.asList(70), null, 100, 1, null);
         requestCountReset.click();
 
-        getTreeGrid().scrollToRow(70);
+        getTreeGrid().scrollToRowByPath(70);
         Assert.assertEquals("1", requestCount.getValue());
     }
 
@@ -149,22 +149,9 @@ private void verifyRow(int rowActualIndex, String itemId) {
     @Test
     public void multipleExpanded_shouldExpandWhenScrolledTo() {
         open(Arrays.asList(0, 2), null, null, null, null);
-        // Scroll to the last index
-        // TODO: Update to use getTreeGrid().scrollToRowAndWait with multiple
-        // arguments once the API is available
-        getTreeGrid().getCommandExecutor().executeScript(
-                "arguments[0].scrollToIndex(2, 2, 2, 2, 2)", getTreeGrid());
-
-        waitUntil(w -> {
-            try {
-                return getTreeGrid().getCell("/0/2/1/2/2/2/3/2/4/2") != null;
-            } catch (RuntimeException e) {
-                return false;
-            }
-        });
-
-        Assert.assertEquals("/0/2/1/2/2/2/3/2/4/2", getTreeGrid()
-                .getCell(getTreeGrid().getLastVisibleRowIndex(), 0).getText());
+        int rowIndex = getTreeGrid().scrollToRowByPath(2, 2, 2, 2, 2);
+        Assert.assertEquals("/0/2/1/2/2/2/3/2/4/2",
+                getTreeGrid().getCell(rowIndex, 0).getText());
     }
 
     @Test
diff --git a/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridRefreshAllIT.java b/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridRefreshAllIT.java
@@ -56,7 +56,7 @@ public void expandItems_scroll_refreshAll_loadingStateResolved() {
         getTreeGrid().expandWithClick(0);
         getTreeGrid().expandWithClick(1);
 
-        getTreeGrid().scrollToRow(100);
+        getTreeGrid().scrollToRowByPath(100);
 
         refreshAllButton.click();
 
@@ -68,11 +68,11 @@ public void expandItems_scroll_refreshAll_scrollBack_expandedItemsRendered() {
         getTreeGrid().expandWithClick(0);
         getTreeGrid().expandWithClick(1);
 
-        getTreeGrid().scrollToRow(100);
+        getTreeGrid().scrollToRowByPath(100);
 
         refreshAllButton.click();
 
-        getTreeGrid().scrollToRow(0);
+        getTreeGrid().scrollToRowByPath(0);
 
         assertCellTexts(0, 0,
                 new String[] { "0 | 0", "1 | 0", "2 | 0", "2 | 1", "2 | 2" });
@@ -95,7 +95,7 @@ public void scrollToEnd_selectRootItem_refreshAll_lastRootItemRendered() {
         TreeGridElement grid = $(TreeGridElement.class)
                 .id("grid-with-page-size");
 
-        grid.scrollToRow(20);
+        grid.scrollToRowByPath(20);
 
         grid.select(14);
 
diff --git a/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridRefreshItemIT.java b/vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridRefreshItemIT.java
@@ -55,11 +55,11 @@ public void expandRootItem_refreshChildItem_childItemRefreshed() {
     public void expandRootItem_scrollToBottom_refreshChildItem_scrollToTop_childItemRefreshed() {
         treeGrid.expandWithClick(0);
 
-        treeGrid.scrollToRow(99);
+        treeGrid.scrollToRowByPath(99);
         assertRowContents(treeGrid.getRowCount() - 1, "Item 99");
 
         clickElementWithJs("refresh-item-0-1");
-        treeGrid.scrollToRow(0);
+        treeGrid.scrollToRowByPath(0);
 
         assertRowContents(0, "Item 0", "Item 0-0", "Updated", "Item 0-2",
                 "Item 1");
diff --git a/vaadin-grid-flow-parent/vaadin-grid-flow/src/main/resources/META-INF/resources/frontend/treeGridConnector.ts b/vaadin-grid-flow-parent/vaadin-grid-flow/src/main/resources/META-INF/resources/frontend/treeGridConnector.ts
@@ -62,6 +62,8 @@ window.Vaadin.Flow.treeGridConnector.initLazy = function (grid) {
     grid._scrollToFlatIndex(flatIndex);
 
     delete grid.__pendingScrollToIndexes;
+
+    return flatIndex;
   };
 
   grid.__getRowLevel = function (row) {
diff --git a/vaadin-grid-flow-parent/vaadin-grid-testbench/src/main/java/com/vaadin/flow/component/grid/testbench/GridElement.java b/vaadin-grid-flow-parent/vaadin-grid-testbench/src/main/java/com/vaadin/flow/component/grid/testbench/GridElement.java
@@ -54,14 +54,9 @@ public void scrollToRow(int row) {
         waitUntilLoadingFinished();
     }
 
-    /**
-     * Scrolls to the row with the given flat row index.
-     *
-     * @param row
-     *            the row to scroll to
-     */
-    protected void scrollToFlatRow(int row) {
-        callFunction("_scrollToFlatIndex", row);
+    void scrollToRowByFlatIndex(int rowFlatIndex) {
+        waitUntilLoadingFinished();
+        callFunction("_scrollToFlatIndex", rowFlatIndex);
         waitUntilLoadingFinished();
     }
 
@@ -130,7 +125,7 @@ public GridTHTDElement getCell(int rowIndex, int colIndex) {
      */
     public GridTHTDElement getCell(int rowIndex, GridColumnElement column) {
         if (!isRowInView(rowIndex)) {
-            scrollToFlatRow(rowIndex);
+            scrollToRowByFlatIndex(rowIndex);
         }
 
         GridTRElement row = getRow(rowIndex);
@@ -266,7 +261,7 @@ public GridTRElement getRow(int rowIndex) throws IndexOutOfBoundsException {
     public GridTRElement getRow(int rowIndex, boolean scroll)
             throws IndexOutOfBoundsException {
         if (scroll && !isRowInView(rowIndex)) {
-            scrollToFlatRow(rowIndex);
+            scrollToRowByFlatIndex(rowIndex);
         }
         var rows = getRows(rowIndex, rowIndex);
         return rows.size() == 1 ? rows.get(0) : null;
diff --git a/vaadin-grid-flow-parent/vaadin-grid-testbench/src/main/java/com/vaadin/flow/component/grid/testbench/TreeGridElement.java b/vaadin-grid-flow-parent/vaadin-grid-testbench/src/main/java/com/vaadin/flow/component/grid/testbench/TreeGridElement.java
