selenium-webdriver 4.9.0 → 4.11.0

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

@@ -62,18 +62,6 @@ module Selenium
         end
       end
 
-      def bitsize
-        @bitsize ||= if defined?(FFI::Platform::ADDRESS_SIZE)
-                       FFI::Platform::ADDRESS_SIZE
-                     elsif defined?(FFI)
-                       FFI.type_size(:pointer) == 4 ? 32 : 64
-                     elsif jruby?
-                       Integer(ENV_JAVA['sun.arch.data.model'])
-                     else
-                       1.size == 4 ? 32 : 64
-                     end
-      end
-
       def jruby?
         engine == :jruby
       end
@@ -158,43 +146,6 @@ module Selenium
         at_exit { yield if Process.pid == pid }
       end
 
-      def find_binary(*binary_names)
-        paths = ENV['PATH'].split(File::PATH_SEPARATOR)
-
-        if windows?
-          binary_names.map! { |n| "#{n}.exe" }
-          binary_names.dup.each { |n| binary_names << n.gsub('exe', 'bat') }
-        end
-
-        binary_names.each do |binary_name|
-          paths.each do |path|
-            full_path = File.join(path, binary_name)
-            full_path = unix_path(full_path) if windows?
-            exe = Dir.glob(full_path).find { |f| File.executable?(f) }
-            return exe if exe
-          end
-        end
-
-        nil
-      end
-
-      def find_in_program_files(*binary_names)
-        paths = [
-          ENV.fetch('PROGRAMFILES', '\\Program Files'),
-          ENV.fetch('ProgramFiles(x86)', '\\Program Files (x86)'),
-          ENV.fetch('ProgramW6432', '\\Program Files')
-        ]
-
-        paths.each do |root|
-          binary_names.each do |name|
-            exe = File.join(root, name)
-            return exe if File.executable?(exe)
-          end
-        end
-
-        nil
-      end
-
       def localhost
         info = Socket.getaddrinfo 'localhost', 80, Socket::AF_INET, Socket::SOCK_STREAM
 

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

@@ -34,7 +34,7 @@ module Selenium
         Platform.interfaces.each do |host|
           TCPServer.new(host, port).close
         rescue *IGNORED_ERRORS => e
-          WebDriver.logger.debug("port prober could not bind to #{host}:#{port} (#{e.message})")
+          WebDriver.logger.debug("port prober could not bind to #{host}:#{port} (#{e.message})", id: :driver_service)
           # ignored - some machines appear unable to bind to some of their interfaces
         end
 

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

@@ -152,7 +152,7 @@ module Selenium
           'socksUsername' => socks_username,
           'socksPassword' => socks_password,
           'socksVersion' => socks_version
-        }.delete_if { |_k, v| v.nil? }
+        }.compact
 
         json_result if json_result.length > 1
       end

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

@@ -27,20 +27,36 @@ module Selenium
     # @api private
     #
     class SeleniumManager
-      BIN_PATH = '../../../../../bin'
-
       class << self
+        attr_writer :bin_path
+
+        def bin_path
+          @bin_path ||= '../../../../../bin'
+        end
+
         # @param [Options] options browser options.
         # @return [String] the path to the correct driver.
         def driver_path(options)
-          message = 'applicable driver not found; attempting to install with Selenium Manager'
-          WebDriver.logger.warn(message)
+          command = generate_command(binary, options)
+
+          output = run(*command)
+
+          browser_path = output['browser_path']
+          driver_path = output['driver_path']
+          Platform.assert_executable driver_path
 
-          unless options.is_a?(Options)
-            raise ArgumentError, "SeleniumManager requires a WebDriver::Options instance, not #{options.inspect}"
+          if options.respond_to? :binary
+            options.binary = browser_path
+            options.browser_version = nil
           end
 
-          command = [binary, '--browser', options.browser_name, '--output', 'json']
+          driver_path
+        end
+
+        private
+
+        def generate_command(binary, options)
+          command = [binary, '--browser', options.browser_name]
           if options.browser_version
             command << '--browser-version'
             command << options.browser_version
@@ -49,21 +65,17 @@ module Selenium
             command << '--browser-path'
             command << options.binary.gsub('\\', '\\\\\\')
           end
-          command << '--debug' if WebDriver.logger.debug?
-
-          location = run(*command)
-          WebDriver.logger.debug("Driver found at #{location}")
-          Platform.assert_executable location
-
-          location
+          if options.proxy
+            command << '--proxy'
+            (command << options.proxy.ssl) || options.proxy.http
+          end
+          command
         end
 
-        private
-
         # @return [String] the path to the correct selenium manager
         def binary
           @binary ||= begin
-            path = File.expand_path(BIN_PATH, __FILE__)
+            path = File.expand_path(bin_path, __FILE__)
             path << if Platform.windows?
                       '/windows/selenium-manager.exe'
                     elsif Platform.mac?
@@ -72,32 +84,43 @@ module Selenium
                       '/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'
+
+            begin
+              Platform.assert_file(location)
+              Platform.assert_executable(location)
+            rescue TypeError
+              raise Error::WebDriverError,
+                    "Unable to locate or obtain Selenium Manager binary; #{location} is not a valid file object"
+            rescue Error::WebDriverError => e
+              raise Error::WebDriverError, "Selenium Manager binary located, but #{e.message}"
             end
 
-            WebDriver.logger.debug("Selenium Manager found at #{location}")
+            WebDriver.logger.debug("Selenium Manager binary found at #{location}", id: :selenium_manager)
             location
           end
         end
 
         def run(*command)
-          WebDriver.logger.debug("Executing Process #{command}")
+          command += %w[--output json]
+          command << '--debug' if WebDriver.logger.debug?
+
+          WebDriver.logger.debug("Executing Process #{command}", id: :selenium_manager)
 
           begin
             stdout, stderr, status = Open3.capture3(*command)
             json_output = stdout.empty? ? nil : JSON.parse(stdout)
-            result = json_output&.dig('result', 'message')
+            result = json_output['result']
           rescue StandardError => e
-            raise Error::WebDriverError, "Unsuccessful command executed: #{command}", e.message
+            raise Error::WebDriverError, "Unsuccessful command executed: #{command}; #{e.message}"
           end
 
-          if status.exitstatus.positive?
-            raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{result}#{stderr}"
+          (json_output&.fetch('logs') || []).each do |log|
+            level = log['level'].casecmp('info').zero? ? 'debug' : log['level'].downcase
+            WebDriver.logger.send(level, log['message'], id: :selenium_manager)
           end
 
-          json_output['logs'].each do |log|
-            WebDriver.logger.send(log['level'].downcase, log['message'])
+          if status.exitstatus.positive?
+            raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{result}#{stderr}"
           end
 
           result

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

@@ -57,7 +57,7 @@ module Selenium
         end
       end
 
-      attr_accessor :host, :executable_path, :port, :args
+      attr_accessor :host, :executable_path, :port, :log, :args
       alias extra_args args
 
       #
@@ -66,15 +66,22 @@ module Selenium
       # @api private
       #
 
-      def initialize(path: nil, port: nil, args: nil)
+      def initialize(path: nil, port: nil, log: nil, args: nil)
         port ||= self.class::DEFAULT_PORT
         args ||= []
 
         @executable_path = path
         @host = Platform.localhost
         @port = Integer(port)
-
-        @args = args.is_a?(Hash) ? extract_service_args(args) : args
+        @log = case log
+               when :stdout
+                 $stdout
+               when :stderr
+                 $stderr
+               else
+                 log
+               end
+        @args = args
 
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
       end
@@ -86,15 +93,6 @@ module Selenium
       def shutdown_supported
         self.class::SHUTDOWN_SUPPORTED
       end
-
-      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
     end # Service
   end # WebDriver
 end # Selenium

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

@@ -41,6 +41,7 @@ module Selenium
         @host = Platform.localhost
         @port = config.port
         @extra_args = config.args
+        @io = config.log
         @shutdown_supported = config.shutdown_supported
 
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
@@ -77,9 +78,10 @@ module Selenium
       private
 
       def build_process(*command)
-        WebDriver.logger.debug("Executing Process #{command}")
+        WebDriver.logger.debug("Executing Process #{command}", id: :driver_service)
         @process = ChildProcess.build(*command)
-        @process.io = WebDriver.logger.io if WebDriver.logger.debug?
+        @io ||= WebDriver.logger.io if WebDriver.logger.debug?
+        @process.io = @io if @io
 
         @process
       end

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

@@ -70,7 +70,7 @@ module Selenium
         @server.close_on_exec = true
         true
       rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => e
-        WebDriver.logger.debug("#{self}: #{e.message}")
+        WebDriver.logger.debug("#{self}: #{e.message}", id: :driver_service)
         false
       end
 

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

@@ -93,7 +93,7 @@ module Selenium
           true
         rescue *NOT_CONNECTED_ERRORS
           sock&.close
-          WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}")
+          WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}", id: :driver_service)
           false
         end
       end

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

@@ -55,7 +55,7 @@ module Selenium
       def send_cmd(**payload)
         id = next_id
         data = payload.merge(id: id)
-        WebDriver.logger.debug "WebSocket -> #{data}"[...MAX_LOG_MESSAGE_SIZE]
+        WebDriver.logger.debug "WebSocket -> #{data}"[...MAX_LOG_MESSAGE_SIZE], id: :bidi
         data = JSON.generate(data)
         out_frame = WebSocket::Frame::Outgoing::Client.new(version: ws.version, data: data, type: 'text')
         socket.write(out_frame.to_s)
@@ -112,7 +112,7 @@ module Selenium
 
         message = JSON.parse(message)
         messages[message['id']] = message
-        WebDriver.logger.debug "WebSocket <- #{message}"[...MAX_LOG_MESSAGE_SIZE]
+        WebDriver.logger.debug "WebSocket <- #{message}"[...MAX_LOG_MESSAGE_SIZE], id: :bidi
 
         message
       end
@@ -129,7 +129,7 @@ module Selenium
           Thread.current.report_on_exception = true
 
           yield params
-        rescue *CONNECTION_ERRORS
+        rescue Error::WebDriverError, *CONNECTION_ERRORS
           Thread.stop
         end
       end

data/lib/selenium/webdriver/devtools.rb

@@ -60,7 +60,7 @@ module Selenium
                           "#{namespace}::#{Object.const_get(methods_to_classes)[method]}"
                         else
                           # selenium-devtools 0.112 and older
-                          "#{namespace}::#{method.capitalize}}"
+                          "#{namespace}::#{method.capitalize}"
                         end
 
         return unless Object.const_defined?(desired_class)

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

@@ -26,6 +26,20 @@ module Selenium
         KEY = 'ms:edgeOptions'
         BROWSER = 'MicrosoftEdge'
 
+        #
+        # Changes the browser name enable webview2
+        # see: https://learn.microsoft.com/en-us/microsoft-edge/webview2/how-to/webdriver
+        # Automation of WebView2 apps with Microsoft Edge WebDriver
+        #
+        # @example Enable webview2
+        #   options = Selenium::WebDriver::Edge::Options.new
+        #   options.webview2!
+        #
+
+        def webview2!
+          @options[:browser_name] = 'webview2'
+        end
+
         private
 
         def enable_logging(browser_options)

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

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

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

@@ -99,21 +99,6 @@ module Selenium
           @options[:prefs][name] = value
         end
 
-        #
-        # Run Firefox in headless mode.
-        #
-        # @example Enable headless mode
-        #   options = Selenium::WebDriver::Firefox::Options.new
-        #   options.headless!
-        #
-
-        def headless!
-          WebDriver.logger.deprecate('`Options#headless!`',
-                                     "`Options#add_argument('-headless')`",
-                                     id: :headless)
-          add_argument '-headless'
-        end
-
         #
         # Sets Firefox profile.
         #

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

@@ -160,7 +160,7 @@ module Selenium
           destination = File.join(directory, 'extensions')
 
           @extensions.each do |name, extension|
-            WebDriver.logger.debug({extenstion: name}.inspect)
+            WebDriver.logger.debug({extension: name}.inspect, id: :firefox_profile)
             extension.write_to(destination)
           end
         end

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

@@ -24,18 +24,6 @@ module Selenium
         DEFAULT_PORT = 4444
         EXECUTABLE = 'geckodriver'
         SHUTDOWN_SUPPORTED = false
-
-        private
-
-        def extract_service_args(driver_opts)
-          driver_args = super
-          driver_opts = driver_opts.dup
-          driver_args << "--binary=#{driver_opts[:binary]}" if driver_opts.key?(:binary)
-          driver_args << "--log=#{driver_opts[:log]}" if driver_opts.key?(:log)
-          driver_args << "--marionette-port=#{driver_opts[:marionette_port]}" if driver_opts.key?(:marionette_port)
-          driver_args << "--host=#{driver_opts[:host]}" if driver_opts.key?(:host)
-          driver_args
-        end
       end # Service
     end # Firefox
   end # WebDriver

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

@@ -41,7 +41,8 @@ module Selenium
           use_per_process_proxy: 'ie.usePerProcessProxy',
           use_legacy_file_upload_dialog_handling: 'ie.useLegacyFileUploadDialogHandling',
           attach_to_edge_chrome: 'ie.edgechromium',
-          edge_executable_path: 'ie.edgepath'
+          edge_executable_path: 'ie.edgepath',
+          ignore_process_match: 'ie.ignoreprocessmatch'
         }.freeze
         BROWSER = 'internet explorer'
 

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

@@ -24,22 +24,6 @@ module Selenium
         DEFAULT_PORT = 5555
         EXECUTABLE = 'IEDriverServer'
         SHUTDOWN_SUPPORTED = true
-
-        private
-
-        def extract_service_args(driver_opts)
-          driver_args = super
-          driver_opts = driver_opts.dup
-          driver_args << "--log-level=#{driver_opts[:log_level].to_s.upcase}" if driver_opts.key?(:log_level)
-          driver_args << "--log-file=#{driver_opts[:log_file]}" if driver_opts.key?(:log_file)
-          if driver_opts.key?(:implementation)
-            driver_args << "--implementation=#{driver_opts[:implementation].to_s.upcase}"
-          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
-        end
       end # Server
     end # IE
   end # WebDriver

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

@@ -407,7 +407,8 @@ module Selenium
 
         def upload(local_file)
           unless File.file?(local_file)
-            WebDriver.logger.debug("File detector only works with files. #{local_file.inspect} isn`t a file!")
+            WebDriver.logger.debug("File detector only works with files. #{local_file.inspect} isn`t a file!",
+                                   id: :file_detector)
             raise Error::WebDriverError, "You are trying to work with something that isn't a file."
           end
 
@@ -443,7 +444,7 @@ module Selenium
         end
 
         def element_attribute(element, name)
-          WebDriver.logger.info "Using script for :getAttribute of #{name}"
+          WebDriver.logger.debug "Using script for :getAttribute of #{name}", id: :script
           execute_atom :getAttribute, element, name
         end
 
@@ -503,7 +504,7 @@ module Selenium
         end
 
         def element_displayed?(element)
-          WebDriver.logger.info 'Using script for :isDisplayed'
+          WebDriver.logger.debug 'Using script for :isDisplayed', id: :script
           execute_atom :isDisplayed, element
         end
 
@@ -615,7 +616,7 @@ module Selenium
             raise ArgumentError, "#{opts.inspect} invalid for #{command.inspect}"
           end
 
-          WebDriver.logger.info("-> #{verb.to_s.upcase} #{path}")
+          WebDriver.logger.debug("-> #{verb.to_s.upcase} #{path}", id: :command)
           http.call(verb, path, command_hash)['value']
         end
 
@@ -682,7 +683,7 @@ module Selenium
           [how, what]
         end
 
-        ESCAPE_CSS_REGEXP = /(['"\\#.:;,!?+<>=~*^$|%&@`{}\-\[\]()])/.freeze
+        ESCAPE_CSS_REGEXP = /(['"\\#.:;,!?+<>=~*^$|%&@`{}\-\[\]()])/
         UNICODE_CODE_POINT = 30
 
         # Escapes invalid characters in CSS selector.

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

@@ -53,83 +53,11 @@ module Selenium
           end
         end
 
-        #
-        # Backward compatibility
-        #
-
-        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.
         #
 
         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 microsoftedge edge
-
-          def firefox(opts = {})
-            WebDriver.logger.deprecate('Remote::Capabilities.firefox', 'Options.firefox', id: :caps_browsers)
-            new({
-              browser_name: 'firefox'
-            }.merge(opts))
-          end
-          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'
-            }.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 ie internet_explorer
-
           def always_match(capabilities)
             new(always_match: capabilities)
           end

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

@@ -49,8 +49,8 @@ module Selenium
               payload                   = JSON.generate(command_hash)
               headers['Content-Length'] = payload.bytesize.to_s if %i[post put].include?(verb)
 
-              WebDriver.logger.info("   >>> #{url} | #{payload}")
-              WebDriver.logger.debug("     > #{headers.inspect}")
+              WebDriver.logger.debug("   >>> #{url} | #{payload}", id: :command)
+              WebDriver.logger.debug("     > #{headers.inspect}", id: :header)
             elsif verb == :post
               payload = '{}'
               headers['Content-Length'] = '2'
@@ -75,7 +75,7 @@ module Selenium
             code = code.to_i
             body = body.to_s.strip
             content_type = content_type.to_s
-            WebDriver.logger.info("<- #{body}")
+            WebDriver.logger.debug("<- #{body}", id: :command)
 
             if content_type.include? CONTENT_TYPE
               raise Error::WebDriverError, "empty body: #{content_type.inspect} (#{code})\n#{body}" if body.empty?

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

@@ -83,7 +83,7 @@ module Selenium
               c.max_redirects   = MAX_REDIRECTS
               c.follow_location = true
               c.timeout         = @timeout if @timeout
-              c.verbose         = WebDriver.logger.info?
+              c.verbose         = WebDriver.logger.debug?
 
               c
             end

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

@@ -16,8 +16,6 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
-require 'net/https'
 require 'ipaddr'
 
 module Selenium
@@ -96,11 +94,12 @@ module Selenium
             end
 
             if response.is_a? Net::HTTPRedirection
+              WebDriver.logger.debug("Redirect to #{response['Location']}; times: #{redirects}")
               raise Error::WebDriverError, 'too many redirects' if redirects >= MAX_REDIRECTS
 
               request(:get, URI.parse(response['Location']), DEFAULT_HEADERS.dup, nil, redirects + 1)
             else
-              WebDriver.logger.debug("   <<<  #{response.instance_variable_get(:@header).inspect}")
+              WebDriver.logger.debug("   <<<  #{response.instance_variable_get(:@header).inspect}", id: :header)
               create_response response.code, response.body, response.content_type
             end
           end

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

@@ -25,7 +25,7 @@ module Selenium
           if response.is_a? String
             super(response)
           else
-            super("status code #{response.code}")
+            super("status code #{response.code}; payload #{response.payload}")
           end
         end
       end # ServerError