Skip to content

Commit 48fd956

Browse files
pujaganipujagani
authored
[bidi] [java] Ensure the listeners returns an id (#14215)
1 parent 5494108 commit 48fd956

3 files changed

Lines changed: 46 additions & 16 deletions

File tree

‎java/src/org/openqa/selenium/bidi/BiDi.java‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ public <X> X send(Command<X> command) {
5151
return connection.sendAndWait(command, timeout);
5252
}
5353

54-
public <X> void addListener(Event<X> event, Consumer<X> handler) {
54+
public <X> long addListener(Event<X> event, Consumer<X> handler) {
5555
Require.nonNull("Event to listen for", event);
5656
Require.nonNull("Handler to call", handler);
5757

5858
send(
5959
new Command<>(
6060
"session.subscribe", Map.of("events", Collections.singletonList(event.getMethod()))));
6161

62-
connection.addListener(event, handler);
62+
return connection.addListener(event, handler);
6363
}
6464

6565
public <X> void addListener(String browsingContextId, Event<X> event, Consumer<X> handler) {
@@ -79,7 +79,7 @@ public <X> void addListener(String browsingContextId, Event<X> event, Consumer<X
7979
connection.addListener(event, handler);
8080
}
8181

82-
public <X> void addListener(Set<String> browsingContextIds, Event<X> event, Consumer<X> handler) {
82+
public <X> long addListener(Set<String> browsingContextIds, Event<X> event, Consumer<X> handler) {
8383
Require.nonNull("List of browsing context ids", browsingContextIds);
8484
Require.nonNull("Event to listen for", event);
8585
Require.nonNull("Handler to call", handler);
@@ -93,7 +93,7 @@ public <X> void addListener(Set<String> browsingContextIds, Event<X> event, Cons
9393
"events",
9494
Collections.singletonList(event.getMethod()))));
9595

96-
connection.addListener(event, handler);
96+
return connection.addListener(event, handler);
9797
}
9898

9999
public <X> void clearListener(Event<X> event) {
@@ -111,6 +111,10 @@ public <X> void clearListener(Event<X> event) {
111111
}
112112
}
113113

114+
public void removeListener(long id) {
115+
connection.removeListener(id);
116+
}
117+
114118
public void clearListeners() {
115119
connection.clearListeners();
116120
}

‎java/src/org/openqa/selenium/bidi/Connection.java‎

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
import java.io.Closeable;
2626
import java.io.StringReader;
2727
import java.time.Duration;
28-
import java.util.ArrayList;
2928
import java.util.HashMap;
3029
import java.util.List;
3130
import java.util.Map;
@@ -66,11 +65,12 @@ public class Connection implements Closeable {
6665
return thread;
6766
});
6867
private static final AtomicLong NEXT_ID = new AtomicLong(1L);
68+
private final AtomicLong EVENT_CALLBACK_ID = new AtomicLong(1);
6969
private WebSocket socket;
7070
private final Map<Long, Consumer<Either<Throwable, JsonInput>>> methodCallbacks =
7171
new ConcurrentHashMap<>();
7272
private final ReadWriteLock callbacksLock = new ReentrantReadWriteLock(true);
73-
private final Map<Event<?>, List<Consumer<?>>> eventCallbacks = new HashMap<>();
73+
private final Map<Event<?>, Map<Long, Consumer<?>>> eventCallbacks = new HashMap<>();
7474
private final HttpClient client;
7575
private final AtomicBoolean underlyingSocketClosed = new AtomicBoolean();
7676

@@ -180,17 +180,26 @@ public <X> X sendAndWait(Command<X> command, Duration timeout) {
180180
}
181181
}
182182

183-
public <X> void addListener(Event<X> event, Consumer<X> handler) {
183+
public <X> long addListener(Event<X> event, Consumer<X> handler) {
184184
Require.nonNull("Event to listen for", event);
185185
Require.nonNull("Handler to call", handler);
186186

187+
long id = EVENT_CALLBACK_ID.getAndIncrement();
188+
187189
Lock lock = callbacksLock.writeLock();
188190
lock.lock();
189191
try {
190-
eventCallbacks.computeIfAbsent(event, (key) -> new ArrayList<>()).add(handler);
192+
eventCallbacks.computeIfAbsent(
193+
event,
194+
key -> {
195+
HashMap<Long, Consumer<?>> map = new HashMap<>();
196+
map.put(id, handler);
197+
return map;
198+
});
191199
} finally {
192200
lock.unlock();
193201
}
202+
return id;
194203
}
195204

196205
public <X> void clearListener(Event<X> event) {
@@ -203,6 +212,23 @@ public <X> void clearListener(Event<X> event) {
203212
}
204213
}
205214

215+
public void removeListener(long id) {
216+
Lock lock = callbacksLock.writeLock();
217+
lock.lock();
218+
try {
219+
eventCallbacks.forEach((k, v) -> v.remove(id));
220+
eventCallbacks.forEach(
221+
(k, v) -> {
222+
v.remove(id);
223+
if (v.isEmpty()) {
224+
eventCallbacks.remove(k);
225+
}
226+
});
227+
} finally {
228+
lock.unlock();
229+
}
230+
}
231+
206232
public <X> boolean isEventSubscribed(Event<X> event) {
207233
Lock lock = callbacksLock.writeLock();
208234
lock.lock();
@@ -354,7 +380,7 @@ private void handleEventResponse(Map<String, Object> rawDataMap) {
354380

355381
final Object finalValue = value;
356382

357-
for (Consumer<?> action : event.getValue()) {
383+
for (Consumer<?> action : event.getValue().values()) {
358384
@SuppressWarnings("unchecked")
359385
Consumer<Object> obj = (Consumer<Object>) action;
360386
LOG.log(

‎java/src/org/openqa/selenium/bidi/module/LogInspector.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ public LogInspector(Set<String> browsingContextIds, WebDriver driver) {
6161
this.browsingContextIds = browsingContextIds;
6262
}
6363

64-
public void onConsoleEntry(Consumer<ConsoleLogEntry> consumer) {
64+
public long onConsoleEntry(Consumer<ConsoleLogEntry> consumer) {
6565
Consumer<LogEntry> logEntryConsumer =
6666
logEntry -> logEntry.getConsoleLogEntry().ifPresent(consumer);
6767

68-
addLogEntryAddedListener(logEntryConsumer);
68+
return addLogEntryAddedListener(logEntryConsumer);
6969
}
7070

7171
public void onConsoleEntry(Consumer<ConsoleLogEntry> consumer, FilterBy filter) {
@@ -105,7 +105,7 @@ public void onJavaScriptLog(Consumer<JavascriptLogEntry> consumer, FilterBy filt
105105
addLogEntryAddedListener(logEntryConsumer);
106106
}
107107

108-
public void onJavaScriptException(Consumer<JavascriptLogEntry> consumer) {
108+
public long onJavaScriptException(Consumer<JavascriptLogEntry> consumer) {
109109
Consumer<LogEntry> logEntryConsumer =
110110
logEntry ->
111111
logEntry
@@ -117,7 +117,7 @@ public void onJavaScriptException(Consumer<JavascriptLogEntry> consumer) {
117117
}
118118
});
119119

120-
addLogEntryAddedListener(logEntryConsumer);
120+
return addLogEntryAddedListener(logEntryConsumer);
121121
}
122122

123123
public void onGenericLog(Consumer<GenericLogEntry> consumer) {
@@ -163,11 +163,11 @@ public void onLog(Consumer<LogEntry> consumer, FilterBy filter) {
163163
addLogEntryAddedListener(logEntryConsumer);
164164
}
165165

166-
private void addLogEntryAddedListener(Consumer<LogEntry> consumer) {
166+
private long addLogEntryAddedListener(Consumer<LogEntry> consumer) {
167167
if (browsingContextIds.isEmpty()) {
168-
this.bidi.addListener(Log.entryAdded(), consumer);
168+
return this.bidi.addListener(Log.entryAdded(), consumer);
169169
} else {
170-
this.bidi.addListener(browsingContextIds, Log.entryAdded(), consumer);
170+
return this.bidi.addListener(browsingContextIds, Log.entryAdded(), consumer);
171171
}
172172
}
173173

0 commit comments

Comments
 (0)