selenium-webdriver 4.26.0 → 4.28.0

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

@@ -0,0 +1,82 @@
+# 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 BiDi
+      class Network
+        EVENTS = {
+          before_request: 'network.beforeRequestSent',
+          response_started: 'network.responseStarted',
+          response_completed: 'network.responseCompleted',
+          auth_required: 'network.authRequired',
+          fetch_error: 'network.fetchError'
+        }.freeze
+
+        PHASES = {
+          before_request: 'beforeRequestSent',
+          response_started: 'responseStarted',
+          auth_required: 'authRequired'
+        }.freeze
+
+        def initialize(bidi)
+          @bidi = bidi
+        end
+
+        def add_intercept(phases: [], contexts: nil, url_patterns: nil)
+          @bidi.send_cmd('network.addIntercept', phases: phases, contexts: contexts, urlPatterns: url_patterns)
+        end
+
+        def remove_intercept(intercept)
+          @bidi.send_cmd('network.removeIntercept', intercept: intercept)
+        end
+
+        def continue_with_auth(request_id, username, password)
+          @bidi.send_cmd(
+            'network.continueWithAuth',
+            'request' => request_id,
+            'action' => 'provideCredentials',
+            'credentials' => {
+              'type' => 'password',
+              'username' => username,
+              'password' => password
+            }
+          )
+        end
+
+        def continue_with_request(**args)
+          @bidi.send_cmd(
+            'network.continueWithRequest',
+            request: args[:request_id],
+            'body' => args[:body],
+            'cookies' => args[:cookies],
+            'headers' => args[:headers],
+            'method' => args[:method],
+            'url' => args[:url]
+          )
+        end
+
+        def on(event, &)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @bidi.add_callback(event, &)
+        end
+      end # Network
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/struct.rb

@@ -23,7 +23,7 @@ module Selenium
       class Struct < ::Struct
         class << self
           def new(*args, &block)
-            super(*args) do
+            super do
               define_method(:initialize) do |**kwargs|
                 converted_kwargs = kwargs.transform_keys { |key| self.class.camel_to_snake(key.to_s).to_sym }
                 super(*converted_kwargs.values_at(*self.class.members))
@@ -37,8 +37,6 @@ module Selenium
           end
         end
       end
-    end
-
-    # BiDi
+    end # BiDi
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/bidi.rb

@@ -25,6 +25,7 @@ module Selenium
       autoload :LogHandler, 'selenium/webdriver/bidi/log_handler'
       autoload :BrowsingContext, 'selenium/webdriver/bidi/browsing_context'
       autoload :Struct, 'selenium/webdriver/bidi/struct'
+      autoload :Network, 'selenium/webdriver/bidi/network'
 
       def initialize(url:)
         @ws = WebSocketConnection.new(url: url)
@@ -38,8 +39,8 @@ module Selenium
         @ws.callbacks
       end
 
-      def add_callback(event, &block)
-        @ws.add_callback(event, &block)
+      def add_callback(event, &)
+        @ws.add_callback(event, &)
       end
 
       def remove_callback(event, id)

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

@@ -64,16 +64,10 @@ module Selenium
         return unless @pid
         return if exited?
 
-        WebDriver.logger.debug("Sending TERM to process: #{@pid}", id: :process)
-        terminate(@pid)
-        poll_for_exit(timeout)
-
-        WebDriver.logger.debug("  -> stopped #{@pid}", id: :process)
-      rescue TimeoutError, Errno::EINVAL
-        WebDriver.logger.debug("    -> sending KILL to process: #{@pid}", id: :process)
-        kill(@pid)
-        wait
-        WebDriver.logger.debug("      -> killed #{@pid}", id: :process)
+        terminate_and_wait_else_kill(timeout)
+      rescue Errno::ECHILD, Errno::ESRCH => e
+        # Process exited earlier than terminate/kill could catch
+        WebDriver.logger.debug("    -> process: #{@pid} does not exist (#{e.class.name})", id: :process)
       end
 
       def alive?
@@ -91,6 +85,9 @@ module Selenium
         WebDriver.logger.debug("  -> exit code is #{exit_code.inspect}", id: :process)
 
         !!exit_code
+      rescue Errno::ECHILD, Errno::ESRCH
+        WebDriver.logger.debug("  -> process: #{@pid} already finished", id: :process)
+        true
       end
 
       def poll_for_exit(timeout)
@@ -110,20 +107,29 @@ module Selenium
 
       private
 
+      def terminate_and_wait_else_kill(timeout)
+        WebDriver.logger.debug("Sending TERM to process: #{@pid}", id: :process)
+        terminate(@pid)
+        poll_for_exit(timeout)
+
+        WebDriver.logger.debug("  -> stopped #{@pid}", id: :process)
+      rescue TimeoutError, Errno::EINVAL
+        WebDriver.logger.debug("    -> sending KILL to process: #{@pid}", id: :process)
+        kill(@pid)
+        wait
+        WebDriver.logger.debug("      -> killed #{@pid}", id: :process)
+      end
+
       def terminate(pid)
         Process.kill(SIGTERM, pid)
       end
 
       def kill(pid)
         Process.kill(SIGKILL, pid)
-      rescue Errno::ECHILD, Errno::ESRCH
-        # already dead
       end
 
       def waitpid2(pid, flags = 0)
         Process.waitpid2(pid, flags)
-      rescue Errno::ECHILD
-        # already dead
       end
     end # ChildProcess
   end # WebDriver

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

@@ -264,6 +264,15 @@ module Selenium
         bridge.add_virtual_authenticator(options)
       end
 
+      #
+      # @return [Network]
+      # @see Network
+      #
+
+      def network
+        @network ||= WebDriver::Network.new(bridge)
+      end
+
       #-------------------------------- sugar  --------------------------------
 
       #

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

@@ -57,6 +57,13 @@ module Selenium
         #
 
         def on_log_event(kind, &block)
+          if browser == :firefox
+            WebDriver.logger.deprecate(
+              'Driver#on_log_event on Firefox',
+              'the script.add_console_message_handler or the script.add_javascript_error_handler methods',
+              id: :on_log_event
+            )
+          end
           raise Error::WebDriverError, "Don't know how to handle #{kind} events" unless KINDS.include?(kind)
 
           enabled = log_listeners[kind].any?

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

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

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

@@ -50,9 +50,11 @@ module Selenium
           super(URLS[class_name] ? "#{msg}; #{SUPPORT_MSG} #{URLS[class_name]}" : msg)
         end
 
+        # steep:ignore:start
         def class_name
-          self.class.name&.split('::')&.last&.to_sym
+          self.class.name.split('::')&.last&.to_sym
         end
+        # steep:ignore:end
       end
 
       #

data/lib/selenium/webdriver/common/fedcm/account.rb

@@ -30,9 +30,7 @@ module Selenium
         attr_reader :account_id, :email, :name, :given_name, :picture_url,
                     :idp_config_url, :login_state, :terms_of_service_url, :privacy_policy_url
 
-        # Initializes a new account with the provided attributes.
-        #
-        # @param [Hash]
+        # steep:ignore:start
         def initialize(**args)
           @account_id = args['accountId']
           @email = args['email']
@@ -44,6 +42,7 @@ module Selenium
           @terms_of_service_url = args['termsOfServiceUrl']
           @privacy_policy_url = args['privacyPolicyUrl']
         end
+        # steep:ignore:end
       end # Account
     end # FedCM
   end # WebDriver

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

@@ -193,8 +193,8 @@ module Selenium
 
       def discard_or_log(level, message, id)
         id = Array(id)
-        return if (@ignored & id).any?
-        return if @allowed.any? && (@allowed & id).none?
+        return if @ignored.intersect?(id)
+        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

@@ -0,0 +1,64 @@
+# 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 Network
+      attr_reader :callbacks
+
+      def initialize(bridge)
+        @network = BiDi::Network.new(bridge.bidi)
+        @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
+        @callbacks[auth_id] = intercept
+
+        auth_id
+      end
+
+      def remove_handler(id)
+        intercept = @callbacks[id]
+        @network.remove_intercept(intercept['intercept'])
+        @callbacks.delete(id)
+      end
+
+      def clear_handlers
+        @callbacks.each_key { |id| remove_handler(id) }
+      end
+
+      def add_request_handler
+        intercept = @network.add_intercept(phases: [BiDi::Network::PHASES[:before_request]])
+        request_id = @network.on(:before_request) do |event|
+          request_id = event['requestId']
+          @network.continue_with_request(request_id: request_id)
+        end
+
+        @callbacks[request_id] = intercept
+
+        request_id
+      end
+    end # Network
+  end # WebDriver
+end # Selenium

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

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

@@ -113,6 +113,7 @@ module Selenium
       def stop_server
         connect_to_server do |http|
           headers = WebDriver::Remote::Http::Common::DEFAULT_HEADERS.dup
+          WebDriver.logger.debug('Sending shutdown request to server', id: :driver_service)
           http.get('/shutdown', headers)
         end
       end

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

@@ -50,6 +50,7 @@ module Selenium
       # @param type either :tab or :window
       #
 
+      # steep:ignore:start
       def new_window(type = :window)
         raise ArgumentError, "Valid types are :tab and :window, received: #{type.inspect}" unless %i[window
                                                                                                      tab].include?(type)
@@ -70,6 +71,7 @@ module Selenium
           window(handle)
         end
       end
+      # steep:ignore:end
 
       #
       # switch to the given window handle

data/lib/selenium/webdriver/common.rb

@@ -102,3 +102,4 @@ require 'selenium/webdriver/common/child_process'
 require 'selenium/webdriver/common/script'
 require 'selenium/webdriver/common/fedcm/account'
 require 'selenium/webdriver/common/fedcm/dialog'
+require 'selenium/webdriver/common/network'

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

@@ -29,6 +29,22 @@ module Selenium
           @bidi = Selenium::WebDriver::BiDi.new(url: socket_url)
         end
 
+        def get(url)
+          browsing_context.navigate(url)
+        end
+
+        def go_back
+          browsing_context.traverse_history(-1)
+        end
+
+        def go_forward
+          browsing_context.traverse_history(1)
+        end
+
+        def refresh
+          browsing_context.reload
+        end
+
         def quit
           super
         ensure
@@ -38,6 +54,12 @@ module Selenium
         def close
           execute(:close_window).tap { |handles| bidi.close if handles.empty? }
         end
+
+        private
+
+        def browsing_context
+          @browsing_context ||= WebDriver::BiDi::BrowsingContext.new(self)
+        end
       end # BiDiBridge
     end # Remote
   end # WebDriver

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, &block)
+          def add_command(name, verb, url, &)
             @extra_commands ||= {}
             @extra_commands[name] = [verb, url]
-            define_method(name, &block)
+            define_method(name, &)
           end
 
           def locator_converter
@@ -686,7 +686,7 @@ module Selenium
         end
 
         def escaper
-          @escaper ||= defined?(URI::Parser) ? URI::DEFAULT_PARSER : URI
+          @escaper ||= defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER
         end
 
         def commands(command)

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

@@ -48,6 +48,7 @@ module Selenium
             # hook for subclasses - will be called on Driver#quit
           end
 
+          # steep:ignore:start
           def call(verb, url, command_hash)
             url      = server_url.merge(url) unless url.is_a?(URI)
             headers  = common_headers.dup
@@ -66,6 +67,7 @@ module Selenium
 
             request verb, url, headers, payload
           end
+          # steep:ignore:end
 
           private
 

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

@@ -37,8 +37,8 @@ module Selenium
           @messages = {}
         end
 
-        def add_condition(name, condition = nil, &blk)
-          @guard_conditions << GuardCondition.new(name, condition, &blk)
+        def add_condition(name, condition = nil, &)
+          @guard_conditions << GuardCondition.new(name, condition, &)
         end
 
         def add_message(name, message)

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.26.0'
+    VERSION = '4.28.0'
   end # WebDriver
 end # Selenium

data/selenium-webdriver.gemspec

@@ -22,13 +22,15 @@ 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'
+    'rubygems_mfa_required' => 'true',
+    'funding_uri' => 'https://github.com/sponsors/SeleniumHQ'
   }
 
   s.required_rubygems_version = Gem::Requirement.new('> 1.3.1') if s.respond_to? :required_rubygems_version=
-  s.required_ruby_version = Gem::Requirement.new('>= 3.0')
+  s.required_ruby_version = Gem::Requirement.new('>= 3.1')
 
   s.files = [
     'CHANGES',

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: selenium-webdriver
 version: !ruby/object:Gem::Version
-  version: 4.26.0
+  version: 4.28.0
 platform: ruby
 authors:
 - Alex Rodionov
 - Titus Fortner
 - Thomas Walpole
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -290,7 +290,6 @@ files:
 - lib/selenium/webdriver/atoms/mutationListener.js
 - lib/selenium/webdriver/bidi.rb
 - lib/selenium/webdriver/bidi/browsing_context.rb
-- lib/selenium/webdriver/bidi/browsing_context_info.rb
 - lib/selenium/webdriver/bidi/log/base_log_entry.rb
 - lib/selenium/webdriver/bidi/log/console_log_entry.rb
 - lib/selenium/webdriver/bidi/log/filter_by.rb
@@ -298,7 +297,7 @@ files:
 - lib/selenium/webdriver/bidi/log/javascript_log_entry.rb
 - lib/selenium/webdriver/bidi/log_handler.rb
 - lib/selenium/webdriver/bidi/log_inspector.rb
-- lib/selenium/webdriver/bidi/navigate_result.rb
+- lib/selenium/webdriver/bidi/network.rb
 - lib/selenium/webdriver/bidi/session.rb
 - lib/selenium/webdriver/bidi/struct.rb
 - lib/selenium/webdriver/chrome.rb
@@ -376,6 +375,7 @@ files:
 - lib/selenium/webdriver/common/logs.rb
 - lib/selenium/webdriver/common/manager.rb
 - lib/selenium/webdriver/common/navigation.rb
+- lib/selenium/webdriver/common/network.rb
 - lib/selenium/webdriver/common/options.rb
 - lib/selenium/webdriver/common/platform.rb
 - lib/selenium/webdriver/common/port_prober.rb
@@ -463,10 +463,12 @@ licenses:
 - Apache-2.0
 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'
-post_install_message: 
+  funding_uri: https://github.com/sponsors/SeleniumHQ
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -474,15 +476,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Selenium is a browser automation tool for automated testing of webapps and
   more

data/lib/selenium/webdriver/bidi/browsing_context_info.rb

@@ -1,35 +0,0 @@
-# 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 BiDi
-      class BrowsingContextInfo
-        attr_accessor :id, :url, :children, :parent_browsing_context
-
-        def initialize(id:, url:, children:, parent_context:)
-          @id = id
-          @url = url
-          @children = children
-          @parent_browsing_context = parent_context
-        end
-      end # BrowsingContextInfo
-    end # BiDi
-  end # WebDriver
-end # Selenium

data/lib/selenium/webdriver/bidi/navigate_result.rb

@@ -1,33 +0,0 @@
-# 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 BiDi
-      class NavigateResult
-        attr_accessor :url, :navigation_id
-
-        def initialize(url:, navigation_id:)
-          @url = url
-          @navigation_id = navigation_id
-        end
-      end # NavigateResult
-    end # BiDi
-  end # WebDriver
-end # Selenium