selenium-webdriver 4.1.0 → 4.14.0

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, :log, :args
+      alias extra_args args
 
       #
       # End users should use a class method for the desired driver, rather than using this directly.
@@ -65,47 +66,37 @@ module Selenium
       # @api private
       #
 
-      def initialize(path: nil, port: nil, args: nil)
-        path ||= self.class.driver_path
+      def initialize(path: nil, port: nil, log: nil, args: nil)
         port ||= self.class::DEFAULT_PORT
         args ||= []
 
-        @executable_path = binary_path(path)
+        @executable_path = path
         @host = Platform.localhost
         @port = Integer(port)
-
-        @extra_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
 
       def launch
-        sm = ServiceManager.new(self)
-        sm.start
-        sm
+        @executable_path ||= begin
+          default_options = WebDriver.const_get("#{self.class.name.split('::')[2]}::Options").new
+          DriverFinder.path(default_options, self.class)
+        end
+        ServiceManager.new(self).tap(&:start)
       end
 
       def shutdown_supported
         self.class::SHUTDOWN_SUPPORTED
       end
-
-      protected
-
-      def extract_service_args(driver_opts)
-        driver_opts.key?(:args) ? driver_opts.delete(:args) : []
-      end
-
-      private
-
-      def binary_path(path = nil)
-        path = path.call if path.is_a?(Proc)
-        path ||= Platform.find_binary(self.class::EXECUTABLE)
-
-        raise Error::WebDriverError, self.class::MISSING_TEXT unless path
-
-        Platform.assert_executable path
-        path
-      end
     end # Service
   end # WebDriver
 end # Selenium

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

@@ -40,7 +40,8 @@ module Selenium
         @executable_path = config.executable_path
         @host = Platform.localhost
         @port = config.port
-        @extra_args = config.extra_args
+        @io = config.log
+        @extra_args = config.args
         @shutdown_supported = config.shutdown_supported
 
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
@@ -49,7 +50,7 @@ module Selenium
       def start
         raise "already started: #{uri.inspect} #{@executable_path.inspect}" if process_running?
 
-        Platform.exit_hook(&method(:stop)) # make sure we don't leave the server running
+        Platform.exit_hook { stop } # make sure we don't leave the server running
 
         socket_lock.locked do
           find_free_port
@@ -60,10 +61,11 @@ module Selenium
 
       def stop
         return unless @shutdown_supported
+        return if process_exited?
 
         stop_server
         @process.poll_for_exit STOP_TIMEOUT
-      rescue ChildProcess::TimeoutError
+      rescue ChildProcess::TimeoutError, Errno::ECONNREFUSED
         nil # noop
       ensure
         stop_process
@@ -76,14 +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)
-        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
+        @io ||= WebDriver.logger.io if WebDriver.logger.debug?
+        @process.io = @io if @io
 
         @process
       end
@@ -103,8 +101,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
 
@@ -112,12 +108,9 @@ module Selenium
         return if process_exited?
 
         @process.stop STOP_TIMEOUT
-        @process.io.stdout.close if Platform.jruby? && !WebDriver.logger.debug?
       end
 
       def stop_server
-        return if process_exited?
-
         connect_to_server do |http|
           headers = WebDriver::Remote::Http::Common::DEFAULT_HEADERS.dup
           http.get('/shutdown', headers)

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

@@ -42,10 +42,10 @@ module Selenium
       def ==(other)
         other.is_a?(self.class) && ref == other.ref
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       def hash
-        @id.hash ^ @bridge.hash
+        [@id, @bridge].hash
       end
 
       #
@@ -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,11 +67,10 @@ 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}")
+        WebDriver.logger.debug("#{self}: #{e.message}", id: :driver_service)
         false
       end
 

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

@@ -93,13 +93,13 @@ 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
 
       def socket_writable?(sock)
-        IO.select(nil, [sock], nil, CONNECT_TIMEOUT)
+        sock.wait_writable(CONNECT_TIMEOUT)
       end
 
       def conn_completed?(sock)

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

@@ -0,0 +1,85 @@
+# 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.
+
+#
+# A credential stored in a virtual authenticator.
+# @see https://w3c.github.io/webauthn/#credential-parameters
+#
+
+module Selenium
+  module WebDriver
+    class Credential
+      class << self
+        def resident(**opts)
+          Credential.new(resident_credential: true, **opts)
+        end
+
+        def non_resident(**opts)
+          Credential.new(resident_credential: false, **opts)
+        end
+
+        def encode(byte_array)
+          Base64.urlsafe_encode64(byte_array&.pack('C*'))
+        end
+
+        def decode(base64)
+          Base64.urlsafe_decode64(base64).unpack('C*')
+        end
+
+        def from_json(opts)
+          user_handle = opts['userHandle'] ? decode(opts['userHandle']) : nil
+          new(id: decode(opts['credentialId']),
+              resident_credential: opts['isResidentCredential'],
+              rp_id: opts['rpId'],
+              private_key: opts['privateKey'],
+              sign_count: opts['signCount'],
+              user_handle: user_handle)
+        end
+      end
+
+      attr_reader :id, :resident_credential, :rp_id, :user_handle, :private_key, :sign_count
+      alias resident_credential? resident_credential
+
+      def initialize(id:, resident_credential:, rp_id:, private_key:, **opts)
+        @id = id
+        @resident_credential = resident_credential
+        @rp_id = rp_id
+        @user_handle = opts.delete(:user_handle) { nil }
+        @private_key = private_key
+        @sign_count = opts.delete(:sign_count) { 0 }
+
+        raise ArgumentError, "Invalid arguments: #{opts.keys}" unless opts.empty?
+      end
+
+      #
+      # @api private
+      #
+
+      def as_json(*)
+        credential_data = {'credentialId' => Credential.encode(id),
+                           'isResidentCredential' => resident_credential?,
+                           'rpId' => rp_id,
+                           'privateKey' => Credential.encode(private_key),
+                           'signCount' => sign_count}
+        credential_data['userHandle'] = Credential.encode(user_handle) if user_handle
+        credential_data
+      end
+    end # Credential
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    class VirtualAuthenticator
+      attr_reader :options
+
+      #
+      # api private
+      # Use `Driver#add_virtual_authenticator`
+      #
+
+      def initialize(bridge, authenticator_id, options)
+        @id = authenticator_id
+        @bridge = bridge
+        @options = options
+        @valid = true
+      end
+
+      def add_credential(credential)
+        credential = credential.as_json
+        @bridge.add_credential credential, @id
+      end
+
+      def credentials
+        credential_data = @bridge.credentials @id
+        credential_data.map do |cred|
+          Credential.from_json(cred)
+        end
+      end
+
+      def remove_credential(credential_id)
+        credential_id = Credential.encode(credential_id) if credential_id.instance_of?(Array)
+        @bridge.remove_credential credential_id, @id
+      end
+
+      def remove_all_credentials
+        @bridge.remove_all_credentials @id
+      end
+
+      def user_verified=(verified)
+        @bridge.user_verified verified, @id
+      end
+
+      def remove!
+        @bridge.remove_virtual_authenticator(@id)
+        @valid = false
+      end
+
+      def valid?
+        @valid
+      end
+    end # VirtualAuthenticator
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,62 @@
+# 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.
+
+#
+# Options for the creation of virtual authenticators.
+# @see http://w3c.github.io/webauthn/#sctn-automation
+#
+
+module Selenium
+  module WebDriver
+    class VirtualAuthenticatorOptions
+      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 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
+
+      #
+      # @api private
+      #
+
+      def as_json(*)
+        {'protocol' => PROTOCOL[protocol],
+         'transport' => TRANSPORT[transport],
+         'hasResidentKey' => resident_key?,
+         'hasUserVerification' => user_verification?,
+         'isUserConsenting' => user_consenting?,
+         'isUserVerified' => user_verified?}
+      end
+    end # VirtualAuthenticatorOptions
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,164 @@
+# 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 '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
+
+      MAX_LOG_MESSAGE_SIZE = 9999
+
+      def initialize(url:)
+        @callback_threads = ThreadGroup.new
+
+        @session_id = nil
+        @url = url
+
+        process_handshake
+        @socket_thread = attach_socket_listener
+      end
+
+      def close
+        @callback_threads.list.each(&:exit)
+        @socket_thread.exit
+        socket.close
+      end
+
+      def callbacks
+        @callbacks ||= Hash.new { |callbacks, event| callbacks[event] = [] }
+      end
+
+      def send_cmd(**payload)
+        id = next_id
+        data = payload.merge(id: id)
+        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)
+
+        wait.until { messages.delete(id) }
+      end
+
+      private
+
+      # We should be thread-safe to use the hash without synchronization
+      # because its keys are WebSocket message identifiers and they should be
+      # unique within a devtools session.
+      def messages
+        @messages ||= {}
+      end
+
+      def process_handshake
+        socket.print(ws.to_s)
+        ws << socket.readpartial(1024)
+      end
+
+      def attach_socket_listener
+        Thread.new do
+          Thread.current.abort_on_exception = true
+          Thread.current.report_on_exception = false
+
+          until socket.eof?
+            incoming_frame << socket.readpartial(1024)
+
+            while (frame = incoming_frame.next)
+              message = process_frame(frame)
+              next unless message['method']
+
+              params = message['params']
+              callbacks[message['method']].each do |callback|
+                @callback_threads.add(callback_thread(params, &callback))
+              end
+            end
+          end
+        rescue *CONNECTION_ERRORS
+          Thread.stop
+        end
+      end
+
+      def incoming_frame
+        @incoming_frame ||= WebSocket::Frame::Incoming::Client.new(version: ws.version)
+      end
+
+      def process_frame(frame)
+        message = frame.to_s
+
+        # Firefox will periodically fail on unparsable empty frame
+        return {} if message.empty?
+
+        message = JSON.parse(message)
+        messages[message['id']] = message
+        WebDriver.logger.debug "WebSocket <- #{message}"[...MAX_LOG_MESSAGE_SIZE], id: :bidi
+
+        message
+      end
+
+      def callback_thread(params)
+        Thread.new do
+          Thread.current.abort_on_exception = true
+
+          # We might end up blocked forever when we have an error in event.
+          # For example, if network interception event raises error,
+          # the browser will keep waiting for the request to be proceeded
+          # before returning back to the original thread. In this case,
+          # we should at least print the error.
+          Thread.current.report_on_exception = true
+
+          yield params
+        rescue Error::WebDriverError, *CONNECTION_ERRORS
+          Thread.stop
+        end
+      end
+
+      def wait
+        @wait ||= Wait.new(timeout: RESPONSE_WAIT_TIMEOUT, interval: RESPONSE_WAIT_INTERVAL)
+      end
+
+      def socket
+        @socket ||= if URI(@url).scheme == 'wss'
+                      socket = TCPSocket.new(ws.host, ws.port)
+                      socket = OpenSSL::SSL::SSLSocket.new(socket, OpenSSL::SSL::SSLContext.new)
+                      socket.sync_close = true
+                      socket.connect
+
+                      socket
+                    else
+                      TCPSocket.new(ws.host, ws.port)
+                    end
+      end
+
+      def ws
+        @ws ||= WebSocket::Handshake::Client.new(url: @url)
+      end
+
+      def next_id
+        @id ||= 0
+        @id += 1
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium

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

@@ -36,8 +36,8 @@ module Selenium
 
       def size=(dimension)
         unless dimension.respond_to?(:width) && dimension.respond_to?(:height)
-          raise ArgumentError, "expected #{dimension.inspect}:#{dimension.class}" \
-                               ' to respond to #width and #height'
+          raise ArgumentError, "expected #{dimension.inspect}:#{dimension.class} " \
+                               'to respond to #width and #height'
         end
 
         @bridge.resize_window dimension.width, dimension.height
@@ -61,8 +61,8 @@ module Selenium
 
       def position=(point)
         unless point.respond_to?(:x) && point.respond_to?(:y)
-          raise ArgumentError, "expected #{point.inspect}:#{point.class}" \
-                               ' to respond to #x and #y'
+          raise ArgumentError, "expected #{point.inspect}:#{point.class} " \
+                               'to respond to #x and #y'
         end
 
         @bridge.reposition_window point.x, point.y
@@ -86,8 +86,8 @@ module Selenium
 
       def rect=(rectangle)
         unless %w[x y width height].all? { |val| rectangle.respond_to? val }
-          raise ArgumentError, "expected #{rectangle.inspect}:#{rectangle.class}" \
-                               ' to respond to #x, #y, #width, and #height'
+          raise ArgumentError, "expected #{rectangle.inspect}:#{rectangle.class} " \
+                               'to respond to #x, #y, #width, and #height'
         end
 
         @bridge.set_window_rect(x: rectangle.x,