add bdiege class

Author: KazuCocoa

lib/appium_lib_core/common/base.rb

@@ -30,8 +30,9 @@
 require_relative 'device/orientation'
 
 # The following files have selenium-webdriver related stuff.
-require_relative 'base/driver'
 require_relative 'base/bridge'
+require_relative 'base/bidi_bridge'
+require_relative 'base/driver'
 require_relative 'base/capabilities'
 require_relative 'base/http_default'
 require_relative 'base/search_context'

lib/appium_lib_core/common/base/bidi_bridge.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# Licensed 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.
+
+require_relative 'bridge'
+
+module Appium
+  module Core
+    class Base
+      class BiDiBridge < ::Appium::Core::Base::Bridge
+        attr_reader :bidi
+
+        # Override
+        # Creates session handling.
+        #
+        # @param [::Appium::Core::Base::Capabilities, Hash] capabilities A capability
+        # @return [::Appium::Core::Base::Capabilities]
+        #
+        # @example
+        #
+        #   opts = {
+        #     caps: {
+        #       platformName: :ios,
+        #       automationName: 'XCUITest',
+        #       app: 'test/functional/app/UICatalog.app.zip',
+        #       platformVersion: '11.4',
+        #       deviceName: 'iPhone Simulator',
+        #       useNewWDA: true,
+        #     },
+        #     appium_lib: {
+        #       wait: 30
+        #     }
+        #   }
+        #   core = ::Appium::Core.for(caps)
+        #   driver = core.start_driver
+        #
+        def create_session(capabilities)
+          super
+          socket_url = @capabilities[:web_socket_url]
+          @bidi = ::Selenium::WebDriver::BiDi.new(url: socket_url)
+        end
+
+        def get(url)
+          browsing_context.navigate(url)
+        end
+
+        def go_back
+          browsing_context.traverse_history(-1)
+        end
+
+        def go_forward
+          browsing_context.traverse_history(1)
+        end
+
+        def refresh
+          browsing_context.reload
+        end
+
+        def quit
+          super
+        ensure
+          bidi.close
+        end
+
+        def close
+          execute(:close_window).tap { |handles| bidi.close if handles.empty? }
+        end
+
+        private
+
+        def browsing_context
+          @browsing_context ||= ::Selenium::WebDriver::BiDi::BrowsingContext.new(self)
+        end
+      end # class BiDiBridge
+    end # class Base
+  end # module Core
+end # module Appium

lib/appium_lib_core/common/base/bridge.rb

@@ -21,9 +21,7 @@ def convert(how, what)
         end
       end # LocatorConverter
 
-      # TODO: switch to use BiDiBridge with 'webSocketUrl'
-      class Bridge < ::Selenium::WebDriver::Remote::BiDiBridge
-      # class Bridge < ::Selenium::WebDriver::Remote::Bridge
+      class Bridge < ::Selenium::WebDriver::Remote::Bridge
         include Device::DeviceLock
         include Device::Keyboard
         include Device::ImeActions
@@ -318,11 +316,6 @@ def element_screenshot(element_id)
         def send_command(command_params)
           execute :chrome_send_command, {}, command_params
         end
-
-        def quit
-          bidi&.close
-          super
-        end
       end # class Bridge
     end # class Base
   end # module Core

lib/appium_lib_core/common/base/driver.rb

@@ -29,9 +29,6 @@ class Driver < ::Selenium::WebDriver::Driver
         include ::Selenium::WebDriver::DriverExtensions::UploadsFiles
         include ::Selenium::WebDriver::DriverExtensions::HasSessionId
 
-        # TODO: allow to install only for newer version
-        include ::Selenium::WebDriver::DriverExtensions::HasBiDi
-
         include ::Appium::Core::Base::Rotatable
         include ::Appium::Core::Base::TakesScreenshot
         include ::Appium::Core::Base::HasRemoteStatus
@@ -57,9 +54,9 @@ def initialize(bridge: nil, listener: nil, **opts) # rubocop:disable Lint/Missin
           @devtools = nil
           @bidi = nil
 
-          # TODO: modify the eleemnt_class
-          # in the selenium webdriver as well
-          ::Selenium::WebDriver::Remote::Bridge.element_class = ::Appium::Core::Element
+          # internal use
+          @has_bidi = false
+
           bridge ||= create_bridge(**opts)
           add_extensions(bridge.browser)
           @bridge = listener ? ::Appium::Support::EventFiringBridge.new(bridge, listener, **original_opts) : bridge
@@ -83,7 +80,14 @@ def create_bridge(**opts)
 
           raise ::Appium::Core::Error::ArgumentError, "Unable to create a driver with parameters: #{opts}" unless opts.empty?
 
-          bridge = ::Appium::Core::Base::Bridge.new(**bridge_opts)
+          if capabilities['webSocketUrl']
+            @has_bidi = true
+            ::Selenium::WebDriver::Remote::BiDiBridge.element_class = ::Appium::Core::Element
+            bridge = ::Appium::Core::Base::BiDiBridge.new(**bridge_opts)
+          else
+            ::Selenium::WebDriver::Remote::Bridge.element_class = ::Appium::Core::Element
+            bridge = ::Appium::Core::Base::Bridge.new(**bridge_opts)
+          end
 
           if session_id.nil?
             bridge.create_session(capabilities)
@@ -97,6 +101,13 @@ def create_bridge(**opts)
 
         public
 
+        def bidi
+          return @bridge.bidi if @has_bidi
+
+          msg = 'BiDi must be enabled by providing webSocketUrl capability to true'
+          raise(::Selenium::WebDriver::Error::WebDriverError, msg)
+        end
+
         # Update +server_url+ and HTTP clients following this arguments, protocol, host, port and path.
         # After this method, +@bridge.http+ will be a new instance following them instead of +server_url+ which is
         # set before creating session.