selenium-webdriver 4.4.0 → 4.8.0

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

@@ -48,9 +48,10 @@ module Selenium
       #
       # @param [String] progname Allow child projects to use Selenium's Logger pattern
       #
-      def initialize(progname = 'Selenium')
+      def initialize(progname = 'Selenium', ignored: nil)
         @logger = create_logger(progname)
-        @ignored = []
+        @ignored = Array(ignored)
+        @first_warning = false
       end
 
       #
@@ -94,6 +95,13 @@ module Selenium
       # @yield see #deprecate
       #
       def warn(message, id: [])
+        unless @first_warning
+          @first_warning = true
+          warn("Details on how to use and modify Selenium logger:\n", id: [:logger_info]) do
+            "https://selenium.dev/documentation/webdriver/troubleshooting/logging#ruby\n"
+          end
+        end
+
         id = Array(id)
         return if (@ignored & id).any?
 

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

@@ -38,12 +38,12 @@ module Selenium
         def ie(**opts)
           IE::Options.new(**opts)
         end
-        alias_method :internet_explorer, :ie
+        alias internet_explorer ie
 
         def edge(**opts)
           Edge::Options.new(**opts)
         end
-        alias_method :microsoftedge, :edge
+        alias microsoftedge edge
 
         def safari(**opts)
           Safari::Options.new(**opts)
@@ -85,7 +85,13 @@ module Selenium
       #
 
       def add_option(name, value = nil)
-        @options[name.keys.first] = name.values.first if value.nil? && name.is_a?(Hash)
+        name, value = name.first if value.nil? && name.is_a?(Hash)
+
+        unless name.to_s.include?(':')
+          WebDriver.logger.deprecate('Options#add_option for w3c or browser specific capabilities',
+                                     'applicable attribute accessors or pass into constructor',
+                                     id: :add_option)
+        end
         @options[name] = value
       end
 
@@ -95,7 +101,7 @@ module Selenium
         as_json == other.as_json
       end
 
-      alias_method :eql?, :==
+      alias eql? ==
 
       #
       # @api private
@@ -106,11 +112,27 @@ module Selenium
 
         w3c_options = process_w3c_options(options)
 
-        self.class::CAPABILITIES.each do |capability_alias, capability_name|
-          capability_value = options.delete(capability_alias)
-          options[capability_name] = capability_value if !capability_value.nil? && !options.key?(capability_name)
+        browser_options = self.class::CAPABILITIES.each_with_object({}) do |(capability_alias, capability_name), hash|
+          from_name = options.delete(capability_name)
+          from_alias = options.delete(capability_alias)
+          capability_value = if !from_name.nil? && capability_alias != capability_name
+                               WebDriver.logger.deprecate("#{capability_name} as option",
+                                                          capability_alias.to_s, id: :option_symbols)
+                               from_name
+                             elsif !from_alias.nil?
+                               from_alias
+                             end
+
+          hash[capability_name] = capability_value unless capability_value.nil?
         end
-        browser_options = defined?(self.class::KEY) ? {self.class::KEY => options} : options
+
+        unless options.empty?
+          msg = 'These options are not w3c compliant and will result in failures in a future release'
+          WebDriver.logger.warn("#{msg}: #{options}")
+          browser_options.merge!(options)
+        end
+
+        browser_options = {self.class::KEY => browser_options} if defined?(self.class::KEY)
 
         process_browser_options(browser_options)
         generate_as_json(w3c_options.merge(browser_options))

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

@@ -78,6 +78,10 @@ module Selenium
         engine == :jruby
       end
 
+      def truffleruby?
+        engine == :truffleruby
+      end
+
       def ruby_version
         RUBY_VERSION
       end
@@ -105,7 +109,6 @@ module Selenium
 
       def cygwin?
         RUBY_PLATFORM.include?('cygwin')
-        !Regexp.last_match.nil?
       end
 
       def null_device

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

@@ -40,7 +40,7 @@ module Selenium
       end
 
       def as_json(*)
-        {"zip" => encoded}
+        {'zip' => encoded}
       end
 
       def to_json(*)

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

@@ -74,7 +74,7 @@ module Selenium
       def ==(other)
         other.is_a?(self.class) && as_json == other.as_json
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       def ftp=(value)
         self.type = :manual

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

@@ -0,0 +1,89 @@
+# 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.
+
+require 'open3'
+
+module Selenium
+  module WebDriver
+    #
+    # Wrapper for getting information from the Selenium Manager binaries.
+    # This implementation is still in beta, and may change.
+    # @api private
+    #
+    class SeleniumManager
+      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)
+          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
+        end
+
+        private
+
+        # @return [String] the path to the correct selenium manager
+        def binary
+          @binary ||= begin
+            path = File.expand_path(BIN_PATH, __FILE__)
+            path << if Platform.windows?
+                      '/windows/selenium-manager.exe'
+                    elsif Platform.mac?
+                      '/macos/selenium-manager'
+                    elsif Platform.linux?
+                      '/linux/selenium-manager'
+                    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'
+            end
+
+            WebDriver.logger.debug("Selenium Manager found at #{location}")
+            location
+          end
+        end
+
+        def run(command)
+          WebDriver.logger.debug("Executing Process #{command}")
+
+          begin
+            stdout, stderr, status = Open3.capture3(command)
+          rescue StandardError => e
+            raise Error::WebDriverError, "Unsuccessful command executed: #{command}", e.message
+          end
+
+          if status.exitstatus.positive?
+            raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{stdout}#{stderr}"
+          end
+
+          stdout.gsub("INFO\t", '').strip
+        end
+      end
+    end # SeleniumManager
+  end # WebDriver
+end # Selenium

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,15 +75,13 @@ 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
 
       def launch
-        sm = ServiceManager.new(self)
-        sm.start
-        sm
+        ServiceManager.new(self).tap(&:start)
       end
 
       def shutdown_supported
@@ -92,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
 
@@ -101,6 +103,12 @@ module Selenium
         path = path.call if path.is_a?(Proc)
         path ||= Platform.find_binary(self.class::EXECUTABLE)
 
+        begin
+          path ||= SeleniumManager.driver_path(self.class::EXECUTABLE)
+        rescue Error::WebDriverError => e
+          WebDriver.logger.debug("Unable obtain driver using Selenium Manager\n #{e.message}")
+        end
+
         raise Error::WebDriverError, self.class::MISSING_TEXT unless path
 
         Platform.assert_executable path

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
@@ -79,12 +79,7 @@ module Selenium
       def build_process(*command)
         WebDriver.logger.debug("Executing Process #{command}")
         @process = ChildProcess.build(*command)
-        if WebDriver.logger.debug?
-          @process.io.stdout = @process.io.stderr = WebDriver.logger.io
-        elsif Platform.jruby?
-          # Apparently we need to read the output of drivers on JRuby.
-          @process.io.stdout = @process.io.stderr = File.new(Platform.null_device, 'w')
-        end
+        @process.io = WebDriver.logger.io if WebDriver.logger.debug?
 
         @process
       end
@@ -104,8 +99,6 @@ module Selenium
 
       def start_process
         @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
-        # NOTE: this is a bug only in Windows 7
-        @process.leader = true unless Platform.windows?
         @process.start
       end
 
@@ -113,7 +106,6 @@ module Selenium
         return if process_exited?
 
         @process.stop STOP_TIMEOUT
-        @process.io.stdout.close if Platform.jruby? && !WebDriver.logger.debug?
       end
 
       def stop_server

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
 
@@ -66,8 +67,7 @@ module Selenium
 
       def can_lock?
         @server = TCPServer.new(Platform.localhost, @port)
-        ChildProcess.close_on_exec @server
-
+        @server.close_on_exec = true
         true
       rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => e
         WebDriver.logger.debug("#{self}: #{e.message}")

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

@@ -22,6 +22,11 @@ require 'websocket'
 module Selenium
   module WebDriver
     class WebSocketConnection
+      CONNECTION_ERRORS = [
+        Errno::ECONNRESET, # connection is aborted (browser process was killed)
+        Errno::EPIPE # broken pipe (browser process was killed)
+      ].freeze
+
       RESPONSE_WAIT_TIMEOUT = 30
       RESPONSE_WAIT_INTERVAL = 0.1
 
@@ -90,6 +95,8 @@ module Selenium
               end
             end
           end
+        rescue *CONNECTION_ERRORS
+          Thread.stop
         end
       end
 
@@ -104,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
@@ -122,6 +129,8 @@ module Selenium
           Thread.current.report_on_exception = true
 
           yield params
+        rescue *CONNECTION_ERRORS
+          Thread.stop
         end
       end
 
@@ -150,7 +159,6 @@ module Selenium
         @id ||= 0
         @id += 1
       end
-
     end # BiDi
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common.rb

@@ -22,6 +22,7 @@ require 'selenium/webdriver/common/platform'
 require 'selenium/webdriver/common/proxy'
 require 'selenium/webdriver/common/log_entry'
 require 'selenium/webdriver/common/file_reaper'
+require 'selenium/webdriver/common/selenium_manager'
 require 'selenium/webdriver/common/service'
 require 'selenium/webdriver/common/service_manager'
 require 'selenium/webdriver/common/socket_lock'
@@ -95,3 +96,4 @@ require 'selenium/webdriver/common/driver'
 require 'selenium/webdriver/common/element'
 require 'selenium/webdriver/common/shadow_root'
 require 'selenium/webdriver/common/websocket_connection'
+require 'selenium/webdriver/common/child_process'

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