selenium-webdriver 4.27.0 → 4.32.0

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

@@ -27,12 +27,13 @@ module Selenium
         # @return [DevTools]
         #
 
-        def devtools
-          @devtools ||= begin
+        def devtools(target_type: 'page')
+          @devtools ||= {}
+          @devtools[target_type] ||= begin
             require 'selenium/devtools'
             Selenium::DevTools.version ||= devtools_version
             Selenium::DevTools.load_version
-            Selenium::WebDriver::DevTools.new(url: devtools_url)
+            Selenium::WebDriver::DevTools.new(url: devtools_url, target_type: target_type)
           end
         end
       end # HasDevTools

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

@@ -59,7 +59,7 @@ module Selenium
         # @yieldparam [Proc] continue block which proceeds with the request and optionally yields response
         #
 
-        def intercept(&)
+        def intercept(&block)
           if browser == :firefox
             WebDriver.logger.deprecate(
               'Driver#intercept on Firefox',
@@ -68,7 +68,7 @@ module Selenium
             )
           end
           @interceptor ||= DevTools::NetworkInterceptor.new(devtools)
-          @interceptor.intercept(&)
+          @interceptor.intercept(&block)
         end
       end # HasNetworkInterception
     end # DriverExtensions

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

@@ -194,7 +194,7 @@ module Selenium
       def discard_or_log(level, message, id)
         id = Array(id)
         return if @ignored.intersect?(id)
-        return if @allowed.any? && (@allowed & id).none?
+        return if @allowed.any? && !@allowed.intersect?(id)
 
         return if ::Logger::Severity.const_get(level.upcase) < @logger.level
 

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

@@ -65,7 +65,7 @@ module Selenium
       # Get the cookie with the given name
       #
       # @param [String] name the name of the cookie
-      # @return [Hash, nil] the cookie, or nil if it wasn't found.
+      # @return [Hash] the cookie, or throws a NoSuchCookieError if it wasn't found.
       #
 
       def cookie_named(name)

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

@@ -17,35 +17,85 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'forwardable'
+
 module Selenium
   module WebDriver
     class Network
-      attr_reader :auth_callbacks
+      extend Forwardable
+
+      attr_reader :callbacks, :network
+      alias bidi network
+
+      def_delegators :network, :continue_with_auth, :continue_with_request, :continue_with_response
 
       def initialize(bridge)
         @network = BiDi::Network.new(bridge.bidi)
-        @auth_callbacks = {}
+        @callbacks = {}
       end
 
-      def add_authentication_handler(username, password)
-        intercept = @network.add_intercept(phases: [BiDi::Network::PHASES[:auth_required]])
-        auth_id = @network.on(:auth_required) do |event|
-          request_id = event['requestId']
-          @network.continue_with_auth(request_id, username, password)
-        end
-        @auth_callbacks[auth_id] = intercept
+      def remove_handler(id)
+        intercept = callbacks[id]
+        network.remove_intercept(intercept['intercept'])
+        callbacks.delete(id)
+      end
 
-        auth_id
+      def clear_handlers
+        callbacks.each_key { |id| remove_handler(id) }
       end
 
-      def remove_authentication_handler(id)
-        intercept = @auth_callbacks[id]
-        @network.remove_intercept(intercept['intercept'])
-        @auth_callbacks.delete(id)
+      def add_authentication_handler(username = nil, password = nil, *filter, pattern_type: nil, &block)
+        selected_block =
+          if username && password
+            proc { |auth| auth.authenticate(username, password) }
+          else
+            block
+          end
+
+        add_handler(
+          :auth_required,
+          BiDi::Network::PHASES[:auth_required],
+          BiDi::InterceptedAuth,
+          filter,
+          pattern_type: pattern_type,
+          &selected_block
+        )
       end
 
-      def clear_authentication_handlers
-        @auth_callbacks.each_key { |id| remove_authentication_handler(id) }
+      def add_request_handler(*filter, pattern_type: nil, &block)
+        add_handler(
+          :before_request,
+          BiDi::Network::PHASES[:before_request],
+          BiDi::InterceptedRequest,
+          filter,
+          pattern_type: pattern_type,
+          &block
+        )
+      end
+
+      def add_response_handler(*filter, pattern_type: nil, &block)
+        add_handler(
+          :response_started,
+          BiDi::Network::PHASES[:response_started],
+          BiDi::InterceptedResponse,
+          filter,
+          pattern_type: pattern_type,
+          &block
+        )
+      end
+
+      private
+
+      def add_handler(event_type, phase, intercept_type, filter, pattern_type: nil)
+        intercept = network.add_intercept(phases: [phase], url_patterns: [filter].flatten, pattern_type: pattern_type)
+        callback_id = network.on(event_type) do |event|
+          request = event['request']
+          intercepted_item = intercept_type.new(network, request)
+          yield(intercepted_item)
+        end
+
+        callbacks[callback_id] = intercept
+        callback_id
       end
     end # Network
   end # WebDriver

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

@@ -52,7 +52,7 @@ module Selenium
         end
 
         def set_capabilities
-          (W3C_OPTIONS + self::CAPABILITIES.keys).each do |key|
+          (W3C_OPTIONS + GRID_OPTIONS + self::CAPABILITIES.keys).each do |key|
             next if method_defined? key
 
             define_method key do

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

@@ -0,0 +1,93 @@
+# 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
+    # Represents options for printing a page.
+    class PrintOptions
+      DEFAULT_SCALE = 1.0
+      DEFAULT_ORIENTATION = 'portrait'
+      DEFAULT_PAGE_SIZE = {width: 21.0, height: 29.7}.freeze # A4 size in cm
+      DEFAULT_MARGINS = {top: 1.0, bottom: 1.0, left: 1.0, right: 1.0}.freeze
+
+      attr_accessor :orientation, :scale, :background, :page_ranges, :margins
+
+      def initialize
+        @orientation = DEFAULT_ORIENTATION
+        @scale = DEFAULT_SCALE
+        @background = false
+        @page_ranges = nil
+        @page_size = DEFAULT_PAGE_SIZE
+        @margins = DEFAULT_MARGINS
+      end
+
+      # Converts the options to a hash format to be used by WebDriver.
+      #
+      # @return [Hash]
+      def to_h
+        options = {
+          orientation: @orientation,
+          scale: @scale,
+          background: @background,
+          pageRanges: @page_ranges,
+          paperWidth: @page_size[:width],
+          paperHeight: @page_size[:height],
+          marginTop: @margins[:top],
+          marginBottom: @margins[:bottom],
+          marginLeft: @margins[:left],
+          marginRight: @margins[:right]
+        }
+
+        options.compact
+      end
+
+      # Gets the current page size.
+      #
+      # @return [Hash] The current page size hash with :width and :height.
+      attr_reader :page_size
+
+      # Sets the page size. Can be a predefined symbol or custom size hash.
+      #
+      # @param [Symbol, Hash] value The predefined size (:letter, :legal, :a4, :tabloid) or a custom hash.
+      def page_size=(value)
+        predefined_sizes = {
+          letter: {width: 21.59, height: 27.94},
+          legal: {width: 21.59, height: 35.56},
+          a4: {width: 21.0, height: 29.7},
+          tabloid: {width: 27.94, height: 43.18}
+        }
+
+        case value
+        when Symbol
+          raise ArgumentError, "Invalid page size: #{value}" unless predefined_sizes.key?(value)
+
+          @page_size = predefined_sizes[value]
+        when Hash
+          unless value.key?(:width) && value.key?(:height)
+            raise ArgumentError, 'Custom page size must include :width and :height'
+          end
+
+          @page_size = value
+        else
+          raise ArgumentError, 'Page size must be a Symbol or a Hash'
+        end
+      end
+    end
+  end
+end

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

@@ -25,13 +25,13 @@ module Selenium
       end
 
       # @return [int] id of the handler
-      def add_console_message_handler(&)
-        @log_handler.add_message_handler('console', &)
+      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(&)
-        @log_handler.add_message_handler('javascript', &)
+      def add_javascript_error_handler(&block)
+        @log_handler.add_message_handler('javascript', &block)
       end
 
       # @param [int] id of the handler previously added

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

@@ -61,25 +61,12 @@ module Selenium
         end
 
         def run(*command)
-          WebDriver.logger.debug("Executing Process #{command}", id: :selenium_manager)
-
-          begin
-            stdout, stderr, status = Open3.capture3(*command)
-          rescue StandardError => e
-            raise Error::WebDriverError, "Unsuccessful command executed: #{command}; #{e.message}"
-          end
+          stdout, stderr, status = execute_command(*command)
+          result = parse_result_and_log(stdout)
 
-          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
+          validate_command_result(command, status, result, stderr)
 
-          result = json_output['result']
-          return result unless status.exitstatus.positive? || result.nil?
-
-          raise Error::WebDriverError,
-                "Unsuccessful command executed: #{command} - Code #{status.exitstatus}\n#{result}\n#{stderr}"
+          result
         end
 
         def platform_location
@@ -98,6 +85,38 @@ module Selenium
             raise Error::WebDriverError, "unsupported platform: #{Platform.os}"
           end
         end
+
+        def execute_command(*command)
+          WebDriver.logger.debug("Executing Process #{command}", id: :selenium_manager)
+
+          Open3.capture3(*command)
+        rescue StandardError => e
+          raise Error::WebDriverError, "Unsuccessful command executed: #{command}; #{e.message}"
+        end
+
+        def parse_result_and_log(stdout)
+          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
+
+          json_output['result']
+        end
+
+        def validate_command_result(command, status, result, stderr)
+          if status.nil? || status.exitstatus.nil?
+            WebDriver.logger.info("No exit status for: #{command}. Assuming success if result is present.",
+                                  id: :selenium_manager)
+          end
+
+          return unless status&.exitstatus&.positive? || result.nil?
+
+          code = status&.exitstatus || 'exit status not available'
+          raise Error::WebDriverError,
+                "Unsuccessful command executed: #{command} - Code #{code}\n#{result}\n#{stderr}"
+        end
       end
     end # SeleniumManager
   end # WebDriver

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

@@ -36,6 +36,7 @@ module Selenium
                                 'It should end with .png extension',
                                 id: :screenshot
         end
+        WebDriver.logger.debug("Saving screenshot to #{Dir.pwd}/#{png_path}")
         File.open(png_path, 'wb') { |f| f << screenshot_as(:png, full_page: full_page) }
       end
 

data/lib/selenium/webdriver/common.rb

@@ -63,10 +63,6 @@ require 'selenium/webdriver/common/action_builder'
 require 'selenium/webdriver/common/virtual_authenticator/credential'
 require 'selenium/webdriver/common/virtual_authenticator/virtual_authenticator_options'
 require 'selenium/webdriver/common/virtual_authenticator/virtual_authenticator'
-require 'selenium/webdriver/common/html5/shared_web_storage'
-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_session_id'
 require 'selenium/webdriver/common/driver_extensions/has_network_conditions'
@@ -91,6 +87,7 @@ 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/print_options'
 require 'selenium/webdriver/common/profile_helper'
 require 'selenium/webdriver/common/options'
 require 'selenium/webdriver/common/takes_screenshot'

data/lib/selenium/webdriver/devtools.rb

@@ -28,10 +28,10 @@ module Selenium
       autoload :Request, 'selenium/webdriver/devtools/request'
       autoload :Response, 'selenium/webdriver/devtools/response'
 
-      def initialize(url:)
+      def initialize(url:, target_type:)
         @ws = WebSocketConnection.new(url: url)
         @session_id = nil
-        start_session
+        start_session(target_type: target_type)
       end
 
       def close
@@ -81,10 +81,12 @@ module Selenium
 
       private
 
-      def start_session
+      def start_session(target_type:)
         targets = target.get_targets.dig('result', 'targetInfos')
-        page_target = targets.find { |target| target['type'] == 'page' }
-        session = target.attach_to_target(target_id: page_target['targetId'], flatten: true)
+        found_target = targets.find { |target| target['type'] == target_type }
+        raise Error::WebDriverError, "Target type '#{target_type}' not found" unless found_target
+
+        session = target.attach_to_target(target_id: found_target['targetId'], flatten: true)
         @session_id = session.dig('result', 'sessionId')
       end
 

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

@@ -30,10 +30,8 @@ module Selenium
                       DriverExtensions::FullPageScreenshot,
                       DriverExtensions::HasContext,
                       DriverExtensions::HasBiDi,
-                      DriverExtensions::HasDevTools,
                       DriverExtensions::HasLogEvents,
                       DriverExtensions::HasNetworkInterception,
-                      DriverExtensions::HasWebStorage,
                       DriverExtensions::PrintsPage].freeze
 
         include LocalDriver
@@ -46,23 +44,6 @@ module Selenium
         def browser
           :firefox
         end
-
-        private
-
-        def devtools_url
-          if capabilities['moz:debuggerAddress'].nil?
-            raise(Error::WebDriverError, 'DevTools is not supported by this version of Firefox; use v85 or higher')
-          end
-
-          uri = URI("http://#{capabilities['moz:debuggerAddress']}")
-          response = Net::HTTP.get(uri.hostname, '/json/version', uri.port)
-
-          JSON.parse(response)['webSocketDebuggerUrl']
-        end
-
-        def devtools_version
-          Firefox::DEVTOOLS_VERSION
-        end
       end # Driver
     end # Firefox
   end # WebDriver

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

@@ -64,9 +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
+          # Enable BiDi only
+          @options[:prefs]['remote.active-protocols'] = 1
           @options[:env] ||= {}
           @options[:log] ||= {level: log_level} if log_level
 

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

@@ -25,6 +25,15 @@ module Selenium
         EXECUTABLE = 'geckodriver'
         SHUTDOWN_SUPPORTED = false
         DRIVER_PATH_ENV_KEY = 'SE_GECKODRIVER'
+
+        def initialize(path: nil, port: nil, log: nil, args: nil)
+          args ||= []
+          unless args.any? { |arg| arg.include?('--connect-existing') }
+            args << '--websocket-port'
+            args << WebDriver::PortProber.above(9222).to_s
+          end
+          super
+        end
       end # Service
     end # Firefox
   end # WebDriver

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

@@ -27,7 +27,7 @@ module Selenium
       #
 
       class Driver < WebDriver::Driver
-        EXTENSIONS = [DriverExtensions::HasWebStorage].freeze
+        EXTENSIONS = [].freeze
 
         include LocalDriver
 

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

@@ -35,10 +35,10 @@ module Selenium
           attr_reader :extra_commands
           attr_writer :element_class, :locator_converter
 
-          def add_command(name, verb, url, &)
+          def add_command(name, verb, url, &block)
             @extra_commands ||= {}
             @extra_commands[name] = [verb, url]
-            define_method(name, &)
+            define_method(name, &block)
           end
 
           def locator_converter
@@ -296,68 +296,6 @@ module Selenium
           execute :take_element_screenshot, id: element
         end
 
-        #
-        # HTML 5
-        #
-
-        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
-            execute_script("return localStorage.getItem('#{key}')")
-          end
-        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
-            execute_script("return sessionStorage.getItem('#{key}')")
-          end
-        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
-
         #
         # javascript execution
         #
@@ -385,6 +323,8 @@ module Selenium
         end
 
         def delete_cookie(name)
+          raise ArgumentError, 'Cookie name cannot be null or empty' if name.nil? || name.to_s.strip.empty?
+
           execute :delete_cookie, name: name
         end
 

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

@@ -27,8 +27,7 @@ module Selenium
 
       class Driver < WebDriver::Driver
         EXTENSIONS = [DriverExtensions::HasDebugger,
-                      DriverExtensions::HasApplePermissions,
-                      DriverExtensions::HasWebStorage].freeze
+                      DriverExtensions::HasApplePermissions].freeze
 
         include LocalDriver
 

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

@@ -37,8 +37,10 @@ module Selenium
           @messages = {}
         end
 
-        def add_condition(name, condition = nil, &)
-          @guard_conditions << GuardCondition.new(name, condition, &)
+        def add_condition(name, condition = false, &block)
+          condition = false if condition.nil?
+          @guard_conditions << GuardCondition.new(name, condition, &block)
+          WebDriver.logger.debug "Running with Guard '#{name}' set to: #{condition}"
         end
 
         def add_message(name, message)

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.27.0'
+    VERSION = '4.32.0'
   end # WebDriver
 end # Selenium

data/selenium-webdriver.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.homepage = 'https://selenium.dev'
   s.metadata = {
     'changelog_uri' => 'https://github.com/SeleniumHQ/selenium/blob/trunk/rb/CHANGES',
+    'documentation_uri' => 'https://www.selenium.dev/documentation/?tab=ruby',
     'github_repo' => 'ssh://github.com/SeleniumHQ/selenium',
     'source_code_uri' => 'https://github.com/SeleniumHQ/selenium/tree/trunk/rb',
     'rubygems_mfa_required' => 'true',
@@ -58,10 +59,10 @@ Gem::Specification.new do |s|
   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.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 'rubocop', ['~> 1.75']
+  s.add_development_dependency 'rubocop-performance', ['~> 1.25']
+  s.add_development_dependency 'rubocop-rake', ['~> 0.7']
+  s.add_development_dependency 'rubocop-rspec', ['~> 3.5']
   s.add_development_dependency 'webmock', ['~> 3.5']
   s.add_development_dependency 'webrick', ['~> 1.7']
   s.add_development_dependency 'yard', ['~> 0.9.11', '>= 0.9.36']