Skip to content

Commit e949bcf

Browse files
authored
feat: detect accidental sharing of ValueSignal with background threads (#23555)
When a ValueSignal instance has been used with modify() and also accessed without a locked VaadinSession, throw an IllegalStateException with guidance to use immutable values instead. This prevents silent data races because modify() temporarily releases its internal lock while the modifie callback runs, relying on the session lock for external synchronization. Fixes #23537
1 parent 8d0fdb7 commit e949bcf

4 files changed

Lines changed: 113 additions & 27 deletions

File tree

‎flow-server/src/main/java/com/vaadin/flow/signals/local/ValueSignal.java‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
import org.jspecify.annotations.Nullable;
2222

2323
import com.vaadin.flow.function.SerializableConsumer;
24+
import com.vaadin.flow.server.VaadinSession;
2425
import com.vaadin.flow.signals.Signal;
2526
import com.vaadin.flow.signals.function.SignalModifier;
2627
import com.vaadin.flow.signals.function.SignalUpdater;
@@ -54,6 +55,8 @@
5455
public class ValueSignal<T> extends AbstractLocalSignal<T> {
5556

5657
private boolean modifyRunning = false;
58+
private transient boolean modifyUsed = false;
59+
private transient boolean usedWithoutSessionLock = false;
5760

5861
/**
5962
* Creates a new value signal with the given initial value.
@@ -85,6 +88,24 @@ protected void checkPreconditions() {
8588
if (modifyRunning) {
8689
throw new ConcurrentModificationException();
8790
}
91+
92+
// Track if the signal has ever been accessed without a locked session
93+
VaadinSession session = VaadinSession.getCurrent();
94+
if (session == null || !session.hasLock()) {
95+
usedWithoutSessionLock = true;
96+
}
97+
98+
if (modifyUsed && usedWithoutSessionLock) {
99+
throw new IllegalStateException(
100+
"This ValueSignal instance has been used with modify() "
101+
+ "and accessed without holding the session lock. "
102+
+ "This is not thread-safe because modify() works "
103+
+ "with mutable values without holding a lock while "
104+
+ "the modifier callback runs. Use immutable values "
105+
+ "with set(), replace(), or update() instead of "
106+
+ "modify() when the signal is shared between "
107+
+ "threads.");
108+
}
88109
}
89110

90111
/**
@@ -198,6 +219,7 @@ public void modify(ValueModifier<T> modifier) {
198219
try {
199220
checkPreconditions();
200221

222+
modifyUsed = true;
201223
modifyRunning = true;
202224
} finally {
203225
unlock();

‎flow-server/src/test/java/com/vaadin/flow/dom/SignalsUnitTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import com.vaadin.flow.server.MockVaadinServletService;
2828
import com.vaadin.flow.server.MockVaadinSession;
2929
import com.vaadin.flow.server.VaadinService;
30+
import com.vaadin.flow.server.VaadinSession;
3031
import com.vaadin.tests.util.MockUI;
3132

3233
import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -73,6 +74,7 @@ private LinkedList<ErrorEvent> mockLockedSessionWithErrorHandler() {
7374

7475
var session = new MockVaadinSession(service);
7576
session.lock();
77+
VaadinSession.setCurrent(session);
7678

7779
// UI is set to field to avoid too eager GC due to WeakReference in
7880
// CurrentInstance.

‎flow-server/src/test/java/com/vaadin/flow/signals/local/ValueSignalHelperTest.java‎

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import org.junit.jupiter.api.Test;
1919

2020
import com.vaadin.flow.function.SerializableConsumer;
21+
import com.vaadin.flow.server.MockVaadinSession;
2122
import com.vaadin.flow.signals.SignalTestBase;
2223

2324
import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -152,60 +153,73 @@ void modifier_returnsCallback() {
152153
}
153154

154155
@Test
155-
void modifier_callbackModifiesSignalInPlace() {
156+
void modifier_callbackModifiesSignalInPlace() throws Exception {
156157
MutablePerson person = new MutablePerson("Alice", 30);
157158
ValueSignal<MutablePerson> signal = new ValueSignal<>(person);
158159
SerializableConsumer<String> callback = signal
159160
.modifier(MutablePerson::setName);
160161

161-
callback.accept("Bob");
162+
new MockVaadinSession().runWithLock(() -> {
163+
callback.accept("Bob");
162164

163-
assertEquals("Bob", signal.get().getName());
164-
assertEquals(30, signal.get().getAge());
165-
assertEquals(person, signal.get());
165+
assertEquals("Bob", signal.get().getName());
166+
assertEquals(30, signal.get().getAge());
167+
assertEquals(person, signal.get());
168+
return null;
169+
});
166170
}
167171

168172
@Test
169-
void modifier_multipleCallbackInvocations_modifiesSignalEachTime() {
173+
void modifier_multipleCallbackInvocations_modifiesSignalEachTime()
174+
throws Exception {
170175
MutablePerson person = new MutablePerson("Alice", 30);
171176
ValueSignal<MutablePerson> signal = new ValueSignal<>(person);
172177
SerializableConsumer<String> callback = signal
173178
.modifier(MutablePerson::setName);
174179

175-
callback.accept("Bob");
176-
assertEquals("Bob", signal.get().getName());
180+
new MockVaadinSession().runWithLock(() -> {
181+
callback.accept("Bob");
182+
assertEquals("Bob", signal.get().getName());
177183

178-
callback.accept("Charlie");
179-
assertEquals("Charlie", signal.get().getName());
184+
callback.accept("Charlie");
185+
assertEquals("Charlie", signal.get().getName());
180186

181-
callback.accept("Diana");
182-
assertEquals("Diana", signal.get().getName());
187+
callback.accept("Diana");
188+
assertEquals("Diana", signal.get().getName());
189+
return null;
190+
});
183191
}
184192

185193
@Test
186-
void modifier_preservesOtherFields() {
194+
void modifier_preservesOtherFields() throws Exception {
187195
MutablePerson person = new MutablePerson("Alice", 30);
188196
ValueSignal<MutablePerson> signal = new ValueSignal<>(person);
189197
SerializableConsumer<String> nameCallback = signal
190198
.modifier(MutablePerson::setName);
191199

192-
nameCallback.accept("Bob");
200+
new MockVaadinSession().runWithLock(() -> {
201+
nameCallback.accept("Bob");
193202

194-
assertEquals("Bob", signal.get().getName());
195-
assertEquals(30, signal.get().getAge());
203+
assertEquals("Bob", signal.get().getName());
204+
assertEquals(30, signal.get().getAge());
205+
return null;
206+
});
196207
}
197208

198209
@Test
199-
void modifier_withNullValue_works() {
210+
void modifier_withNullValue_works() throws Exception {
200211
MutablePerson person = new MutablePerson("Alice", 30);
201212
ValueSignal<MutablePerson> signal = new ValueSignal<>(person);
202213
SerializableConsumer<String> callback = signal
203214
.modifier(MutablePerson::setName);
204215

205-
callback.accept(null);
216+
new MockVaadinSession().runWithLock(() -> {
217+
callback.accept(null);
206218

207-
assertNull(signal.get().getName());
208-
assertEquals(30, signal.get().getAge());
219+
assertNull(signal.get().getName());
220+
assertEquals(30, signal.get().getAge());
221+
return null;
222+
});
209223
}
210224

211225
}

‎flow-server/src/test/java/com/vaadin/flow/signals/local/ValueSignalTest.java‎

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323

2424
import org.junit.jupiter.api.Test;
2525

26+
import com.vaadin.flow.server.MockVaadinSession;
2627
import com.vaadin.flow.signals.Signal;
2728
import com.vaadin.flow.signals.SignalTestBase;
2829
import com.vaadin.flow.signals.impl.UsageTracker;
@@ -110,17 +111,20 @@ void update_callbackThrows_exceptionPropagated() {
110111
}
111112

112113
@Test
113-
void modify_modifiesValue_valueModified() {
114+
void modify_modifiesValue_valueModified() throws Exception {
114115
String[] holder = new String[] { "initial" };
115116
ValueSignal<String[]> signal = new ValueSignal<>(holder);
116117

117-
signal.modify(value -> {
118-
assertSame(holder, value);
119-
holder[0] = "update";
120-
});
118+
new MockVaadinSession().runWithLock(() -> {
119+
signal.modify(value -> {
120+
assertSame(holder, value);
121+
holder[0] = "update";
122+
});
121123

122-
assertEquals("update", holder[0]);
123-
assertSame(holder, signal.get());
124+
assertEquals("update", holder[0]);
125+
assertSame(holder, signal.get());
126+
return null;
127+
});
124128
}
125129

126130
@Test
@@ -424,6 +428,50 @@ void transactions_writeSignalInTransaction_throws() {
424428
});
425429
}
426430

431+
@Test
432+
void threadSafety_modifyWithSessionLock_noException() throws Exception {
433+
MockVaadinSession session = new MockVaadinSession();
434+
435+
ValueSignal<String[]> signal = new ValueSignal<>(
436+
new String[] { "initial" });
437+
438+
session.runWithLock(() -> {
439+
signal.modify(value -> value[0] = "modified");
440+
signal.get();
441+
signal.set(new String[] { "new" });
442+
return null;
443+
});
444+
}
445+
446+
@Test
447+
void threadSafety_modifyWithSessionThenAccessWithoutLock_throws()
448+
throws Exception {
449+
MockVaadinSession session = new MockVaadinSession();
450+
451+
ValueSignal<String[]> signal = new ValueSignal<>(
452+
new String[] { "initial" });
453+
454+
session.runWithLock(() -> {
455+
signal.modify(value -> value[0] = "modified");
456+
return null;
457+
});
458+
459+
Thread other = Thread.startVirtualThread(() -> {
460+
assertThrows(IllegalStateException.class, () -> signal.get());
461+
});
462+
other.join();
463+
}
464+
465+
@Test
466+
void threadSafety_modifyWithoutSessionThenAccess_throws() {
467+
ValueSignal<String[]> signal = new ValueSignal<>(
468+
new String[] { "initial" });
469+
470+
signal.modify(value -> value[0] = "modified");
471+
472+
assertThrows(IllegalStateException.class, () -> signal.get());
473+
}
474+
427475
private static void assertEventually(BooleanSupplier test) {
428476
for (int i = 0; i < 10; i++) {
429477
if (test.getAsBoolean()) {

0 commit comments

Comments
 (0)