Merge branch 'master' into dependabot/bundler/steep-tw-1.10.0

Author: KazuCocoa

.github/workflows/functional-test.yml

@@ -20,33 +20,47 @@ jobs:
         test_targets:
           - target: test/functional/ios/driver_test.rb,test/functional/ios/patch_test.rb
             name: test1
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/webdriver/create_session_test.rb,test/functional/ios/webdriver/w3c_actions_test.rb
             name: test2
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/webdriver/device_test.rb
             name: test3
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/ios/device_test.rb
             name: test4
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/ios/device_wda_attachment_test.rb,test/functional/ios/ios/search_context_test.rb
             name: test5
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/ios/image_comparison_test.rb
             name: test6
+            platform: ios
+            wdaName: WebDriverAgentRunner-Runner.app
           - target: test/functional/ios/tv_driver_test.rb
             name: test7
+            platform: tvOS
+            wdaName: WebDriverAgentRunner_tvOS-Runner.app
 
-    runs-on: macos-14
+    runs-on: macos-15
 
     # Please make sure the available Xcode versions and iOS versions
     # on the runner images. https://github.com/actions/runner-images
     env:
-      XCODE_VERSION: 15.3
-      IOS_VERSION: 17.4
-      IOS_DEVICE_NAME: iPhone 15 Plus
+      XCODE_VERSION: 16.4
+      IOS_VERSION: 18.5
+      IOS_DEVICE_NAME: iPhone 16 Plus
 
     steps:
     - uses: actions/checkout@v3
 
     - name: Install Node.js
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v5
       with:
         node-version: 'lts/*'
 
@@ -65,11 +79,16 @@ jobs:
     # Start Appium
     - run: npm install -g appium
     - run: |
-        appium driver install xcuitest
         appium plugin install images
         appium plugin install execute-driver
+        # Workaround to keep symlink to global appium
+        appium driver install xcuitest
         nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium.log &
 
+    - run: |
+        appium driver run xcuitest download-wda-sim --platform=${{matrix.test_targets.platform}} --outdir=${{github.workspace}}/wda
+      name: Downloading prebuilt WDA
+
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -83,6 +102,7 @@ jobs:
       env:
         IGNORE_VERSION_SKIP: true
         CI: true
+        LOCAL_PREBUILT_WDA: ${{ github.workspace }}/wda/${{matrix.test_targets.wdaName}}
 
     - name: Save server output
       if: ${{ always() }}
@@ -94,7 +114,14 @@ jobs:
           test/report/
 
   ios_test_with_other_deps:
-    runs-on: macos-14
+    runs-on: macos-15
+
+    # Please make sure the available Xcode versions and iOS versions
+    # on the runner images. https://github.com/actions/runner-images
+    env:
+      XCODE_VERSION: 16.4
+      IOS_VERSION: 18.5
+      IOS_DEVICE_NAME: iPhone 16 Plus
 
     steps:
     - uses: actions/checkout@v3
@@ -123,15 +150,21 @@ jobs:
         brew install applesimutils
 
     # Start Appium
+    - run: npm root -g
     - name: Install appium and mjpeg-consumer
       run: |
         npm install -g appium
         npm install -g mjpeg-consumer
     - run: |
-        appium driver install xcuitest
-        appium plugin install images@2.1.8
+        appium plugin install images
         appium plugin install execute-driver
-        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors > appium.log &
+        # Workaround to keep symlink to global appium
+        appium driver install xcuitest
+        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium.log &
+
+    - run: |
+        npx appium driver run xcuitest download-wda-sim --platform=ios --outdir=${{github.workspace}}/wda
+      name: Downloading prebuilt WDA
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
@@ -145,6 +178,7 @@ jobs:
       env:
         IGNORE_VERSION_SKIP: true
         CI: true
+        LOCAL_PREBUILT_WDA: ${{ github.workspace }}/wda/WebDriverAgentRunner-Runner.app
 
     - name: Save server output
       if: ${{ always() }}
@@ -192,9 +226,15 @@ jobs:
           - target: test/functional/android/android/mjpeg_server_test.rb,test/functional/android/android/image_comparison_test.rb
             automation_name: espresso
             name: test10
+          - 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: 34
+      API_LEVEL: 36
       ARCH: x86_64
 
     steps:
@@ -216,7 +256,7 @@ jobs:
         appium driver install ${{matrix.test_targets.automation_name}}
         appium plugin install images
         appium plugin install execute-driver
-        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors > appium.log &
+        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium.log &
 
     - name: Enable KVM group perms
       run: |

.github/workflows/unittest.yml

@@ -55,7 +55,7 @@ jobs:
         run: |
           gem install ffi
           bundle install
-          gem uninstall --force eventmachine && gem install eventmachine --platform ruby
+          gem uninstall --force eventmachine && gem install eventmachine --platform ruby -- --with-ldflags="-Wl,-undefined,dynamic_lookup"
       - name: Run tests
         run: |
           bundle exec rake test:unit

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,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)
+
 ## [11.0.1] - 2025-03-27
 - Remove `::Selenium::WebDriver::DriverExtensions::HasWebStorage` import to follow selenium webdriver 4.30.0
 

Gemfile

@@ -8,8 +8,8 @@ gem 'minitest', '~> 5.0'
 gem 'minitest-reporters', '~> 1.1'
 gem 'parallel_tests'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '1.75.2'
+gem 'rubocop', '1.81.7'
 gem 'simplecov'
 gem 'steep', '~> 1.10.0'
-gem 'webmock', '~> 3.25.0'
+gem 'webmock', '~> 3.26.0'
 gem 'yard', '~> 0.9.11'

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: '26.0',
+        deviceName: 'iPhone 17',
         # 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
 }

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'

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