fix: use targeted item refresh when signal-bound item value changes by Artur- · Pull Request #23913 · vaadin/flow

Artur- · 2026-03-17T09:19:25Z

Thread old item identity through DataRefreshEvent so that KeyMapper can remap keys when an item is replaced with a new instance (different identity). This replaces the refreshAll() workaround with a targeted single-item refresh for signal-bound grid items.

Fixes vaadin/flow-components#8938

Thread old item identity through DataRefreshEvent so that KeyMapper can remap keys when an item is replaced with a new instance (different identity). This replaces the refreshAll() workaround with a targeted single-item refresh for signal-bound grid items. Fixes #8938

...data/src/main/java/com/vaadin/flow/data/provider/hierarchy/HierarchicalDataCommunicator.java

flow-data/src/main/java/com/vaadin/flow/data/provider/AbstractDataProvider.java

flow-data/src/main/java/com/vaadin/flow/data/provider/DataCommunicator.java

flow-data/src/main/java/com/vaadin/flow/data/provider/DataKeyMapper.java

flow-data/src/test/java/com/vaadin/flow/data/provider/KeyMapperTest.java

github-actions · 2026-03-17T09:43:39Z

Test Results

1 388 files +1 1 388 suites +1 1h 28m 43s ⏱️ +49s
9 925 tests +2 9 854 ✅ +2 71 💤 ±0 0 ❌ ±0
10 398 runs +2 10 318 ✅ +2 80 💤 ±0 0 ❌ ±0

Results for commit e28fefb. ± Comparison against base commit 7891d15.

♻️ This comment has been updated with latest results.

- Rename refreshWithOldData to refresh overload for clarity - Replace "threading" terminology with clearer wording in javadocs - Simplify handleDataRefreshEvent to always use refresh(item, oldItem) - Make DataKeyMapper.refresh(T, T) throw instead of silently discarding - Add item swap in HierarchicalDataCommunicator cache context - Add key reuse assertion in KeyMapperTest - Fix spotless formatting

flow-data/src/main/java/com/vaadin/flow/data/provider/hierarchy/Cache.java

- Move rootCache context update into Cache.refreshItem(T, T) to avoid memory leaks and keep remapping logic encapsulated - Update indexToItemId mapping when item identity changes - Fix AbstractLazyDataViewTest to verify two-arg refresh calls

flow-data/src/main/java/com/vaadin/flow/data/provider/hierarchy/Cache.java

flow-data/src/main/java/com/vaadin/flow/data/provider/AbstractDataView.java

- Remove Cache.refreshItem(T, T) identity-changing overload - HierarchicalDataCommunicator.refresh(T, T) throws when identities differ, deferring TreeGrid bindItems support to a future change - AbstractDataView.replaceItem throws for non-AbstractDataProvider - DataViewUtils throws for non-AbstractDataView signal bindings

flow-data/src/main/java/com/vaadin/flow/data/provider/DataViewUtils.java

- Add DataProvider.replaceItem(T oldItem, T newItem) as default method - Add DataView.replaceItem(T oldItem, T newItem) to the interface - Make DataRefreshEvent.getOldItem() public - AbstractDataProvider overrides replaceItem to fire event with old item - AbstractDataView.replaceItem delegates to DataProvider.replaceItem - Remove all instanceof checks from DataViewUtils and AbstractDataView

flow-data/src/main/java/com/vaadin/flow/data/provider/DataChangeEvent.java

flow-data/src/main/java/com/vaadin/flow/data/provider/KeyMapper.java

Swap parameter order in DataKeyMapper.refresh, KeyMapper.refresh, and DataCommunicator.refresh to match the (oldItem, newItem) convention used by DataProvider.replaceItem and DataView.replaceItem.

...data/src/main/java/com/vaadin/flow/data/provider/hierarchy/HierarchicalDataCommunicator.java

Align replaceItem methods with the refresh/DataRefreshEvent convention where the new/primary item is always the first parameter.

...data/src/main/java/com/vaadin/flow/data/provider/hierarchy/HierarchicalDataCommunicator.java

flow-data/src/main/java/com/vaadin/flow/data/provider/KeyMapper.java

Align DataKeyMapper.refresh, KeyMapper.refresh, DataCommunicator.refresh, and HierarchicalDataCommunicator.refresh with the convention where the new/primary item is always the first parameter, matching refresh(T data) and replaceItem(T newItem, T oldItem).

Without this override, the default DataProvider.replaceItem falls back to refreshItem, losing the old item identity.

Use refreshItem(T newItem, T oldItem) as an overload of the existing refreshItem(T item), keeping naming consistent within DataProvider and DataView.

sonarqubecloud · 2026-03-17T14:17:20Z

Quality Gate passed

Issues
1464 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

…23913) - Add a two-argument `refreshItem(T newItem, T oldItem)` overload to `DataProvider`, `DataView`, and related classes, enabling targeted refresh when an item's identity changes (e.g., signal-bound items replaced with new instances) - `DataRefreshEvent` now carries an optional old item reference via `getOldItem()`, allowing`DataCommunicator` and `KeyMapper` to remap from the old identity to the new one instead of failing to find the item - `HierarchicalDataCommunicator` throws `UnsupportedOperationException` for identity-changing refreshes, deferring TreeGrid `bindItems` support to a future change Fixes #8938

…23913) (#23922) - Add a two-argument `refreshItem(T newItem, T oldItem)` overload to `DataProvider`, `DataView`, and related classes, enabling targeted refresh when an item's identity changes (e.g., signal-bound items replaced with new instances) - `DataRefreshEvent` now carries an optional old item reference via `getOldItem()`, allowing`DataCommunicator` and `KeyMapper` to remap from the old identity to the new one instead of failing to find the item - `HierarchicalDataCommunicator` throws `UnsupportedOperationException` for identity-changing refreshes, deferring TreeGrid `bindItems` support to a future change Fixes #8938 Co-authored-by: Artur Signell <artur@vaadin.com>

…hanges (#23913) (#23922)" This reverts commit ed04eaa

Artur- requested a review from Legioth March 17, 2026 09:19