selenium-webdriver 4.12.0 → 4.23.0

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

@@ -43,7 +43,7 @@ module Selenium
 
         def for(browser, opts = {})
           case browser
-          when :chrome
+          when :chrome, :chrome_headless_shell
             Chrome::Driver.new(**opts)
           when :internet_explorer, :ie
             IE::Driver.new(**opts)
@@ -70,10 +70,9 @@ module Selenium
 
       def initialize(bridge: nil, listener: nil, **opts)
         @devtools = nil
-        @bidi = nil
         bridge ||= create_bridge(**opts)
-        add_extensions(bridge.browser)
         @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
+        add_extensions(@bridge.browser)
       end
 
       def inspect
@@ -100,6 +99,22 @@ module Selenium
         @navigate ||= WebDriver::Navigation.new(bridge)
       end
 
+      #
+      # @return [Script]
+      # @see Script
+      #
+
+      def script(*args)
+        if args.any?
+          WebDriver.logger.deprecate('`Driver#script` as an alias for `#execute_script`',
+                                     '`Driver#execute_script`',
+                                     id: :driver_script)
+          execute_script(*args)
+        else
+          @script ||= WebDriver::Script.new(bridge)
+        end
+      end
+
       #
       # @return [TargetLocator]
       # @see TargetLocator
@@ -174,7 +189,6 @@ module Selenium
       ensure
         @service_manager&.stop
         @devtools&.close
-        @bidi&.close
       end
 
       #
@@ -182,10 +196,7 @@ module Selenium
       #
 
       def close
-        # If no top-level browsing contexts are open after calling close,
-        # it indicates that the WebDriver session is closed.
-        # If the WebDriver session is closed, the BiDi session also needs to be closed.
-        bridge.close.tap { |handles| @bidi&.close if handles&.empty? }
+        bridge&.close
       end
 
       #
@@ -267,12 +278,6 @@ module Selenium
 
       alias all find_elements
 
-      #
-      #   driver.script('function() { ... };')
-      #
-
-      alias script execute_script
-
       # Get the first element matching the given selector. If given a
       # String or Symbol, it will be used as the id of the element.
       #
@@ -292,7 +297,7 @@ module Selenium
       end
 
       def browser
-        bridge&.browser
+        bridge.browser
       end
 
       def capabilities
@@ -313,7 +318,8 @@ module Selenium
       attr_reader :bridge
 
       def create_bridge(caps:, url:, http_client: nil)
-        Remote::Bridge.new(http_client: http_client, url: url).tap do |bridge|
+        klass = caps['webSocketUrl'] ? Remote::BiDiBridge : Remote::Bridge
+        klass.new(http_client: http_client, url: url).tap do |bridge|
           bridge.create_session(caps)
         end
       end
@@ -329,7 +335,7 @@ module Selenium
 
       def add_extensions(browser)
         extensions = case browser
-                     when :chrome, :msedge
+                     when :chrome, :chrome_headless_shell, :msedge, :microsoftedge
                        Chromium::Driver::EXTENSIONS
                      when :firefox
                        Firefox::Driver::EXTENSIONS

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

@@ -28,7 +28,7 @@ module Selenium
         #
 
         def bidi
-          @bidi ||= Selenium::WebDriver::BiDi.new(url: capabilities[:web_socket_url])
+          @bridge.bidi
         end
       end # HasBiDi
     end # DriverExtensions

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

@@ -0,0 +1,55 @@
+# 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 DriverExtensions
+      module HasFedCmDialog
+        # Disables the promise rejection delay for FedCm.
+        #
+        # FedCm by default delays promise resolution in failure cases for privacy reasons.
+        # This method allows turning it off to let tests run faster where this is not relevant.
+        def enable_fedcm_delay=(enable)
+          @bridge.fedcm_delay(enable)
+        end
+
+        # Resets the FedCm dialog cooldown.
+        #
+        # If a user agent triggers a cooldown when the account chooser is dismissed,
+        # this method resets that cooldown so that the dialog can be triggered again immediately.
+        def reset_fedcm_cooldown
+          @bridge.reset_fedcm_cooldown
+        end
+
+        def fedcm_dialog
+          @fedcm_dialog ||= FedCM::Dialog.new(@bridge)
+        end
+
+        def wait_for_fedcm_dialog(timeout: 5, interval: 0.2, message: nil, ignore: nil)
+          wait = Wait.new(timeout: timeout, interval: interval, message: message, ignore: ignore)
+          wait.until do
+            fedcm_dialog if fedcm_dialog.type
+          rescue Error::NoSuchAlertError
+            nil
+          end
+        end
+      end # HasFedCmDialog
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,65 @@
+# 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 DriverExtensions
+      module HasFileDownloads
+        def downloadable_files
+          verify_enabled
+
+          @bridge.downloadable_files['names']
+        end
+
+        def download_file(file_name, target_directory)
+          verify_enabled
+
+          response = @bridge.download_file(file_name)
+          contents = response['contents']
+
+          File.open("#{file_name}.zip", 'wb') { |f| f << Base64.decode64(contents) }
+          target_directory += '/' unless target_directory.end_with?('/')
+          FileUtils.mkdir_p(target_directory)
+
+          begin
+            Zip::File.open("#{file_name}.zip") do |zip|
+              zip.each { |entry| zip.extract(entry, "#{target_directory}#{file_name}") }
+            end
+          ensure
+            FileUtils.rm_f("#{file_name}.zip")
+          end
+        end
+
+        def delete_downloadable_files
+          verify_enabled
+
+          @bridge.delete_downloadable_files
+        end
+
+        private
+
+        def verify_enabled
+          return if capabilities['se:downloadsEnabled']
+
+          raise Error::WebDriverError, 'You must enable downloads in order to work with downloadable files.'
+        end
+      end # HasFileDownloads
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

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

@@ -64,7 +64,7 @@ module Selenium
           return if enabled
 
           devtools.runtime.enable
-          __send__("log_#{kind}_events")
+          __send__(:"log_#{kind}_events")
         end
 
         private

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

@@ -20,25 +20,77 @@
 module Selenium
   module WebDriver
     class DriverFinder
-      def self.path(options, klass)
-        path = klass.driver_path
-        path = path.call if path.is_a?(Proc)
+      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
 
-        path ||= begin
-          SeleniumManager.driver_path(options) unless options.is_a?(Remote::Capabilities)
+            formatted
+          end
         rescue StandardError => e
-          raise Error::NoSuchDriverError, "Unable to obtain #{klass::EXECUTABLE} using Selenium Manager; #{e.message}"
+          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
 
-        begin
-          Platform.assert_executable(path)
-        rescue TypeError
-          raise Error::NoSuchDriverError, "Unable to locate or obtain #{klass::EXECUTABLE}"
-        rescue Error::WebDriverError => e
-          raise Error::NoSuchDriverError, "#{klass::EXECUTABLE} located, but: #{e.message}"
+      def to_args
+        args = ['--browser', @options.browser_name]
+        if @options.browser_version
+          args << '--browser-version'
+          args << @options.browser_version
         end
-
-        path
+        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

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

@@ -29,7 +29,7 @@ module Selenium
         return if error.nil?
 
         klass_name = error.split.map(&:capitalize).join.sub(/Error$/, '')
-        const_get("#{klass_name}Error", false)
+        const_get(:"#{klass_name}Error", false)
       rescue NameError
         WebDriverError
       end
@@ -37,17 +37,29 @@ module Selenium
       SUPPORT_MSG = 'For documentation on this error, please visit:'
       ERROR_URL = 'https://www.selenium.dev/documentation/webdriver/troubleshooting/errors'
 
-      class WebDriverError < StandardError; end
+      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
+
+        def class_name
+          self.class.name&.split('::')&.last&.to_sym
+        end
+      end
 
       #
       # An element could not be located on the page using the given search parameters.
       #
 
-      class NoSuchElementError < WebDriverError
-        def initialize(msg = '')
-          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}#no-such-element-exception")
-        end
-      end
+      class NoSuchElementError < WebDriverError; end
 
       #
       # A command to switch to a frame could not be satisfied because the frame could not be found.
@@ -65,11 +77,7 @@ module Selenium
       # A command failed because the referenced element is no longer attached to the DOM.
       #
 
-      class StaleElementReferenceError < WebDriverError
-        def initialize(msg = '')
-          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}#stale-element-reference-exception")
-        end
-      end
+      class StaleElementReferenceError < WebDriverError; end
 
       #
       # A command failed because the referenced shadow root is no longer attached to the DOM.
@@ -143,11 +151,7 @@ module Selenium
       # Argument was an invalid selector.
       #
 
-      class InvalidSelectorError < WebDriverError
-        def initialize(msg = '')
-          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}#invalid-selector-exception")
-        end
-      end
+      class InvalidSelectorError < WebDriverError; end
 
       #
       # A new session could not be created.
@@ -232,11 +236,7 @@ module Selenium
       # Indicates that driver was not specified and could not be located.
       #
 
-      class NoSuchDriverError < WebDriverError
-        def initialize(msg = '')
-          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}/driver_location")
-        end
-      end
+      class NoSuchDriverError < WebDriverError; end
     end # Error
   end # WebDriver
 end # Selenium

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

@@ -0,0 +1,50 @@
+# 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://fedidcg.github.io/FedCM/#dictdef-identityprovideraccount
+      #      https://fedidcg.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
+
+        # Initializes a new account with the provided attributes.
+        #
+        # @param [Hash]
+        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
+      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/interactions/pointer_actions.rb

@@ -91,7 +91,6 @@ module Selenium
       #   element. A negative value means coordinates to the left of the center.
       # @param [Integer] down_by Optional offset from the in-view center of the
       #   element. A negative value means coordinates to the top of the center.
-      # @param [Symbol || String] device optional name of the PointerInput device to move.
       # @return [ActionBuilder] A self reference.
       #
 

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

@@ -28,7 +28,7 @@ module Selenium
 
       class PointerCancel < Interaction
         def initialize(source)
-          super(source)
+          super
           @type = :pointerCancel
         end
 

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

@@ -38,7 +38,8 @@ module Selenium
       #    el = driver.find_element(id: "some_id")
       #    driver.action.scroll_to(element).perform
       #
-      # @param [Object] Which element to scroll into the viewport.
+      # @param [Object] element Which element to scroll into the viewport.
+      # @param [Object] device Which device to use to scroll
       # @return [Selenium::WebDriver::WheelActions] A self reference.
       def scroll_to(element, device: nil)
         scroll(origin: element, device: device)

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

@@ -28,7 +28,7 @@ module Selenium
 
       class WheelInput < InputDevice
         def initialize(name = nil)
-          super(name)
+          super
           @type = Interactions::WHEEL
         end
 

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

@@ -38,7 +38,14 @@ module Selenium
           raise ArgumentError, ":options must be an instance of #{default_options.class}"
         end
 
-        service.executable_path ||= WebDriver::DriverFinder.path(options, service.class)
+        service.executable_path ||= begin
+          finder = WebDriver::DriverFinder.new(options, service)
+          if options.respond_to?(:binary) && finder.browser_path?
+            options.binary = finder.browser_path
+            options.browser_version = nil
+          end
+          finder.driver_path
+        end
         options.as_json
       end
     end