selenium-webdriver 4.1.0 → 4.12.0

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Remote
-
       #
       # Driver implementation for remote server.
       # @api private
@@ -29,19 +28,13 @@ module Selenium
       class Driver < WebDriver::Driver
         include DriverExtensions::UploadsFiles
         include DriverExtensions::HasSessionId
-        include DriverExtensions::HasRemoteStatus
 
-        def initialize(bridge: nil, listener: nil, **opts)
-          desired_capabilities = opts[:desired_capabilities]
-          if desired_capabilities.is_a?(Symbol)
-            unless Remote::Capabilities.respond_to?(desired_capabilities)
-              raise Error::WebDriverError, "invalid desired capability: #{desired_capabilities.inspect}"
-            end
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          raise ArgumentError, "Can not set :service object on #{self.class}" if service
 
-            opts[:desired_capabilities] = Remote::Capabilities.__send__(desired_capabilities)
-          end
-          opts[:url] ||= "http://#{Platform.localhost}:4444/wd/hub"
-          super
+          url ||= "http://#{Platform.localhost}:4444/wd/hub"
+          caps = process_options(options, capabilities)
+          super(caps: caps, url: url, **opts)
           @bridge.file_detector = ->((filename, *)) { File.exist?(filename) && filename.to_s }
         end
 
@@ -52,8 +45,32 @@ module Selenium
         end
 
         def devtools_version
-          capabilities['se:cdpVersion']&.split('.')&.first ||
-            raise(Error::WebDriverError, "DevTools is not supported by the Remote Server")
+          cdp_version = capabilities['se:cdpVersion']&.split('.')&.first
+          raise Error::WebDriverError, 'DevTools is not supported by the Remote Server' unless cdp_version
+
+          Integer(cdp_version)
+        end
+
+        def process_options(options, capabilities)
+          if options && capabilities
+            msg = "Don't use both :options and :capabilities when initializing #{self.class}, prefer :options"
+            raise ArgumentError, msg
+          elsif options.nil? && capabilities.nil?
+            raise ArgumentError, "#{self.class} needs :options to be set"
+          end
+          options ? options.as_json : generate_capabilities(capabilities)
+        end
+
+        def generate_capabilities(capabilities)
+          Array(capabilities).map { |cap|
+            if cap.is_a? Symbol
+              cap = WebDriver::Options.send(cap)
+            elsif !cap.respond_to? :as_json
+              msg = ":capabilities parameter only accepts objects responding to #as_json which #{cap.class} does not"
+              raise ArgumentError, msg
+            end
+            cap.as_json
+          }.inject(:merge)
         end
       end # Driver
     end # Remote

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

@@ -49,8 +49,8 @@ module Selenium
               payload                   = JSON.generate(command_hash)
               headers['Content-Length'] = payload.bytesize.to_s if %i[post put].include?(verb)
 
-              WebDriver.logger.info("   >>> #{url} | #{payload}")
-              WebDriver.logger.debug("     > #{headers.inspect}")
+              WebDriver.logger.debug("   >>> #{url} | #{payload}", id: :command)
+              WebDriver.logger.debug("     > #{headers.inspect}", id: :header)
             elsif verb == :post
               payload = '{}'
               headers['Content-Length'] = '2'
@@ -75,7 +75,7 @@ module Selenium
             code = code.to_i
             body = body.to_s.strip
             content_type = content_type.to_s
-            WebDriver.logger.info("<- #{body}")
+            WebDriver.logger.debug("<- #{body}", id: :command)
 
             if content_type.include? CONTENT_TYPE
               raise Error::WebDriverError, "empty body: #{content_type.inspect} (#{code})\n#{body}" if body.empty?

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

@@ -22,7 +22,6 @@ require 'curb'
 module Selenium
   module WebDriver
     module Remote
-
       module Http
         #
         # An alternative to the default Net::HTTP client.
@@ -38,7 +37,6 @@ module Selenium
         #
 
         class Curb < Common
-
           def quit_errors
             [Curl::Err::RecvError] + super
           end
@@ -85,7 +83,7 @@ module Selenium
               c.max_redirects   = MAX_REDIRECTS
               c.follow_location = true
               c.timeout         = @timeout if @timeout
-              c.verbose         = WebDriver.logger.info?
+              c.verbose         = WebDriver.logger.debug?
 
               c
             end

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

@@ -16,8 +16,6 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
-require 'net/https'
 require 'ipaddr'
 
 module Selenium
@@ -75,9 +73,10 @@ module Selenium
             begin
               request = new_request_for(verb, url, headers, payload)
               response = response_for(request)
-            rescue Errno::ECONNABORTED, Errno::ECONNRESET, Errno::EADDRINUSE
-              # a retry is sometimes needed on Windows XP where we may quickly
-              # run out of ephemeral ports
+            rescue Errno::ECONNABORTED, Errno::ECONNRESET, Errno::EADDRINUSE, Errno::EADDRNOTAVAIL
+              # a retry is sometimes needed:
+              #   on Windows XP where we may quickly run out of ephemeral ports
+              #   when the port becomes temporarily unavailable
               #
               # A more robust solution is bumping the MaxUserPort setting
               # as described here:
@@ -85,13 +84,6 @@ module Selenium
               # http://msdn.microsoft.com/en-us/library/aa560610%28v=bts.20%29.aspx
               raise if retries >= MAX_RETRIES
 
-              retries += 1
-              sleep 2
-              retry
-            rescue Errno::EADDRNOTAVAIL => e
-              # a retry is sometimes needed when the port becomes temporarily unavailable
-              raise if retries >= MAX_RETRIES
-
               retries += 1
               sleep 2
               retry
@@ -102,10 +94,12 @@ module Selenium
             end
 
             if response.is_a? Net::HTTPRedirection
+              WebDriver.logger.debug("Redirect to #{response['Location']}; times: #{redirects}")
               raise Error::WebDriverError, 'too many redirects' if redirects >= MAX_REDIRECTS
 
               request(:get, URI.parse(response['Location']), DEFAULT_HEADERS.dup, nil, redirects + 1)
             else
+              WebDriver.logger.debug("   <<<  #{response.instance_variable_get(:@header).inspect}", id: :header)
               create_response response.code, response.body, response.content_type
             end
           end
@@ -142,8 +136,8 @@ module Selenium
 
           def proxy
             @proxy ||= begin
-              proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
-              no_proxy = ENV['no_proxy'] || ENV['NO_PROXY']
+              proxy = ENV.fetch('http_proxy', nil) || ENV.fetch('HTTP_PROXY', nil)
+              no_proxy = ENV.fetch('no_proxy', nil) || ENV.fetch('NO_PROXY', nil)
 
               if proxy
                 proxy = "http://#{proxy}" unless proxy.start_with?('http://')

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Remote
-
       #
       # @api private
       #
@@ -74,7 +73,7 @@ module Selenium
         end
 
         def backtrace_from_remote(server_trace)
-          server_trace.map { |frame|
+          server_trace.filter_map do |frame|
             next unless frame.is_a?(Hash)
 
             file = frame['fileName']
@@ -87,7 +86,7 @@ module Selenium
             meth = 'unknown' if meth.nil? || meth.empty?
 
             "[remote server] #{file}:#{line}:in `#{meth}'"
-          }.compact
+          end
         end
 
         def process_error

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

@@ -25,7 +25,7 @@ module Selenium
           if response.is_a? String
             super(response)
           else
-            super("status code #{response.code}")
+            super("status code #{response.code}; payload #{response.payload}")
           end
         end
       end # ServerError

data/lib/selenium/webdriver/remote.rb

@@ -27,7 +27,6 @@ module Selenium
       autoload :Driver,       'selenium/webdriver/remote/driver'
       autoload :Response,     'selenium/webdriver/remote/response'
       autoload :Capabilities, 'selenium/webdriver/remote/capabilities'
-      autoload :COMMANDS,     'selenium/webdriver/remote/commands'
 
       module Http
         autoload :Common,  'selenium/webdriver/remote/http/common'

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Safari
-
       #
       # Driver implementation for Safari.
       # @api private
@@ -31,6 +30,13 @@ module Selenium
                       DriverExtensions::HasApplePermissions,
                       DriverExtensions::HasWebStorage].freeze
 
+        include LocalDriver
+
+        def initialize(options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(options, service, url)
+          super(caps: caps, url: url, **opts)
+        end
+
         def browser
           :safari
         end

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

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module Safari
       module Features
-
         # https://developer.apple.com/library/content/documentation/NetworkingInternetWeb/Conceptual/WebDriverEndpointDoc/Commands/Commands.html
         SAFARI_COMMANDS = {
           get_permissions: [:get, 'session/:session_id/apple/permissions'],
@@ -44,7 +43,6 @@ module Selenium
         def attach_debugger
           execute :attach_debugger, {}, {}
         end
-
       end # Bridge
     end # Safari
   end # WebDriver

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

@@ -26,7 +26,7 @@ module Selenium
         # @see https://developer.apple.com/documentation/webkit/about_webdriver_for_safari
         CAPABILITIES = {automatic_inspection: 'safari:automaticInspection',
                         automatic_profiling: 'safari:automaticProfiling'}.freeze
-        BROWSER = 'safari'
+        BROWSER = Selenium::WebDriver::Safari.technology_preview? ? 'Safari Technology Preview' : 'safari'
 
         def add_option(name, value = nil)
           key = name.is_a?(Hash) ? name.keys.first : name
@@ -35,6 +35,10 @@ module Selenium
           super
         end
 
+        def as_json(*)
+          @options[:browser_name] = Safari.technology_preview? ? 'Safari Technology Preview' : 'safari'
+          super
+        end
       end # Options
     end # Safari
   end # WebDriver

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

@@ -23,11 +23,17 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT = 7050
         EXECUTABLE = 'safaridriver'
-        MISSING_TEXT = <<~ERROR
-          Unable to find Apple's safaridriver which comes with Safari 10.
-          More info at https://webkit.org/blog/6900/webdriver-support-in-safari-10/
-        ERROR
         SHUTDOWN_SUPPORTED = false
+
+        def initialize(path: nil, port: nil, log: nil, args: nil)
+          raise Error::WebDriverError, 'Safari Service does not support setting log output' if log
+
+          super
+        end
+
+        def log=(*)
+          raise Error::WebDriverError, 'Safari Service does not support setting log output'
+        end
       end # Service
     end # Safari
   end # WebDriver

data/lib/selenium/webdriver/safari.rb

@@ -29,7 +29,7 @@ module Selenium
         attr_accessor :use_technology_preview
 
         def technology_preview
-          "/Applications/Safari\ Technology\ Preview.app/Contents/MacOS/safaridriver"
+          '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver'
         end
 
         def technology_preview!
@@ -53,20 +53,6 @@ module Selenium
 
           raise Error::WebDriverError, 'Unable to find Safari'
         end
-
-        def driver_path=(path)
-          WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path=',
-                                     'Selenium::WebDriver::Safari::Service#driver_path=',
-                                     id: :driver_path
-          Selenium::WebDriver::Safari::Service.driver_path = path
-        end
-
-        def driver_path
-          WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path',
-                                     'Selenium::WebDriver::Safari::Service#driver_path',
-                                     id: :driver_path
-          Selenium::WebDriver::Safari::Service.driver_path
-        end
       end
     end # Safari
   end # WebDriver

data/lib/selenium/webdriver/support/color.rb

@@ -21,29 +21,29 @@ module Selenium
   module WebDriver
     module Support
       class Color
-        RGB_PATTERN = %r{^\s*rgb\(\s*(\d{1,3})\s*,
+        RGB_PATTERN = /^\s*rgb\(\s*(\d{1,3})\s*,
                           \s*(\d{1,3})\s*,
-                          \s*(\d{1,3})\s*\)\s*$}x.freeze
-        RGB_PCT_PATTERN = %r{^\s*rgb\(\s*(\d{1,3}|\d{1,2}\.\d+)%\s*,
+                          \s*(\d{1,3})\s*\)\s*$/x
+        RGB_PCT_PATTERN = /^\s*rgb\(\s*(\d{1,3}|\d{1,2}\.\d+)%\s*,
                               \s*(\d{1,3}|\d{1,2}\.\d+)%\s*,
-                              \s*(\d{1,3}|\d{1,2}\.\d+)%\s*\)\s*$}x.freeze
-        RGBA_PATTERN = %r{^\s*rgba\(\s*(\d{1,3})\s*,
+                              \s*(\d{1,3}|\d{1,2}\.\d+)%\s*\)\s*$/x
+        RGBA_PATTERN = /^\s*rgba\(\s*(\d{1,3})\s*,
                           \s*(\d{1,3})\s*,
                           \s*(\d{1,3})\s*,
-                          \s*(0|1|0\.\d+)\s*\)\s*$}x.freeze
-        RGBA_PCT_PATTERN = %r{^\s*rgba\(\s*(\d{1,3}|\d{1,2}\.\d+)
+                          \s*(0|1|0\.\d+)\s*\)\s*$/x
+        RGBA_PCT_PATTERN = /^\s*rgba\(\s*(\d{1,3}|\d{1,2}\.\d+)
                               %\s*,\s*(\d{1,3}|\d{1,2}\.\d+)
                               %\s*,\s*(\d{1,3}|\d{1,2}\.\d+)
-                              %\s*,\s*(0|1|0\.\d+)\s*\)\s*$}x.freeze
-        HEX_PATTERN = /#(\h{2})(\h{2})(\h{2})/.freeze
-        HEX3_PATTERN = /#(\h)(\h)(\h)/.freeze
-        HSL_PATTERN = %r{^\s*hsl\(\s*(\d{1,3})\s*,
+                              %\s*,\s*(0|1|0\.\d+)\s*\)\s*$/x
+        HEX_PATTERN = /#(\h{2})(\h{2})(\h{2})/
+        HEX3_PATTERN = /#(\h)(\h)(\h)/
+        HSL_PATTERN = /^\s*hsl\(\s*(\d{1,3})\s*,
                          \s*(\d{1,3})%\s*,
-                         \s*(\d{1,3})%\s*\)\s*$}x.freeze
-        HSLA_PATTERN = %r{^\s*hsla\(\s*(\d{1,3})\s*,
+                         \s*(\d{1,3})%\s*\)\s*$/x
+        HSLA_PATTERN = /^\s*hsla\(\s*(\d{1,3})\s*,
                           \s*(\d{1,3})%\s*,
                           \s*(\d{1,3})%\s*,
-                          \s*(0|1|0\.\d+)\s*\)\s*$}x.freeze
+                          \s*(0|1|0\.\d+)\s*\)\s*$/x
 
         attr_reader :red, :green, :blue, :alpha
 
@@ -83,12 +83,12 @@ module Selenium
             g = r
             b = r
           else
-            luminocity2 = l < 0.5 ? l * (1 + s) : l + s - l * s
-            luminocity1 = 2 * l - luminocity2
+            luminocity2 = l < 0.5 ? l * (s + 1) : l + s - (l * s)
+            luminocity1 = (l * 2) - luminocity2
 
-            r = hue_to_rgb(luminocity1, luminocity2, h + 1.0 / 3.0)
+            r = hue_to_rgb(luminocity1, luminocity2, h + (1.0 / 3.0))
             g = hue_to_rgb(luminocity1, luminocity2, h)
-            b = hue_to_rgb(luminocity1, luminocity2, h - 1.0 / 3.0)
+            b = hue_to_rgb(luminocity1, luminocity2, h - (1.0 / 3.0))
           end
 
           new (r * 255).round, (g * 255).round, (b * 255).round, a
@@ -99,11 +99,11 @@ module Selenium
           hue -= 1 if hue > 1.0
 
           if hue < 1.0 / 6.0
-            (lum1 + (lum2 - lum1) * 6.0 * hue)
+            (lum1 + ((lum2 - lum1) * 6.0 * hue))
           elsif hue < 1.0 / 2.0
             lum2
           elsif hue < 2.0 / 3.0
-            lum1 + (lum2 - lum1) * ((2.0 / 3.0) - hue) * 6.0
+            lum1 + ((lum2 - lum1) * ((2.0 / 3.0) - hue) * 6.0)
           else
             lum1
           end
@@ -122,10 +122,10 @@ module Selenium
 
           [red, green, blue, alpha] == [other.red, other.green, other.blue, other.alpha]
         end
-        alias_method :eql?, :==
+        alias eql? ==
 
         def hash
-          [red, green, blue, alpha].hash ^ self.class.hash
+          [red, green, blue, alpha, self.class].hash
         end
 
         def rgb

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

@@ -21,14 +21,12 @@ module Selenium
   module WebDriver
     module Support
       class Guards
-
         #
         # Guard derived from RSpec example metadata.
         # @api private
         #
 
         class Guard
-
           attr_reader :guarded, :type, :messages, :reason
 
           def initialize(guarded, type, guards = nil)

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

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module Support
       class Guards
-
         #
         # Guard derived from RSpec example metadata.
         # @api private
@@ -32,7 +31,7 @@ module Selenium
 
           def initialize(name, condition = nil, &blk)
             @name = name
-            @execution = if block_given?
+            @execution = if blk
                            proc(&blk)
                          else
                            proc { |guarded| guarded.include?(condition) }
@@ -44,7 +43,6 @@ module Selenium
 
             list.empty? || @execution.call(list)
           end
-
         end # GuardCondition
       end # Guards
     end # Support

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

@@ -48,7 +48,7 @@ module Selenium
         def disposition
           if !skipping_guard.nil?
             [:skip, skipping_guard.message]
-          elsif !pending_guard.nil? && ENV['SKIP_PENDING']
+          elsif !pending_guard.nil? && ENV.fetch('SKIP_PENDING', nil)
             [:skip, pending_guard.message]
           elsif !pending_guard.nil?
             [:pending, pending_guard.message]

data/lib/selenium/webdriver/support/relative_locator.rb

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Support
-
       #
       # @api private
       #

data/lib/selenium/webdriver/support/select.rb

@@ -86,7 +86,7 @@ module Selenium
         #
         #     <option value="foo">Bar</option>
         #
-        # When slecting by :value, selects all options that have a value matching the argument. That is, when given "foo" this
+        # When selecting by :value, selects all options that have a value matching the argument. That is, when given "foo" this
         # would select an option like:
         #
         #     <option value="foo">Bar</option>
@@ -215,6 +215,8 @@ module Selenium
         end
 
         def select_option(option)
+          raise Error::UnsupportedOperationError, 'You may not select a disabled option' unless option.enabled?
+
           option.click unless option.selected?
         end
 

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.1.0'
+    VERSION = '4.12.0'
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver.rb

@@ -17,13 +17,13 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'childprocess'
 require 'tmpdir'
 require 'fileutils'
 require 'date'
 require 'json'
 require 'set'
 require 'uri'
+require 'net/http'
 
 require 'selenium/webdriver/atoms'
 require 'selenium/webdriver/common'
@@ -34,8 +34,9 @@ module Selenium
     Point     = Struct.new(:x, :y)
     Dimension = Struct.new(:width, :height)
     Rectangle = Struct.new(:x, :y, :width, :height)
-    Location  = Struct.new(:latitude, :longitude, :altitude)
 
+    autoload :BiDi,       'selenium/webdriver/bidi'
+    autoload :Chromium,   'selenium/webdriver/chromium'
     autoload :Chrome,     'selenium/webdriver/chrome'
     autoload :DevTools,   'selenium/webdriver/devtools'
     autoload :Edge,       'selenium/webdriver/edge'
@@ -94,8 +95,9 @@ module Selenium
     # @return [Logger]
     #
 
-    def self.logger
-      @logger ||= WebDriver::Logger.new
+    def self.logger(**opts)
+      level = $DEBUG || ENV.key?('DEBUG') ? :debug : :info
+      @logger ||= WebDriver::Logger.new('Selenium', default_level: level, **opts)
     end
   end # WebDriver
 end # Selenium

data/selenium-webdriver.gemspec

@@ -24,11 +24,13 @@ Gem::Specification.new do |s|
   s.homepage = 'https://selenium.dev'
   s.metadata = {
     'changelog_uri' => 'https://github.com/SeleniumHQ/selenium/blob/trunk/rb/CHANGES',
-    'source_code_uri' => 'https://github.com/SeleniumHQ/selenium/tree/trunk/rb'
+    'github_repo' => 'ssh://github.com/SeleniumHQ/selenium',
+    'source_code_uri' => 'https://github.com/SeleniumHQ/selenium/tree/trunk/rb',
+    'rubygems_mfa_required' => 'true'
   }
 
   s.required_rubygems_version = Gem::Requirement.new('> 1.3.1') if s.respond_to? :required_rubygems_version=
-  s.required_ruby_version = Gem::Requirement.new('>= 2.6')
+  s.required_ruby_version = Gem::Requirement.new('>= 3.0')
 
   s.files = [
     'CHANGES',
@@ -40,23 +42,23 @@ Gem::Specification.new do |s|
     'lib/selenium-webdriver.rb',
     'lib/selenium/server.rb',
     'lib/selenium/webdriver.rb'
-  ] + Dir['lib/selenium/webdriver/**/*']
+  ]
+  s.files += Dir['bin/**/*']
+  s.files += Dir['lib/selenium/webdriver/**/*']
 
+  s.bindir = 'bin'
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'childprocess', ['>= 0.5', '< 5.0']
   s.add_runtime_dependency 'rexml', ['~> 3.2', '>= 3.2.5']
-  s.add_runtime_dependency 'rubyzip', ['>= 1.2.2']
+  s.add_runtime_dependency 'rubyzip', ['>= 1.2.2', '< 3.0']
+  s.add_runtime_dependency 'websocket', ['~> 1.0']
 
-  # childprocess requires ffi on windows but doesn't declare it in its dependencies
-  s.add_development_dependency 'ffi'
-  s.add_development_dependency 'pry', ['~> 0.14']
   s.add_development_dependency 'rack', ['~> 2.0']
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rake', ['~> 13.0']
   s.add_development_dependency 'rspec', ['~> 3.0']
-  s.add_development_dependency 'rubocop', ['~> 1.8.0']
-  s.add_development_dependency 'rubocop-performance'
-  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'rubocop', ['~> 1.42']
+  s.add_development_dependency 'rubocop-performance', ['~> 1.15']
+  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']