selenium-webdriver 4.32.0 → 4.40.0

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

@@ -68,9 +68,9 @@ module Selenium
       # @api private
       #
 
-      def initialize(bridge: nil, listener: nil, **opts)
+      def initialize(bridge: nil, listener: nil, **)
         @devtools = nil
-        bridge ||= create_bridge(**opts)
+        bridge ||= create_bridge(**)
         @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
         add_extensions(@bridge.browser)
       end
@@ -131,8 +131,8 @@ module Selenium
       # @see ActionBuilder
       #
 
-      def action(**opts)
-        bridge.action(**opts)
+      def action(**)
+        bridge.action(**)
       end
 
       #
@@ -225,8 +225,8 @@ module Selenium
       #   The value returned from the script.
       #
 
-      def execute_script(script, *args)
-        bridge.execute_script(script, *args)
+      def execute_script(script, *)
+        bridge.execute_script(script, *)
       end
 
       # Execute an asynchronous piece of JavaScript in the context of the
@@ -244,8 +244,8 @@ module Selenium
       # @return [WebDriver::Element,Integer,Float,Boolean,NilClass,String,Array]
       #
 
-      def execute_async_script(script, *args)
-        bridge.execute_async_script(script, *args)
+      def execute_async_script(script, *)
+        bridge.execute_async_script(script, *)
       end
 
       #
@@ -326,11 +326,6 @@ module Selenium
         end
       end
 
-      def service_url(service)
-        @service_manager = service.launch
-        @service_manager.uri
-      end
-
       def screenshot
         bridge.screenshot
       end

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

@@ -39,7 +39,13 @@ module Selenium
 
           begin
             Zip::File.open("#{file_name}.zip") do |zip|
-              zip.each { |entry| zip.extract(entry, "#{target_directory}#{file_name}") }
+              zip.each do |entry|
+                if Zipper::RUBYZIP_V3
+                  zip.extract(entry, file_name, destination_directory: target_directory)
+                else
+                  zip.extract(entry, "#{target_directory}#{file_name}")
+                end
+              end
             end
           ensure
             FileUtils.rm_f("#{file_name}.zip")

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

@@ -38,9 +38,9 @@ module Selenium
       ERROR_URL = 'https://www.selenium.dev/documentation/webdriver/troubleshooting/errors'
 
       URLS = {
-        NoSuchElementError: "#{ERROR_URL}#no-such-element-exception",
-        StaleElementReferenceError: "#{ERROR_URL}#stale-element-reference-exception",
-        InvalidSelectorError: "#{ERROR_URL}#invalid-selector-exception",
+        NoSuchElementError: "#{ERROR_URL}#nosuchelementexception",
+        StaleElementReferenceError: "#{ERROR_URL}#staleelementreferenceexception",
+        InvalidSelectorError: "#{ERROR_URL}#invalidselectorexception",
         NoSuchDriverError: "#{ERROR_URL}/driver_location"
       }.freeze
 
@@ -119,6 +119,13 @@ module Selenium
 
       class NoSuchWindowError < WebDriverError; end
 
+      #
+      # A command to find a devtools target could not be satisfied because
+      # the target could not be found.
+      #
+
+      class NoSuchTargetError < WebDriverError; end
+
       #
       # The element does not have a shadow root.
       #

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

@@ -44,8 +44,8 @@ module Selenium
       # @return [ActionBuilder] A self reference
       #
 
-      def key_down(*args, device: nil)
-        key_action(*args, action: :create_key_down, device: device)
+      def key_down(*, device: nil)
+        key_action(*, action: :create_key_down, device: device)
       end
 
       #
@@ -71,8 +71,8 @@ module Selenium
       # @return [ActionBuilder] A self reference
       #
 
-      def key_up(*args, device: nil)
-        key_action(*args, action: :create_key_up, device: device)
+      def key_up(*, device: nil)
+        key_action(*, action: :create_key_up, device: device)
       end
 
       #

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

@@ -46,8 +46,8 @@ module Selenium
       # @return [ActionBuilder] A self reference.
       #
 
-      def pointer_down(button = :left, device: nil, **opts)
-        button_action(button, :create_pointer_down, device: device, **opts)
+      def pointer_down(button = :left, device: nil, **)
+        button_action(button, :create_pointer_down, device: device, **)
       end
 
       #
@@ -63,8 +63,8 @@ module Selenium
       # @return [ActionBuilder] A self reference.
       #
 
-      def pointer_up(button = :left, device: nil, **opts)
-        button_action(button, :create_pointer_up, device: device, **opts)
+      def pointer_up(button = :left, device: nil, **)
+        button_action(button, :create_pointer_up, device: device, **)
       end
 
       #
@@ -122,13 +122,13 @@ module Selenium
       # @raise [MoveTargetOutOfBoundsError] if the provided offset is outside the document's boundaries.
       #
 
-      def move_by(right_by, down_by, device: nil, duration: default_move_duration, **opts)
+      def move_by(right_by, down_by, device: nil, duration: default_move_duration, **)
         pointer = pointer_input(device)
         pointer.create_pointer_move(duration: duration,
                                     x: Integer(right_by),
                                     y: Integer(down_by),
                                     origin: Interactions::PointerMove::POINTER,
-                                    **opts)
+                                    **)
         tick(pointer)
         self
       end
@@ -150,13 +150,13 @@ module Selenium
       # @raise [MoveTargetOutOfBoundsError] if the provided x or y value is outside the document's boundaries.
       #
 
-      def move_to_location(x, y, device: nil, duration: default_move_duration, **opts)
+      def move_to_location(x, y, device: nil, duration: default_move_duration, **)
         pointer = pointer_input(device)
         pointer.create_pointer_move(duration: duration,
                                     x: Integer(x),
                                     y: Integer(y),
                                     origin: Interactions::PointerMove::VIEWPORT,
-                                    **opts)
+                                    **)
         tick(pointer)
         self
       end
@@ -336,9 +336,9 @@ module Selenium
 
       private
 
-      def button_action(button, action, device: nil, **opts)
+      def button_action(button, action, device: nil, **)
         pointer = pointer_input(device)
-        pointer.send(action, button, **opts)
+        pointer.send(action, button, **)
         tick(pointer)
         self
       end

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

@@ -49,16 +49,16 @@ module Selenium
           KIND[pointer]
         end
 
-        def create_pointer_move(duration: 0, x: 0, y: 0, origin: nil, **opts)
-          add_action(PointerMove.new(self, duration, x, y, origin: origin, **opts))
+        def create_pointer_move(duration: 0, x: 0, y: 0, origin: nil, **)
+          add_action(PointerMove.new(self, duration, x, y, origin: origin, **))
         end
 
-        def create_pointer_down(button, **opts)
-          add_action(PointerPress.new(self, :down, button, **opts))
+        def create_pointer_down(button, **)
+          add_action(PointerPress.new(self, :down, button, **))
         end
 
-        def create_pointer_up(button, **opts)
-          add_action(PointerPress.new(self, :up, button, **opts))
+        def create_pointer_up(button, **)
+          add_action(PointerPress.new(self, :up, button, **))
         end
 
         def create_pointer_cancel

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

@@ -75,6 +75,13 @@ module Selenium
         subtract: "\ue027",
         decimal: "\ue028",
         divide: "\ue029",
+        numpad_multiply: "\ue024",
+        numpad_add: "\ue025",
+        numpad_comma: "\ue026",
+        numpad_subtract: "\ue027",
+        numpad_decimal: "\ue028",
+        numpad_divide: "\ue029",
+        numpad_enter: "\ue007",
         f1: "\ue031",
         f2: "\ue032",
         f3: "\ue033",
@@ -95,6 +102,8 @@ module Selenium
         right_control: "\ue051",
         right_alt: "\ue052",
         right_meta: "\ue053",
+        options: "\ue052",
+        function: "\ue051", # macOS Function key, same as right_control
         numpad_page_up: "\ue054",
         numpad_page_down: "\ue055",
         numpad_end: "\ue056",

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

@@ -27,7 +27,17 @@ module Selenium
         caps = process_options(options, service)
         url = service_url(service)
 
-        [caps, url]
+        begin
+          yield(caps, url) if block_given?
+        rescue Selenium::WebDriver::Error::WebDriverError
+          @service_manager&.stop
+          raise
+        end
+      end
+
+      def service_url(service)
+        @service_manager = service.launch
+        @service_manager.uri
       end
 
       def process_options(options, service)

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

@@ -79,6 +79,8 @@ module Selenium
       #
 
       def delete_cookie(name)
+        raise ArgumentError, 'Cookie name cannot be null or empty' if name.nil? || name.to_s.strip.empty?
+
         @bridge.delete_cookie name
       end
 

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

@@ -29,26 +29,26 @@ module Selenium
       class << self
         attr_reader :driver_path
 
-        def chrome(**opts)
-          Chrome::Options.new(**opts)
+        def chrome(**)
+          Chrome::Options.new(**)
         end
 
-        def firefox(**opts)
-          Firefox::Options.new(**opts)
+        def firefox(**)
+          Firefox::Options.new(**)
         end
 
-        def ie(**opts)
-          IE::Options.new(**opts)
+        def ie(**)
+          IE::Options.new(**)
         end
         alias internet_explorer ie
 
-        def edge(**opts)
-          Edge::Options.new(**opts)
+        def edge(**)
+          Edge::Options.new(**)
         end
         alias microsoftedge edge
 
-        def safari(**opts)
-          Safari::Options.new(**opts)
+        def safari(**)
+          Safari::Options.new(**)
         end
 
         def set_capabilities
@@ -71,6 +71,8 @@ module Selenium
       def initialize(**opts)
         self.class.set_capabilities
 
+        opts[:web_socket_url] = opts.delete(:bidi) if opts.key?(:bidi)
+
         @options = opts
         @options[:browser_name] = self.class::BROWSER
       end
@@ -91,6 +93,14 @@ module Selenium
         @options[name] = value
       end
 
+      def enable_bidi!
+        @options[:web_socket_url] = true
+      end
+
+      def bidi?
+        !!@options[:web_socket_url]
+      end
+
       def ==(other)
         return false unless other.is_a? self.class
 
@@ -131,11 +141,20 @@ module Selenium
 
       def process_w3c_options(options)
         w3c_options = options.select { |key, val| w3c?(key) && !val.nil? }
-        w3c_options[:unhandled_prompt_behavior] &&= w3c_options[:unhandled_prompt_behavior]&.to_s&.tr('_', ' ')
+        w3c_options[:unhandled_prompt_behavior] &&=
+          process_unhandled_prompt_behavior_value(w3c_options[:unhandled_prompt_behavior])
         options.delete_if { |key, _val| w3c?(key) }
         w3c_options
       end
 
+      def process_unhandled_prompt_behavior_value(value)
+        if value.is_a?(Hash)
+          value.transform_values { |v| process_unhandled_prompt_behavior_value(v) }
+        else
+          value&.to_s&.tr('_', ' ')
+        end
+      end
+
       def process_browser_options(_browser_options)
         nil
       end

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

@@ -51,9 +51,7 @@ module Selenium
       end
 
       def ci
-        if ENV['TRAVIS']
-          :travis
-        elsif ENV['JENKINS']
+        if ENV['JENKINS']
           :jenkins
         elsif ENV['APPVEYOR']
           :appveyor

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

@@ -77,6 +77,7 @@ module Selenium
       alias eql? ==
 
       def ftp=(value)
+        WebDriver.logger.deprecate('FTP proxy support', nil, id: :ftp_proxy)
         self.type = :manual
         @ftp = value
       end

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

@@ -28,27 +28,27 @@ module Selenium
       class << self
         attr_reader :driver_path
 
-        def chrome(**opts)
-          Chrome::Service.new(**opts)
+        def chrome(**)
+          Chrome::Service.new(**)
         end
 
-        def firefox(**opts)
-          Firefox::Service.new(**opts)
+        def firefox(**)
+          Firefox::Service.new(**)
         end
 
-        def ie(**opts)
-          IE::Service.new(**opts)
+        def ie(**)
+          IE::Service.new(**)
         end
         alias internet_explorer ie
 
-        def edge(**opts)
-          Edge::Service.new(**opts)
+        def edge(**)
+          Edge::Service.new(**)
         end
         alias microsoftedge edge
         alias msedge edge
 
-        def safari(**opts)
-          Safari::Service.new(**opts)
+        def safari(**)
+          Safari::Service.new(**)
         end
 
         def driver_path=(path)

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

@@ -127,10 +127,36 @@ module Selenium
       end
 
       def connect_until_stable
-        socket_poller = SocketPoller.new @host, @port, START_TIMEOUT
-        return if socket_poller.connected?
+        deadline = current_time + START_TIMEOUT
 
-        raise Error::WebDriverError, cannot_connect_error_text
+        loop do
+          error = check_connection_error
+          return unless error
+
+          raise Error::WebDriverError, "#{cannot_connect_error_text}: #{error}" if current_time > deadline
+
+          sleep 0.1
+        end
+      end
+
+      def check_connection_error
+        response = Net::HTTP.start(@host, @port, open_timeout: 0.5, read_timeout: 1) do |http|
+          http.get('/status', {'Connection' => 'close'})
+        end
+
+        return "status returned #{response.code}\n#{response.body}" unless response.is_a?(Net::HTTPSuccess)
+
+        status = JSON.parse(response.body)
+        ready = status['ready'] || status.dig('value', 'ready')
+        "driver not ready: #{response.body}" unless ready
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::EPIPE, Errno::ETIMEDOUT,
+             Errno::EADDRNOTAVAIL, Errno::EHOSTUNREACH, Net::OpenTimeout, Net::ReadTimeout,
+             EOFError, SocketError, Net::HTTPBadResponse, JSON::ParserError => e
+        "#{e.class}: #{e.message}"
+      end
+
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
 
       def cannot_connect_error_text

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

@@ -93,7 +93,7 @@ module Selenium
           true
         rescue *NOT_CONNECTED_ERRORS
           sock&.close
-          WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}", id: :driver_service)
+          WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}", id: :socket_poller)
           false
         end
       end

data/lib/selenium/webdriver/common/virtual_authenticator/credential.rb

@@ -26,12 +26,12 @@ module Selenium
   module WebDriver
     class Credential
       class << self
-        def resident(**opts)
-          Credential.new(resident_credential: true, **opts)
+        def resident(**)
+          Credential.new(resident_credential: true, **)
         end
 
-        def non_resident(**opts)
-          Credential.new(resident_credential: false, **opts)
+        def non_resident(**)
+          Credential.new(resident_credential: false, **)
         end
 
         def encode(byte_array)

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

@@ -29,7 +29,7 @@ module Selenium
       # @param [Hash] opts Options for this instance
       # @option opts [Numeric] :timeout (5) Seconds to wait before timing out.
       # @option opts [Numeric] :interval (0.2) Seconds to sleep between polls.
-      # @option opts [String] :message Exception mesage if timed out.
+      # @option opts [String] :message Exception message if timed out.
       # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Error::NoSuchElementError)
       #
 
@@ -37,7 +37,8 @@ module Selenium
         @timeout  = opts.fetch(:timeout, DEFAULT_TIMEOUT)
         @interval = opts.fetch(:interval, DEFAULT_INTERVAL)
         @message  = opts[:message]
-        @ignored  = Array(opts[:ignore] || Error::NoSuchElementError)
+        @message_provider = opts[:message_provider]
+        @ignored = Array(opts[:ignore] || Error::NoSuchElementError)
       end
 
       #
@@ -64,6 +65,8 @@ module Selenium
 
         msg = if @message
                 @message.dup
+              elsif @message_provider
+                @message_provider.call
               else
                 "timed out after #{@timeout} seconds"
               end