selenium-webdriver 4.4.0 → 4.8.0

data/lib/selenium/webdriver/devtools/pinned_script.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     class DevTools
       class PinnedScript
-
         attr_accessor :key, :devtools_identifier, :script
 
         def initialize(script)
@@ -52,7 +51,6 @@ module Selenium
         def remove
           "__webdriver_#{key} = undefined"
         end
-
       end # PinnedScript
     end # DevTools
   end # WebDriver

data/lib/selenium/webdriver/devtools/request.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     class DevTools
       class Request
-
         attr_accessor :url, :method, :headers, :post_data
         attr_reader :id
 
@@ -60,7 +59,6 @@ module Selenium
         def inspect
           %(#<#{self.class.name} @id="#{id}" @method="#{method}" @url="#{url}")
         end
-
       end # Request
     end # DevTools
   end # WebDriver

data/lib/selenium/webdriver/devtools/response.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     class DevTools
       class Response
-
         attr_accessor :code, :body, :headers
         attr_reader :id
 
@@ -59,7 +58,6 @@ module Selenium
         def inspect
           %(#<#{self.class.name} @id="#{id}" @code="#{code}")
         end
-
       end # Response
     end # DevTools
   end # WebDriver

data/lib/selenium/webdriver/devtools.rb

@@ -81,7 +81,6 @@ module Selenium
       def error_message(error)
         [error['code'], error['message'], error['data']].join(': ')
       end
-
     end # DevTools
   end # WebDriver
 end # Selenium

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

@@ -17,18 +17,25 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/chrome/driver'
+require 'selenium/webdriver/chromium/driver'
 
 module Selenium
   module WebDriver
     module Edge
-
       #
       # Driver implementation for Microsoft Edge.
       # @api private
       #
 
-      class Driver < Selenium::WebDriver::Chrome::Driver
+      class Driver < Chromium::Driver
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          raise ArgumentError, "Can't initialize #{self.class} with :url" if url
+
+          caps = process_options(options, capabilities)
+          url = service_url(service || Service.edge)
+          super(caps: caps, url: url, **opts)
+        end
+
         def browser
           :edge
         end
@@ -38,6 +45,16 @@ module Selenium
         def devtools_address
           "http://#{capabilities['ms:edgeOptions']['debuggerAddress']}"
         end
+
+        def process_options(options, capabilities)
+          if options && !options.is_a?(Options)
+            raise ArgumentError, ":options must be an instance of #{Options}"
+          elsif options.nil? && capabilities.nil?
+            options = Options.new
+          end
+
+          super(options, capabilities)
+        end
       end # Driver
     end # Edge
   end # WebDriver

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

@@ -17,14 +17,13 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/chrome/features'
+require 'selenium/webdriver/chromium/features'
 
 module Selenium
   module WebDriver
     module Edge
       module Features
-
-        include WebDriver::Chrome::Features
+        include WebDriver::Chromium::Features
 
         EDGE_COMMANDS = {
           get_cast_sinks: [:get, 'session/:session_id/ms/cast/get_sinks'],
@@ -37,7 +36,7 @@ module Selenium
         }.freeze
 
         def commands(command)
-          EDGE_COMMANDS[command] || Chrome::Features::CHROME_COMMANDS[command] || self.class::COMMANDS[command]
+          EDGE_COMMANDS[command] || CHROMIUM_COMMANDS[command] || self.class::COMMANDS[command]
         end
       end # Bridge
     end # Edge

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

@@ -17,23 +17,21 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/chrome/options'
+require 'selenium/webdriver/chromium/options'
 
 module Selenium
   module WebDriver
     module Edge
-      class Options < Selenium::WebDriver::Chrome::Options
+      class Options < Chromium::Options
         KEY = 'ms:edgeOptions'
         BROWSER = 'MicrosoftEdge'
 
-        protected
+        private
 
         def enable_logging(browser_options)
           browser_options['ms:loggingPrefs'] = @logging_prefs
         end
 
-        private
-
         def binary_path
           Edge.path
         end

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

@@ -17,7 +17,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/chrome/profile'
+require 'selenium/webdriver/chromium/profile'
 
 module Selenium
   module WebDriver
@@ -26,7 +26,7 @@ module Selenium
       # @private
       #
 
-      class Profile < Selenium::WebDriver::Chrome::Profile
+      class Profile < Chromium::Profile
       end # Profile
     end # Edge
   end # WebDriver

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

@@ -17,12 +17,12 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/chrome/service'
+require 'selenium/webdriver/chromium/service'
 
 module Selenium
   module WebDriver
     module Edge
-      class Service < Selenium::WebDriver::Chrome::Service
+      class Service < Chromium::Service
         DEFAULT_PORT = 9515
         EXECUTABLE = 'msedgedriver'
         MISSING_TEXT = <<~ERROR

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
@@ -37,6 +36,14 @@ module Selenium
                       DriverExtensions::HasWebStorage,
                       DriverExtensions::PrintsPage].freeze
 
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          raise ArgumentError, "Can't initialize #{self.class} with :url" if url
+
+          caps = process_options(options, capabilities)
+          url = service_url(service || Service.firefox)
+          super(caps: caps, url: url, **opts)
+        end
+
         def browser
           :firefox
         end
@@ -45,7 +52,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']}")
@@ -57,6 +64,16 @@ module Selenium
         def devtools_version
           Firefox::DEVTOOLS_VERSION
         end
+
+        def process_options(options, capabilities)
+          if options && !options.is_a?(Options)
+            raise ArgumentError, ":options must be an instance of #{Options}"
+          elsif options.nil? && capabilities.nil?
+            options = Options.new
+          end
+
+          super(options, capabilities)
+        end
       end # Driver
     end # Firefox
   end # WebDriver

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,7 +34,11 @@ module Selenium
         end
 
         def install_addon(path, temporary)
-          addon = File.open(path, 'rb') { |crx_file| Base64.strict_encode64 crx_file.read }
+          addon = if File.directory?(path)
+                    Zipper.zip(path)
+                  else
+                    File.open(path, 'rb') { |crx_file| Base64.strict_encode64 crx_file.read }
+                  end
 
           payload = {addon: addon}
           payload[:temporary] = temporary unless temporary.nil?

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

@@ -57,7 +57,8 @@ 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)
 
@@ -107,6 +108,9 @@ module Selenium
         #
 
         def headless!
+          WebDriver.logger.deprecate('`Options#headless!`',
+                                     "`Options#add_argument('-headless')`",
+                                     id: :headless)
           add_argument '-headless'
         end
 
@@ -177,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
@@ -143,7 +143,7 @@ module Selenium
           end
         end
 
-        alias_method :as_json, :encoded
+        alias as_json encoded
 
         private
 

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

@@ -32,7 +32,6 @@ module Selenium
 
         private
 
-        # NOTE: This processing is deprecated
         def extract_service_args(driver_opts)
           driver_args = super
           driver_opts = driver_opts.dup

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,9 +29,29 @@ module Selenium
       class Driver < WebDriver::Driver
         EXTENSIONS = [DriverExtensions::HasWebStorage].freeze
 
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          raise ArgumentError, "Can't initialize #{self.class} with :url" if url
+
+          caps = process_options(options, capabilities)
+          url = service_url(service || Service.ie)
+          super(caps: caps, url: url, **opts)
+        end
+
         def browser
           :internet_explorer
         end
+
+        private
+
+        def process_options(options, capabilities)
+          if options && !options.is_a?(Options)
+            raise ArgumentError, ":options must be an instance of #{Options}"
+          elsif options.nil? && capabilities.nil?
+            options = Options.new
+          end
+
+          super(options, capabilities)
+        end
       end # Driver
     end # IE
   end # WebDriver

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

@@ -32,7 +32,6 @@ module Selenium
 
         private
 
-        # NOTE: This processing is deprecated
         def extract_service_args(driver_opts)
           driver_args = super
           driver_opts = driver_opts.dup
@@ -43,7 +42,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/remote/bridge.rb

@@ -186,6 +186,7 @@ module Selenium
           execute :delete_session
           http.close
         rescue *QUIT_ERRORS
+          nil
         end
 
         def close
@@ -367,18 +368,10 @@ module Selenium
         # actions
         #
 
-        def action(deprecated_async = nil, async: false, devices: [], duration: 250)
-          ActionBuilder.new self, nil, nil, deprecated_async, async: async, devices: devices, duration: duration
-        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}
@@ -400,7 +393,7 @@ 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
@@ -425,7 +418,7 @@ module Selenium
         end
 
         def submit_element(element)
-          script = "var form = arguments[0];\n" \
+          script = "/* submitForm */ var form = arguments[0];\n" \
                    "while (form.nodeName != \"FORM\" && form.parentNode) {\n  " \
                    "form = form.parentNode;\n" \
                    "}\n" \
@@ -437,7 +430,7 @@ module Selenium
 
           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"
+          raise Error::UnsupportedOperationError, 'To submit an element, it must be nested inside a form element'
         end
 
         #
@@ -525,7 +518,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)

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
 

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Remote
-
       #
       # https://w3c.github.io/webdriver/#endpoints
       # @api private
@@ -165,7 +164,6 @@ module Selenium
           set_user_verified: [:post, 'session/:session_id/webauthn/authenticator/:authenticatorId/uv']
 
         }.freeze
-
       end # Bridge
     end # Remote
   end # WebDriver

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Remote
-
       #
       # Driver implementation for remote server.
       # @api private
@@ -30,17 +29,12 @@ module Selenium
         include DriverExtensions::UploadsFiles
         include DriverExtensions::HasSessionId
 
-        def initialize(bridge: nil, listener: nil, **opts)
-          desired_capabilities = opts[:desired_capabilities]
-          if desired_capabilities.is_a?(Symbol)
-            unless Remote::Capabilities.respond_to?(desired_capabilities)
-              raise Error::WebDriverError, "invalid desired capability: #{desired_capabilities.inspect}"
-            end
-
-            opts[:desired_capabilities] = Remote::Capabilities.__send__(desired_capabilities)
-          end
-          opts[:url] ||= "http://#{Platform.localhost}:4444/wd/hub"
-          super
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          raise ArgumentError, "Can not set :service object on #{self.class}" if service
+
+          url ||= "http://#{Platform.localhost}:4444/wd/hub"
+          caps = process_options(options, capabilities)
+          super(caps: caps, url: url, **opts)
           @bridge.file_detector = ->((filename, *)) { File.exist?(filename) && filename.to_s }
         end
 
@@ -52,7 +46,13 @@ module Selenium
 
         def devtools_version
           capabilities['se:cdpVersion']&.split('.')&.first ||
-            raise(Error::WebDriverError, "DevTools is not supported by the Remote Server")
+            raise(Error::WebDriverError, 'DevTools is not supported by the Remote Server')
+        end
+
+        def process_options(options, capabilities)
+          raise ArgumentError, "#{self.class} needs :options to be set" if options.nil? && capabilities.nil?
+
+          super(options, capabilities)
         end
       end # Driver
     end # Remote

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

@@ -22,7 +22,6 @@ require 'curb'
 module Selenium
   module WebDriver
     module Remote
-
       module Http
         #
         # An alternative to the default Net::HTTP client.
@@ -38,7 +37,6 @@ module Selenium
         #
 
         class Curb < Common
-
           def quit_errors
             [Curl::Err::RecvError] + super
           end

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

@@ -100,6 +100,7 @@ module Selenium
 
               request(:get, URI.parse(response['Location']), DEFAULT_HEADERS.dup, nil, redirects + 1)
             else
+              WebDriver.logger.debug("   <<<  #{response.instance_variable_get(:@header).inspect}")
               create_response response.code, response.body, response.content_type
             end
           end

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Remote
-
       #
       # @api private
       #