selenium-webdriver 4.1.0 → 4.9.0

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Firefox
-
       #
       # Driver implementation for Firefox using GeckoDriver.
       # @api private
@@ -30,12 +29,20 @@ module Selenium
         EXTENSIONS = [DriverExtensions::HasAddons,
                       DriverExtensions::FullPageScreenshot,
                       DriverExtensions::HasContext,
+                      DriverExtensions::HasBiDi,
                       DriverExtensions::HasDevTools,
                       DriverExtensions::HasLogEvents,
                       DriverExtensions::HasNetworkInterception,
                       DriverExtensions::HasWebStorage,
                       DriverExtensions::PrintsPage].freeze
 
+        include LocalDriver
+
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(capabilities, options, service, url)
+          super(caps: caps, url: url, **opts)
+        end
+
         def browser
           :firefox
         end
@@ -44,7 +51,7 @@ module Selenium
 
         def devtools_url
           if capabilities['moz:debuggerAddress'].nil?
-            raise(Error::WebDriverError, "DevTools is not supported by this version of Firefox; use v85 or higher")
+            raise(Error::WebDriverError, 'DevTools is not supported by this version of Firefox; use v85 or higher')
           end
 
           uri = URI("http://#{capabilities['moz:debuggerAddress']}")

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

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module Firefox
       module Features
-
         FIREFOX_COMMANDS = {
           get_context: [:get, 'session/:session_id/moz/context'],
           set_context: [:post, 'session/:session_id/moz/context'],
@@ -35,12 +34,13 @@ module Selenium
         end
 
         def install_addon(path, temporary)
-          if @file_detector
-            local_file = @file_detector.call(path)
-            path = upload(local_file) if local_file
-          end
+          addon = if File.directory?(path)
+                    Zipper.zip(path)
+                  else
+                    File.open(path, 'rb') { |crx_file| Base64.strict_encode64 crx_file.read }
+                  end
 
-          payload = {path: path}
+          payload = {addon: addon}
           payload[:temporary] = temporary unless temporary.nil?
           execute :install_addon, {}, payload
         end

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

@@ -25,11 +25,12 @@ module Selenium
 
         KEY = 'moz:firefoxOptions'
 
-        # see: https://firefox-source-docs.mozilla.org/testing/geckodriver/Capabilities.html
+        # see: https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions
         CAPABILITIES = {binary: 'binary',
                         args: 'args',
                         log: 'log',
                         prefs: 'prefs',
+                        env: 'env',
                         android_package: 'androidPackage',
                         android_activity: 'androidActivity',
                         android_device_serial: 'androidDeviceSerial',
@@ -56,12 +57,14 @@ module Selenium
         #
 
         def initialize(log_level: nil, **opts)
-          @debugger_address = opts.delete(:debugger_address)
+          @debugger_address = opts.delete(:debugger_address) { true }
+          opts[:accept_insecure_certs] = true unless opts.key?(:accept_insecure_certs)
 
           super(**opts)
 
           @options[:args] ||= []
           @options[:prefs] ||= {}
+          @options[:env] ||= {}
           @options[:log] ||= {level: log_level} if log_level
 
           process_profile(@options.delete(:profile))
@@ -105,6 +108,9 @@ module Selenium
         #
 
         def headless!
+          WebDriver.logger.deprecate('`Options#headless!`',
+                                     "`Options#add_argument('-headless')`",
+                                     id: :headless)
           add_argument '-headless'
         end
 
@@ -175,7 +181,7 @@ module Selenium
         end
 
         def camelize?(key)
-          key != "prefs"
+          key != 'prefs'
         end
       end # Options
     end # Firefox

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

@@ -26,11 +26,11 @@ module Selenium
         VALID_PREFERENCE_TYPES = [TrueClass, FalseClass, Integer, Float, String].freeze
 
         DEFAULT_PREFERENCES = {
-          "browser.newtabpage.enabled" => false,
-          "browser.startup.homepage" => "about:blank",
-          "browser.usedOnWindows10.introURL" => "about:blank",
-          "network.captive-portal-service.enabled" => false,
-          "security.csp.enable" => false
+          'browser.newtabpage.enabled' => false,
+          'browser.startup.homepage' => 'about:blank',
+          'browser.usedOnWindows10.introURL' => 'about:blank',
+          'network.captive-portal-service.enabled' => false,
+          'security.csp.enable' => false
         }.freeze
 
         attr_reader   :name, :log_file
@@ -96,7 +96,7 @@ module Selenium
             raise TypeError, "expected one of #{VALID_PREFERENCE_TYPES.inspect}, got #{value.inspect}:#{value.class}"
           end
 
-          if value.is_a?(String) && stringified?(value)
+          if value.is_a?(String) && Util.stringified?(value)
             raise ArgumentError, "preference values must be plain strings: #{key.inspect} => #{value.inspect}"
           end
 
@@ -143,7 +143,7 @@ module Selenium
           end
         end
 
-        alias_method :as_json, :encoded
+        alias as_json encoded
 
         private
 
@@ -221,10 +221,6 @@ module Selenium
             end
           end
         end
-
-        def stringified?(str)
-          /^".*"$/.match?(str)
-        end
       end # Profile
     end # Firefox
   end # WebDriver

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

@@ -23,16 +23,10 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT = 4444
         EXECUTABLE = 'geckodriver'
-        MISSING_TEXT = <<~ERROR
-          Unable to find Mozilla geckodriver. Please download the server from
-          https://github.com/mozilla/geckodriver/releases and place it somewhere on your PATH.
-          More info at https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver.
-        ERROR
         SHUTDOWN_SUPPORTED = false
 
         private
 
-        # NOTE: This processing is deprecated
         def extract_service_args(driver_opts)
           driver_args = super
           driver_opts = driver_opts.dup

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

@@ -0,0 +1,46 @@
+# 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 Firefox
+      # @api private
+      module Util
+        module_function
+
+        def app_data_path
+          case Platform.os
+          when :windows
+            "#{ENV.fetch('APPDATA')}\\Mozilla\\Firefox"
+          when :macosx
+            "#{Platform.home}/Library/Application Support/Firefox"
+          when :unix, :linux
+            "#{Platform.home}/.mozilla/firefox"
+          else
+            raise "Unknown os: #{Platform.os}"
+          end
+        end
+
+        def stringified?(str)
+          str =~ /^".*"$/
+        end
+      end # Util
+    end # Firefox
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/firefox.rb

@@ -24,6 +24,7 @@ require 'rexml/document'
 module Selenium
   module WebDriver
     module Firefox
+      autoload :Util, 'selenium/webdriver/firefox/util'
       autoload :Extension, 'selenium/webdriver/firefox/extension'
       autoload :ProfilesIni, 'selenium/webdriver/firefox/profiles_ini'
       autoload :Profile, 'selenium/webdriver/firefox/profile'
@@ -41,20 +42,6 @@ module Selenium
       # until WebDriver Bidi is available.
       DEVTOOLS_VERSION = 85
 
-      def self.driver_path=(path)
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path=',
-                                   'Selenium::WebDriver::Firefox::Service#driver_path=',
-                                   id: :driver_path
-        Selenium::WebDriver::Firefox::Service.driver_path = path
-      end
-
-      def self.driver_path
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path',
-                                   'Selenium::WebDriver::Firefox::Service#driver_path',
-                                   id: :driver_path
-        Selenium::WebDriver::Firefox::Service.driver_path
-      end
-
       def self.path=(path)
         Platform.assert_executable path
         @path = path

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module IE
-
       #
       # Driver implementation for Internet Explorer supporting
       # both OSS and W3C dialects of JSON wire protocol.
@@ -30,6 +29,13 @@ module Selenium
       class Driver < WebDriver::Driver
         EXTENSIONS = [DriverExtensions::HasWebStorage].freeze
 
+        include LocalDriver
+
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(capabilities, options, service, url)
+          super(caps: caps, url: url, **opts)
+        end
+
         def browser
           :internet_explorer
         end

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

@@ -23,16 +23,10 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT = 5555
         EXECUTABLE = 'IEDriverServer'
-        MISSING_TEXT = <<~ERROR
-          Unable to find IEDriverServer. Please download the server from
-          https://www.selenium.dev/downloads/ and place it somewhere on your PATH.
-          More info at https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver.
-        ERROR
         SHUTDOWN_SUPPORTED = true
 
         private
 
-        # NOTE: This processing is deprecated
         def extract_service_args(driver_opts)
           driver_args = super
           driver_opts = driver_opts.dup
@@ -43,7 +37,7 @@ module Selenium
           end
           driver_args << "--host=#{driver_opts[:host]}" if driver_opts.key?(:host)
           driver_args << "--extract_path=#{driver_opts[:extract_path]}" if driver_opts.key?(:extract_path)
-          driver_args << "--silent" if driver_opts[:silent] == true
+          driver_args << '--silent' if driver_opts[:silent] == true
           driver_args
         end
       end # Server

data/lib/selenium/webdriver/ie.rb

@@ -23,20 +23,6 @@ module Selenium
       autoload :Driver, 'selenium/webdriver/ie/driver'
       autoload :Options, 'selenium/webdriver/ie/options'
       autoload :Service, 'selenium/webdriver/ie/service'
-
-      def self.driver_path=(path)
-        WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path=',
-                                   'Selenium::WebDriver::IE::Service#driver_path=',
-                                   id: :driver_path
-        Selenium::WebDriver::IE::Service.driver_path = path
-      end
-
-      def self.driver_path
-        WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path',
-                                   'Selenium::WebDriver::IE::Service#driver_path',
-                                   id: :driver_path
-        Selenium::WebDriver::IE::Service.driver_path
-      end
     end # IE
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/remote/{commands.rb → bridge/commands.rb}

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Remote
-
       #
       # https://w3c.github.io/webdriver/#endpoints
       # @api private
@@ -60,10 +59,6 @@ module Selenium
           fullscreen_window: [:post, 'session/:session_id/window/fullscreen'],
           minimize_window: [:post, 'session/:session_id/window/minimize'],
           maximize_window: [:post, 'session/:session_id/window/maximize'],
-          set_window_size: [:post, 'session/:session_id/window/size'],
-          get_window_size: [:get, 'session/:session_id/window/size'],
-          set_window_position: [:post, 'session/:session_id/window/position'],
-          get_window_position: [:get, 'session/:session_id/window/position'],
           set_window_rect: [:post, 'session/:session_id/window/rect'],
           get_window_rect: [:get, 'session/:session_id/window/rect'],
           switch_to_frame: [:post, 'session/:session_id/frame'],
@@ -130,7 +125,6 @@ module Selenium
           #
 
           element_click: [:post, 'session/:session_id/element/:id/click'],
-          element_tap: [:post, 'session/:session_id/element/:id/tap'],
           element_clear: [:post, 'session/:session_id/element/:id/clear'],
           element_send_keys: [:post, 'session/:session_id/element/:id/value'],
 
@@ -154,9 +148,22 @@ module Selenium
           # server extensions
           #
 
-          upload_file: [:post, 'session/:session_id/se/file']
-        }.freeze
+          upload_file: [:post, 'session/:session_id/se/file'],
 
+          #
+          # virtual-authenticator
+          #
+
+          add_virtual_authenticator: [:post, 'session/:session_id/webauthn/authenticator'],
+          remove_virtual_authenticator: [:delete, 'session/:session_id/webauthn/authenticator/:authenticatorId'],
+          add_credential: [:post, 'session/:session_id/webauthn/authenticator/:authenticatorId/credential'],
+          get_credentials: [:get, 'session/:session_id/webauthn/authenticator/:authenticatorId/credentials'],
+          remove_credential: [:delete,
+                              'session/:session_id/webauthn/authenticator/:authenticatorId/credentials/:credentialId'],
+          remove_all_credentials: [:delete, 'session/:session_id/webauthn/authenticator/:authenticatorId/credentials'],
+          set_user_verified: [:post, 'session/:session_id/webauthn/authenticator/:authenticatorId/uv']
+
+        }.freeze
       end # Bridge
     end # Remote
   end # WebDriver

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

@@ -21,6 +21,7 @@ module Selenium
   module WebDriver
     module Remote
       class Bridge
+        autoload :COMMANDS, 'selenium/webdriver/remote/bridge/commands'
         include Atoms
 
         PORT = 4444
@@ -30,8 +31,8 @@ module Selenium
 
         #
         # 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 [String, URI] url url for the remote server
+        # @param [Object] http_client an HTTP client instance that implements the same protocol as Http::Default
         # @api private
         #
 
@@ -118,7 +119,7 @@ module Selenium
         end
 
         def alert=(keys)
-          execute :send_alert_text, {}, {value: keys.split(//), text: keys}
+          execute :send_alert_text, {}, {value: keys.chars, text: keys}
         end
 
         def alert_text
@@ -146,9 +147,7 @@ module Selenium
         end
 
         def page_source
-          execute_script('var source = document.documentElement.outerHTML;' \
-                            'if (!source) { source = new XMLSerializer().serializeToString(document); }' \
-                            'return source;')
+          execute :get_page_source
         end
 
         #
@@ -188,6 +187,7 @@ module Selenium
           execute :delete_session
           http.close
         rescue *QUIT_ERRORS
+          nil
         end
 
         def close
@@ -369,21 +369,10 @@ module Selenium
         # actions
         #
 
-        def action(async = false)
-          ActionBuilder.new self,
-                            Interactions.pointer(:mouse, name: 'mouse'),
-                            Interactions.key('keyboard'),
-                            async
-        end
-        alias_method :actions, :action
-
-        def mouse
-          raise Error::UnsupportedOperationError, '#mouse is no longer supported, use #action instead'
-        end
-
-        def keyboard
-          raise Error::UnsupportedOperationError, '#keyboard is no longer supported, use #action instead'
+        def action(async: false, devices: [], duration: 250)
+          ActionBuilder.new self, async: async, devices: devices, duration: duration
         end
+        alias actions action
 
         def send_actions(data)
           execute :actions, {}, {actions: data}
@@ -405,15 +394,15 @@ module Selenium
           # TODO: rework file detectors before Selenium 4.0
           if @file_detector
             local_files = keys.first&.split("\n")&.map { |key| @file_detector.call(Array(key)) }&.compact
-            if local_files.any?
+            if local_files&.any?
               keys = local_files.map { |local_file| upload(local_file) }
               keys = Array(keys.join("\n"))
             end
           end
 
           # Keep .split(//) for backward compatibility for now
-          text = keys.join('')
-          execute :element_send_keys, {id: element}, {value: text.split(//), text: text}
+          text = keys.join
+          execute :element_send_keys, {id: element}, {value: text.chars, text: text}
         end
 
         def upload(local_file)
@@ -430,10 +419,19 @@ module Selenium
         end
 
         def submit_element(element)
-          form = find_element_by('xpath', "./ancestor-or-self::form", [:element, element])
-          execute_script("var e = arguments[0].ownerDocument.createEvent('Event');" \
-                            "e.initEvent('submit', true, true);" \
-                            'if (arguments[0].dispatchEvent(e)) { arguments[0].submit() }', form.as_json)
+          script = "/* submitForm */ var form = arguments[0];\n" \
+                   "while (form.nodeName != \"FORM\" && form.parentNode) {\n  " \
+                   "form = form.parentNode;\n" \
+                   "}\n" \
+                   "if (!form) { throw Error('Unable to find containing form element'); }\n" \
+                   "if (!form.ownerDocument) { throw Error('Unable to find owning document'); }\n" \
+                   "var e = form.ownerDocument.createEvent('Event');\n" \
+                   "e.initEvent('submit', true, true);\n" \
+                   "if (form.dispatchEvent(e)) { HTMLFormElement.prototype.submit.call(form) }\n"
+
+          execute_script(script, Element::ELEMENT_KEY => element)
+        rescue Error::JavascriptError
+          raise Error::UnsupportedOperationError, 'To submit an element, it must be nested inside a form element'
         end
 
         #
@@ -521,7 +519,7 @@ module Selenium
           Element.new self, element_id_from(execute(:get_active_element))
         end
 
-        alias_method :switch_to_active_element, :active_element
+        alias switch_to_active_element active_element
 
         def find_element_by(how, what, parent_ref = [])
           how, what = convert_locator(how, what)
@@ -564,6 +562,39 @@ module Selenium
           ShadowRoot.new self, shadow_root_id_from(id)
         end
 
+        #
+        # virtual-authenticator
+        #
+
+        def add_virtual_authenticator(options)
+          authenticator_id = execute :add_virtual_authenticator, {}, options.as_json
+          VirtualAuthenticator.new(self, authenticator_id, options)
+        end
+
+        def remove_virtual_authenticator(id)
+          execute :remove_virtual_authenticator, {authenticatorId: id}
+        end
+
+        def add_credential(credential, id)
+          execute :add_credential, {authenticatorId: id}, credential
+        end
+
+        def credentials(authenticator_id)
+          execute :get_credentials, {authenticatorId: authenticator_id}
+        end
+
+        def remove_credential(credential_id, authenticator_id)
+          execute :remove_credential, {credentialId: credential_id, authenticatorId: authenticator_id}
+        end
+
+        def remove_all_credentials(authenticator_id)
+          execute :remove_all_credentials, {authenticatorId: authenticator_id}
+        end
+
+        def user_verified(verified, authenticator_id)
+          execute :set_user_verified, {authenticatorId: authenticator_id}, {isUserVerified: verified}
+        end
+
         private
 
         #
@@ -639,8 +670,6 @@ module Selenium
           when 'name'
             how = 'css selector'
             what = "*[name='#{escape_css(what.to_s)}']"
-          when 'tag name'
-            how = 'css selector'
           end
 
           if what.is_a?(Hash)

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

@@ -20,14 +20,12 @@
 module Selenium
   module WebDriver
     module Remote
-
       #
       # Specification of the desired and/or actual capabilities of the browser that the
       # server is being asked to create.
       #
 
       class Capabilities
-
         KNOWN = [
           :browser_name,
           :browser_version,
@@ -59,10 +57,25 @@ module Selenium
         # Backward compatibility
         #
 
-        alias_method :version, :browser_version
-        alias_method :version=, :browser_version=
-        alias_method :platform, :platform_name
-        alias_method :platform=, :platform_name=
+        def version
+          WebDriver.logger.deprecate('`Capabilities#version`', '`Capabilities#browser_version`', id: :jwp_caps)
+          browser_version
+        end
+
+        def version=(value)
+          WebDriver.logger.deprecate('`Capabilities#version=`', '`Capabilities#browser_version=`', id: :jwp_caps)
+          self.browser_version = value
+        end
+
+        def platform
+          WebDriver.logger.deprecate('`Capabilities#platform`', '`Capabilities#platform_name`', id: :jwp_caps)
+          platform_name
+        end
+
+        def platform=(value)
+          WebDriver.logger.deprecate('`Capabilities#platform=`', '`Capabilities#platform_name=`', id: :jwp_caps)
+          self.platform_name = value
+        end
 
         #
         # Convenience methods for the common choices.
@@ -70,44 +83,52 @@ module Selenium
 
         class << self
           def chrome(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.chrome', 'Options.chrome', id: :caps_browsers)
             new({
               browser_name: 'chrome'
             }.merge(opts))
           end
 
           def edge(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.edge', 'Options.edge', id: :caps_browsers)
             new({
               browser_name: 'MicrosoftEdge'
             }.merge(opts))
           end
-          alias_method :microsoftedge, :edge
+          alias microsoftedge edge
 
           def firefox(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.firefox', 'Options.firefox', id: :caps_browsers)
             new({
               browser_name: 'firefox'
             }.merge(opts))
           end
-          alias_method :ff, :firefox
+          alias ff firefox
 
           def safari(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.safari', 'Options.safari', id: :caps_browsers)
             new({
-              browser_name: Selenium::WebDriver::Safari.technology_preview? ? "Safari Technology Preview" : 'safari'
+              browser_name: Selenium::WebDriver::Safari.technology_preview? ? 'Safari Technology Preview' : 'safari'
             }.merge(opts))
           end
 
           def htmlunit(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.htmlunit',
+                                       'as argument in constructor',
+                                       id: :caps_browsers)
             new({
               browser_name: 'htmlunit'
             }.merge(opts))
           end
 
           def internet_explorer(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.ie', 'Options.ie', id: :caps_browsers)
             new({
               browser_name: 'internet explorer',
               platform_name: :windows
             }.merge(opts))
           end
-          alias_method :ie, :internet_explorer
+          alias ie internet_explorer
 
           def always_match(capabilities)
             new(always_match: capabilities)
@@ -134,7 +155,8 @@ module Selenium
 
             # Remote Server Specific
             if data.key?('webdriver.remote.sessionid')
-              caps[:remote_session_id] = data.delete('webdriver.remote.sessionid')
+              caps[:remote_session_id] =
+                data.delete('webdriver.remote.sessionid')
             end
 
             KNOWN.each do |cap|
@@ -269,7 +291,7 @@ module Selenium
           as_json == other.as_json
         end
 
-        alias_method :eql?, :==
+        alias eql? ==
 
         protected