[java][BiDi] add clearListners via browsingContextIds for inspectors

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

@@ -21,6 +21,8 @@
 
 import java.io.Closeable;
 import java.time.Duration;
+import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -34,6 +36,7 @@ public class BiDi implements Closeable {
 
   private final Duration timeout;
   private final Connection connection;
+  private final Map<Event<?>, List<Long>> contextListenerIds = new HashMap<>();
 
   /**
    * @deprecated Use constructor with timeout parameter: {@link #BiDi(Connection, Duration)}
@@ -104,7 +107,7 @@ public <X> long addListener(String browsingContextId, Event<X> event, Consumer<X
   }
 
   public <X> long addListener(Set<String> browsingContextIds, Event<X> event, Consumer<X> handler) {
-    Require.nonNull("List of browsing context ids", browsingContextIds);
+    Require.nonEmpty("List of browsing context ids", browsingContextIds);
     Require.nonNull("Event to listen for", event);
     Require.nonNull("Handler to call", handler);
 
@@ -113,7 +116,9 @@ public <X> long addListener(Set<String> browsingContextIds, Event<X> event, Cons
             "session.subscribe",
             Map.of("contexts", browsingContextIds, "events", List.of(event.getMethod()))));
 
-    return connection.addListener(event, handler);
+    long id = connection.addListener(event, handler);
+    contextListenerIds.computeIfAbsent(event, k -> new ArrayList<>()).add(id);
+    return id;
   }
 
   public <X> void clearListener(Event<X> event) {
@@ -127,6 +132,32 @@ public <X> void clearListener(Event<X> event) {
     }
   }
 
+  public <X> void clearListener(Set<String> browsingContextIds, Event<X> event) {
+    Require.nonEmpty("List of browsing context ids", browsingContextIds);
+    Require.nonNull("Event to listen for", event);
+
+    // The browser throws an error if we try to unsubscribe an event that was not subscribed in the
+    // first place
+    if (!connection.isEventSubscribed(event)) {
+      return;
+    }
+
+    List<Long> ids = contextListenerIds.remove(event);
+    if (ids != null && !ids.isEmpty()) {
+      // Subscription was context-specific: unsubscribe only for those contexts.
+      send(
+          new Command<>(
+              "session.unsubscribe",
+              Map.of("contexts", browsingContextIds, "events", List.of(event.getMethod()))));
+      ids.forEach(connection::removeListener);
+    } else {
+      // Subscription was global: context-specific unsubscription is invalid per the BiDi protocol,
+      // so fall back to a global unsubscription.
+      send(new Command<>("session.unsubscribe", Map.of("events", List.of(event.getMethod()))));
+      connection.clearListener(event);
+    }
+  }
+
   public void removeListener(long id) {
     connection.removeListener(id);
   }

java/src/org/openqa/selenium/bidi/module/BrowsingContextInspector.java

@@ -20,6 +20,7 @@
 import java.io.StringReader;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.function.Consumer;
@@ -240,6 +241,27 @@ private void addNavigationEventListener(String name, Consumer<NavigationInfo> co
     }
   }
 
+  public void clearListener(String browsingContextId) {
+    Require.nonNull("Browsing context id", browsingContextId);
+    clearListeners(Collections.singleton(browsingContextId));
+  }
+
+  public void clearListeners(Set<String> browsingContextIds) {
+    Require.nonNull("Browsing context id list", browsingContextIds);
+
+    List.of(
+            browsingContextCreated,
+            browsingContextDestroyed,
+            userPromptOpened,
+            userPromptClosed,
+            historyUpdated,
+            downloadWillBeginEvent,
+            downloadEndEvent)
+        .forEach(event -> this.bidi.clearListener(browsingContextIds, event));
+
+    navigationEventSet.forEach(event -> this.bidi.clearListener(browsingContextIds, event));
+  }
+
   @Override
   public void close() {
     this.bidi.clearListener(browsingContextCreated);

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

@@ -152,8 +152,18 @@ private long addLogEntryAddedListener(Consumer<LogEntry> consumer) {
     }
   }
 
+  public void clearListener(String browsingContextId) {
+    Require.nonNull("Browsing context id", browsingContextId);
+    clearListeners(Collections.singleton(browsingContextId));
+  }
+
+  public void clearListeners(Set<String> browsingContextIds) {
+    Require.nonNull("Browsing context id list", browsingContextIds);
+    this.bidi.clearListener(browsingContextIds, this.logEntryAddedEvent);
+  }
+
   @Override
   public void close() {
-    this.bidi.clearListener(Log.entryAdded());
+    this.bidi.clearListener(this.logEntryAddedEvent);
   }
 }

java/src/org/openqa/selenium/bidi/module/SpeculationInspector.java

@@ -69,8 +69,18 @@ public void removeListener(long subscriptionId) {
     this.bidi.removeListener(subscriptionId);
   }
 
+  public void clearListener(String browsingContextId) {
+    Require.nonNull("Browsing context id", browsingContextId);
+    clearListeners(Collections.singleton(browsingContextId));
+  }
+
+  public void clearListeners(Set<String> browsingContextIds) {
+    Require.nonNull("Browsing context id list", browsingContextIds);
+    this.bidi.clearListener(browsingContextIds, this.prefetchStatusUpdatedEvent);
+  }
+
   @Override
   public void close() {
-    this.bidi.clearListener(Speculation.prefetchStatusUpdated());
+    this.bidi.clearListener(this.prefetchStatusUpdatedEvent);
   }
 }

java/test/org/openqa/selenium/bidi/browsingcontext/BrowsingContextInspectorTest.java

@@ -24,11 +24,15 @@
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.openqa.selenium.testing.drivers.Browser.FIREFOX;
 
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
@@ -318,6 +322,71 @@ void canListenToNavigationFailedEvent()
     }
   }
 
+  @Test
+  @NeedsFreshDriver
+  void canClearListenersForBrowsingContext()
+      throws ExecutionException, InterruptedException, TimeoutException {
+    try (BrowsingContextInspector inspector = new BrowsingContextInspector(driver)) {
+      CompletableFuture<NavigationInfo> future = new CompletableFuture<>();
+      inspector.onDomContentLoaded(future::complete);
+
+      BrowsingContext context = new BrowsingContext(driver, driver.getWindowHandle());
+      context.navigate(appServer.whereIs("/bidi/logEntryAdded.html"), ReadinessState.COMPLETE);
+
+      NavigationInfo navigationInfo = future.get(5, TimeUnit.SECONDS);
+      assertThat(navigationInfo.getBrowsingContextId()).isEqualTo(context.getId());
+
+      // Clear listeners for this browsing context
+      inspector.clearListener(context.getId());
+
+      // Re-subscribe and verify events still work after re-subscribing
+      CompletableFuture<NavigationInfo> newFuture = new CompletableFuture<>();
+      inspector.onDomContentLoaded(newFuture::complete);
+
+      context.navigate(appServer.whereIs("/simpleTest.html"), ReadinessState.COMPLETE);
+
+      NavigationInfo newNavigationInfo = newFuture.get(5, TimeUnit.SECONDS);
+      assertThat(newNavigationInfo.getBrowsingContextId()).isEqualTo(context.getId());
+      assertThat(newNavigationInfo.getUrl()).contains("/simpleTest.html");
+    }
+  }
+
+  @Test
+  @NeedsFreshDriver
+  void canClearListenersForMultipleBrowsingContexts()
+      throws ExecutionException, InterruptedException, TimeoutException {
+    Set<String> browsingContextIds = new HashSet<>();
+    browsingContextIds.add(driver.getWindowHandle());
+
+    try (BrowsingContextInspector inspector = new BrowsingContextInspector(driver)) {
+      List<NavigationInfo> receivedEvents = new ArrayList<>();
+      CountDownLatch latch = new CountDownLatch(1);
+      inspector.onNavigationStarted(
+          info -> {
+            receivedEvents.add(info);
+            latch.countDown();
+          });
+
+      BrowsingContext context = new BrowsingContext(driver, driver.getWindowHandle());
+      context.navigate(appServer.whereIs("/bidi/logEntryAdded.html"), ReadinessState.COMPLETE);
+
+      latch.await(5, TimeUnit.SECONDS);
+      assertThat(receivedEvents).hasSizeGreaterThanOrEqualTo(1);
+
+      // Clear listeners for the set of browsing context ids
+      inspector.clearListeners(browsingContextIds);
+
+      // Re-subscribe with a new listener after clearing
+      CompletableFuture<NavigationInfo> newFuture = new CompletableFuture<>();
+      inspector.onNavigationStarted(newFuture::complete);
+
+      context.navigate(appServer.whereIs("/simpleTest.html"), ReadinessState.COMPLETE);
+
+      NavigationInfo newNavigationInfo = newFuture.get(5, TimeUnit.SECONDS);
+      assertThat(newNavigationInfo.getBrowsingContextId()).isEqualTo(context.getId());
+    }
+  }
+
   @Test
   @NeedsFreshDriver
   void canListenToHistoryUpdatedEvent()

java/test/org/openqa/selenium/bidi/log/LogInspectorTest.java

@@ -20,7 +20,9 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 
+import java.util.ArrayList;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CountDownLatch;
@@ -430,6 +432,74 @@ void canListenToAnyTypeOfLogForMultipleBrowsingContexts() throws InterruptedExce
     }
   }
 
+  @Test
+  @NeedsFreshDriver
+  void canClearListenersForBrowsingContext()
+      throws ExecutionException, InterruptedException, TimeoutException {
+    String browsingContextId = driver.getWindowHandle();
+    try (LogInspector logInspector = new LogInspector(driver)) {
+      CompletableFuture<ConsoleLogEntry> future = new CompletableFuture<>();
+      logInspector.onConsoleEntry(future::complete);
+
+      page = appServer.whereIs("/bidi/logEntryAdded.html");
+      driver.get(page);
+      driver.findElement(By.id("consoleLog")).click();
+
+      ConsoleLogEntry logEntry = future.get(5, TimeUnit.SECONDS);
+      assertThat(logEntry.getText()).isEqualTo("Hello, world!");
+
+      // Clear listeners for this browsing context
+      logInspector.clearListener(browsingContextId);
+
+      // Re-subscribe and verify events still work after re-subscribing
+      CompletableFuture<ConsoleLogEntry> newFuture = new CompletableFuture<>();
+      logInspector.onConsoleEntry(newFuture::complete);
+
+      driver.findElement(By.id("consoleLog")).click();
+
+      ConsoleLogEntry newLogEntry = newFuture.get(5, TimeUnit.SECONDS);
+      assertThat(newLogEntry.getText()).isEqualTo("Hello, world!");
+    }
+  }
+
+  @Test
+  @NeedsFreshDriver
+  void canClearListenersForMultipleBrowsingContexts()
+      throws ExecutionException, InterruptedException, TimeoutException {
+    Set<String> browsingContextIds = new HashSet<>();
+    browsingContextIds.add(driver.getWindowHandle());
+
+    try (LogInspector logInspector = new LogInspector(driver)) {
+      List<ConsoleLogEntry> receivedEntries = new ArrayList<>();
+      CountDownLatch latch = new CountDownLatch(1);
+      logInspector.onConsoleEntry(
+          entry -> {
+            receivedEntries.add(entry);
+            latch.countDown();
+          });
+
+      page = appServer.whereIs("/bidi/logEntryAdded.html");
+      driver.get(page);
+      driver.findElement(By.id("consoleLog")).click();
+
+      latch.await(5, TimeUnit.SECONDS);
+      assertThat(receivedEntries).hasSize(1);
+      assertThat(receivedEntries.get(0).getText()).isEqualTo("Hello, world!");
+
+      // Clear listeners for the set of browsing context ids
+      logInspector.clearListeners(browsingContextIds);
+
+      // Re-subscribe with a new listener after clearing
+      CompletableFuture<ConsoleLogEntry> newFuture = new CompletableFuture<>();
+      logInspector.onConsoleEntry(newFuture::complete);
+
+      driver.findElement(By.id("consoleLog")).click();
+
+      ConsoleLogEntry newLogEntry = newFuture.get(5, TimeUnit.SECONDS);
+      assertThat(newLogEntry.getText()).isEqualTo("Hello, world!");
+    }
+  }
+
   @Test
   @NeedsFreshDriver
   void canListenToLogsWithMultipleConsumers()