feat: Implement HasBiDi interface support in AppiumDriver

Author: mykola-mokhnach

src/main/java/io/appium/java_client/AppiumDriver.java

@@ -30,6 +30,8 @@
 import org.openqa.selenium.SessionNotCreatedException;
 import org.openqa.selenium.UnsupportedCommandException;
 import org.openqa.selenium.WebDriverException;
+import org.openqa.selenium.bidi.BiDi;
+import org.openqa.selenium.bidi.HasBiDi;
 import org.openqa.selenium.remote.CapabilityType;
 import org.openqa.selenium.remote.DriverCommand;
 import org.openqa.selenium.remote.ErrorHandler;
@@ -42,6 +44,8 @@
 import org.openqa.selenium.remote.http.HttpClient;
 import org.openqa.selenium.remote.http.HttpMethod;
 
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.net.URL;
 import java.util.Arrays;
 import java.util.Collections;
@@ -66,7 +70,8 @@ public class AppiumDriver extends RemoteWebDriver implements
         LogsEvents,
         HasBrowserCheck,
         CanRememberExtensionPresence,
-        HasSettings {
+        HasSettings,
+        HasBiDi {
 
     private static final ErrorHandler ERROR_HANDLER = new ErrorHandler(new ErrorCodesMobile(), true);
     // frequently used command parameters
@@ -76,6 +81,8 @@ public class AppiumDriver extends RemoteWebDriver implements
     protected final RemoteLocationContext locationContext;
     private final ExecuteMethod executeMethod;
     private final Set<String> absentExtensionNames = new HashSet<>();
+    protected URI biDiUri;
+    protected BiDi biDi;
 
     /**
      * Creates a new instance based on command {@code executor} and {@code capabilities}.
@@ -171,54 +178,6 @@ public AppiumDriver(URL remoteSessionAddress, String platformName, String automa
         setSessionId(sessionAddress.getId());
     }
 
-    /**
-     * Changes platform name if it is not set and returns merged capabilities.
-     *
-     * @param originalCapabilities the given {@link Capabilities}.
-     * @param defaultName          a platformName value which has to be set up
-     * @return {@link Capabilities} with changed platform name value or the original capabilities
-     */
-    protected static Capabilities ensurePlatformName(
-            Capabilities originalCapabilities, String defaultName) {
-        return originalCapabilities.getPlatformName() == null
-                ? originalCapabilities.merge(new ImmutableCapabilities(PLATFORM_NAME, defaultName))
-                : originalCapabilities;
-    }
-
-    /**
-     * Changes automation name if it is not set and returns merged capabilities.
-     *
-     * @param originalCapabilities the given {@link Capabilities}.
-     * @param defaultName          a platformName value which has to be set up
-     * @return {@link Capabilities} with changed mobile automation name value or the original capabilities
-     */
-    protected static Capabilities ensureAutomationName(
-            Capabilities originalCapabilities, String defaultName) {
-        String currentAutomationName = CapabilityHelpers.getCapability(
-                originalCapabilities, AUTOMATION_NAME_OPTION, String.class);
-        if (isNullOrEmpty(currentAutomationName)) {
-            String capabilityName = originalCapabilities.getCapabilityNames()
-                    .contains(AUTOMATION_NAME_OPTION) ? AUTOMATION_NAME_OPTION : APPIUM_PREFIX + AUTOMATION_NAME_OPTION;
-            return originalCapabilities.merge(new ImmutableCapabilities(capabilityName, defaultName));
-        }
-        return originalCapabilities;
-    }
-
-    /**
-     * Changes platform and automation names if they are not set
-     * and returns merged capabilities.
-     *
-     * @param originalCapabilities the given {@link Capabilities}.
-     * @param defaultPlatformName  a platformName value which has to be set up
-     * @param defaultAutomationName The default automation name to set up for this class
-     * @return {@link Capabilities} with changed platform/automation name value or the original capabilities
-     */
-    protected static Capabilities ensurePlatformAndAutomationNames(
-            Capabilities originalCapabilities, String defaultPlatformName, String defaultAutomationName) {
-        Capabilities capsWithPlatformFixed = ensurePlatformName(originalCapabilities, defaultPlatformName);
-        return ensureAutomationName(capsWithPlatformFixed, defaultAutomationName);
-    }
-
     @Override
     public ExecuteMethod getExecuteMethod() {
         return executeMethod;
@@ -260,39 +219,6 @@ public void addCommand(HttpMethod httpMethod, String url, String methodName) {
         ((AppiumCommandExecutor) getCommandExecutor()).refreshAdditionalCommands();
     }
 
-    @Override
-    protected void startSession(Capabilities capabilities) {
-        var response = Optional.ofNullable(
-                execute(DriverCommand.NEW_SESSION(singleton(capabilities)))
-        ).orElseThrow(() -> new SessionNotCreatedException(
-                    "The underlying command executor returned a null response."
-        ));
-
-        var rawCapabilities = Optional.ofNullable(response.getValue())
-                .map(value -> {
-                    if (!(value instanceof Map)) {
-                        throw new SessionNotCreatedException(String.format(
-                                "The underlying command executor returned a response "
-                                        + "with a non well formed payload: %s", response)
-                        );
-                    }
-                    //noinspection unchecked
-                    return (Map<String, Object>) value;
-                })
-                .orElseThrow(() -> new SessionNotCreatedException(
-                    "The underlying command executor returned a response without payload: " + response)
-                );
-
-        // TODO: remove this workaround for Selenium API enforcing some legacy capability values in major version
-        rawCapabilities.remove("platform");
-        if (rawCapabilities.containsKey(CapabilityType.BROWSER_NAME)
-                && isNullOrEmpty((String) rawCapabilities.get(CapabilityType.BROWSER_NAME))) {
-            rawCapabilities.remove(CapabilityType.BROWSER_NAME);
-        }
-        this.capabilities = new BaseOptions<>(rawCapabilities);
-        setSessionId(response.getSessionId());
-    }
-
     @Override
     public Response execute(String driverCommand, Map<String, ?> parameters) {
         return super.execute(driverCommand, parameters);
@@ -337,7 +263,118 @@ public AppiumDriver markExtensionAbsence(String extName) {
         return this;
     }
 
+    @Override
+    public Optional<BiDi> maybeGetBiDi() {
+        return Optional.ofNullable(this.biDi);
+    }
+
     protected HttpClient getHttpClient() {
         return ((HttpCommandExecutor) getCommandExecutor()).client;
     }
+
+    @Override
+    protected void startSession(Capabilities capabilities) {
+        var response = Optional.ofNullable(
+                execute(DriverCommand.NEW_SESSION(singleton(capabilities)))
+        ).orElseThrow(() -> new SessionNotCreatedException(
+                "The underlying command executor returned a null response."
+        ));
+
+        var rawCapabilities = Optional.ofNullable(response.getValue())
+                .map(value -> {
+                    if (!(value instanceof Map)) {
+                        throw new SessionNotCreatedException(String.format(
+                                "The underlying command executor returned a response "
+                                        + "with a non well formed payload: %s", response)
+                        );
+                    }
+                    //noinspection unchecked
+                    return (Map<String, Object>) value;
+                })
+                .orElseThrow(() -> new SessionNotCreatedException(
+                        "The underlying command executor returned a response without payload: " + response)
+                );
+
+        // TODO: remove this workaround for Selenium API enforcing some legacy capability values in major version
+        rawCapabilities.remove("platform");
+        if (rawCapabilities.containsKey(CapabilityType.BROWSER_NAME)
+                && isNullOrEmpty((String) rawCapabilities.get(CapabilityType.BROWSER_NAME))) {
+            rawCapabilities.remove(CapabilityType.BROWSER_NAME);
+        }
+        this.capabilities = new BaseOptions<>(rawCapabilities);
+        this.initBiDi(capabilities);
+        setSessionId(response.getSessionId());
+    }
+
+    /**
+     * Changes platform name if it is not set and returns merged capabilities.
+     *
+     * @param originalCapabilities the given {@link Capabilities}.
+     * @param defaultName          a platformName value which has to be set up
+     * @return {@link Capabilities} with changed platform name value or the original capabilities
+     */
+    protected static Capabilities ensurePlatformName(
+            Capabilities originalCapabilities, String defaultName) {
+        return originalCapabilities.getPlatformName() == null
+                ? originalCapabilities.merge(new ImmutableCapabilities(PLATFORM_NAME, defaultName))
+                : originalCapabilities;
+    }
+
+    /**
+     * Changes automation name if it is not set and returns merged capabilities.
+     *
+     * @param originalCapabilities the given {@link Capabilities}.
+     * @param defaultName          a platformName value which has to be set up
+     * @return {@link Capabilities} with changed mobile automation name value or the original capabilities
+     */
+    protected static Capabilities ensureAutomationName(
+            Capabilities originalCapabilities, String defaultName) {
+        String currentAutomationName = CapabilityHelpers.getCapability(
+                originalCapabilities, AUTOMATION_NAME_OPTION, String.class);
+        if (isNullOrEmpty(currentAutomationName)) {
+            String capabilityName = originalCapabilities.getCapabilityNames()
+                    .contains(AUTOMATION_NAME_OPTION) ? AUTOMATION_NAME_OPTION : APPIUM_PREFIX + AUTOMATION_NAME_OPTION;
+            return originalCapabilities.merge(new ImmutableCapabilities(capabilityName, defaultName));
+        }
+        return originalCapabilities;
+    }
+
+    /**
+     * Changes platform and automation names if they are not set
+     * and returns merged capabilities.
+     *
+     * @param originalCapabilities the given {@link Capabilities}.
+     * @param defaultPlatformName  a platformName value which has to be set up
+     * @param defaultAutomationName The default automation name to set up for this class
+     * @return {@link Capabilities} with changed platform/automation name value or the original capabilities
+     */
+    protected static Capabilities ensurePlatformAndAutomationNames(
+            Capabilities originalCapabilities, String defaultPlatformName, String defaultAutomationName) {
+        Capabilities capsWithPlatformFixed = ensurePlatformName(originalCapabilities, defaultPlatformName);
+        return ensureAutomationName(capsWithPlatformFixed, defaultAutomationName);
+    }
+
+    private void initBiDi(Capabilities responseCaps) {
+        var webSocketUrl = CapabilityHelpers.getCapability(responseCaps, "webSocketUrl", String.class);
+        if (webSocketUrl == null) {
+            return;
+        }
+        try {
+            this.biDiUri = new URI(webSocketUrl);
+        } catch (URISyntaxException e) {
+            // no valid url -> no BiDi
+            return;
+        }
+        var executor = getCommandExecutor();
+        final HttpClient wsClient;
+        if (executor instanceof AppiumCommandExecutor) {
+            var wsConfig = ((AppiumCommandExecutor) executor).getAppiumClientConfig().baseUri(biDiUri);
+            wsClient = ((AppiumCommandExecutor) executor).getHttpClientFactory().createClient(wsConfig);
+        } else {
+            var wsConfig = AppiumClientConfig.defaultConfig().baseUri(biDiUri);
+            wsClient = HttpClient.Factory.createDefault().createClient(wsConfig);
+        }
+        var biDiConnection = new org.openqa.selenium.bidi.Connection(wsClient, biDiUri.toString());
+        this.biDi = new BiDi(biDiConnection);
+    }
 }

src/main/java/io/appium/java_client/remote/AppiumCommandExecutor.java

@@ -19,6 +19,7 @@
 import com.google.common.base.Throwables;
 import io.appium.java_client.AppiumClientConfig;
 import io.appium.java_client.internal.ReflectionHelpers;
+import lombok.Getter;
 import org.openqa.selenium.SessionNotCreatedException;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.remote.Command;
@@ -54,9 +55,9 @@
 public class AppiumCommandExecutor extends HttpCommandExecutor {
 
     private final Optional<DriverService> serviceOptional;
-
+    @Getter
     private final HttpClient.Factory httpClientFactory;
-
+    @Getter
     private final AppiumClientConfig appiumClientConfig;
 
     /**