appium_lib_core 11.0.1 → 11.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a55943a46ddf58f1d5d55f35ca053dd462e5fa64f96acc2fcc25bd0f9e359abb
-  data.tar.gz: 5fdec234ffc06d2d378ebfc328d6c8799e660f7ec0113ba67f24381da9aca682
+  metadata.gz: 701a3cbc303b81ada16130a28d1a4d2a42f96547b474cb612ef7d64e221fa1c9
+  data.tar.gz: 6af95a9abdb55ba70a678b007dae0d1f2a585140e80ffc19c90f7e271f88de19
 SHA512:
-  metadata.gz: 16711bfc64ce4ef4c6501f45f03bcaf4aac07a41d7f24a99e0307309f6d1a9a81de9a1a871d1a74e1da69cdcfa863c5a40b863c05c127821e90c723757ac3d06
-  data.tar.gz: 150380ab09f8287fc1863ea67c3144a858773704c8566c5ff5409e27246609f396c572a8ab28b120936ff7d040aea773ac5582f23f61d21b4aabc38812748fa8
+  metadata.gz: d0368fce9366a63d848c6ea3cea893a2df6a0a43a9d8b747affd0da66cd52a127a187df4f037ed628a055e010d7616f061a664df9a17f39971619ba13babf89b
+  data.tar.gz: b654930fcfb681003d8163c8ed7aed461b7633799e26c70bd9499fbbc336927ca9f87bf25254c1188960e88eade1370460557a83802a1799509de9c3e78144b5

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 All notable changes to this project will be documented in this file.
 Read `release_notes.md` for commit level details.
 
+## [11.1.0] - 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)
+
 ## [11.0.1] - 2025-03-27
 - Remove `::Selenium::WebDriver::DriverExtensions::HasWebStorage` import to follow selenium webdriver 4.30.0
 

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.74.0'
+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'])
+          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/app_management.rb

@@ -29,7 +29,7 @@ module Appium
 
           def install_app(path, options = {})
             args = { appPath: path }
-            args[:options] = options unless options.empty?
+            args[:options] = options unless options&.empty?
 
             execute :install_app, {}, args
           end

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.1' unless defined? ::Appium::Core::VERSION
-    DATE    = '2025-03-27' unless defined? ::Appium::Core::DATE
+    VERSION = '11.1.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2025-08-08' unless defined? ::Appium::Core::DATE
   end
 end

data/sig/gems/em.rbs

@@ -0,0 +1,5 @@
+module EM
+  def stop: () -> untyped
+
+  def run: () -> untyped
+end

data/sig/gems/faye.rbs

@@ -0,0 +1,10 @@
+module Faye
+  module WebSocket
+    class Client
+      def initialize: (String, String, Hash[Symbol, untyped]) -> void
+      def close: () -> void
+      def send: (String) -> void
+      def on: (String, Proc) -> void
+    end
+  end
+end

data/sig/gems/selenium/atoms.rbs

@@ -0,0 +1,16 @@
+module Selenium
+  module WebDriver
+    module Atoms
+      include _Bridge
+      include _ExecuteScript
+
+      def atom_script: (Symbol) -> String
+
+      private
+
+      def read_atom: (Symbol function) -> String
+
+      def execute_atom: (Symbol function_name, [Element | String | Symbol] arguments) -> [Element | Integer | Float | bool | nil | String | Array[untyped]]
+    end
+  end
+end

data/sig/gems/selenium/bidi/browsing_context.rbs

@@ -0,0 +1,27 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      class BrowsingContext
+        @bidi: untyped
+
+        @id: untyped
+
+        attr_accessor id: untyped
+
+        READINESS_STATE: Hash[Symbol, String]
+
+        def initialize: (driver: untyped, ?browsing_context_id: untyped?, ?type: untyped?, ?reference_context: untyped?) -> void
+
+        def navigate: (url: untyped, ?readiness_state: untyped?) -> untyped
+
+        def get_tree: (?max_depth: untyped?) -> untyped
+
+        def close: () -> untyped
+
+        private
+
+        def create: (untyped type, untyped reference_context) -> untyped
+      end
+    end
+  end
+end

data/sig/gems/selenium/bidi/browsing_context_info.rbs

@@ -0,0 +1,25 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      class BrowsingContextInfo
+        @id: untyped
+
+        @url: untyped
+
+        @children: untyped
+
+        @parent_browsing_context: untyped
+
+        attr_accessor id: untyped
+
+        attr_accessor url: untyped
+
+        attr_accessor children: untyped
+
+        attr_accessor parent_browsing_context: untyped
+
+        def initialize: (id: untyped, url: untyped, children: untyped, parent_context: untyped) -> void
+      end
+    end
+  end
+end

data/sig/gems/selenium/bidi/log_inspector.rbs

@@ -0,0 +1,33 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      class LogInspector
+        @bidi: untyped
+
+        EVENTS: Hash[Symbol, String]
+
+        LOG_LEVEL: Hash[Symbol, String]
+
+        def initialize: (untyped driver, ?untyped? browsing_context_ids) -> void
+
+        def on_console_entry: (?untyped? filter_by) { () -> untyped } -> untyped
+
+        def on_javascript_log: (?untyped? filter_by) { () -> untyped } -> untyped
+
+        def on_javascript_exception: () { () -> untyped } -> untyped
+
+        def on_log: (?untyped? filter_by) { (untyped) -> untyped } -> untyped?
+
+        private
+
+        def on: (untyped event) { () -> untyped } -> untyped
+
+        def check_valid_filter: (untyped filter_by) -> (nil | untyped)
+
+        def console_log_events: (untyped params, untyped filter_by) { (untyped) -> untyped } -> untyped?
+
+        def javascript_log_events: (untyped params, untyped filter_by) { (untyped) -> untyped } -> untyped?
+      end
+    end
+  end
+end

data/sig/gems/selenium/bidi/navigate_result.rbs

@@ -0,0 +1,17 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      class NavigateResult
+        @url: untyped
+
+        @navigation_id: untyped
+
+        attr_accessor url: untyped
+
+        attr_accessor navigation_id: untyped
+
+        def initialize: (url: untyped, navigation_id: untyped) -> void
+      end
+    end
+  end
+end

data/sig/gems/selenium/bidi/session.rbs

@@ -0,0 +1,19 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      class Session
+        @bidi: untyped
+
+        Status: untyped
+
+        def initialize: (untyped bidi) -> void
+
+        def status: () -> untyped
+
+        def subscribe: (untyped events, ?untyped? browsing_contexts) -> untyped
+
+        def unsubscribe: (untyped events, ?untyped? browsing_contexts) -> untyped
+      end
+    end
+  end
+end