selenium-webdriver 4.21.1 → 4.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b167c7575b53791dfd989aae9c4ba8375661ff7c43fe343c4f4234673f8f6ba0
-  data.tar.gz: cc520cbd925b221a24e38547b15101bbf68812989affaf7435534f96099f7bc4
+  metadata.gz: 6eff1b0194347648ce4b4e5f2e5871f2fdfdeb85fa00edb762db57f480aeb3e0
+  data.tar.gz: d2d6c02c0357e5b52f0e843a704a554c0bf853d5b16c76bf6ed909614c0d62f1
 SHA512:
-  metadata.gz: 7313dfdf491d92732485821260da007ad0b63bd5570e9c5623c7fc6dfdba0b14fdddd6293d62c7e30b31610ca986a7c17291174091e1d3ffb7d3dee81caaeffe
-  data.tar.gz: 63a335b0a954e00c75cee80f9c2129360e1542b9d1d7528b461d51b5840935457a88a3528114f29f146949cf273581143dc1eaa8aefd6b479a3c81e0d3d0cc1f
+  metadata.gz: 4d7fa72ea30b744c7fd5eb6ddaa7c61b889a1dc5f0d21ef36d6e03fa7ad983e94c0ac071e7a6f0c6942e6d3d43722923d1b8d33ac1b83c43597ea5f153ebc275
+  data.tar.gz: 1288baedcdaea282540c55457eff420891b3fabe8b791a62a22b71a0fdd4c6da6e16b1f3a9d83056d684ea8a2efe1f674a40f206ef8ad9b659fcded049dd9695

data/CHANGES

@@ -1,3 +1,25 @@
+4.23.0 (2024-07-18)
+=========================
+* Add FedCM support to the ruby selenium client (#13796)
+* Add URLs constant to update error messages (#14174)
+* Update selenium manager types (#14189)
+* Add backtrace locations and cause to errors (#14170)
+* Add CDP for Chrome 127 and remove 124
+
+4.22.0 (2024-06-20)
+=========================
+
+* Force UTF-8 encoding on logger (see #6937)
+* Don't crash when ChildProcess is already killed (see #14032)
+* Manage bidi instance on the bridge not the driver (#14071)
+* Implement High Level Logging API with BiDi (#14073)
+* Fix bug with message deletion in Guard class
+* Change output for Guard class
+* Implement toggle for BiDi and Classic implementations (#14092)
+* Add preference to enable CDP in Firefox by default (#14091)
+* Add support for the w3c silent option for the ruby library (#14152)
+* Add CDP for Chrome 126 and remove 123
+
 4.21.1 (2024-05-16)
 =========================
 

data/README.md

@@ -15,7 +15,7 @@ This gem provides Ruby bindings for Selenium and supports MRI >= 3.0.
 
 ## License
 
-Copyright 2009-2023 Software Freedom Conservancy
+Copyright 2009-2024 Software Freedom Conservancy
 
 Licensed to the Software Freedom Conservancy (SFC) under one
 or more contributor license agreements.  See the NOTICE file

data/lib/selenium/webdriver/bidi/log/javascript_log_entry.rb

@@ -24,7 +24,7 @@ module Selenium
         attr_accessor :type
 
         def initialize(level:, text:, timestamp:, type:, stack_trace:)
-          super(level: level, text: text, timestamp: timestamp, type: type, stack_trace: stack_trace)
+          super
           @type = 'javascript'
         end
       end # JavascriptLogEntry

data/lib/selenium/webdriver/bidi/log_handler.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you 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.
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class LogHandler
+        ConsoleLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :method, :args, :type)
+        JavaScriptLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type)
+
+        def initialize(bidi)
+          @bidi = bidi
+          @log_entry_subscribed = false
+        end
+
+        # @return [int] id of the handler
+        def add_message_handler(type)
+          subscribe_log_entry unless @log_entry_subscribed
+          @bidi.add_callback('log.entryAdded') do |params|
+            if params['type'] == type
+              log_entry_klass = type == 'console' ? ConsoleLogEntry : JavaScriptLogEntry
+              yield(log_entry_klass.new(**params))
+            end
+          end
+        end
+
+        # @param [int] id of the handler previously added
+        def remove_message_handler(id)
+          @bidi.remove_callback('log.entryAdded', id)
+          unsubscribe_log_entry if @log_entry_subscribed && @bidi.callbacks['log.entryAdded'].empty?
+        end
+
+        private
+
+        def subscribe_log_entry
+          @bidi.session.subscribe('log.entryAdded')
+          @log_entry_subscribed = true
+        end
+
+        def unsubscribe_log_entry
+          @bidi.session.unsubscribe('log.entryAdded')
+          @log_entry_subscribed = false
+        end
+      end # LogHandler
+    end # Bidi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log_inspector.rb

@@ -41,6 +41,10 @@ module Selenium
         }.freeze
 
         def initialize(driver, browsing_context_ids = nil)
+          WebDriver.logger.deprecate('LogInspector class',
+                                     'Script class with driver.script',
+                                     id: :log_inspector)
+
           unless driver.capabilities.web_socket_url
             raise Error::WebDriverError,
                   'WebDriver instance must support BiDi protocol'
@@ -92,7 +96,7 @@ module Selenium
 
         def on(event, &block)
           event = EVENTS[event] if event.is_a?(Symbol)
-          @bidi.callbacks["log.#{event}"] << block
+          @bidi.add_callback("log.#{event}", &block)
         end
 
         def check_valid_filter(filter_by)

data/lib/selenium/webdriver/bidi/session.rb

@@ -29,21 +29,21 @@ module Selenium
 
         def status
           status = @bidi.send_cmd('session.status')
-          Status.new(status['ready'], status['message'])
+          Status.new(**status)
         end
 
         def subscribe(events, browsing_contexts = nil)
-          events_list = Array(events)
-          browsing_contexts_list = browsing_contexts.nil? ? nil : Array(browsing_contexts)
+          opts = {events: Array(events)}
+          opts[:browsing_contexts] = Array(browsing_contexts) if browsing_contexts
 
-          @bidi.send_cmd('session.subscribe', events: events_list, contexts: browsing_contexts_list)
+          @bidi.send_cmd('session.subscribe', **opts)
         end
 
         def unsubscribe(events, browsing_contexts = nil)
-          events_list = Array(events)
-          browsing_contexts_list = browsing_contexts.nil? ? nil : Array(browsing_contexts)
+          opts = {events: Array(events)}
+          opts[:browsing_contexts] = Array(browsing_contexts) if browsing_contexts
 
-          @bidi.send_cmd('session.unsubscribe', events: events_list, contexts: browsing_contexts_list)
+          @bidi.send_cmd('session.unsubscribe', **opts)
         end
       end # Session
     end # BiDi

data/lib/selenium/webdriver/bidi/struct.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you 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.
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class Struct < ::Struct
+        class << self
+          def new(*args, &block)
+            super(*args) do
+              define_method(:initialize) do |**kwargs|
+                converted_kwargs = kwargs.transform_keys { |key| self.class.camel_to_snake(key.to_s).to_sym }
+                super(*converted_kwargs.values_at(*self.class.members))
+              end
+              class_eval(&block) if block
+            end
+          end
+
+          def camel_to_snake(camel_str)
+            camel_str.gsub(/([A-Z])/, '_\1').downcase
+          end
+        end
+      end
+    end
+
+    # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi.rb

@@ -22,7 +22,9 @@ module Selenium
     class BiDi
       autoload :Session, 'selenium/webdriver/bidi/session'
       autoload :LogInspector, 'selenium/webdriver/bidi/log_inspector'
+      autoload :LogHandler, 'selenium/webdriver/bidi/log_handler'
       autoload :BrowsingContext, 'selenium/webdriver/bidi/browsing_context'
+      autoload :Struct, 'selenium/webdriver/bidi/struct'
 
       def initialize(url:)
         @ws = WebSocketConnection.new(url: url)
@@ -36,6 +38,14 @@ module Selenium
         @ws.callbacks
       end
 
+      def add_callback(event, &block)
+        @ws.add_callback(event, &block)
+      end
+
+      def remove_callback(event, id)
+        @ws.remove_callback(event, id)
+      end
+
       def session
         @session ||= Session.new(self)
       end

data/lib/selenium/webdriver/chromium/driver.rb

@@ -29,6 +29,7 @@ module Selenium
         EXTENSIONS = [DriverExtensions::HasCDP,
                       DriverExtensions::HasBiDi,
                       DriverExtensions::HasCasting,
+                      DriverExtensions::HasFedCmDialog,
                       DriverExtensions::HasNetworkConditions,
                       DriverExtensions::HasNetworkInterception,
                       DriverExtensions::HasWebStorage,

data/lib/selenium/webdriver/common/child_process.rb

@@ -84,7 +84,7 @@ module Selenium
         return false unless @pid
 
         WebDriver.logger.debug("Checking if #{@pid} is exited:", id: :process)
-        _, @status = Process.waitpid2(@pid, Process::WNOHANG | Process::WUNTRACED) if @status.nil?
+        _, @status = waitpid2(@pid, Process::WNOHANG | Process::WUNTRACED) if @status.nil?
         return false if @status.nil?
 
         exit_code = @status.exitstatus || @status.termsig
@@ -105,7 +105,7 @@ module Selenium
       def wait
         return if exited?
 
-        _, @status = Process.waitpid2(@pid)
+        _, @status = waitpid2(@pid)
       end
 
       private
@@ -119,6 +119,12 @@ module Selenium
       rescue Errno::ECHILD, Errno::ESRCH
         # already dead
       end
+
+      def waitpid2(pid, flags = 0)
+        Process.waitpid2(pid, flags)
+      rescue Errno::ECHILD
+        # already dead
+      end
     end # ChildProcess
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/driver.rb

@@ -70,10 +70,9 @@ module Selenium
 
       def initialize(bridge: nil, listener: nil, **opts)
         @devtools = nil
-        @bidi = nil
         bridge ||= create_bridge(**opts)
-        add_extensions(bridge.browser)
         @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
+        add_extensions(@bridge.browser)
       end
 
       def inspect
@@ -100,6 +99,22 @@ module Selenium
         @navigate ||= WebDriver::Navigation.new(bridge)
       end
 
+      #
+      # @return [Script]
+      # @see Script
+      #
+
+      def script(*args)
+        if args.any?
+          WebDriver.logger.deprecate('`Driver#script` as an alias for `#execute_script`',
+                                     '`Driver#execute_script`',
+                                     id: :driver_script)
+          execute_script(*args)
+        else
+          @script ||= WebDriver::Script.new(bridge)
+        end
+      end
+
       #
       # @return [TargetLocator]
       # @see TargetLocator
@@ -174,7 +189,6 @@ module Selenium
       ensure
         @service_manager&.stop
         @devtools&.close
-        @bidi&.close
       end
 
       #
@@ -182,10 +196,7 @@ module Selenium
       #
 
       def close
-        # If no top-level browsing contexts are open after calling close,
-        # it indicates that the WebDriver session is closed.
-        # If the WebDriver session is closed, the BiDi session also needs to be closed.
-        bridge.close.tap { |handles| @bidi&.close if handles&.empty? }
+        bridge&.close
       end
 
       #
@@ -267,12 +278,6 @@ module Selenium
 
       alias all find_elements
 
-      #
-      #   driver.script('function() { ... };')
-      #
-
-      alias script execute_script
-
       # Get the first element matching the given selector. If given a
       # String or Symbol, it will be used as the id of the element.
       #
@@ -313,7 +318,8 @@ module Selenium
       attr_reader :bridge
 
       def create_bridge(caps:, url:, http_client: nil)
-        Remote::Bridge.new(http_client: http_client, url: url).tap do |bridge|
+        klass = caps['webSocketUrl'] ? Remote::BiDiBridge : Remote::Bridge
+        klass.new(http_client: http_client, url: url).tap do |bridge|
           bridge.create_session(caps)
         end
       end

data/lib/selenium/webdriver/common/driver_extensions/has_bidi.rb

@@ -28,7 +28,7 @@ module Selenium
         #
 
         def bidi
-          @bidi ||= Selenium::WebDriver::BiDi.new(url: capabilities[:web_socket_url])
+          @bridge.bidi
         end
       end # HasBiDi
     end # DriverExtensions

data/lib/selenium/webdriver/common/driver_extensions/has_fedcm_dialog.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you 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.
+
+module Selenium
+  module WebDriver
+    module DriverExtensions
+      module HasFedCmDialog
+        # Disables the promise rejection delay for FedCm.
+        #
+        # FedCm by default delays promise resolution in failure cases for privacy reasons.
+        # This method allows turning it off to let tests run faster where this is not relevant.
+        def enable_fedcm_delay=(enable)
+          @bridge.fedcm_delay(enable)
+        end
+
+        # Resets the FedCm dialog cooldown.
+        #
+        # If a user agent triggers a cooldown when the account chooser is dismissed,
+        # this method resets that cooldown so that the dialog can be triggered again immediately.
+        def reset_fedcm_cooldown
+          @bridge.reset_fedcm_cooldown
+        end
+
+        def fedcm_dialog
+          @fedcm_dialog ||= FedCM::Dialog.new(@bridge)
+        end
+
+        def wait_for_fedcm_dialog(timeout: 5, interval: 0.2, message: nil, ignore: nil)
+          wait = Wait.new(timeout: timeout, interval: interval, message: message, ignore: ignore)
+          wait.until do
+            fedcm_dialog if fedcm_dialog.type
+          rescue Error::NoSuchAlertError
+            nil
+          end
+        end
+      end # HasFedCmDialog
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/error.rb

@@ -37,17 +37,29 @@ module Selenium
       SUPPORT_MSG = 'For documentation on this error, please visit:'
       ERROR_URL = 'https://www.selenium.dev/documentation/webdriver/troubleshooting/errors'
 
-      class WebDriverError < StandardError; end
+      URLS = {
+        NoSuchElementError: "#{ERROR_URL}#no-such-element-exception",
+        StaleElementReferenceError: "#{ERROR_URL}#stale-element-reference-exception",
+        InvalidSelectorError: "#{ERROR_URL}#invalid-selector-exception",
+        NoSuchDriverError: "#{ERROR_URL}/driver_location"
+      }.freeze
+
+      class WebDriverError < StandardError
+        def initialize(msg = '')
+          # Remove this conditional when all the error pages have been documented
+          super(URLS[class_name] ? "#{msg}; #{SUPPORT_MSG} #{URLS[class_name]}" : msg)
+        end
+
+        def class_name
+          self.class.name&.split('::')&.last&.to_sym
+        end
+      end
 
       #
       # An element could not be located on the page using the given search parameters.
       #
 
-      class NoSuchElementError < WebDriverError
-        def initialize(msg = '')
-          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}#no-such-element-exception")
-        end
-      end
+      class NoSuchElementError < WebDriverError; end
 
       #
       # A command to switch to a frame could not be satisfied because the frame could not be found.
@@ -65,11 +77,7 @@ module Selenium
       # A command failed because the referenced element is no longer attached to the DOM.
       #
 
-      class StaleElementReferenceError < WebDriverError
-        def initialize(msg = '')
-          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}#stale-element-reference-exception")
-        end
-      end
+      class StaleElementReferenceError < WebDriverError; end
 
       #
       # A command failed because the referenced shadow root is no longer attached to the DOM.
@@ -143,11 +151,7 @@ module Selenium
       # Argument was an invalid selector.
       #
 
-      class InvalidSelectorError < WebDriverError
-        def initialize(msg = '')
-          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}#invalid-selector-exception")
-        end
-      end
+      class InvalidSelectorError < WebDriverError; end
 
       #
       # A new session could not be created.
@@ -232,11 +236,7 @@ module Selenium
       # Indicates that driver was not specified and could not be located.
       #
 
-      class NoSuchDriverError < WebDriverError
-        def initialize(msg = '')
-          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}/driver_location")
-        end
-      end
+      class NoSuchDriverError < WebDriverError; end
     end # Error
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/fedcm/account.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you 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.
+
+module Selenium
+  module WebDriver
+    module FedCM
+      # Represents an account displayed in a FedCm account list.
+      # See: https://fedidcg.github.io/FedCM/#dictdef-identityprovideraccount
+      #      https://fedidcg.github.io/FedCM/#webdriver-accountlist
+      class Account
+        LOGIN_STATE_SIGNIN = 'SignIn'
+        LOGIN_STATE_SIGNUP = 'SignUp'
+
+        attr_reader :account_id, :email, :name, :given_name, :picture_url,
+                    :idp_config_url, :login_state, :terms_of_service_url, :privacy_policy_url
+
+        # Initializes a new account with the provided attributes.
+        #
+        # @param [Hash]
+        def initialize(**args)
+          @account_id = args['accountId']
+          @email = args['email']
+          @name = args['name']
+          @given_name = args['givenName']
+          @picture_url = args['pictureUrl']
+          @idp_config_url = args['idpConfigUrl']
+          @login_state = args['loginState']
+          @terms_of_service_url = args['termsOfServiceUrl']
+          @privacy_policy_url = args['privacyPolicyUrl']
+        end
+      end # Account
+    end # FedCM
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/fedcm/dialog.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you 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.
+
+module Selenium
+  module WebDriver
+    module FedCM
+      class Dialog
+        def initialize(bridge)
+          @bridge = bridge
+        end
+
+        DIALOG_TYPE_ACCOUNT_LIST = 'AccountChooser'
+        DIALOG_TYPE_AUTO_REAUTH = 'AutoReauthn'
+
+        # Closes the dialog as if the user had clicked X.
+        def click
+          @bridge.click_fedcm_dialog_button
+        end
+
+        # Closes the dialog as if the user had clicked X.
+        def cancel
+          @bridge.cancel_fedcm_dialog
+        end
+
+        # Selects an account as if the user had clicked on it.
+        #
+        # @param [Integer] index The index of the account to select from the list returned by get_accounts.
+        def select_account(index)
+          @bridge.select_fedcm_account index
+        end
+
+        # Returns the type of the open dialog.
+        #
+        # One of DIALOG_TYPE_ACCOUNT_LIST and DIALOG_TYPE_AUTO_REAUTH.
+        def type
+          @bridge.fedcm_dialog_type
+        end
+
+        # Returns the title of the dialog.
+        def title
+          @bridge.fedcm_title
+        end
+
+        # Returns the subtitle of the dialog or nil if none.
+        def subtitle
+          @bridge.fedcm_subtitle
+        end
+
+        # Returns the accounts shown in the account chooser.
+        #
+        # If this is an auto reauth dialog, returns the single account that is being signed in.
+        def accounts
+          @bridge.fedcm_account_list.map { |account| Account.new(**account) }
+        end
+      end # Dialog
+    end # FedCM
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/fedcm.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you 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.
+
+module Selenium
+  module WebDriver
+    module FedCM
+      autoload :Account, 'fedcm/account'
+      autoload :Dialog, 'fedcm/dialog'
+    end # FedCM
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/interactions/pointer_cancel.rb

@@ -28,7 +28,7 @@ module Selenium
 
       class PointerCancel < Interaction
         def initialize(source)
-          super(source)
+          super
           @type = :pointerCancel
         end
 

data/lib/selenium/webdriver/common/interactions/wheel_input.rb

@@ -28,7 +28,7 @@ module Selenium
 
       class WheelInput < InputDevice
         def initialize(name = nil)
-          super(name)
+          super
           @type = Interactions::WHEEL
         end
 

data/lib/selenium/webdriver/common/logger.rb

@@ -185,7 +185,7 @@ module Selenium
         logger.progname = name
         logger.level = level
         logger.formatter = proc do |severity, time, progname, msg|
-          "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n"
+          "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n".force_encoding('UTF-8')
         end
 
         logger

data/lib/selenium/webdriver/common/script.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you 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.
+
+module Selenium
+  module WebDriver
+    class Script
+      def initialize(bridge)
+        @log_handler = BiDi::LogHandler.new(bridge.bidi)
+      end
+
+      # @return [int] id of the handler
+      def add_console_message_handler(&block)
+        @log_handler.add_message_handler('console', &block)
+      end
+
+      # @return [int] id of the handler
+      def add_javascript_error_handler(&block)
+        @log_handler.add_message_handler('javascript', &block)
+      end
+
+      # @param [int] id of the handler previously added
+      def remove_console_message_handler(id)
+        @log_handler.remove_message_handler(id)
+      end
+
+      alias remove_javascript_error_handler remove_console_message_handler
+    end # Script
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/websocket_connection.rb

@@ -52,6 +52,18 @@ module Selenium
         @callbacks ||= Hash.new { |callbacks, event| callbacks[event] = [] }
       end
 
+      def add_callback(event, &block)
+        callbacks[event] << block
+        block.object_id
+      end
+
+      def remove_callback(event, id)
+        return if callbacks[event].reject! { |callback| callback.object_id == id }
+
+        ids = callbacks[event]&.map(&:object_id)
+        raise Error::WebDriverError, "Callback with ID #{id} does not exist for event #{event}: #{ids}"
+      end
+
       def send_cmd(**payload)
         id = next_id
         data = payload.merge(id: id)

data/lib/selenium/webdriver/common.rb

@@ -89,6 +89,7 @@ require 'selenium/webdriver/common/driver_extensions/has_pinned_scripts'
 require 'selenium/webdriver/common/driver_extensions/has_cdp'
 require 'selenium/webdriver/common/driver_extensions/has_casting'
 require 'selenium/webdriver/common/driver_extensions/has_launching'
+require 'selenium/webdriver/common/driver_extensions/has_fedcm_dialog'
 require 'selenium/webdriver/common/keys'
 require 'selenium/webdriver/common/profile_helper'
 require 'selenium/webdriver/common/options'
@@ -98,3 +99,6 @@ require 'selenium/webdriver/common/element'
 require 'selenium/webdriver/common/shadow_root'
 require 'selenium/webdriver/common/websocket_connection'
 require 'selenium/webdriver/common/child_process'
+require 'selenium/webdriver/common/script'
+require 'selenium/webdriver/common/fedcm/account'
+require 'selenium/webdriver/common/fedcm/dialog'

data/lib/selenium/webdriver/firefox/options.rb

@@ -64,6 +64,9 @@ module Selenium
 
           @options[:args] ||= []
           @options[:prefs] ||= {}
+          # Firefox 129 onwards the CDP protocol will not be enabled by default. Setting this preference will enable it.
+          # https://fxdx.dev/deprecating-cdp-support-in-firefox-embracing-the-future-with-webdriver-bidi/.
+          @options[:prefs]['remote.active-protocols'] = 3
           @options[:env] ||= {}
           @options[:log] ||= {level: log_level} if log_level
 

data/lib/selenium/webdriver/ie/options.rb

@@ -42,7 +42,8 @@ module Selenium
           use_legacy_file_upload_dialog_handling: 'ie.useLegacyFileUploadDialogHandling',
           attach_to_edge_chrome: 'ie.edgechromium',
           edge_executable_path: 'ie.edgepath',
-          ignore_process_match: 'ie.ignoreprocessmatch'
+          ignore_process_match: 'ie.ignoreprocessmatch',
+          silent: 'silent'
         }.freeze
         BROWSER = 'internet explorer'
 
@@ -81,7 +82,7 @@ module Selenium
 
         def initialize(**opts)
           @args = (opts.delete(:args) || []).to_set
-          super(**opts)
+          super
 
           @options[:native_events] = true if @options[:native_events].nil?
         end

data/lib/selenium/webdriver/remote/bidi_bridge.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you 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.
+
+module Selenium
+  module WebDriver
+    module Remote
+      class BiDiBridge < Bridge
+        attr_reader :bidi
+
+        def create_session(capabilities)
+          super
+          socket_url = @capabilities[:web_socket_url]
+          @bidi = Selenium::WebDriver::BiDi.new(url: socket_url)
+        end
+
+        def quit
+          super
+        ensure
+          bidi.close
+        end
+
+        def close
+          execute(:close_window).tap { |handles| bidi.close if handles.empty? }
+        end
+      end # BiDiBridge
+    end # Remote
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/remote/bridge/commands.rb

@@ -155,8 +155,20 @@ module Selenium
           remove_credential: [:delete,
                               'session/:session_id/webauthn/authenticator/:authenticatorId/credentials/:credentialId'],
           remove_all_credentials: [:delete, 'session/:session_id/webauthn/authenticator/:authenticatorId/credentials'],
-          set_user_verified: [:post, 'session/:session_id/webauthn/authenticator/:authenticatorId/uv']
+          set_user_verified: [:post, 'session/:session_id/webauthn/authenticator/:authenticatorId/uv'],
 
+          #
+          # federated-credential management
+          #
+
+          get_fedcm_title: [:get, 'session/:session_id/fedcm/gettitle'],
+          get_fedcm_dialog_type: [:get, 'session/:session_id/fedcm/getdialogtype'],
+          get_fedcm_account_list: [:get, 'session/:session_id/fedcm/accountlist'],
+          click_fedcm_dialog_button: [:post, 'session/:session_id/fedcm/clickdialogbutton'],
+          cancel_fedcm_dialog: [:post, 'session/:session_id/fedcm/canceldialog'],
+          select_fedcm_account: [:post, 'session/:session_id/fedcm/selectaccount'],
+          set_fedcm_delay: [:post, 'session/:session_id/fedcm/setdelayenabled'],
+          reset_fedcm_cooldown: [:post, 'session/:session_id/fedcm/resetcooldown']
         }.freeze
       end # Bridge
     end # Remote

data/lib/selenium/webdriver/remote/bridge.rb

@@ -602,6 +602,51 @@ module Selenium
           execute :set_user_verified, {authenticatorId: authenticator_id}, {isUserVerified: verified}
         end
 
+        #
+        # federated-credential management
+        #
+
+        def cancel_fedcm_dialog
+          execute :cancel_fedcm_dialog
+        end
+
+        def select_fedcm_account(index)
+          execute :select_fedcm_account, {}, {accountIndex: index}
+        end
+
+        def fedcm_dialog_type
+          execute :get_fedcm_dialog_type
+        end
+
+        def fedcm_title
+          execute(:get_fedcm_title).fetch('title')
+        end
+
+        def fedcm_subtitle
+          execute(:get_fedcm_title).fetch('subtitle', nil)
+        end
+
+        def fedcm_account_list
+          execute :get_fedcm_account_list
+        end
+
+        def fedcm_delay(enabled)
+          execute :set_fedcm_delay, {}, {enabled: enabled}
+        end
+
+        def reset_fedcm_cooldown
+          execute :reset_fedcm_cooldown
+        end
+
+        def click_fedcm_dialog_button
+          execute :click_fedcm_dialog_button, {}, {dialogButton: 'ConfirmIdpLoginContinue'}
+        end
+
+        def bidi
+          msg = 'BiDi must be enabled by setting #web_socket_url to true in options class'
+          raise(WebDriver::Error::WebDriverError, msg)
+        end
+
         def command_list
           COMMANDS
         end

data/lib/selenium/webdriver/remote/response.rb

@@ -28,7 +28,7 @@ module Selenium
         attr_reader :code, :payload
 
         def initialize(code, payload = nil)
-          @code    = code
+          @code = code
           @payload = payload || {}
 
           assert_ok
@@ -37,11 +37,8 @@ module Selenium
         def error
           error, message, backtrace = process_error
           klass = Error.for_error(error) || return
-
           ex = klass.new(message)
-          ex.set_backtrace(caller)
-          add_backtrace ex, backtrace
-
+          add_cause(ex, error, backtrace)
           ex
         end
 
@@ -59,34 +56,12 @@ module Selenium
           raise Error::ServerError, self
         end
 
-        def add_backtrace(ex, server_trace)
-          return unless server_trace
-
-          backtrace = case server_trace
-                      when Array
-                        backtrace_from_remote(server_trace)
-                      when String
-                        server_trace.split("\n")
-                      end
-
-          ex.set_backtrace(backtrace + ex.backtrace)
-        end
-
-        def backtrace_from_remote(server_trace)
-          server_trace.filter_map do |frame|
-            next unless frame.is_a?(Hash)
-
-            file = frame['fileName']
-            line = frame['lineNumber']
-            meth = frame['methodName']
-
-            class_name = frame['className']
-            file = "#{class_name}(#{file})" if class_name
-
-            meth = 'unknown' if meth.nil? || meth.empty?
-
-            "[remote server] #{file}:#{line}:in `#{meth}'"
-          end
+        def add_cause(ex, error, backtrace)
+          cause = Error::WebDriverError.new
+          cause.set_backtrace(backtrace)
+          raise ex, cause: cause
+        rescue Error.for_error(error)
+          ex
         end
 
         def process_error

data/lib/selenium/webdriver/remote/server_error.rb

@@ -23,7 +23,7 @@ module Selenium
       class ServerError < StandardError
         def initialize(response)
           if response.is_a? String
-            super(response)
+            super
           else
             super("status code #{response.code}; payload #{response.payload}")
           end

data/lib/selenium/webdriver/remote.rb

@@ -25,6 +25,7 @@ module Selenium
     module Remote
       autoload :Features,     'selenium/webdriver/remote/features'
       autoload :Bridge,       'selenium/webdriver/remote/bridge'
+      autoload :BiDiBridge,   'selenium/webdriver/remote/bidi_bridge'
       autoload :Driver,       'selenium/webdriver/remote/driver'
       autoload :Response,     'selenium/webdriver/remote/response'
       autoload :Capabilities, 'selenium/webdriver/remote/capabilities'

data/lib/selenium/webdriver/support/guards/guard.rb

@@ -27,7 +27,7 @@ module Selenium
         #
 
         class Guard
-          attr_reader :guarded, :type, :messages, :reason
+          attr_reader :guarded, :type, :messages, :reason, :tracker
 
           def initialize(guarded, type, guards = nil)
             @guarded = guarded
@@ -36,22 +36,21 @@ module Selenium
             @messages[:unknown] = 'TODO: Investigate why this is failing and file a bug report'
             @type = type
 
-            @reason = @guarded.delete(:reason)
+            @reason = @guarded[:reason] || 'No reason given'
+            @guarded[:reason] = @reason
           end
 
           def message
-            details = case @reason
+            details = case reason
                       when Integer
-                        "Bug Filed: #{@tracker}/#{@reason}"
+                        "Bug Filed: #{tracker}/#{reason}"
                       when Symbol
-                        @messages[@reason]
-                      when String
-                        @reason
+                        messages[reason]
                       else
-                        'no reason given'
+                        "Guarded by #{guarded};"
                       end
 
-            case @type
+            case type
             when :exclude
               "Test skipped because it breaks test run; #{details}"
             when :flaky

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.21.1'
+    VERSION = '4.23.0'
   end # WebDriver
 end # Selenium

data/selenium-webdriver.gemspec

@@ -47,10 +47,11 @@ Gem::Specification.new do |s|
   s.bindir = 'bin'
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'base64', ['~> 0.2']
-  s.add_runtime_dependency 'rexml', ['~> 3.2', '>= 3.2.5']
-  s.add_runtime_dependency 'rubyzip', ['>= 1.2.2', '< 3.0']
-  s.add_runtime_dependency 'websocket', ['~> 1.0']
+  s.add_dependency 'base64', ['~> 0.2']
+  s.add_dependency 'logger', ['~> 1.4']
+  s.add_dependency 'rexml', ['~> 3.2', '>= 3.2.5']
+  s.add_dependency 'rubyzip', ['>= 1.2.2', '< 3.0']
+  s.add_dependency 'websocket', ['~> 1.0']
 
   s.add_development_dependency 'git', ['~> 1.19']
   s.add_development_dependency 'rack', ['~> 2.0']
@@ -58,6 +59,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', ['~> 3.0']
   s.add_development_dependency 'rubocop', ['~> 1.60', '>=1.60.2']
   s.add_development_dependency 'rubocop-performance', ['~> 1.15']
+  s.add_development_dependency 'rubocop-rake', ['~> 0.6.0']
   s.add_development_dependency 'rubocop-rspec', ['~> 2.16']
   s.add_development_dependency 'webmock', ['~> 3.5']
   s.add_development_dependency 'webrick', ['~> 1.7']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-webdriver
 version: !ruby/object:Gem::Version
-  version: 4.21.1
+  version: 4.23.0
 platform: ruby
 authors:
 - Alex Rodionov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -26,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +184,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -268,9 +296,11 @@ files:
 - lib/selenium/webdriver/bidi/log/filter_by.rb
 - lib/selenium/webdriver/bidi/log/generic_log_entry.rb
 - lib/selenium/webdriver/bidi/log/javascript_log_entry.rb
+- lib/selenium/webdriver/bidi/log_handler.rb
 - lib/selenium/webdriver/bidi/log_inspector.rb
 - lib/selenium/webdriver/bidi/navigate_result.rb
 - lib/selenium/webdriver/bidi/session.rb
+- lib/selenium/webdriver/bidi/struct.rb
 - lib/selenium/webdriver/chrome.rb
 - lib/selenium/webdriver/chrome/driver.rb
 - lib/selenium/webdriver/chrome/features.rb
@@ -298,6 +328,7 @@ files:
 - lib/selenium/webdriver/common/driver_extensions/has_context.rb
 - lib/selenium/webdriver/common/driver_extensions/has_debugger.rb
 - lib/selenium/webdriver/common/driver_extensions/has_devtools.rb
+- lib/selenium/webdriver/common/driver_extensions/has_fedcm_dialog.rb
 - lib/selenium/webdriver/common/driver_extensions/has_file_downloads.rb
 - lib/selenium/webdriver/common/driver_extensions/has_launching.rb
 - lib/selenium/webdriver/common/driver_extensions/has_log_events.rb
@@ -313,6 +344,9 @@ files:
 - lib/selenium/webdriver/common/driver_finder.rb
 - lib/selenium/webdriver/common/element.rb
 - lib/selenium/webdriver/common/error.rb
+- lib/selenium/webdriver/common/fedcm.rb
+- lib/selenium/webdriver/common/fedcm/account.rb
+- lib/selenium/webdriver/common/fedcm/dialog.rb
 - lib/selenium/webdriver/common/file_reaper.rb
 - lib/selenium/webdriver/common/html5/local_storage.rb
 - lib/selenium/webdriver/common/html5/session_storage.rb
@@ -347,6 +381,7 @@ files:
 - lib/selenium/webdriver/common/port_prober.rb
 - lib/selenium/webdriver/common/profile_helper.rb
 - lib/selenium/webdriver/common/proxy.rb
+- lib/selenium/webdriver/common/script.rb
 - lib/selenium/webdriver/common/search_context.rb
 - lib/selenium/webdriver/common/selenium_manager.rb
 - lib/selenium/webdriver/common/service.rb
@@ -393,6 +428,7 @@ files:
 - lib/selenium/webdriver/ie/options.rb
 - lib/selenium/webdriver/ie/service.rb
 - lib/selenium/webdriver/remote.rb
+- lib/selenium/webdriver/remote/bidi_bridge.rb
 - lib/selenium/webdriver/remote/bridge.rb
 - lib/selenium/webdriver/remote/bridge/commands.rb
 - lib/selenium/webdriver/remote/bridge/locator_converter.rb