selenium-webdriver 4.17.0 → 4.26.0

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

@@ -22,6 +22,8 @@ module Selenium
     module Remote
       class Bridge
         autoload :COMMANDS, 'selenium/webdriver/remote/bridge/commands'
+        autoload :LocatorConverter, 'selenium/webdriver/remote/bridge/locator_converter'
+
         include Atoms
 
         PORT = 4444
@@ -29,6 +31,25 @@ module Selenium
         attr_accessor :http, :file_detector
         attr_reader :capabilities
 
+        class << self
+          attr_reader :extra_commands
+          attr_writer :element_class, :locator_converter
+
+          def add_command(name, verb, url, &block)
+            @extra_commands ||= {}
+            @extra_commands[name] = [verb, url]
+            define_method(name, &block)
+          end
+
+          def locator_converter
+            @locator_converter ||= LocatorConverter.new
+          end
+
+          def element_class
+            @element_class ||= Element
+          end
+        end
+
         #
         # Initializes the bridge with the given server URL
         # @param [String, URI] url url for the remote server
@@ -43,6 +64,8 @@ module Selenium
           @http = http_client || Http::Default.new
           @http.server_url = uri
           @file_detector = nil
+
+          @locator_converter = self.class.locator_converter
         end
 
         #
@@ -278,6 +301,7 @@ module Selenium
         #
 
         def local_storage_item(key, value = nil)
+          WebDriver.logger.deprecate('local_storage_item(key, value)', id: :local_storage_item)
           if value
             execute_script("localStorage.setItem('#{key}', '#{value}')")
           else
@@ -286,22 +310,27 @@ module Selenium
         end
 
         def remove_local_storage_item(key)
+          WebDriver.logger.deprecate('remove_local_storage_item(key)', id: :remove_local_storage_item)
           execute_script("localStorage.removeItem('#{key}')")
         end
 
         def local_storage_keys
+          WebDriver.logger.deprecate('local_storage_keys', id: :local_storage_keys)
           execute_script('return Object.keys(localStorage)')
         end
 
         def clear_local_storage
+          WebDriver.logger.deprecate('clear_local_storage', id: :clear_local_storage)
           execute_script('localStorage.clear()')
         end
 
         def local_storage_size
+          WebDriver.logger.deprecate('local_storage_size', id: :local_storage_size)
           execute_script('return localStorage.length')
         end
 
         def session_storage_item(key, value = nil)
+          WebDriver.logger.deprecate('session_storage_item(key, value)', id: :session_storage_item)
           if value
             execute_script("sessionStorage.setItem('#{key}', '#{value}')")
           else
@@ -310,18 +339,22 @@ module Selenium
         end
 
         def remove_session_storage_item(key)
+          WebDriver.logger.deprecate('remove_session_storage_item(key)', id: :remove_session_storage_item)
           execute_script("sessionStorage.removeItem('#{key}')")
         end
 
         def session_storage_keys
+          WebDriver.logger.deprecate('session_storage_keys', id: :session_storage_keys)
           execute_script('return Object.keys(sessionStorage)')
         end
 
         def clear_session_storage
+          WebDriver.logger.deprecate('clear_session_storage', id: :clear_session_storage)
           execute_script('sessionStorage.clear()')
         end
 
         def session_storage_size
+          WebDriver.logger.deprecate('session_storage_size', id: :session_storage_size)
           execute_script('return sessionStorage.length')
         end
 
@@ -413,7 +446,7 @@ module Selenium
                    "e.initEvent('submit', true, true);\n" \
                    "if (form.dispatchEvent(e)) { HTMLFormElement.prototype.submit.call(form) }\n"
 
-          execute_script(script, Element::ELEMENT_KEY => element)
+          execute_script(script, Bridge.element_class::ELEMENT_KEY => element)
         rescue Error::JavascriptError
           raise Error::UnsupportedOperationError, 'To submit an element, it must be nested inside a form element'
         end
@@ -500,13 +533,13 @@ module Selenium
         #
 
         def active_element
-          Element.new self, element_id_from(execute(:get_active_element))
+          Bridge.element_class.new self, element_id_from(execute(:get_active_element))
         end
 
         alias switch_to_active_element active_element
 
         def find_element_by(how, what, parent_ref = [])
-          how, what = convert_locator(how, what)
+          how, what = @locator_converter.convert(how, what)
 
           return execute_atom(:findElements, Support::RelativeLocator.new(what).as_json).first if how == 'relative'
 
@@ -520,11 +553,11 @@ module Selenium
                  execute :find_element, {}, {using: how, value: what.to_s}
                end
 
-          Element.new self, element_id_from(id)
+          Bridge.element_class.new self, element_id_from(id)
         end
 
         def find_elements_by(how, what, parent_ref = [])
-          how, what = convert_locator(how, what)
+          how, what = @locator_converter.convert(how, what)
 
           return execute_atom :findElements, Support::RelativeLocator.new(what).as_json if how == 'relative'
 
@@ -538,7 +571,7 @@ module Selenium
                   execute :find_elements, {}, {using: how, value: what.to_s}
                 end
 
-          ids.map { |id| Element.new self, element_id_from(id) }
+          ids.map { |id| Bridge.element_class.new self, element_id_from(id) }
         end
 
         def shadow_root(element)
@@ -579,6 +612,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
@@ -612,7 +690,7 @@ module Selenium
         end
 
         def commands(command)
-          command_list[command]
+          command_list[command] || Bridge.extra_commands[command]
         end
 
         def unwrap_script_result(arg)
@@ -621,7 +699,7 @@ module Selenium
             arg.map { |e| unwrap_script_result(e) }
           when Hash
             element_id = element_id_from(arg)
-            return Element.new(self, element_id) if element_id
+            return Bridge.element_class.new(self, element_id) if element_id
 
             shadow_root_id = shadow_root_id_from(arg)
             return ShadowRoot.new self, shadow_root_id if shadow_root_id
@@ -633,7 +711,7 @@ module Selenium
         end
 
         def element_id_from(id)
-          id['ELEMENT'] || id[Element::ELEMENT_KEY]
+          id['ELEMENT'] || id[Bridge.element_class::ELEMENT_KEY]
         end
 
         def shadow_root_id_from(id)
@@ -644,43 +722,6 @@ module Selenium
           capabilities = {alwaysMatch: capabilities} if !capabilities['alwaysMatch'] && !capabilities['firstMatch']
           {capabilities: capabilities}
         end
-
-        def convert_locator(how, what)
-          how = SearchContext::FINDERS[how.to_sym] || how
-
-          case how
-          when 'class name'
-            how = 'css selector'
-            what = ".#{escape_css(what.to_s)}"
-          when 'id'
-            how = 'css selector'
-            what = "##{escape_css(what.to_s)}"
-          when 'name'
-            how = 'css selector'
-            what = "*[name='#{escape_css(what.to_s)}']"
-          end
-
-          if what.is_a?(Hash)
-            what = what.each_with_object({}) do |(h, w), hash|
-              h, w = convert_locator(h.to_s, w)
-              hash[h] = w
-            end
-          end
-
-          [how, what]
-        end
-
-        ESCAPE_CSS_REGEXP = /(['"\\#.:;,!?+<>=~*^$|%&@`{}\-\[\]()])/
-        UNICODE_CODE_POINT = 30
-
-        # Escapes invalid characters in CSS selector.
-        # @see https://mathiasbynens.be/notes/css-escapes
-        def escape_css(string)
-          string = string.gsub(ESCAPE_CSS_REGEXP) { |match| "\\#{match}" }
-          string = "\\#{UNICODE_CODE_POINT + Integer(string[0])} #{string[1..]}" if string[0]&.match?(/[[:digit:]]/)
-
-          string
-        end
       end # Bridge
     end # Remote
   end # WebDriver

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

@@ -99,7 +99,7 @@ module Selenium
           end
 
           def camel_case(str_or_sym)
-            str_or_sym.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+            str_or_sym.to_s.gsub(/_([a-z])/) { Regexp.last_match(1)&.upcase }
           end
 
           private

data/lib/selenium/webdriver/remote/http/common.rb

@@ -26,10 +26,18 @@ module Selenium
           CONTENT_TYPE    = 'application/json'
           DEFAULT_HEADERS = {
             'Accept' => CONTENT_TYPE,
-            'Content-Type' => "#{CONTENT_TYPE}; charset=UTF-8",
-            'User-Agent' => "selenium/#{WebDriver::VERSION} (ruby #{Platform.os})"
+            'Content-Type' => "#{CONTENT_TYPE}; charset=UTF-8"
           }.freeze
 
+          class << self
+            attr_accessor :extra_headers
+            attr_writer :user_agent
+
+            def user_agent
+              @user_agent ||= "selenium/#{WebDriver::VERSION} (ruby #{Platform.os})"
+            end
+          end
+
           attr_writer :server_url
 
           def quit_errors
@@ -42,7 +50,7 @@ module Selenium
 
           def call(verb, url, command_hash)
             url      = server_url.merge(url) unless url.is_a?(URI)
-            headers  = DEFAULT_HEADERS.dup
+            headers  = common_headers.dup
             headers['Cache-Control'] = 'no-cache' if verb == :get
 
             if command_hash
@@ -61,6 +69,16 @@ module Selenium
 
           private
 
+          def common_headers
+            @common_headers ||= begin
+              headers = DEFAULT_HEADERS.dup
+              headers['User-Agent'] = Common.user_agent
+              headers = headers.merge(Common.extra_headers || {})
+
+              headers
+            end
+          end
+
           def server_url
             return @server_url if @server_url
 

data/lib/selenium/webdriver/remote/http/curb.rb

@@ -37,6 +37,13 @@ module Selenium
         #
 
         class Curb < Common
+          attr_accessor :timeout
+
+          def initialize(timeout: nil)
+            @timeout = timeout
+            super()
+          end
+
           def quit_errors
             [Curl::Err::RecvError] + super
           end
@@ -53,7 +60,7 @@ module Selenium
             client.headers = headers
 
             # http://github.com/taf2/curb/issues/issue/33
-            client.head   = false
+            client.head = false
             client.delete = false
 
             case verb
@@ -80,11 +87,10 @@ module Selenium
             @client ||= begin
               c = Curl::Easy.new
 
-              c.max_redirects   = MAX_REDIRECTS
+              c.max_redirects = MAX_REDIRECTS
               c.follow_location = true
-              c.timeout         = @timeout if @timeout
-              c.verbose         = WebDriver.logger.debug?
-
+              c.timeout = timeout if timeout
+              c.verbose = WebDriver.logger.debug?
               c
             end
           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,17 +56,13 @@ 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)
+        def add_cause(ex, error, backtrace)
+          cause = Error::WebDriverError.new
+          backtrace = backtrace_from_remote(backtrace) if backtrace.is_a?(Array)
+          cause.set_backtrace(backtrace)
+          raise ex, cause: cause
+        rescue Error.for_error(error)
+          ex
         end
 
         def backtrace_from_remote(server_trace)
@@ -78,14 +71,14 @@ module Selenium
 
             file = frame['fileName']
             line = frame['lineNumber']
-            meth = frame['methodName']
+            method = frame['methodName']
 
             class_name = frame['className']
             file = "#{class_name}(#{file})" if class_name
 
-            meth = 'unknown' if meth.nil? || meth.empty?
+            method = 'unknown' if method.nil? || method.empty?
 
-            "[remote server] #{file}:#{line}:in `#{meth}'"
+            "[remote server] #{file}:#{line}:in `#{method}'"
           end
         end
 

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,12 +25,13 @@ 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'
 
       module Http
-        autoload :Common,  'selenium/webdriver/remote/http/common'
+        autoload :Common, 'selenium/webdriver/remote/http/common'
         autoload :Default, 'selenium/webdriver/remote/http/default'
       end
     end

data/lib/selenium/webdriver/safari/service.rb

@@ -24,7 +24,7 @@ module Selenium
         DEFAULT_PORT = 7050
         EXECUTABLE = 'safaridriver'
         SHUTDOWN_SUPPORTED = false
-
+        DRIVER_PATH_ENV_KEY = 'SE_SAFARIDRIVER'
         def initialize(path: nil, port: nil, log: nil, args: nil)
           raise Error::WebDriverError, 'Safari Service does not support setting log output' if log
 

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.17.0'
+    VERSION = '4.26.0'
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver.rb

@@ -49,7 +49,7 @@ module Selenium
     # @api private
 
     def self.root
-      @root ||= File.expand_path('..', __dir__)
+      @root ||= File.expand_path('..', __dir__.to_s)
     end
 
     #

data/selenium-webdriver.gemspec

@@ -47,18 +47,21 @@ 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']
   s.add_development_dependency 'rake', ['~> 13.0']
   s.add_development_dependency 'rspec', ['~> 3.0']
-  s.add_development_dependency 'rubocop', ['~> 1.42']
+  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']
-  s.add_development_dependency 'yard', ['~> 0.9.11']
+  s.add_development_dependency 'yard', ['~> 0.9.11', '>= 0.9.36']
 end