[java] Close BiDi session on closing the last top-level browsing context

Author: pujagani

java/src/org/openqa/selenium/remote/RemoteWebDriver.java

@@ -72,6 +72,7 @@
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.time.Duration;
+import java.util.ArrayList;
 import java.util.Base64;
 import java.util.Collection;
 import java.util.Collections;
@@ -415,9 +416,16 @@ public void close() {
       }
     }
 
-    execute(DriverCommand.CLOSE);
-  }
+    Response response = execute(DriverCommand.CLOSE);
+    Object value = response.getValue();
+    List<String> windowHandles = (ArrayList<String>) value;
 
+    if (windowHandles.isEmpty() && this instanceof HasBiDi) {
+      // If no top-level browsing contexts are open after calling close, it indicates that the WebDriver session is closed.
+      // If the WebDriver session is closed, the BiDi session also needs to be closed.
+      ((HasBiDi) this).maybeGetBiDi().ifPresent(BiDi::close);
+    }
+  }
   @Override
   public void quit() {
     // no-op if session id is null. We're only going to make ourselves unhappy

java/test/org/openqa/selenium/bidi/BiDiSessionCleanUpTest.java

@@ -0,0 +1,83 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package org.openqa.selenium.bidi;
+
+import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
+import static org.assertj.core.api.AssertionsForClassTypes.assertThatExceptionOfType;
+
+import org.junit.jupiter.api.Test;
+import org.openqa.selenium.TimeoutException;
+import org.openqa.selenium.WindowType;
+import org.openqa.selenium.firefox.FirefoxDriver;
+import org.openqa.selenium.firefox.FirefoxOptions;
+
+import java.util.Collections;
+
+class BiDiSessionCleanUpTest {
+
+  private FirefoxDriver driver;
+
+  @Test
+  void shouldNotCloseBiDiSessionIfOneWindowIsClosed() {
+    FirefoxOptions options = new FirefoxOptions();
+    // Enable BiDi
+    options.setCapability("webSocketUrl", true);
+
+    driver = new FirefoxDriver(options);
+
+    BiDi biDi = driver.getBiDi();
+
+    BiDiSessionStatus status = biDi.send(new Command<>("session.status", Collections.emptyMap(), BiDiSessionStatus.class));
+    assertThat(status).isNotNull();
+    assertThat(status.getMessage()).isEqualTo("Session already started");
+
+    driver.switchTo().newWindow(WindowType.WINDOW);
+    driver.switchTo().newWindow(WindowType.TAB);
+    driver.switchTo().newWindow(WindowType.TAB);
+
+    driver.close();
+
+    BiDiSessionStatus statusAfterClosing = biDi.send(new Command<>("session.status", Collections.emptyMap(), BiDiSessionStatus.class));
+    assertThat(statusAfterClosing).isNotNull();
+    assertThat(status.getMessage()).isEqualTo("Session already started");
+    driver.quit();
+  }
+
+  @Test
+  void shouldCloseBiDiSessionIfLastWindowIsClosed() {
+    FirefoxOptions options = new FirefoxOptions();
+    // Enable BiDi
+    options.setCapability("webSocketUrl", true);
+
+    driver = new FirefoxDriver(options);
+
+    BiDi biDi = driver.getBiDi();
+
+    BiDiSessionStatus status = biDi.send(new Command<>("session.status", Collections.emptyMap(), BiDiSessionStatus.class));
+    assertThat(status).isNotNull();
+    assertThat(status.getMessage()).isEqualTo("Session already started");
+
+    driver.close();
+
+    // Closing the last top-level browsing context, closes the WebDriver and BiDi session
+    assertThatExceptionOfType(TimeoutException.class)
+      .isThrownBy(() -> biDi.send(new Command<>("session.status",
+                                                Collections.emptyMap(),
+                                                BiDiSessionStatus.class)));
+  }
+}

java/test/org/openqa/selenium/remote/RemoteWebDriverUnitTest.java

@@ -40,6 +40,7 @@
 import java.io.IOException;
 import java.net.URL;
 import java.time.Duration;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
@@ -270,7 +271,7 @@ void canHandleGetWindowHandlesCommand() {
 
   @Test
   void canHandleCloseCommand() {
-    WebDriverFixture fixture = new WebDriverFixture(echoCapabilities, nullValueResponder);
+    WebDriverFixture fixture = new WebDriverFixture(echoCapabilities, valueResponder(new ArrayList<>()));
 
     fixture.driver.close();