selenium-webdriver 4.35.0 → 4.47.0

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

@@ -40,7 +40,6 @@ module Selenium
         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
@@ -110,19 +109,28 @@ module Selenium
         end
 
         def port=(port)
+          WebDriver.logger.deprecate('Firefox::Profile#port=', 'the Service class', id: :firefox_profile)
           self[WEBDRIVER_PREFS[:port]] = port
         end
 
+        def secure_ssl=(value)
+          WebDriver.logger.deprecate('Firefox::Profile#secure_ssl=', id: :firefox_profile)
+          @secure_ssl = value
+        end
+
+        def load_no_focus_lib=(value)
+          WebDriver.logger.deprecate('Firefox::Profile#load_no_focus_lib=', id: :firefox_profile)
+          @load_no_focus_lib = value
+        end
+
         def log_file=(file)
           @log_file = file
           self[WEBDRIVER_PREFS[:log_file]] = file
         end
 
-        #
-        # Add the extension (directory, .zip or .xpi) at the given path to the profile.
-        #
-
         def add_extension(path, name = extension_name_for(path))
+          WebDriver.logger.deprecate('Firefox::Profile#add_extension', 'Driver#install_addon',
+                                     id: :firefox_profile)
           @extensions[name] = Extension.new(path)
         end
 
@@ -133,7 +141,6 @@ module Selenium
           when :manual
             self['network.proxy.type'] = 1
 
-            set_manual_proxy_preference 'ftp', proxy.ftp
             set_manual_proxy_preference 'http', proxy.http
             set_manual_proxy_preference 'ssl', proxy.ssl
             set_manual_proxy_preference 'socks', proxy.socks

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

@@ -26,14 +26,43 @@ module Selenium
         SHUTDOWN_SUPPORTED = false
         DRIVER_PATH_ENV_KEY = 'SE_GECKODRIVER'
 
-        def initialize(path: nil, port: nil, log: nil, args: nil)
-          args ||= []
+        def initialize(args: nil, **)
+          args = Array(args.dup)
           unless args.any? { |arg| arg.include?('--connect-existing') || arg.include?('--websocket-port') }
             args << '--websocket-port'
             args << '0'
           end
+
+          configure_debug_args(args) if ENV.key?('SE_DEBUG')
+
           super
         end
+
+        def launch
+          configure_debug_args(args) if ENV.key?('SE_DEBUG')
+
+          super
+        end
+
+        private
+
+        def configure_debug_args(args)
+          # An explicit geckodriver log setting is more specific than Selenium's
+          # generic SE_DEBUG fallback, so preserve it and skip adding `-v`.
+          if args.any? { |arg| arg.start_with?('--log') }
+            warn_explicit_log_preference unless @log_preference_warned
+            @log_preference_warned = true
+            args.reject! { |arg| arg.start_with?('-v') }
+            return
+          end
+
+          args << '-v' unless args.any? { |arg| /\A-v+\z/.match?(arg) }
+        end
+
+        def warn_explicit_log_preference
+          WebDriver.logger.warn('SE_DEBUG is set; preserving user-specified geckodriver --log setting instead of ' \
+                                'adding -v', id: :se_debug)
+        end
       end # Service
     end # Firefox
   end # WebDriver

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

@@ -31,9 +31,10 @@ module Selenium
 
         include LocalDriver
 
-        def initialize(options: nil, service: nil, url: nil, **)
-          caps, url = initialize_local_driver(options, service, url)
-          super(caps: caps, url: url, **)
+        def initialize(options: nil, service: nil, url: nil, http_client: nil, client_config: nil, **)
+          initialize_local_driver(options, service, url, http_client, client_config) do |caps, client|
+            super(caps: caps, http_client: client, **)
+          end
         end
 
         def browser

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

@@ -25,6 +25,16 @@ module Selenium
         EXECUTABLE = 'IEDriverServer'
         SHUTDOWN_SUPPORTED = true
         DRIVER_PATH_ENV_KEY = 'SE_IEDRIVER'
+
+        def initialize(args: nil, **)
+          if ENV.key?('SE_DEBUG')
+            args = Array(args.dup)
+            warn_driver_log_override if args.reject! { |arg| arg.include?('log-level') || arg.include?('silent') }
+            args << '--log-level=DEBUG'
+          end
+
+          super
+        end
       end # Server
     end # IE
   end # WebDriver

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

@@ -17,38 +17,60 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/bidi'
+require 'selenium/webdriver/bidi/protocol'
+
 module Selenium
   module WebDriver
     module Remote
       class BiDiBridge < Bridge
-        attr_reader :bidi
+        attr_reader :bidi, :connection
+
+        READINESS_STATE = {
+          'none' => :none,
+          'eager' => :interactive,
+          'normal' => :complete
+        }.freeze
 
         def create_session(capabilities)
           super
-          socket_url = @capabilities[:web_socket_url]
-          @bidi = Selenium::WebDriver::BiDi.new(url: socket_url)
+
+          begin
+            @bidi = Selenium::WebDriver::BiDi.new(url: validated_socket_url)
+            # Reuse the BiDi object's socket as the connection until the bridge owns it directly.
+            @connection = @bidi.ws
+          rescue StandardError
+            quit
+            raise
+          end
         end
 
         def get(url)
-          browsing_context.navigate(url)
+          browsing_context.navigate(context: window_handle, url: url, wait: readiness_state)
+          nil
         end
 
         def go_back
-          browsing_context.traverse_history(-1)
+          browsing_context.traverse_history(context: window_handle, delta: -1)
+          nil
         end
 
         def go_forward
-          browsing_context.traverse_history(1)
+          browsing_context.traverse_history(context: window_handle, delta: 1)
+          nil
         end
 
         def refresh
-          browsing_context.reload
+          browsing_context.reload(context: window_handle, wait: readiness_state)
+          nil
         end
 
         def quit
-          super
+          bidi&.close
+        rescue *QUIT_ERRORS
+          nil
         ensure
-          bidi.close
+          super
         end
 
         def close
@@ -57,8 +79,20 @@ module Selenium
 
         private
 
+        def validated_socket_url
+          url = @capabilities[:web_socket_url]
+          return url if url.is_a?(String) && url.start_with?('ws://', 'wss://')
+
+          raise Error::WebDriverError,
+                "BiDi was enabled, but the remote end did not return a valid webSocketUrl: #{url.inspect}."
+        end
+
         def browsing_context
-          @browsing_context ||= WebDriver::BiDi::BrowsingContext.new(self)
+          @browsing_context ||= BiDi::Protocol::BrowsingContext.new(connection)
+        end
+
+        def readiness_state
+          READINESS_STATE.fetch(capabilities[:page_load_strategy] || 'normal')
         end
       end # BiDiBridge
     end # Remote

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

@@ -51,20 +51,13 @@ module Selenium
         end
 
         #
-        # Initializes the bridge with the given server URL
-        # @param [String, URI] url url for the remote server
-        # @param [Object] http_client an HTTP client instance that implements the same protocol as Http::Default
+        # @param [Object] http_client a configured HTTP client implementing the same protocol as Http::Default
         # @api private
         #
 
-        def initialize(url:, http_client: nil)
-          uri = url.is_a?(URI) ? url : URI.parse(url)
-          uri.path += '/' unless uri.path.end_with?('/')
-
-          @http = http_client || Http::Default.new
-          @http.server_url = uri
+        def initialize(http_client:)
+          @http = http_client
           @file_detector = nil
-
           @locator_converter = self.class.locator_converter
         end
 
@@ -206,12 +199,20 @@ module Selenium
           switch_to_frame nil
         end
 
-        QUIT_ERRORS = [IOError].freeze
+        QUIT_ERRORS = [IOError, EOFError, WebSocket::Error].freeze
 
         def quit
-          execute :delete_session
-          http.close
-        rescue *QUIT_ERRORS
+          begin
+            execute :delete_session
+          rescue *QUIT_ERRORS => e
+            WebDriver.logger.debug "delete_session failed during quit: #{e.class}: #{e.message}", id: :quit
+          ensure
+            begin
+              http.close
+            rescue *QUIT_ERRORS => e
+              WebDriver.logger.debug "http.close failed during quit: #{e.class}: #{e.message}", id: :quit
+            end
+          end
           nil
         end
 
@@ -597,6 +598,11 @@ module Selenium
           raise(WebDriver::Error::WebDriverError, msg)
         end
 
+        def connection
+          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

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

@@ -29,13 +29,18 @@ module Selenium
         include DriverExtensions::UploadsFiles
         include DriverExtensions::HasSessionId
         include DriverExtensions::HasFileDownloads
+        include DriverExtensions::HasSessionEvents
 
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **)
-          raise ArgumentError, "Can not set :service object on #{self.class}" if service
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, http_client: nil, client_config: nil,
+                       **)
+          assert_arguments(service, url, http_client, client_config)
 
-          url ||= "http://#{Platform.localhost}:4444/wd/hub"
           caps = process_options(options, capabilities)
-          super(caps: caps, url: url, **)
+          http_client ||= Remote::Http::Default.new(client_config: client_config)
+          server_url = url || client_config&.server_url || "http://#{Platform.localhost}:4444/wd/hub"
+          http_client.server_url = server_url
+          caps['se:remoteUrl'] = server_url.to_s.chomp('/')
+          super(caps: caps, http_client: http_client, **)
           @bridge.file_detector = ->((filename, *)) { File.exist?(filename) && filename.to_s }
           command_list = @bridge.command_list
           @bridge.extend(WebDriver::Remote::Features)
@@ -44,6 +49,12 @@ module Selenium
 
         private
 
+        def assert_arguments(service, url, http_client, client_config)
+          raise ArgumentError, "Can not set :service object on #{self.class}" if service
+          raise ArgumentError, 'Cannot use both :http_client and :client_config' if http_client && client_config
+          raise ArgumentError, 'Cannot use both :url and a ClientConfig#server_url' if url && client_config&.server_url
+        end
+
         def devtools_url
           capabilities['se:cdp']
         end

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

@@ -25,7 +25,8 @@ module Selenium
           upload_file: [:post, 'session/:session_id/se/file'],
           get_downloadable_files: [:get, 'session/:session_id/se/files'],
           download_file: [:post, 'session/:session_id/se/files'],
-          delete_downloadable_files: [:delete, 'session/:session_id/se/files']
+          delete_downloadable_files: [:delete, 'session/:session_id/se/files'],
+          fire_session_event: [:post, 'session/:session_id/se/event']
         }.freeze
 
         def add_commands(commands)
@@ -69,6 +70,30 @@ module Selenium
         def delete_downloadable_files
           execute :delete_downloadable_files
         end
+
+        #
+        # Fires a custom session event to the remote server event bus.
+        # This allows test code to trigger server-side utilities that subscribe to
+        # the event bus.
+        #
+        # @param [String] event_type The type of event (e.g., "test:failed", "log:collect")
+        # @param [Hash] payload Optional data to include with the event
+        # @return [Hash] Response data including success status, event type, and timestamp
+        #
+        # @example Fire a simple event
+        #   driver.fire_session_event("test:started")
+        #
+        # @example Fire an event with payload
+        #   driver.fire_session_event("test:failed", {
+        #     testName: "LoginTest",
+        #     error: "Element not found"
+        #   })
+        #
+        def fire_session_event(event_type, payload = nil)
+          params = {eventType: event_type}
+          params[:payload] = payload if payload
+          execute :fire_session_event, {}, params
+        end
       end
     end # Remote
   end # WebDriver

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

@@ -28,17 +28,35 @@ module Selenium
             'Accept' => CONTENT_TYPE,
             'Content-Type' => "#{CONTENT_TYPE}; charset=UTF-8"
           }.freeze
+          BINARY_ENCODINGS = [Encoding::BINARY, Encoding::ASCII_8BIT].freeze
 
           class << self
-            attr_accessor :extra_headers
-            attr_writer :user_agent
-
             def user_agent
-              @user_agent ||= "selenium/#{WebDriver::VERSION} (ruby #{Platform.os})"
+              ClientConfig.default_user_agent
+            end
+
+            def user_agent=(value)
+              ClientConfig.default_user_agent = value
+            end
+
+            def extra_headers
+              ClientConfig.default_extra_headers
+            end
+
+            def extra_headers=(value)
+              ClientConfig.default_extra_headers = value
             end
           end
 
-          attr_writer :server_url
+          attr_reader :client_config
+
+          def initialize(client_config: nil)
+            @client_config = client_config || ClientConfig.new
+          end
+
+          def server_url=(url)
+            client_config.server_url = url
+          end
 
           def quit_errors
             [IOError]
@@ -55,6 +73,7 @@ module Selenium
             headers['Cache-Control'] = 'no-cache' if verb == :get
 
             if command_hash
+              command_hash              = ensure_utf8_encoding(command_hash)
               payload                   = JSON.generate(command_hash)
               headers['Content-Length'] = payload.bytesize.to_s if %i[post put].include?(verb)
 
@@ -74,23 +93,49 @@ module Selenium
           def common_headers
             @common_headers ||= begin
               headers = DEFAULT_HEADERS.dup
-              headers['User-Agent'] = Common.user_agent
-              headers = headers.merge(Common.extra_headers || {})
-
-              headers
+              headers['User-Agent'] = client_config.user_agent
+              headers.merge(client_config.extra_headers || {})
             end
           end
 
           def server_url
-            return @server_url if @server_url
-
-            raise Error::WebDriverError, 'server_url not set'
+            client_config.server_url || raise(Error::WebDriverError, 'server_url not set')
           end
 
           def request(*)
             raise NotImplementedError, 'subclass responsibility'
           end
 
+          def ensure_utf8_encoding(obj)
+            case obj
+            when String
+              encode_string_to_utf8(obj)
+            when Array
+              obj.map { |item| ensure_utf8_encoding(item) }
+            when Hash
+              obj.each_with_object({}) do |(key, value), result|
+                result[ensure_utf8_encoding(key)] = ensure_utf8_encoding(value)
+              end
+            else
+              obj
+            end
+          end
+
+          def encode_string_to_utf8(str)
+            return str if str.encoding == Encoding::UTF_8 && str.valid_encoding?
+
+            if BINARY_ENCODINGS.include?(str.encoding)
+              result = str.dup.force_encoding(Encoding::UTF_8)
+              return result if result.valid_encoding?
+            end
+
+            str.encode(Encoding::UTF_8)
+          rescue EncodingError => e
+            raise Error::WebDriverError,
+                  "Unable to encode string to UTF-8: #{e.message}. " \
+                  "String encoding: #{str.encoding}, content: #{str.inspect}"
+          end
+
           def create_response(code, body, content_type)
             code = code.to_i
             body = body.to_s.strip

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

@@ -26,20 +26,18 @@ module Selenium
         #
         # An alternative to the default Net::HTTP client.
         #
-        # This can be used for the Firefox and Remote drivers if you have Curb
-        # installed.
-        #
-        # @example Using Curb
-        #   require 'selenium/webdriver/remote/http/curb'
-        #   include Selenium
-        #
-        #   driver = WebDriver.for :firefox, :http_client => WebDriver::Remote::Http::Curb.new
+        # @deprecated Subclass {Selenium::WebDriver::Remote::Http::Common} to implement a custom HTTP client.
         #
 
         class Curb < Common
           attr_accessor :timeout
 
           def initialize(timeout: nil)
+            WebDriver.logger.deprecate(
+              'Selenium::WebDriver::Remote::Http::Curb',
+              'a custom subclass of Selenium::WebDriver::Remote::Http::Common',
+              id: :curb
+            )
             @timeout = timeout
             super()
           end

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

@@ -24,19 +24,41 @@ module Selenium
       module Http
         # @api private
         class Default < Common
-          attr_writer :proxy
-
-          attr_accessor :open_timeout, :read_timeout
-
           # Initializes object.
           # Warning: Setting {#open_timeout} to non-nil values will cause a separate thread to spawn.
           # Debuggers that freeze the process will not be able to evaluate any operations if that happens.
+          # @param [ClientConfig] client_config - Configuration used to build the HTTP client.
           # @param [Numeric] open_timeout - Open timeout to apply to HTTP client.
           # @param [Numeric] read_timeout - Read timeout (seconds) to apply to HTTP client.
-          def initialize(open_timeout: nil, read_timeout: nil)
-            @open_timeout = open_timeout
-            @read_timeout = read_timeout
-            super()
+          def initialize(client_config: nil, open_timeout: nil, read_timeout: nil)
+            if client_config && (open_timeout || read_timeout)
+              raise ArgumentError, 'Cannot use both :client_config and :open_timeout/:read_timeout'
+            end
+
+            client_config ||= ClientConfig.new
+            client_config.open_timeout = open_timeout if open_timeout
+            client_config.read_timeout = read_timeout if read_timeout
+            super(client_config: client_config)
+          end
+
+          def open_timeout
+            client_config.open_timeout
+          end
+
+          def read_timeout
+            client_config.read_timeout
+          end
+
+          def open_timeout=(value)
+            client_config.open_timeout = value
+          end
+
+          def read_timeout=(value)
+            client_config.read_timeout = value
+          end
+
+          def proxy=(value)
+            client_config.proxy = value
           end
 
           def close
@@ -94,16 +116,20 @@ 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)
+              follow_redirect(response, redirects)
             else
               WebDriver.logger.debug("   <<<  #{response.instance_variable_get(:@header).inspect}", id: :header)
               create_response response.code, response.body, response.content_type
             end
           end
 
+          def follow_redirect(response, redirects)
+            WebDriver.logger.debug("Redirect to #{response['Location']}; times: #{redirects}", id: :redirect)
+            raise Error::WebDriverError, 'too many redirects' if redirects >= client_config.max_redirects
+
+            request(:get, URI.parse(response['Location']), DEFAULT_HEADERS.dup, nil, redirects + 1)
+          end
+
           def new_request_for(verb, url, headers, payload)
             req = Net::HTTP.const_get(verb.to_s.capitalize).new(url.path, headers)
 
@@ -120,52 +146,43 @@ module Selenium
 
           def new_http_client
             if use_proxy?
-              url = @proxy.http
+              url = proxy.http
               unless proxy.respond_to?(:http) && url
                 raise Error::WebDriverError,
-                      "expected HTTP proxy, got #{@proxy.inspect}"
+                      "expected HTTP proxy, got #{proxy.inspect}"
               end
 
-              proxy = URI.parse(url)
+              proxy_uri = URI.parse(url)
 
-              Net::HTTP.new(server_url.host, server_url.port, proxy.host, proxy.port, proxy.user, proxy.password)
+              Net::HTTP.new(server_url.host, server_url.port,
+                            proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
             else
               Net::HTTP.new server_url.host, server_url.port
             end
           end
 
           def proxy
-            @proxy ||= begin
-              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://')
-                Proxy.new(http: proxy, no_proxy: no_proxy)
-              end
-            end
+            client_config.proxy
           end
 
           def use_proxy?
             return false if proxy.nil?
+            return true unless proxy.no_proxy
 
-            if proxy.no_proxy
-              ignored = proxy.no_proxy.split(',').any? do |host|
-                host == '*' ||
-                  host == server_url.host || (
-                begin
-                  IPAddr.new(host).include?(server_url.host)
-                rescue ArgumentError
-                  false
-                end
-              )
-              end
+            !proxy_ignored?
+          end
 
-              !ignored
-            else
-              true
+          def proxy_ignored?
+            proxy.no_proxy.split(',').map(&:strip).reject(&:empty?).any? do |host|
+              host == '*' || host == server_url.host || ip_match?(host)
             end
           end
+
+          def ip_match?(host)
+            IPAddr.new(host).include?(server_url.host)
+          rescue ArgumentError
+            false
+          end
         end # Default
       end # Http
     end # Remote

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

@@ -31,9 +31,10 @@ module Selenium
 
         include LocalDriver
 
-        def initialize(options: nil, service: nil, url: nil, **)
-          caps, url = initialize_local_driver(options, service, url)
-          super(caps: caps, url: url, **)
+        def initialize(options: nil, service: nil, url: nil, http_client: nil, client_config: nil, **)
+          initialize_local_driver(options, service, url, http_client, client_config) do |caps, client|
+            super(caps: caps, http_client: client, **)
+          end
         end
 
         def browser