selenium-webdriver 4.12.0 → 4.23.0

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

@@ -103,7 +103,7 @@ module Selenium
       #
       # @param [Array, Symbol] ids
       #
-      def allow(ids)
+      def allow(*ids)
         @allowed += Array(ids).flatten
       end
 
@@ -112,7 +112,7 @@ module Selenium
       # Overrides default #debug to skip ignored messages by provided id
       #
       # @param [String] message
-      # @param [Symbol, Array<Sybmol>] id
+      # @param [Symbol, Array<Symbol>] id
       # @yield see #deprecate
       #
       def debug(message, id: [], &block)
@@ -123,7 +123,7 @@ module Selenium
       # Used to supply information of general interest
       #
       # @param [String] message
-      # @param [Symbol, Array<Sybmol>] id
+      # @param [Symbol, Array<Symbol>] id
       # @yield see #deprecate
       #
       def info(message, id: [], &block)
@@ -134,7 +134,7 @@ module Selenium
       # Used to supply information that suggests an error occurred
       #
       # @param [String] message
-      # @param [Symbol, Array<Sybmol>] id
+      # @param [Symbol, Array<Symbol>] id
       # @yield see #deprecate
       #
       def error(message, id: [], &block)
@@ -145,7 +145,7 @@ module Selenium
       # Used to supply information that suggests action be taken by user
       #
       # @param [String] message
-      # @param [Symbol, Array<Sybmol>] id
+      # @param [Symbol, Array<Symbol>] id
       # @yield see #deprecate
       #
       def warn(message, id: [], &block)
@@ -181,11 +181,11 @@ module Selenium
       private
 
       def create_logger(name, level:)
-        logger = ::Logger.new($stdout)
+        logger = ::Logger.new($stderr)
         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/manager.rb

@@ -56,7 +56,7 @@ module Selenium
         opts[:httpOnly] = http_only if http_only
 
         obj = opts.delete(:expires)
-        opts[:expiry] = seconds_from(obj).to_i if obj
+        opts[:expiry] = seconds_from(obj).to_int if obj
 
         @bridge.add_cookie opts
       end

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

@@ -24,6 +24,8 @@ module Selenium
                        set_window_rect timeouts unhandled_prompt_behavior strict_file_interactability
                        web_socket_url].freeze
 
+      GRID_OPTIONS = %i[enable_downloads].freeze
+
       class << self
         attr_reader :driver_path
 
@@ -57,7 +59,7 @@ module Selenium
               @options[key]
             end
 
-            define_method "#{key}=" do |value|
+            define_method :"#{key}=" do |value|
               @options[key] = value
             end
           end
@@ -104,6 +106,8 @@ module Selenium
       def as_json(*)
         options = @options.dup
 
+        downloads = options.delete(:enable_downloads)
+        options['se:downloadsEnabled'] = downloads unless downloads.nil?
         w3c_options = process_w3c_options(options)
 
         browser_options = self.class::CAPABILITIES.each_with_object({}) do |(capability_alias, capability_name), hash|
@@ -173,7 +177,7 @@ module Selenium
       end
 
       def camel_case(str)
-        str.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+        str.gsub(/_([a-z])/) { Regexp.last_match(1)&.upcase }
       end
     end # Options
   end # WebDriver

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

@@ -86,6 +86,10 @@ module Selenium
         os == :linux
       end
 
+      def unix?
+        os == :unix
+      end
+
       def wsl?
         return false unless linux?
 
@@ -107,7 +111,9 @@ module Selenium
         windows? && !cygwin? ? %("#{str}") : str
       end
 
-      def cygwin_path(path, **opts)
+      def cygwin_path(path, only_cygwin: false, **opts)
+        return path if only_cygwin && !cygwin?
+
         flags = []
         opts.each { |k, v| flags << "--#{k}" if v }
 

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

@@ -49,7 +49,7 @@ module Selenium
         proxy = new
 
         ALLOWED.each do |k, v|
-          proxy.send("#{k}=", data[v]) if data.key?(v)
+          proxy.send(:"#{k}=", data[v]) if data.key?(v)
         end
 
         proxy
@@ -60,7 +60,7 @@ module Selenium
 
         opts.each do |k, v|
           if ALLOWED.key?(k)
-            send("#{k}=", v)
+            send(:"#{k}=", v)
           else
             not_allowed << k
           end

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

@@ -35,6 +35,14 @@ module Selenium
         xpath: 'xpath'
       }.freeze
 
+      class << self
+        attr_accessor :extra_finders
+
+        def finders
+          FINDERS.merge(extra_finders || {})
+        end
+      end
+
       #
       # Find the first element matching the given arguments
       #
@@ -57,7 +65,7 @@ module Selenium
       def find_element(*args)
         how, what = extract_args(args)
 
-        by = FINDERS[how.to_sym]
+        by = SearchContext.finders[how.to_sym]
         raise ArgumentError, "cannot find element by #{how.inspect}" unless by
 
         bridge.find_element_by by, what, ref
@@ -72,7 +80,7 @@ module Selenium
       def find_elements(*args)
         how, what = extract_args(args)
 
-        by = FINDERS[how.to_sym]
+        by = SearchContext.finders[how.to_sym]
         raise ArgumentError, "cannot find elements by #{how.inspect}" unless by
 
         bridge.find_elements_by by, what, ref

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

@@ -34,76 +34,33 @@ module Selenium
           @bin_path ||= '../../../../../bin'
         end
 
-        # @param [Options] options browser options.
-        # @return [String] the path to the correct driver.
-        def driver_path(options)
-          command = generate_command(binary, options)
-
-          output = run(*command)
-
-          browser_path = output['browser_path']
-          driver_path = output['driver_path']
-          Platform.assert_executable driver_path
-
-          if options.respond_to? :binary
-            options.binary = browser_path
-            options.browser_version = nil
-          end
-
-          driver_path
+        # @param [Array] arguments what gets sent to to Selenium Manager binary.
+        # @return [Hash] paths to the requested assets.
+        def binary_paths(*arguments)
+          arguments += %w[--language-binding ruby]
+          arguments += %w[--output json]
+          arguments << '--debug' if WebDriver.logger.debug?
+
+          run(binary, *arguments)
         end
 
         private
 
-        def generate_command(binary, options)
-          command = [binary, '--browser', options.browser_name]
-          if options.browser_version
-            command << '--browser-version'
-            command << options.browser_version
-          end
-          if options.respond_to?(:binary) && !options.binary.nil?
-            command << '--browser-path'
-            command << options.binary.gsub('\\', '\\\\\\')
-          end
-          if options.proxy
-            command << '--proxy'
-            (command << options.proxy.ssl) || options.proxy.http
-          end
-          command
-        end
-
         # @return [String] the path to the correct selenium manager
         def binary
           @binary ||= begin
-            path = File.expand_path(bin_path, __FILE__)
-            path << if Platform.windows?
-                      '/windows/selenium-manager.exe'
-                    elsif Platform.mac?
-                      '/macos/selenium-manager'
-                    elsif Platform.linux?
-                      '/linux/selenium-manager'
-                    end
-            location = File.expand_path(path, __FILE__)
-
-            begin
-              Platform.assert_file(location)
-              Platform.assert_executable(location)
-            rescue TypeError
-              raise Error::WebDriverError,
-                    "Unable to locate or obtain Selenium Manager binary; #{location} is not a valid file object"
-            rescue Error::WebDriverError => e
-              raise Error::WebDriverError, "Selenium Manager binary located, but #{e.message}"
+            if (location = ENV.fetch('SE_MANAGER_PATH', nil))
+              WebDriver.logger.debug("Selenium Manager set by ENV['SE_MANAGER_PATH']: #{location}")
             end
+            location ||= platform_location
 
+            Platform.assert_executable(location)
             WebDriver.logger.debug("Selenium Manager binary found at #{location}", id: :selenium_manager)
             location
           end
         end
 
         def run(*command)
-          command += %w[--output json]
-          command << '--debug' if WebDriver.logger.debug?
-
           WebDriver.logger.debug("Executing Process #{command}", id: :selenium_manager)
 
           begin
@@ -112,16 +69,34 @@ module Selenium
             raise Error::WebDriverError, "Unsuccessful command executed: #{command}; #{e.message}"
           end
 
-          json_output = stdout.empty? ? {} : JSON.parse(stdout)
-          (json_output['logs'] || []).each do |log|
+          json_output = stdout.empty? ? {'logs' => [], 'result' => {}} : JSON.parse(stdout)
+          json_output['logs'].each do |log|
             level = log['level'].casecmp('info').zero? ? 'debug' : log['level'].downcase
             WebDriver.logger.send(level, log['message'], id: :selenium_manager)
           end
 
           result = json_output['result']
-          return result unless status.exitstatus.positive?
+          return result unless status.exitstatus.positive? || result.nil?
 
-          raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{result}#{stderr}"
+          raise Error::WebDriverError,
+                "Unsuccessful command executed: #{command} - Code #{status.exitstatus}\n#{result}\n#{stderr}"
+        end
+
+        def platform_location
+          directory = File.expand_path(bin_path, __FILE__)
+          if Platform.windows?
+            "#{directory}/windows/selenium-manager.exe"
+          elsif Platform.mac?
+            "#{directory}/macos/selenium-manager"
+          elsif Platform.linux?
+            "#{directory}/linux/selenium-manager"
+          elsif Platform.unix?
+            WebDriver.logger.warn('Selenium Manager binary may not be compatible with Unix',
+                                  id: %i[selenium_manager unix_binary])
+            "#{directory}/linux/selenium-manager"
+          else
+            raise Error::WebDriverError, "unsupported platform: #{Platform.os}"
+          end
         end
       end
     end # SeleniumManager

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

@@ -87,6 +87,10 @@ module Selenium
       end
 
       def launch
+        @executable_path ||= begin
+          default_options = WebDriver.const_get("#{self.class.name&.split('::')&.[](2)}::Options").new
+          DriverFinder.new(default_options, self).driver_path
+        end
         ServiceManager.new(self).tap(&:start)
       end
 

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

@@ -40,8 +40,8 @@ module Selenium
         @executable_path = config.executable_path
         @host = Platform.localhost
         @port = config.port
-        @extra_args = config.args
         @io = config.log
+        @extra_args = config.args
         @shutdown_supported = config.shutdown_supported
 
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1

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

@@ -78,7 +78,7 @@ module Selenium
         def listening?
           addr     = Socket.getaddrinfo(@host, @port, Socket::AF_INET, Socket::SOCK_STREAM)
           sock     = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
-          sockaddr = Socket.pack_sockaddr_in(@port, addr[0][3])
+          sockaddr = Socket.pack_sockaddr_in(@port, addr[0][3].to_s)
 
           begin
             sock.connect_nonblock sockaddr

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

@@ -49,6 +49,10 @@ module Selenium
       # @api public
 
       def screenshot_as(format, full_page: false)
+        if full_page && !respond_to?(:save_full_page_screenshot)
+          raise Error::UnsupportedOperationError, "Full Page Screenshots are not supported for #{inspect}"
+        end
+
         case format
         when :base64
           full_page ? full_screenshot : screenshot
@@ -57,8 +61,6 @@ module Selenium
         else
           raise Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
         end
-      rescue NameError
-        raise Error::UnsupportedOperationError, "Full Page Screenshots are not supported for #{inspect}"
       end
     end # TakesScreenshot
   end # WebDriver

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

@@ -68,10 +68,8 @@ require 'selenium/webdriver/common/html5/local_storage'
 require 'selenium/webdriver/common/html5/session_storage'
 require 'selenium/webdriver/common/driver_extensions/has_web_storage'
 require 'selenium/webdriver/common/driver_extensions/downloads_files'
-require 'selenium/webdriver/common/driver_extensions/has_location'
 require 'selenium/webdriver/common/driver_extensions/has_session_id'
 require 'selenium/webdriver/common/driver_extensions/has_network_conditions'
-require 'selenium/webdriver/common/driver_extensions/has_network_connection'
 require 'selenium/webdriver/common/driver_extensions/has_network_interception'
 require 'selenium/webdriver/common/driver_extensions/has_apple_permissions'
 require 'selenium/webdriver/common/driver_extensions/has_permissions'
@@ -83,6 +81,7 @@ require 'selenium/webdriver/common/driver_extensions/full_page_screenshot'
 require 'selenium/webdriver/common/driver_extensions/has_addons'
 require 'selenium/webdriver/common/driver_extensions/has_bidi'
 require 'selenium/webdriver/common/driver_extensions/has_devtools'
+require 'selenium/webdriver/common/driver_extensions/has_file_downloads'
 require 'selenium/webdriver/common/driver_extensions/has_authentication'
 require 'selenium/webdriver/common/driver_extensions/has_logs'
 require 'selenium/webdriver/common/driver_extensions/has_log_events'
@@ -90,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 +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/devtools/network_interceptor.rb

@@ -98,7 +98,7 @@ module Selenium
           original = DevTools::Request.from(id, params)
           mutable = DevTools::Request.from(id, params)
 
-          block.call(mutable) do |&continue| # rubocop:disable Performance/RedundantBlockCall
+          block.call(mutable) do |&continue|
             pending_response_requests[id] = continue
 
             if original == mutable

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

@@ -35,8 +35,12 @@ module Selenium
           send_command: [:post, 'session/:session_id/ms/cdp/execute']
         }.freeze
 
+        def command_list
+          EDGE_COMMANDS.merge(CHROMIUM_COMMANDS).merge(self.class::COMMANDS)
+        end
+
         def commands(command)
-          EDGE_COMMANDS[command] || CHROMIUM_COMMANDS[command] || self.class::COMMANDS[command]
+          command_list[command]
         end
       end # Bridge
     end # Edge

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

@@ -24,6 +24,13 @@ module Selenium
         DEFAULT_PORT = 9515
         EXECUTABLE = 'msedgedriver'
         SHUTDOWN_SUPPORTED = true
+
+        def log
+          return @log unless @log.is_a? String
+
+          @args << "--log-path=#{@log}"
+          @log = nil
+        end
       end # Service
     end # Edge
   end # WebDriver

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

@@ -29,8 +29,12 @@ module Selenium
           full_page_screenshot: [:get, 'session/:session_id/moz/screenshot/full']
         }.freeze
 
+        def command_list
+          FIREFOX_COMMANDS.merge(self.class::COMMANDS)
+        end
+
         def commands(command)
-          FIREFOX_COMMANDS[command] || self.class::COMMANDS[command]
+          command_list[command]
         end
 
         def install_addon(path, temporary)

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/firefox/profile.rb

@@ -24,6 +24,10 @@ module Selenium
         include ProfileHelper
 
         VALID_PREFERENCE_TYPES = [TrueClass, FalseClass, Integer, Float, String].freeze
+        WEBDRIVER_PREFS = {
+          port: 'webdriver_firefox_port',
+          log_file: 'webdriver.log.file'
+        }.freeze
 
         DEFAULT_PREFERENCES = {
           'browser.newtabpage.enabled' => false,
@@ -33,8 +37,10 @@ module Selenium
           'security.csp.enable' => false
         }.freeze
 
-        attr_reader   :name, :log_file
-        attr_writer   :secure_ssl, :load_no_focus_lib
+        LOCK_FILES = %w[.parentlock parent.lock lock].freeze
+
+        attr_reader :name, :log_file
+        attr_writer :secure_ssl, :load_no_focus_lib
 
         class << self
           def ini
@@ -176,7 +182,7 @@ module Selenium
         end
 
         def delete_lock_files(directory)
-          %w[.parentlock parent.lock].each do |name|
+          LOCK_FILES.each do |name|
             FileUtils.rm_f File.join(directory, name)
           end
         end
@@ -204,8 +210,8 @@ module Selenium
           File.read(path).split("\n").each do |line|
             next unless line =~ /user_pref\("([^"]+)"\s*,\s*(.+?)\);/
 
-            key = Regexp.last_match(1).strip
-            value = Regexp.last_match(2).strip
+            key = Regexp.last_match(1)&.strip
+            value = Regexp.last_match(2)&.strip
 
             # wrap the value in an array to make it a valid JSON string.
             prefs[key] = JSON.parse("[#{value}]").first
@@ -221,7 +227,9 @@ module Selenium
             end
           end
         end
-      end # Profile
+      end
+
+      # Profile
     end # Firefox
   end # WebDriver
 end # Selenium

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

@@ -52,7 +52,7 @@ module Selenium
             when /^\[Profile/
               name, path = nil if path_for(name, is_relative, path)
             when /^Name=(.+)$/
-              name = Regexp.last_match(1).strip
+              name = Regexp.last_match(1)&.strip
             when /^IsRelative=(.+)$/
               is_relative = Regexp.last_match(1).strip == '1'
             when /^Path=(.+)$/

data/lib/selenium/webdriver/{common/driver_extensions/has_location.rb → ie/features.rb}

@@ -17,20 +17,18 @@
 # specific language governing permissions and limitations
 # under the License.
 
-# TODO: Deprecated; Delete after 4.0 release
 module Selenium
   module WebDriver
-    module DriverExtensions
-      module HasLocation
-        def location
-          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support getting location'
+    module IE
+      module Features
+        def command_list
+          self.class::COMMANDS
         end
 
-        def location=(*)
-          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support setting location'
+        def commands(command)
+          command_list[command]
         end
-        alias set_location location
-      end # HasLocation
-    end # DriverExtensions
+      end # Bridge
+    end # Ie
   end # WebDriver
 end # Selenium

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

@@ -20,9 +20,10 @@
 module Selenium
   module WebDriver
     module IE
-      autoload :Driver, 'selenium/webdriver/ie/driver'
-      autoload :Options, 'selenium/webdriver/ie/options'
-      autoload :Service, 'selenium/webdriver/ie/service'
+      autoload :Features, 'selenium/webdriver/ie/features'
+      autoload :Driver,   'selenium/webdriver/ie/driver'
+      autoload :Options,  'selenium/webdriver/ie/options'
+      autoload :Service,  'selenium/webdriver/ie/service'
     end # IE
   end # WebDriver
 end # Selenium