selenium-webdriver 4.1.0 → 4.28.0

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

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasNetworkInterception
-
         #
         # Intercepts requests coming from browser allowing
         # to either pass them through like proxy or provide
@@ -60,75 +59,16 @@ module Selenium
         # @yieldparam [Proc] continue block which proceeds with the request and optionally yields response
         #
 
-        def intercept(&block)
-          devtools.network.set_cache_disabled(cache_disabled: true)
-          devtools.fetch.on(:request_paused) do |params|
-            id = params['requestId']
-            if params.key?('responseStatusCode') || params.key?('responseErrorReason')
-              intercept_response(id, params, &pending_response_requests.delete(id))
-            else
-              intercept_request(id, params, &block)
-            end
-          end
-          devtools.fetch.enable(patterns: [{requestStage: 'Request'}, {requestStage: 'Response'}])
-        end
-
-        private
-
-        def pending_response_requests
-          @pending_response_requests ||= {}
-        end
-
-        def intercept_request(id, params, &block)
-          original = DevTools::Request.from(id, params)
-          mutable = DevTools::Request.from(id, params)
-
-          block.call(mutable) do |&continue| # rubocop:disable Performance/RedundantBlockCall
-            pending_response_requests[id] = continue
-
-            if original == mutable
-              devtools.fetch.continue_request(request_id: id)
-            else
-              devtools.fetch.continue_request(
-                request_id: id,
-                url: mutable.url,
-                method: mutable.method,
-                post_data: mutable.post_data,
-                headers: mutable.headers.map do |k, v|
-                  {name: k, value: v}
-                end
-              )
-            end
-          end
-        end
-
-        def intercept_response(id, params)
-          return devtools.fetch.continue_request(request_id: id) unless block_given?
-
-          body = fetch_response_body(id)
-          original = DevTools::Response.from(id, body, params)
-          mutable = DevTools::Response.from(id, body, params)
-          yield mutable
-
-          if original == mutable
-            devtools.fetch.continue_request(request_id: id)
-          else
-            devtools.fetch.fulfill_request(
-              request_id: id,
-              body: (Base64.strict_encode64(mutable.body) if mutable.body),
-              response_code: mutable.code,
-              response_headers: mutable.headers.map do |k, v|
-                {name: k, value: v}
-              end
+        def intercept(&)
+          if browser == :firefox
+            WebDriver.logger.deprecate(
+              'Driver#intercept on Firefox',
+              'the new bidi.network.add_intercept method',
+              id: :intercept
             )
           end
-        end
-
-        def fetch_response_body(id)
-          devtools.fetch.get_response_body(request_id: id).dig('result', 'body')
-        rescue Error::WebDriverError
-          # CDP fails to get body on certain responses (301) and raises:
-          # Can only get response body on requests captured after headers received.
+          @interceptor ||= DevTools::NetworkInterceptor.new(devtools)
+          @interceptor.intercept(&)
         end
       end # HasNetworkInterception
     end # DriverExtensions

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

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasPermissions
-
         #
         # Set one permission.
         #
@@ -44,7 +43,6 @@ module Selenium
             @bridge.set_permission(key, value)
           end
         end
-
       end # HasPermissions
     end # DriverExtensions
   end # WebDriver

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

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasPinnedScripts
-
         #
         # Returns the list of all pinned scripts.
         #
@@ -62,7 +61,7 @@ module Selenium
         #
         # Unpins script making it undefined for the subsequent calls.
         #
-        # @param [DevTools::PinnedScript]
+        # @param [DevTools::PinnedScript] script
         #
 
         def unpin_script(script)
@@ -70,7 +69,6 @@ module Selenium
           devtools.page.remove_script_to_evaluate_on_new_document(identifier: script.devtools_identifier)
           pinned_scripts.delete(script)
         end
-
       end # HasPinnedScripts
     end # DriverExtensions
   end # WebDriver

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

@@ -0,0 +1,97 @@
+# 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 DriverFinder
+      def self.path(options, service_class)
+        WebDriver.logger.deprecate('DriverFinder.path(options, service_class)',
+                                   'DriverFinder.new(options, service).driver_path')
+        new(options, service_class.new).driver_path
+      end
+
+      def initialize(options, service)
+        @options = options
+        @service = service
+      end
+
+      def browser_path
+        paths[:browser_path]
+      end
+
+      def driver_path
+        paths[:driver_path]
+      end
+
+      def browser_path?
+        !browser_path.nil? && !browser_path.empty?
+      end
+
+      private
+
+      def paths
+        @paths ||= begin
+          path = @service.class.driver_path
+          path = path.call if path.is_a?(Proc)
+          exe = @service.class::EXECUTABLE
+          if path
+            WebDriver.logger.debug("Skipping Selenium Manager; path to #{exe} specified in service class: #{path}")
+            Platform.assert_executable(path)
+            {driver_path: path}
+          else
+            output = SeleniumManager.binary_paths(*to_args)
+            formatted = {driver_path: Platform.cygwin_path(output['driver_path'], only_cygwin: true),
+                         browser_path: Platform.cygwin_path(output['browser_path'], only_cygwin: true)}
+            Platform.assert_executable(formatted[:driver_path])
+
+            browser_path = formatted[:browser_path]
+            Platform.assert_executable(browser_path)
+            if @options.respond_to?(:binary) && @options.binary.nil?
+              @options.binary = browser_path
+              @options.browser_version = nil
+            end
+
+            formatted
+          end
+        rescue StandardError => e
+          WebDriver.logger.error("Exception occurred: #{e.message}")
+          WebDriver.logger.error("Backtrace:\n\t#{e.backtrace&.join("\n\t")}")
+          raise Error::NoSuchDriverError, "Unable to obtain #{exe}"
+        end
+      end
+
+      def to_args
+        args = ['--browser', @options.browser_name]
+        if @options.browser_version
+          args << '--browser-version'
+          args << @options.browser_version
+        end
+        if @options.respond_to?(:binary) && !@options.binary.nil?
+          args << '--browser-path'
+          args << @options.binary.gsub('\\', '\\\\\\')
+        end
+        if @options.proxy
+          args << '--proxy'
+          args << (@options.proxy.ssl || @options.proxy.http)
+        end
+        args
+      end
+    end
+  end
+end

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

@@ -43,10 +43,10 @@ module Selenium
       def ==(other)
         other.is_a?(self.class) && ref == other.ref
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       def hash
-        @id.hash ^ @bridge.hash
+        [@id, @bridge].hash
       end
 
       #
@@ -101,7 +101,7 @@ module Selenium
       # if it exists. If it does not, then the value of the attribute with the given name is returned.
       # If neither exists, null is returned.
       #
-      # The "style" attribute is converted as best can be to a text representation with a trailing semi-colon.
+      # The "style" attribute is converted as best can be to a text representation with a trailing semicolon.
       #
       # The following are deemed to be "boolean" attributes, and will return either "true" or "false":
       #
@@ -207,7 +207,7 @@ module Selenium
       def send_keys(*args)
         bridge.send_keys_to_element @id, Keys.encode(args)
       end
-      alias_method :send_key, :send_keys
+      alias send_key send_keys
 
       #
       # If this element is a text entry element, this will clear the value. Has no effect on other
@@ -275,7 +275,7 @@ module Selenium
       def css_value(prop)
         bridge.element_value_of_css_property @id, prop
       end
-      alias_method :style, :css_value
+      alias style css_value
 
       #
       # Get the location of this element.
@@ -333,18 +333,18 @@ module Selenium
       #   element.first(id: 'foo')
       #
 
-      alias_method :first, :find_element
+      alias first find_element
 
       #
       #   element.all(class: 'bar')
       #
 
-      alias_method :all, :find_elements
+      alias all find_elements
 
       #
       #   element['class'] or element[:class] #=> "someclass"
       #
-      alias_method :[], :attribute
+      alias [] attribute
 
       #
       # @api private

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Error
-
       #
       # Returns exception from its string representation.
       # @param [String, nil] error
@@ -29,13 +28,34 @@ module Selenium
       def self.for_error(error)
         return if error.nil?
 
-        klass_name = error.split(' ').map(&:capitalize).join.sub(/Error$/, '')
-        const_get("#{klass_name}Error", false)
+        klass_name = error.split.map(&:capitalize).join.sub(/Error$/, '')
+        const_get(:"#{klass_name}Error", false)
       rescue NameError
         WebDriverError
       end
 
-      class WebDriverError < StandardError; end
+      SUPPORT_MSG = 'For documentation on this error, please visit:'
+      ERROR_URL = 'https://www.selenium.dev/documentation/webdriver/troubleshooting/errors'
+
+      URLS = {
+        NoSuchElementError: "#{ERROR_URL}#no-such-element-exception",
+        StaleElementReferenceError: "#{ERROR_URL}#stale-element-reference-exception",
+        InvalidSelectorError: "#{ERROR_URL}#invalid-selector-exception",
+        NoSuchDriverError: "#{ERROR_URL}/driver_location"
+      }.freeze
+
+      class WebDriverError < StandardError
+        def initialize(msg = '')
+          # Remove this conditional when all the error pages have been documented
+          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
+        end
+        # steep:ignore:end
+      end
 
       #
       # An element could not be located on the page using the given search parameters.
@@ -214,6 +234,11 @@ module Selenium
 
       class UnsupportedOperationError < WebDriverError; end
 
+      #
+      # Indicates that driver was not specified and could not be located.
+      #
+
+      class NoSuchDriverError < WebDriverError; end
     end # Error
   end # WebDriver
 end # Selenium

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

@@ -0,0 +1,49 @@
+# 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
+    module FedCM
+      # Represents an account displayed in a FedCm account list.
+      # See: https://w3c-fedid.github.io/FedCM/#dictdef-identityprovideraccount
+      #      https://w3c-fedid.github.io/FedCM/#webdriver-accountlist
+      class Account
+        LOGIN_STATE_SIGNIN = 'SignIn'
+        LOGIN_STATE_SIGNUP = 'SignUp'
+
+        attr_reader :account_id, :email, :name, :given_name, :picture_url,
+                    :idp_config_url, :login_state, :terms_of_service_url, :privacy_policy_url
+
+        # steep:ignore:start
+        def initialize(**args)
+          @account_id = args['accountId']
+          @email = args['email']
+          @name = args['name']
+          @given_name = args['givenName']
+          @picture_url = args['pictureUrl']
+          @idp_config_url = args['idpConfigUrl']
+          @login_state = args['loginState']
+          @terms_of_service_url = args['termsOfServiceUrl']
+          @privacy_policy_url = args['privacyPolicyUrl']
+        end
+        # steep:ignore:end
+      end # Account
+    end # FedCM
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,74 @@
+# 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
+    module FedCM
+      class Dialog
+        def initialize(bridge)
+          @bridge = bridge
+        end
+
+        DIALOG_TYPE_ACCOUNT_LIST = 'AccountChooser'
+        DIALOG_TYPE_AUTO_REAUTH = 'AutoReauthn'
+
+        # Closes the dialog as if the user had clicked X.
+        def click
+          @bridge.click_fedcm_dialog_button
+        end
+
+        # Closes the dialog as if the user had clicked X.
+        def cancel
+          @bridge.cancel_fedcm_dialog
+        end
+
+        # Selects an account as if the user had clicked on it.
+        #
+        # @param [Integer] index The index of the account to select from the list returned by get_accounts.
+        def select_account(index)
+          @bridge.select_fedcm_account index
+        end
+
+        # Returns the type of the open dialog.
+        #
+        # One of DIALOG_TYPE_ACCOUNT_LIST and DIALOG_TYPE_AUTO_REAUTH.
+        def type
+          @bridge.fedcm_dialog_type
+        end
+
+        # Returns the title of the dialog.
+        def title
+          @bridge.fedcm_title
+        end
+
+        # Returns the subtitle of the dialog or nil if none.
+        def subtitle
+          @bridge.fedcm_subtitle
+        end
+
+        # Returns the accounts shown in the account chooser.
+        #
+        # If this is an auto reauth dialog, returns the single account that is being signed in.
+        def accounts
+          @bridge.fedcm_account_list.map { |account| Account.new(**account) }
+        end
+      end # Dialog
+    end # FedCM
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,27 @@
+# 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
+    module FedCM
+      autoload :Account, 'fedcm/account'
+      autoload :Dialog, 'fedcm/dialog'
+    end # FedCM
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/html5/shared_web_storage.rb

@@ -26,8 +26,8 @@ module Selenium
         def key?(key)
           keys.include? key
         end
-        alias_method :member?, :key?
-        alias_method :has_key?, :key?
+        alias member? key?
+        alias has_key? key?
 
         def fetch(key)
           return self[key] if key? key

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

@@ -22,8 +22,15 @@ require 'securerandom'
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Superclass for the input device sources
+      # Manages Array of Interaction instances for the device
+      #
+      # @api private
+      #
+
       class InputDevice
-        attr_reader :name, :actions
+        attr_reader :name, :actions, :type
 
         def initialize(name = nil)
           @name = name || SecureRandom.uuid
@@ -44,9 +51,8 @@ module Selenium
           add_action(Pause.new(self, duration))
         end
 
-        def no_actions? # Determine if only pauses are present
-          actions = @actions.reject { |action| action.type == Interaction::PAUSE }
-          actions.empty?
+        def encode
+          {type: type, id: name, actions: @actions.map(&:encode)} unless @actions.empty?
         end
       end # InputDevice
     end # Interactions

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

@@ -20,37 +20,24 @@
 module Selenium
   module WebDriver
     module Interactions
-      class Interaction
-        PAUSE = :pause
+      #
+      # Superclass for classes defining actions
+      # Do not initialize directly, only use subclass
+      #
+      # @api private
+      #
 
-        attr_reader :source
+      class Interaction
+        attr_reader :type
 
         def initialize(source)
-          unless Interactions::SOURCE_TYPES.include? source.type
-            raise TypeError,
-                  "#{source.type} is not a valid input type"
-          end
-
-          @source = source
+          assert_source(source)
         end
-      end
 
-      class Pause < Interaction
-        def initialize(source, duration = nil)
-          super(source)
-          @duration = duration
+        def assert_source(_source)
+          raise NotImplementedError, 'subclass responsibility'
         end
-
-        def type
-          PAUSE
-        end
-
-        def encode
-          output = {type: type}
-          output[:duration] = (@duration * 1000).to_i if @duration
-          output
-        end
-      end # Interaction
+      end
     end # Interactions
   end # WebDriver
 end # Selenium

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

@@ -23,20 +23,40 @@ module Selenium
       KEY = :key
       POINTER = :pointer
       NONE = :none
-      SOURCE_TYPES = [KEY, POINTER, NONE].freeze
+      WHEEL = :wheel
+
+      #
+      # Class methods for initializing known Input devices
+      #
 
       class << self
-        def key(name)
+        def key(name = nil)
           KeyInput.new(name)
         end
 
-        def pointer(kind, **kwargs)
-          PointerInput.new(kind, **kwargs)
+        def pointer(kind = :mouse, name: nil)
+          PointerInput.new(kind, name: name)
+        end
+
+        def mouse(name: nil)
+          pointer(name: name)
+        end
+
+        def pen(name: nil)
+          pointer(:pen, name: name)
+        end
+
+        def touch(name: nil)
+          pointer(:touch, name: name)
         end
 
         def none(name = nil)
           NoneInput.new(name)
         end
+
+        def wheel(name = nil)
+          WheelInput.new(name)
+        end
       end
     end # Interactions
   end # WebDriver

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

@@ -134,12 +134,16 @@ module Selenium
       #
 
       def key_action(*args, action: nil, device: nil)
-        key_input = get_device(device) || key_inputs.first
+        key_input = key_input(device)
         click(args.shift) if args.first.is_a? Element
         key_input.send(action, args.last)
         tick(key_input)
         self
       end
+
+      def key_input(name = nil)
+        device(name: name, type: Interactions::KEY) || add_key_input('keyboard')
+      end
     end # KeyActions
   end # WebDriver
 end # Selenium