selenium-webdriver 4.22.0 → 4.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 425032a72d60652d09ca2ee43f54c4d9ff9abdb8d22cde817902b59ee42f4bb1
-  data.tar.gz: 149b4ee90b89bf5d5c82fbc274f2758034dd0827671639041232a8fee208b756
+  metadata.gz: 6eff1b0194347648ce4b4e5f2e5871f2fdfdeb85fa00edb762db57f480aeb3e0
+  data.tar.gz: d2d6c02c0357e5b52f0e843a704a554c0bf853d5b16c76bf6ed909614c0d62f1
 SHA512:
-  metadata.gz: 3025eae993eb26d61f3bc67d975611c8bf5a0c61ebf72685b19c263f2d4a1dc26c55e0c4dc9c406e17cdcd84437fc6bf56d583ef3833b227299109abefa294b6
-  data.tar.gz: 32e914171ea8ba5b4635edf5f829a982f6a343911475a56827b71ded109e3702fcd4079b7db12c49311e16b3ef1df81b0ee4365df1c6011c542aca8d7a348d19
+  metadata.gz: 4d7fa72ea30b744c7fd5eb6ddaa7c61b889a1dc5f0d21ef36d6e03fa7ad983e94c0ac071e7a6f0c6942e6d3d43722923d1b8d33ac1b83c43597ea5f153ebc275
+  data.tar.gz: 1288baedcdaea282540c55457eff420891b3fabe8b791a62a22b71a0fdd4c6da6e16b1f3a9d83056d684ea8a2efe1f674a40f206ef8ad9b659fcded049dd9695

data/CHANGES

@@ -1,3 +1,11 @@
+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)
 =========================
 

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/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.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'
@@ -99,3 +100,5 @@ 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/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,46 @@ 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)

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/version.rb

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

data/selenium-webdriver.gemspec

@@ -47,11 +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 'logger', ['~> 1.4']
-  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']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-webdriver
 version: !ruby/object:Gem::Version
-  version: 4.22.0
+  version: 4.23.0
 platform: ruby
 authors:
 - Alex Rodionov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -328,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
@@ -343,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