Merge branch 'master' into appium3

Author: KazuCocoa

.github/workflows/functional-test.yml

@@ -225,6 +225,13 @@ jobs:
           # - target: test/functional/android/android/mjpeg_server_test.rb,test/functional/android/android/image_comparison_test.rb
           #   automation_name: espresso
           #   name: test10
+          # FIXME: rever the comment out after https://github.com/appium/appium/pull/21468
+          - target: test/functional/android/webdriver/bidi_test.rb
+            automation_name: uiautomator2
+            name: test11
+          # - target: test/functional/android/webdriver/bidi_test.rb
+          #   automation_name: espresso
+          #   name: test12
 
     env:
       API_LEVEL: 36

CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 Read `release_notes.md` for commit level details.
 
+## [11.1.0,11.1.1] - 2025-08-08
+- Add WebDriver BiDi support. Please set `webSocketUrl` in the capabilities to enable it.
+    - `test/functional/android/webdriver/bidi_test.rb` can be an example usage.
+    - Older versions of the Selenium Ruby bindings may raise exceptions due to missing module dependencies.
+
 ## [11.0.2] - 2025-04-27
 - Add more sig definitions [#571](https://github.com/appium/ruby_lib_core/pull/571)
 

Gemfile

@@ -8,7 +8,7 @@ gem 'minitest', '~> 5.0'
 gem 'minitest-reporters', '~> 1.1'
 gem 'parallel_tests'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '1.79.0'
+gem 'rubocop', '1.79.2'
 gem 'simplecov'
 gem 'steep', '~> 1.9.3'
 gem 'webmock', '~> 3.25.0'

README.md

@@ -191,7 +191,7 @@ capabilities: {
   deviceName: 'iPhone Simulator',
   automationName: 'XCUITest',
   app: '/path/to/MyiOS.app'
-},
+}
 appium_lib: {
   listener: CustomListener.new
 }

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,96 @@
+# 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: :android,
+        #       automationName: 'uiautomator2',
+        #       platformVersion: '15',
+        #       deviceName: 'Android',
+        #       webSocketUrl: true,
+        #     },
+        #     appium_lib: {
+        #       wait: 30
+        #     }
+        #   }
+        #   core = ::Appium::Core.for(caps)
+        #   driver = core.start_driver
+        #
+        def create_session(capabilities)
+          super
+
+          return @capabilities if @capabilities.nil?
+
+          begin
+            socket_url = @capabilities[:web_socket_url]
+            @bidi = ::Selenium::WebDriver::BiDi.new(url: socket_url) if socket_url
+          rescue StandardError => e
+            ::Appium::Logger.warn "WebSocket connection to #{socket_url} for BiDi failed. Error #{e}"
+            raise
+          end
+
+          @capabilities
+        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/driver.rb

@@ -54,7 +54,9 @@ def initialize(bridge: nil, listener: nil, **opts) # rubocop:disable Lint/Missin
           @devtools = nil
           @bidi = nil
 
-          # in the selenium webdriver as well
+          # internal use
+          @has_bidi = false
+
           ::Selenium::WebDriver::Remote::Bridge.element_class = ::Appium::Core::Element
           bridge ||= create_bridge(**opts)
           add_extensions(bridge.browser)
@@ -79,7 +81,9 @@ 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)
+          @has_bidi = capabilities && capabilities['webSocketUrl'] ? true : false
+          bridge_clzz = @has_bidi ? ::Appium::Core::Base::BiDiBridge : ::Appium::Core::Base::Bridge
+          bridge = bridge_clzz.new(**bridge_opts)
 
           if session_id.nil?
             bridge.create_session(capabilities)
@@ -996,6 +1000,28 @@ def execute_driver(script: '', type: 'webdriverio', timeout_ms: nil)
         def convert_to_element(response_id)
           @bridge.convert_to_element response_id
         end
+
+        # Return bidi instance
+        # @return [::Selenium::WebDriver::BiDi]
+        #
+        # @example
+        #
+        #     log_entries = []
+        #     driver.bidi.send_cmd('session.subscribe', 'events': ['log.entryAdded'], 'contexts': ['NATIVE_APP'])
+        #     subscribe_id = driver.bidi.add_callback('log.entryAdded') do |params|
+        #       log_entries << params
+        #     end
+        #     driver.page_source
+        #
+        #     driver.bidi.remove_callback('log.entryAdded', subscribe_id)
+        #     driver.bidi.send_cmd('session.unsubscribe', 'events': ['log.entryAdded'], 'contexts': ['NATIVE_APP'])
+        #
+        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
       end # class Driver
     end # class Base
   end # module Core

lib/appium_lib_core/driver.rb

@@ -421,8 +421,8 @@ def start_driver(server_url: nil,
             d_c = DirectConnections.new(@driver.capabilities)
             @driver.update_sending_request_to(protocol: d_c.protocol, host: d_c.host, port: d_c.port, path: d_c.path)
           end
-        rescue Errno::ECONNREFUSED
-          raise "ERROR: Unable to connect to Appium. Is the server running on #{@custom_url}?"
+        rescue Errno::ECONNREFUSED => e
+          raise "ERROR: Unable to connect to Appium. Is the server running on #{@custom_url}? Error: #{e}"
         end
 
         if @http_client.instance_variable_defined? :@additional_headers

lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '11.0.2' unless defined? ::Appium::Core::VERSION
-    DATE    = '2025-04-27' unless defined? ::Appium::Core::DATE
+    VERSION = '11.1.1' unless defined? ::Appium::Core::VERSION
+    DATE    = '2025-08-08' unless defined? ::Appium::Core::DATE
   end
 end

release_notes.md

@@ -1,3 +1,46 @@
+#### v11.1.1 2025-08-08
+
+- [4651cac](https://github.com/appium/ruby_lib_core/commit/4651cac25d4f95374568d1c97083ecd0eb9e4547) Release 11.1.1
+- [5b5e47b](https://github.com/appium/ruby_lib_core/commit/5b5e47b05e0f8f2577af4f0d595658531f3efc66) fix: fix rubocop
+
+
+#### v11.1.0 2025-08-08
+
+- [0486d1b](https://github.com/appium/ruby_lib_core/commit/0486d1b5042ff86c0d4378bbd0eec574d5825fdd) Release 11.1.0
+- [fd23456](https://github.com/appium/ruby_lib_core/commit/fd23456861a907adae5d955ca766d70795686465) feat: add BiDi bridge (#631)
+- [f244a36](https://github.com/appium/ruby_lib_core/commit/f244a365b067fc925017ca4b1d6fdfd85974221a) chore(deps): update rubocop requirement from 1.79.1 to 1.79.2 (#630)
+- [8302f6f](https://github.com/appium/ruby_lib_core/commit/8302f6fd39dfcaf6209b31c3977707305f45af90) docs: fix code example
+- [85ffb58](https://github.com/appium/ruby_lib_core/commit/85ffb5831ef35495153532c9e5b65dc55f18c2d1) chore(deps): update rubocop requirement from 1.79.0 to 1.79.1 (#628)
+- [1770174](https://github.com/appium/ruby_lib_core/commit/1770174e222f9e68fab5c0f989332a52e004a301) chore(deps): update rubocop requirement from 1.78.0 to 1.79.0 (#627)
+- [9e622f2](https://github.com/appium/ruby_lib_core/commit/9e622f220902a9fd71e7b8be5a64f21402cd6422) docs: Update README.md
+- [900ff29](https://github.com/appium/ruby_lib_core/commit/900ff29f57d14b0d281a9edcd0270f4ae22bdadc) docs: modify readme a bit
+- [65a4e32](https://github.com/appium/ruby_lib_core/commit/65a4e322d80739091c9425d2a5f5bec4ddc290d5) test: fix argument naming in mobile_commands_test.rb
+- [2b5a566](https://github.com/appium/ruby_lib_core/commit/2b5a5661d6de87309f874e3f9860ac08c01e5045) test: fix syntax
+- [61dfd40](https://github.com/appium/ruby_lib_core/commit/61dfd401a08fb329f5c0cc75b93db93b8cc94779) chore(deps): update rubocop requirement from 1.77.0 to 1.78.0 (#626)
+- [1f193c1](https://github.com/appium/ruby_lib_core/commit/1f193c1e2d62722c547089aa1c589ff55cb3d3d7) ci: use prebuilt wda (#625)
+- [8c4b08a](https://github.com/appium/ruby_lib_core/commit/8c4b08ad9e4fab7185940393956c14e55dfab9e1) ci: update functional-test.yml
+- [ee92823](https://github.com/appium/ruby_lib_core/commit/ee92823e15740df9763ff7970bd8606234689950) test: remove unused variable
+- [43c2fd2](https://github.com/appium/ruby_lib_core/commit/43c2fd2b8b8af2d9e4eb4f07e9d74209ace41f88) test: use newer xcode/ios
+- [61b2277](https://github.com/appium/ruby_lib_core/commit/61b2277ff2e391571b87e6d3931aac9e0ce9e206) chore(deps): update rubocop requirement from 1.76.2 to 1.77.0 (#624)
+- [3de46ab](https://github.com/appium/ruby_lib_core/commit/3de46abaa933e6fa813b78192650e1f9ead5a238) test: tune default caps
+- [844a704](https://github.com/appium/ruby_lib_core/commit/844a704935fff3a8e839fed26c649d27ae5d268b) test: tune timeout for uia2 (#623)
+- [1d6adc0](https://github.com/appium/ruby_lib_core/commit/1d6adc0b43d5f89b5a5f15315e725ff50a32c804) chore(deps): update rubocop requirement from 1.76.1 to 1.76.2 (#622)
+- [b12d61d](https://github.com/appium/ruby_lib_core/commit/b12d61d5837843f4bd53b40a72090e7474a539c4) test: update scenario for ios 26 (#621)
+- [8baec17](https://github.com/appium/ruby_lib_core/commit/8baec1754d8af9b1dc0024020ba0c819ea49570a) chore(deps): update rubocop requirement from 1.76.0 to 1.76.1 (#620)
+- [cdc82c8](https://github.com/appium/ruby_lib_core/commit/cdc82c8cf165964180a69343ba5294a542e438c8) chore(deps): update rubocop requirement from 1.75.8 to 1.76.0 (#619)
+- [7e7166f](https://github.com/appium/ruby_lib_core/commit/7e7166fa76a71ac563813085adf43b86c6221b9f) chore(deps): update rubocop requirement from 1.75.7 to 1.75.8 (#618)
+- [82b2180](https://github.com/appium/ruby_lib_core/commit/82b218038d4f7178062127e6ce31de0ac149ceb9) chore(deps): update faye-websocket requirement from ~> 0.11.0 to >= 0.11, < 0.13 (#617)
+- [e26e4bb](https://github.com/appium/ruby_lib_core/commit/e26e4bb53573d7bea851ace672beb7f8f3c22cfd) chore(deps): update rubocop requirement from 1.75.6 to 1.75.7 (#616)
+- [84341e5](https://github.com/appium/ruby_lib_core/commit/84341e512f777ae602ad57e0ac525cf480e74255) ci: use api level 36 for Android tests (#615)
+- [69319c8](https://github.com/appium/ruby_lib_core/commit/69319c8779b076a9827d8c6ec6290292199dee44) ci: turn for win (#612)
+- [a28736c](https://github.com/appium/ruby_lib_core/commit/a28736cf63aa41884aff978a0a49001e522c855f) test: some small adjustments
+- [1492e6a](https://github.com/appium/ruby_lib_core/commit/1492e6a888f5d2c2151bba2695ff787bee752c0c) test: update the app path
+- [019b34a](https://github.com/appium/ruby_lib_core/commit/019b34ad42b0368da21784bffd9acb1012eaba14) chore(deps): update rubocop requirement from 1.75.5 to 1.75.6 (#613)
+- [6332ab8](https://github.com/appium/ruby_lib_core/commit/6332ab8392eeabfc8d4905ed3a43ab1305558d52) docs(readme): update Libraries links (#610)
+- [985b3b9](https://github.com/appium/ruby_lib_core/commit/985b3b9e92dc537c8816c5a4ec768a6025a3b548) chore(deps): update rubocop requirement from 1.75.4 to 1.75.5 (#609)
+- [c5945ca](https://github.com/appium/ruby_lib_core/commit/c5945ca2bc45190a1f36a19154c1cea1b00e6dc1) chore(deps): update rubocop requirement from 1.75.3 to 1.75.4 (#607)
+
+
 #### v11.0.2 2025-04-27
 
 - [dccd87f](https://github.com/appium/ruby_lib_core/commit/dccd87f9bca10efb541629eb2f0f58bd77fd87fb) Release 11.0.2