appium_lib_core 11.0.2 → 11.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d726486fec10984535bedbd31b2d24a7891a7d10ba31f06f823307678ac0bc6
-  data.tar.gz: 8de3869f41fa4f680e8db592d26287430bdb68b9a79f757baeb6018afbeac80f
+  metadata.gz: 644a3a9d74789b47ce2eec29dbb617beaa63316fb3d6e51a46574109751592d9
+  data.tar.gz: 10eecbb5e22544478cd0de674cee969556f5996dfbb015f0014a7232fd551d41
 SHA512:
-  metadata.gz: e98f8d19e9e09abc6ee28f1be39e9d22d41dceabc57cc936594adda74df1a699a100059c242787bba4c0ea331a6681257f171ab8e397cf890631463692d4d655
-  data.tar.gz: 7b80fe220f197d16a45ecc6cc83495388efd1261a90c2597ca0651666b885dbeccf9fe4809f46e19fad47361113f0f0fd3ea267df8fe8c65c437e4feff8a3ba5
+  metadata.gz: f5c30750553e49bcfef55ccefd3842d006f08fef508a8f966fff7a882e334c5a13b7f34d28497f2ceadc74bdfa4e2b443bf4fca41730ff9eaa024893a184dae7
+  data.tar.gz: 887fe2d2a19f5c277119ab74b511bad76ef6316693c76b9a51c8308d882ab5e591ee068c7d715d73a474eb0788b456c555bba732041be49827e4ee9e4bcdc87b

data/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 dependencies.
+
 ## [11.0.2] - 2025-04-27
 - Add more sig definitions [#571](https://github.com/appium/ruby_lib_core/pull/571)
 

data/Gemfile

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

data/README.md

@@ -114,8 +114,8 @@ $ IGNORE_VERSION_SKIP=true CI=true bundle exec rake test:func:android
     opts = {
       capabilities: { # Append capabilities
         platformName: 'ios',
-        platformVersion: '11.0',
-        deviceName: 'iPhone Simulator',
+        platformVersion: '18.4',
+        deviceName: 'iPhone 16 Plus',
         # app: '/path/to/MyiOS.app',  # Without 'app' capability, an appium session starts with the home screen
         automationName: 'XCUITest'
       },
@@ -138,7 +138,7 @@ $ IGNORE_VERSION_SKIP=true CI=true bundle exec rake test:func:android
     $ ruby test.rb
     ```
 
-[Appium::Core.for](https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver#for-class_method) documentation has more example to build a new driver instance.
+[Appium::Core.for](https://rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver#for-class_method) documentation has more example to build a new driver instance.
 
 More examples are in [test/functional](test/functional)
 
@@ -153,9 +153,29 @@ attached_driver.page_source
 
 ### Capabilities
 
-Read [Appium/Core/Driver](https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver) to catch up with available capabilities.
-Capabilities affect only ruby_lib is [Appium/Core/Options](https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Options).
+Read [Appium/Core/Driver](https://rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver) to catch up with available capabilities.
+Capabilities affect only ruby_lib is [Appium/Core/Options](https://rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Options).
 
+### Improvement ideas
+
+- for iOS
+
+```
+$ appium driver run xcuitest download-wda-sim --outdir=/path/to/download/prebuilt/wda/
+```
+
+Then, adding capabilities below:
+
+```json
+{
+  "appium:usePreinstalledWDA": true,
+  "appium:prebuiltWDAPath": "/path/to/download/prebuilt/wda/WebDriverAgentRunner-Runner.app"
+}
+```
+
+It will improve initial new session request performance for iOS simulator.
+
+`"appium:settings[respectSystemAlerts]" => true` for capability will also help to work with [permissions](https://appium.github.io/appium-xcuitest-driver/latest/guides/troubleshooting/#interact-with-dialogs-managed-by-comapplespringboard).
 
 ### Gives custom listener
 
@@ -171,7 +191,7 @@ capabilities: {
   deviceName: 'iPhone Simulator',
   automationName: 'XCUITest',
   app: '/path/to/MyiOS.app'
-},
+}
 appium_lib: {
   listener: CustomListener.new
 }

data/appium_lib_core.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faye-websocket', '~> 0.11.0'
+  spec.add_dependency 'faye-websocket', '>= 0.11', '< 0.13'
   spec.add_dependency 'selenium-webdriver', '~> 4.21'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

data/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

data/lib/appium_lib_core/common/base/driver.rb

@@ -54,7 +54,9 @@ module Appium
           @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 @@ module Appium
 
           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 @@ module Appium
         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

data/lib/appium_lib_core/common/base.rb

@@ -30,8 +30,9 @@ require_relative 'device/execute_driver'
 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'

data/lib/appium_lib_core/common/device/keyboard.rb

@@ -25,7 +25,7 @@ module Appium
             execute_script 'mobile:hideKeyboard', option
           end
 
-          def is_keyboard_shown # rubocop:disable Naming/PredicateName
+          def is_keyboard_shown # rubocop:disable Naming/PredicatePrefix
             execute_script 'mobile:isKeyboardShown', {}
           end
         end # module Keyboard

data/lib/appium_lib_core/driver.rb

@@ -421,8 +421,8 @@ module Appium
             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

data/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

data/sig/lib/appium_lib_core/common/base/bidi_bridge.rbs

@@ -0,0 +1,25 @@
+module Appium
+  module Core
+    class Base
+      class BiDiBridge < ::Appium::Core::Base::Bridge
+        @bidi: ::Selenium::WebDriver::BiDi
+
+        def attach_to: (untyped session_id, untyped platform_name, untyped automation_name) -> untyped
+
+        def create_session: (untyped capabilities) -> ::Appium::Core::Base::Capabilities
+
+        def get: (string url) -> untyped
+
+        def go_back: () -> untyped
+
+        def go_forward: () -> untyped
+
+        def refresh: () -> untyped
+
+        def quit: () -> untyped
+
+        def close: () -> untyped
+      end
+    end
+  end
+end

data/sig/lib/appium_lib_core/common/base/bridge.rbs

@@ -94,7 +94,7 @@ module Appium
         #   core = ::Appium::Core.for(caps)
         #   driver = core.start_driver
         #
-        def create_session: (untyped capabilities) -> untyped
+        def create_session: (untyped capabilities) -> ::Appium::Core::Base::Capabilities
 
         # Append +appium:+ prefix for Appium following W3C spec
         # https://www.w3.org/TR/webdriver/#dfn-validate-capabilities

data/sig/lib/appium_lib_core/common/base/search_context.rbs

@@ -1 +1,9 @@
-APPIUM_EXTRA_FINDERS: { accessibility_id: "accessibility id", image: "-image", custom: "-custom", uiautomator: "-android uiautomator", viewtag: "-android viewtag", data_matcher: "-android datamatcher", view_matcher: "-android viewmatcher", predicate: "-ios predicate string", class_chain: "-ios class chain" }
+module Appium
+  module Core
+    class Base
+      module SearchContext
+        APPIUM_EXTRA_FINDERS: { Symbol => String }
+      end
+    end
+  end
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 11.0.2
+  version: 11.1.1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-28 00:00:00.000000000 Z
+date: 2025-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +78,7 @@ files:
 - lib/appium_lib_core/android_uiautomator2.rb
 - lib/appium_lib_core/common.rb
 - lib/appium_lib_core/common/base.rb
+- lib/appium_lib_core/common/base/bidi_bridge.rb
 - lib/appium_lib_core/common/base/bridge.rb
 - lib/appium_lib_core/common/base/capabilities.rb
 - lib/appium_lib_core/common/base/device_ime.rb
@@ -187,6 +194,7 @@ files:
 - sig/lib/appium_lib_core/android/uiautomator1/bridge.rbs
 - sig/lib/appium_lib_core/android/uiautomator2/bridge.rbs
 - sig/lib/appium_lib_core/android/uiautomator2/device/battery.rbs
+- sig/lib/appium_lib_core/common/base/bidi_bridge.rbs
 - sig/lib/appium_lib_core/common/base/bridge.rbs
 - sig/lib/appium_lib_core/common/base/capabilities.rbs
 - sig/lib/appium_lib_core/common/base/device_ime.rbs