selenium-webdriver 4.7.0 → 4.8.0

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

@@ -27,24 +27,22 @@ module Selenium
     # @api private
     #
     class SeleniumManager
-      BIN_PATH = "../../../../../bin"
+      BIN_PATH = '../../../../../bin'
 
       class << self
         # @param [String] driver_name which driver to use.
         # @return [String] the path to the correct driver.
         def driver_path(driver_name)
-          @driver_path ||= begin
-            unless %w[chromedriver geckodriver msedgedriver IEDriverServer.exe].include?(driver_name)
-              msg = "Unable to locate driver with name: #{driver_name}"
-              raise Error::WebDriverError, msg
-            end
+          unless %w[chromedriver geckodriver msedgedriver IEDriverServer].include?(driver_name)
+            msg = "Unable to locate driver with name: #{driver_name}"
+            raise Error::WebDriverError, msg
+          end
 
-            location = run("#{binary} --driver #{driver_name}")
-            WebDriver.logger.debug("Driver found at #{location}")
-            Platform.assert_executable location
+          location = run("#{binary} --driver #{driver_name}")
+          WebDriver.logger.debug("Driver found at #{location}")
+          Platform.assert_executable location
 
-            location
-          end
+          location
         end
 
         private
@@ -62,7 +60,7 @@ module Selenium
                     end
             location = File.expand_path(path, __FILE__)
             unless location.is_a?(String) && File.exist?(location) && File.executable?(location)
-              raise Error::WebDriverError, "Unable to obtain Selenium Manager"
+              raise Error::WebDriverError, 'Unable to obtain Selenium Manager'
             end
 
             WebDriver.logger.debug("Selenium Manager found at #{location}")

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

@@ -39,12 +39,13 @@ module Selenium
         def ie(**opts)
           IE::Service.new(**opts)
         end
-        alias_method :internet_explorer, :ie
+        alias internet_explorer ie
 
         def edge(**opts)
           Edge::Service.new(**opts)
         end
-        alias_method :microsoftedge, :edge
+        alias microsoftedge edge
+        alias msedge edge
 
         def safari(**opts)
           Safari::Service.new(**opts)
@@ -56,8 +57,8 @@ module Selenium
         end
       end
 
-      attr_accessor :host
-      attr_reader :executable_path, :port, :extra_args
+      attr_accessor :host, :executable_path, :port, :args
+      alias extra_args args
 
       #
       # End users should use a class method for the desired driver, rather than using this directly.
@@ -74,7 +75,7 @@ module Selenium
         @host = Platform.localhost
         @port = Integer(port)
 
-        @extra_args = args.is_a?(Hash) ? extract_service_args(args) : args
+        @args = args.is_a?(Hash) ? extract_service_args(args) : args
 
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
       end
@@ -90,6 +91,9 @@ module Selenium
       protected
 
       def extract_service_args(driver_opts)
+        WebDriver.logger.deprecate('initializing Service class with :args using Hash',
+                                   ':args parameter with an Array of String values',
+                                   id: :driver_opts)
         driver_opts.key?(:args) ? driver_opts.delete(:args) : []
       end
 

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

@@ -40,7 +40,7 @@ module Selenium
         @executable_path = config.executable_path
         @host = Platform.localhost
         @port = config.port
-        @extra_args = config.extra_args
+        @extra_args = config.args
         @shutdown_supported = config.shutdown_supported
 
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1

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

@@ -42,7 +42,7 @@ module Selenium
       def ==(other)
         other.is_a?(self.class) && ref == other.ref
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       def hash
         [@id, @bridge].hash
@@ -81,7 +81,6 @@ module Selenium
       private
 
       attr_reader :bridge
-
     end # ShadowRoot
   end # WebDriver
 end # Selenium

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

@@ -26,6 +26,7 @@ module Selenium
     class SocketLock
       def initialize(port, timeout)
         @port    = port
+        @server  = nil
         @timeout = timeout
       end
 

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

@@ -32,8 +32,8 @@ module Selenium
       def save_screenshot(png_path, full_page: false)
         extension = File.extname(png_path).downcase
         if extension != '.png'
-          WebDriver.logger.warn "name used for saved screenshot does not match file type. " \
-                                "It should end with .png extension",
+          WebDriver.logger.warn 'name used for saved screenshot does not match file type. ' \
+                                'It should end with .png extension',
                                 id: :screenshot
         end
         File.open(png_path, 'wb') { |f| f << screenshot_as(:png, full_page: full_page) }
@@ -60,7 +60,6 @@ module Selenium
       rescue NameError
         raise Error::UnsupportedOperationError, "Full Page Screenshots are not supported for #{inspect}"
       end
-
     end # TakesScreenshot
   end # WebDriver
 end # Selenium

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

@@ -51,9 +51,8 @@ module Selenium
       #
 
       def new_window(type = :window)
-        unless %i[window tab].include?(type)
-          raise ArgumentError, "Valid types are :tab and :window, received: #{type.inspect}"
-        end
+        raise ArgumentError, "Valid types are :tab and :window, received: #{type.inspect}" unless %i[window
+                                                                                                     tab].include?(type)
 
         handle = @bridge.new_window(type)['handle']
 

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

@@ -48,7 +48,7 @@ module Selenium
       def script
         Float(@bridge.timeouts['script']) / 1000
       end
-      alias_method :script_timeout, :script
+      alias script_timeout script
 
       #
       # Sets the amount of time to wait for an asynchronous script to finish
@@ -59,7 +59,7 @@ module Selenium
       def script=(seconds)
         @bridge.timeouts = {'script' => Integer(seconds * 1000)}
       end
-      alias_method :script_timeout=, :script=
+      alias script_timeout= script=
 
       #
       # Gets the amount of time to wait for a page load to complete before throwing an error.

data/lib/selenium/webdriver/common/virtual_authenticator/credential.rb

@@ -44,8 +44,8 @@ module Selenium
 
         def from_json(opts)
           user_handle = opts['userHandle'] ? decode(opts['userHandle']) : nil
-          new(id: decode(opts["credentialId"]),
-              resident_credential: opts["isResidentCredential"],
+          new(id: decode(opts['credentialId']),
+              resident_credential: opts['isResidentCredential'],
               rp_id: opts['rpId'],
               private_key: opts['privateKey'],
               sign_count: opts['signCount'],
@@ -54,15 +54,17 @@ module Selenium
       end
 
       attr_reader :id, :resident_credential, :rp_id, :user_handle, :private_key, :sign_count
-      alias_method :resident_credential?, :resident_credential
+      alias resident_credential? resident_credential
 
-      def initialize(id:, resident_credential:, rp_id:, private_key:, user_handle: nil, sign_count: 0)
+      def initialize(id:, resident_credential:, rp_id:, private_key:, **opts)
         @id = id
         @resident_credential = resident_credential
         @rp_id = rp_id
-        @user_handle = user_handle
+        @user_handle = opts.delete(:user_handle) { nil }
         @private_key = private_key
-        @sign_count = sign_count
+        @sign_count = opts.delete(:sign_count) { 0 }
+
+        raise ArgumentError, "Invalid arguments: #{opts.keys}" unless opts.empty?
       end
 
       #

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     class VirtualAuthenticator
-
       attr_reader :options
 
       #

data/lib/selenium/webdriver/common/virtual_authenticator/virtual_authenticator_options.rb

@@ -25,24 +25,24 @@
 module Selenium
   module WebDriver
     class VirtualAuthenticatorOptions
-
-      PROTOCOL = {ctap2: "ctap2", u2f: "ctap1/u2f"}.freeze
-      TRANSPORT = {ble: "ble", usb: "usb", nfc: "nfc", internal: "internal"}.freeze
+      PROTOCOL = {ctap2: 'ctap2', u2f: 'ctap1/u2f'}.freeze
+      TRANSPORT = {ble: 'ble', usb: 'usb', nfc: 'nfc', internal: 'internal'}.freeze
 
       attr_accessor :protocol, :transport, :resident_key, :user_verification, :user_consenting, :user_verified
-      alias_method :resident_key?, :resident_key
-      alias_method :user_verification?, :user_verification
-      alias_method :user_consenting?, :user_consenting
-      alias_method :user_verified?, :user_verified
-
-      def initialize(protocol: :ctap2, transport: :usb, resident_key: false,
-                     user_verification: false, user_consenting: true, user_verified: false)
-        @protocol = protocol
-        @transport = transport
-        @resident_key = resident_key
-        @user_verification = user_verification
-        @user_consenting = user_consenting
-        @user_verified = user_verified
+      alias resident_key? resident_key
+      alias user_verification? user_verification
+      alias user_consenting? user_consenting
+      alias user_verified? user_verified
+
+      def initialize(**opts)
+        @protocol = opts.delete(:protocol) { :ctap2 }
+        @transport = opts.delete(:transport) { :usb }
+        @resident_key = opts.delete(:resident_key) { false }
+        @user_verification = opts.delete(:user_verification) { false }
+        @user_consenting = opts.delete(:user_consenting) { true }
+        @user_verified = opts.delete(:user_verified) { false }
+
+        raise ArgumentError, "Invalid arguments: #{opts.keys}" unless opts.empty?
       end
 
       #

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

@@ -111,7 +111,7 @@ module Selenium
         return {} if message.empty?
 
         message = JSON.parse(message)
-        messages[message["id"]] = message
+        messages[message['id']] = message
         WebDriver.logger.debug "WebSocket <- #{message}"[...MAX_LOG_MESSAGE_SIZE]
 
         message
@@ -159,7 +159,6 @@ module Selenium
         @id ||= 0
         @id += 1
       end
-
     end # BiDi
   end # WebDriver
 end # Selenium

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

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     class DevTools
       class ConsoleEvent
-
         attr_accessor :type, :timestamp, :args
 
         def initialize(type:, timestamp:, args:)
@@ -31,7 +30,6 @@ module Selenium
             arg.key?('value') ? arg['value'] : arg
           end
         end
-
       end # ConsoleEvent
     end # DevTools
   end # WebDriver

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

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     class DevTools
       class ExceptionEvent
-
         attr_accessor :description, :timestamp, :stacktrace
 
         def initialize(description:, timestamp:, stacktrace:)
@@ -29,7 +28,6 @@ module Selenium
           @timestamp = Time.at(timestamp / 1000)
           @stacktrace = stacktrace
         end
-
       end # ExceptionEvent
     end # DevTools
   end # WebDriver

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

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     class DevTools
       class MutationEvent
-
         attr_accessor :element, :attribute_name, :current_value, :old_value
 
         def initialize(element:, attribute_name:, current_value:, old_value:)
@@ -30,7 +29,6 @@ module Selenium
           @current_value = current_value
           @old_value = old_value
         end
-
       end # MutationEvent
     end # DevTools
   end # WebDriver

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     class DevTools
-
       #
       # Wraps the network request/response interception, providing
       # thread-safety guarantees and handling special cases such as browser
@@ -31,14 +30,13 @@ module Selenium
       #
 
       class NetworkInterceptor
-
         # CDP fails to get body on certain responses (301) and raises:
         # "Can only get response body on requests captured after headers received."
-        CANNOT_GET_BODY_ON_REDIRECT_ERROR_CODE = "-32000"
+        CANNOT_GET_BODY_ON_REDIRECT_ERROR_CODE = '-32000'
 
         # CDP fails to operate with intercepted requests.
         # Typical reason is browser cancelling intercepted requests/responses.
-        INVALID_INTERCEPTION_ID_ERROR_CODE = "-32602"
+        INVALID_INTERCEPTION_ID_ERROR_CODE = '-32602'
 
         def initialize(devtools)
           @devtools = devtools
@@ -129,7 +127,7 @@ module Selenium
         def continue_request(id)
           devtools.fetch.continue_request(request_id: id)
         end
-        alias_method :continue_response, :continue_request
+        alias continue_response continue_request
 
         def mutate_request(request)
           devtools.fetch.continue_request(
@@ -169,7 +167,6 @@ module Selenium
         def cancelled?(network_id)
           lock.synchronize { !!cancelled_requests.delete(network_id) }
         end
-
       end # NetworkInterceptor
     end # DevTools
   end # WebDriver

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'],

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

@@ -108,6 +108,9 @@ module Selenium
         #
 
         def headless!
+          WebDriver.logger.deprecate('`Options#headless!`',
+                                     "`Options#add_argument('-headless')`",
+                                     id: :headless)
           add_argument '-headless'
         end
 
@@ -178,7 +181,7 @@ module Selenium
         end
 
         def camelize?(key)
-          key != "prefs"
+          key != 'prefs'
         end
       end # Options
     end # Firefox