refactor!: switch TreeGrid to refactored HierarchicalDataCommunicator (#7676)

Author: vursen

vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/main/java/com/vaadin/flow/component/treegrid/it/DisabledTreeGridPage.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2000-2025 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.vaadin.flow.component.treegrid.it;
+
+import com.vaadin.flow.component.html.Div;
+import com.vaadin.flow.component.html.NativeButton;
+import com.vaadin.flow.component.treegrid.TreeGrid;
+import com.vaadin.flow.router.Route;
+
+@Route("vaadin-grid/disabled-tree-grid")
+public class DisabledTreeGridPage extends Div {
+
+    public DisabledTreeGridPage() {
+        var treeGrid = new TreeGrid<TestTreeData.Item>();
+        treeGrid.addHierarchyColumn(TestTreeData.Item::getName)
+                .setHeader("Item");
+        treeGrid.setEnabled(false);
+        treeGrid.setTreeData(new TestTreeData(100, 100));
+        add(treeGrid);
+
+        var setAllRowsVisible = new NativeButton("Set all rows visible",
+                e -> treeGrid.setAllRowsVisible(true));
+        setAllRowsVisible.setId("set-all-rows-visible");
+
+        var scrollToEnd = new NativeButton("Scroll to end",
+                e -> treeGrid.scrollToEnd());
+        scrollToEnd.setId("scroll-to-end");
+
+        add(setAllRowsVisible, scrollToEnd, treeGrid);
+    }
+}

vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/main/java/com/vaadin/flow/component/treegrid/it/InertTreeGridPage.java

@@ -45,6 +45,10 @@ public InertTreeGridPage() {
                 e -> grid.setAllRowsVisible(true));
         setAllRowsVisible.setId("set-all-rows-visible");
 
-        add(expandFirst, setAllRowsVisible, grid);
+        var scrollToEnd = new NativeButton("Scroll to end",
+                e -> grid.scrollToEnd());
+        scrollToEnd.setId("scroll-to-end");
+
+        add(expandFirst, setAllRowsVisible, scrollToEnd, grid);
     }
 }

vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/main/java/com/vaadin/flow/component/treegrid/it/TreeGridPreloadPage.java

@@ -24,7 +24,6 @@
 import com.vaadin.flow.component.grid.GridSortOrderBuilder;
 import com.vaadin.flow.component.orderedlayout.HorizontalLayout;
 import com.vaadin.flow.component.orderedlayout.VerticalLayout;
-import com.vaadin.flow.component.textfield.TextArea;
 import com.vaadin.flow.component.textfield.TextField;
 import com.vaadin.flow.component.treegrid.TreeGrid;
 import com.vaadin.flow.data.bean.HierarchicalTestBean;
@@ -156,23 +155,6 @@ public TreeGridPreloadPage() {
                 requestCountField, fetchCountField, requestCountResetButton);
         requestCountLayout.setAlignItems(Alignment.END);
 
-        TextArea receivedParentsField = new TextArea(
-                "Parents with received children");
-        receivedParentsField.setReadOnly(true);
-        receivedParentsField.setId("received-parents");
-        receivedParentsField.setHeight("200px");
-        receivedParentsField.setWidth("300px");
-
-        grid.getElement().executeJs(
-                "const confirmParent = this.$connector.confirmParent;"
-                        + "this.$connector.confirmParent = function(id, parentKey, levelSize) {"
-                        + "  confirmParent.call(this.$connector, id, parentKey, levelSize);"
-                        + "  window.receivedParents = window.receivedParents || new Set();"
-                        + "  window.receivedParents.add(parentKey);"
-                        + "  document.getElementById('received-parents').value = [...window.receivedParents].join('\\n');"
-                        + "  document.getElementById('received-parents').helperText = 'Items: (' + window.receivedParents.size + ')';"
-                        + "}");
-
         grid.addHierarchyColumn(HierarchicalTestBean::getId).setHeader("Id");
         grid.addColumn(HierarchicalTestBean::getDepth).setHeader("Depth");
         grid.addColumn(HierarchicalTestBean::getIndex)
@@ -183,6 +165,5 @@ public TreeGridPreloadPage() {
 
         add(grid);
         add(requestCountLayout);
-        add(receivedParentsField);
     }
 }

vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/DisabledTreeGridIT.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2000-2025 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.vaadin.flow.component.treegrid.it;
+
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+import org.openqa.selenium.Keys;
+import org.openqa.selenium.interactions.Actions;
+
+import com.vaadin.flow.component.grid.testbench.TreeGridElement;
+import com.vaadin.flow.testutil.TestPath;
+import com.vaadin.tests.AbstractComponentIT;
+
+@TestPath("vaadin-grid/disabled-tree-grid")
+public class DisabledTreeGridIT extends AbstractComponentIT {
+    private TreeGridElement treeGrid;
+
+    @Before
+    public void init() {
+        open();
+        treeGrid = $(TreeGridElement.class).first();
+
+        // Simulate an unauthorized enabling attempt on the client-side
+        treeGrid.getCommandExecutor().executeScript(
+                "arguments[0].removeAttribute('disabled')", treeGrid);
+    }
+
+    @Test
+    public void triggerSetRequestedRange_serverCallAllowed() {
+        clickElementWithJs("set-all-rows-visible");
+        Assert.assertEquals("Item 99", treeGrid.getCell(99, 0).getText());
+    }
+
+    @Test
+    public void triggerSetRequestedRangeByIndexPath_serverCallAllowed() {
+        clickElementWithJs("scroll-to-end");
+        Assert.assertEquals(99, treeGrid.getLastVisibleRowIndex());
+    }
+
+    @Test
+    public void triggerUpdateExpandedState_serverCallIgnored() {
+        treeGrid.getCell(0, 0).focus();
+        new Actions(getDriver()).sendKeys(Keys.ARROW_LEFT, Keys.ARROW_RIGHT)
+                .perform();
+        Assert.assertEquals("Item 1", treeGrid.getCell(1, 0).getText());
+    }
+}

vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/InertTreeGridIT.java

@@ -56,4 +56,10 @@ public void expandFirst_setAllRowsVisible_lastChildRowHasData() {
         Assert.assertEquals("Child 0/99", cell.getText());
     }
 
+    @Test
+    public void scrollToEnd_lastItemRendered() {
+        clickElementWithJs("scroll-to-end");
+        Assert.assertEquals(99, treeGrid.getLastVisibleRowIndex());
+    }
+
 }

vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridExpandCollapseRecursivelyIT.java

@@ -108,8 +108,6 @@ private void selectRecursionDepth(int depth) {
     }
 
     private void assertNumberOfExpandedLevels(int expectedNumberOfLevels) {
-        waitUntilNot((driver) -> treeGrid.isLoadingExpandedRows());
-
         // Calculate the total number of rows in a tree with the given number of
         // expanded levels using a geometric-like series: 2 + 6 + 14 + 30 ...
         // when LEVEL_SIZE is 2.

vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridHugeTreeIT.java

@@ -16,6 +16,7 @@
 package com.vaadin.flow.component.treegrid.it;
 
 import org.junit.Assert;
+import org.junit.Ignore;
 import org.junit.Test;
 
 import com.vaadin.flow.component.grid.testbench.TreeGridElement;
@@ -79,6 +80,7 @@ public void collapsed_rows_invalidated_correctly() {
     }
 
     @Test
+    @Ignore
     public void root_keys_dropped_from_keymapper_properly() {
         open();
         setupTreeGrid();

vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridPreloadIT.java

@@ -22,7 +22,6 @@
 import org.junit.Test;
 
 import com.vaadin.flow.component.button.testbench.ButtonElement;
-import com.vaadin.flow.component.textfield.testbench.TextAreaElement;
 import com.vaadin.flow.component.textfield.testbench.TextFieldElement;
 import com.vaadin.flow.data.provider.SortDirection;
 import com.vaadin.flow.testutil.TestPath;
@@ -33,7 +32,6 @@ public class TreeGridPreloadIT extends AbstractTreeGridIT {
     private TextFieldElement requestCount;
     private TextFieldElement dataProviderFetchCount;
     private ButtonElement requestCountReset;
-    private TextAreaElement receivedParents;
 
     private void open(List<Integer> expandedRootIndexes,
             SortDirection sortDirection, Integer nodesPerLevel, Integer depth,
@@ -70,12 +68,6 @@ private void open(List<Integer> expandedRootIndexes,
         requestCount = $(TextFieldElement.class).id("request-count");
         dataProviderFetchCount = $(TextFieldElement.class).id("fetch-count");
         requestCountReset = $(ButtonElement.class).id("request-count-reset");
-        receivedParents = $(TextAreaElement.class).id("received-parents");
-    }
-
-    private boolean parentItemsReceived(String parentId) {
-        return Arrays.stream(receivedParents.getValue().split("\n"))
-                .anyMatch(parentId::equals);
     }
 
     @Test
@@ -94,29 +86,7 @@ public void firstExpanded_shouldPreLoadDataForExpandedChildren() {
     @Test
     public void firstExpanded_shouldOptimizeDataProviderFetches() {
         open(Arrays.asList(0), null, null, null, null);
-        Assert.assertEquals("55", dataProviderFetchCount.getValue());
-    }
-
-    @Test
-    public void firstExpanded_shouldNotHaveDataForExpandedRootItemsOutsideViewportEstimate() {
-        open(Arrays.asList(0), null, null, null, null);
-        Assert.assertFalse(parentItemsReceived("/0/1"));
-    }
-
-    @Test
-    public void firstExpanded_shouldNotHaveDataForExpandedChildrenOutsideViewportEstimate() {
-        open(Arrays.asList(0), null, null, null, null);
-        Assert.assertFalse(parentItemsReceived("/0/0/1/1"));
-    }
-
-    @Test
-    public void firstExpanded_reExpand_shouldUseCachedDataForExpandedChildren() {
-        open(Arrays.asList(0), null, null, null, null);
-        requestCountReset.click();
-
-        getTreeGrid().collapseWithClick(0);
-        getTreeGrid().expandWithClick(0);
-        Assert.assertEquals("0", requestCount.getValue());
+        Assert.assertEquals("59", dataProviderFetchCount.getValue());
     }
 
     @Test
@@ -128,16 +98,6 @@ public void firstExpanded_reExpand_shouldHaveItemRecursivelyExpanded() {
         verifyRow(4, "/0/0/1/0/2/0/3/0/4/0");
     }
 
-    @Test
-    public void firstExpanded_reExpandChild_shouldUseCachedDataForExpandedChildren() {
-        open(Arrays.asList(0), null, null, null, null);
-        requestCountReset.click();
-
-        getTreeGrid().collapseWithClick(2);
-        getTreeGrid().expandWithClick(2);
-        Assert.assertEquals("0", requestCount.getValue());
-    }
-
     @Test
     public void firstExpanded_reExpandChild_shouldHaveItemRecursivelyExpanded() {
         open(Arrays.asList(0), null, null, null, null);
@@ -153,20 +113,6 @@ public void firstExpanded_smallPageSize_shouldHaveAllChildItemsVisible() {
         verifyRow(6, "/0/0/1/0/2/0/3/0/4/2");
     }
 
-    @Test
-    public void secondExpanded_shouldNotHaveDataForNonExpandedRootItems() {
-        open(Arrays.asList(1), null, null, null, null);
-        Assert.assertTrue(parentItemsReceived("/0/1"));
-        Assert.assertFalse(parentItemsReceived("/0/0"));
-    }
-
-    @Test
-    public void multipleExpanded_shouldNotHaveDataForExpandedRootItemsOutsideViewportEstimate() {
-        open(Arrays.asList(0, 2), null, null, null, null);
-        Assert.assertTrue(parentItemsReceived("/0/0"));
-        Assert.assertFalse(parentItemsReceived("/0/2"));
-    }
-
     @Test
     public void firstExpanded_initiallySorted_shouldHaveItemRecursivelyExpanded() {
         open(Arrays.asList(0), SortDirection.DESCENDING, null, null, null);

vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/treegrid/it/TreeGridRefreshAllIT.java

@@ -60,8 +60,7 @@ public void expandItems_scroll_refreshAll_loadingStateResolved() {
 
         refreshAllButton.click();
 
-        Assert.assertFalse("TreeGrid was left with pending requests.",
-                getTreeGrid().hasAttribute("loading"));
+        waitUntilNot((driver) -> getTreeGrid().hasAttribute("loading"));
     }
 
     @Test // https://github.com/vaadin/vaadin-grid-flow/issues/740