Skip to content

Commit 0dc4260

Browse files
authored
fix: Let DataCommunicator#flush keep track of which StateTree is supposed to execute its flushRequest (#14068) (#14188)
DataCommunicator#flush can be stuck when moving between UI instances, for instance when the @PreserveOnRefresh annotation is present.
1 parent 402aaed commit 0dc4260

2 files changed

Lines changed: 55 additions & 15 deletions

File tree

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

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
import com.vaadin.flow.internal.ExecutionContext;
4646
import com.vaadin.flow.internal.JsonUtils;
4747
import com.vaadin.flow.internal.NodeOwner;
48+
import com.vaadin.flow.internal.NullOwner;
4849
import com.vaadin.flow.internal.Range;
4950
import com.vaadin.flow.internal.StateNode;
5051
import com.vaadin.flow.internal.StateTree;
@@ -115,9 +116,8 @@ public class DataCommunicator<T> implements Serializable {
115116

116117
private Registration dataProviderUpdateRegistration;
117118
private HashSet<T> updatedData = new HashSet<>();
118-
119-
private SerializableConsumer<ExecutionContext> flushRequest;
120-
private SerializableConsumer<ExecutionContext> flushUpdatedDataRequest;
119+
private FlushRequest flushRequest;
120+
private FlushRequest flushUpdatedDataRequest;
121121

122122
private CallbackDataProvider.CountCallback<T, ?> countCallback;
123123
private int itemCountEstimate = -1;
@@ -1093,28 +1093,27 @@ private void requestFlush() {
10931093
}
10941094

10951095
private void requestFlush(boolean forced) {
1096-
if ((flushRequest == null || forced) && fetchEnabled) {
1097-
flushRequest = context -> {
1096+
if ((flushRequest == null || !flushRequest.canExecute(stateNode)
1097+
|| forced) && fetchEnabled) {
1098+
flushRequest = FlushRequest.register(stateNode, context -> {
10981099
if (!context.isClientSideInitialized()) {
10991100
reset();
11001101
arrayUpdater.initialize();
11011102
}
11021103
flush();
11031104
flushRequest = null;
1104-
};
1105-
stateNode.runWhenAttached(ui -> ui.getInternals().getStateTree()
1106-
.beforeClientResponse(stateNode, flushRequest));
1105+
});
11071106
}
11081107
}
11091108

11101109
private void requestFlushUpdatedData() {
1111-
if (flushUpdatedDataRequest == null) {
1112-
flushUpdatedDataRequest = context -> {
1113-
flushUpdatedData();
1114-
flushUpdatedDataRequest = null;
1115-
};
1116-
stateNode.runWhenAttached(ui -> ui.getInternals().getStateTree()
1117-
.beforeClientResponse(stateNode, flushUpdatedDataRequest));
1110+
if (flushUpdatedDataRequest == null
1111+
|| !flushUpdatedDataRequest.canExecute(stateNode)) {
1112+
flushUpdatedDataRequest = FlushRequest.register(stateNode,
1113+
context -> {
1114+
flushUpdatedData();
1115+
flushUpdatedDataRequest = null;
1116+
});
11181117
}
11191118
}
11201119

@@ -1476,6 +1475,27 @@ public static Activation empty() {
14761475
}
14771476
}
14781477

1478+
private static class FlushRequest implements Serializable {
1479+
1480+
private NodeOwner owner;
1481+
1482+
static FlushRequest register(StateNode stateNode,
1483+
SerializableConsumer<ExecutionContext> action) {
1484+
FlushRequest request = new FlushRequest();
1485+
request.owner = stateNode.getOwner();
1486+
stateNode.runWhenAttached(ui -> {
1487+
request.owner = stateNode.getOwner();
1488+
ui.getInternals().getStateTree().beforeClientResponse(stateNode,
1489+
action);
1490+
});
1491+
return request;
1492+
}
1493+
1494+
boolean canExecute(StateNode stateNode) {
1495+
return owner instanceof NullOwner || owner == stateNode.getOwner();
1496+
}
1497+
}
1498+
14791499
private static Logger getLogger() {
14801500
return LoggerFactory.getLogger(DataCommunicator.class);
14811501
}

‎flow-data/src/test/java/com/vaadin/flow/data/provider/DataCommunicatorTest.java‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1567,6 +1567,26 @@ public void setRequestedRange_customPageSize_customPageSizeConsidered_itemsReque
15671567
600, queryCaptor.getValue().getLimit());
15681568
}
15691569

1570+
// Simulates a flush request enqueued during a page reload with
1571+
// @PreserveOnRefresh
1572+
// see https://github.com/vaadin/flow/issues/14067
1573+
@Test
1574+
public void reattach_differentUI_requestFlushExecuted() {
1575+
dataCommunicator.setDataProvider(createDataProvider(), null);
1576+
dataCommunicator.setRequestedRange(0, 50);
1577+
1578+
MockUI newUI = new MockUI();
1579+
// simulates preserve on refresh
1580+
// DataCommunicator has a flushRequest pending
1581+
// that should be rescheduled on the new state tree
1582+
newUI.getInternals().moveElementsFrom(ui);
1583+
ui = newUI;
1584+
fakeClientCommunication();
1585+
1586+
Assert.assertEquals("Expected initial full reset.",
1587+
Range.withLength(0, 50), lastSet);
1588+
}
1589+
15701590
@Tag("test-component")
15711591
private static class TestComponent extends Component {
15721592

0 commit comments

Comments
 (0)