selenium-webdriver 4.2.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5767633e16bd3296a248757bd01f157c6441a7780d3bcfd972a7c03f94237d54
-  data.tar.gz: 6e82108ff5bd955eeb68e2b7a8e23aa9c766d900f46bbb4e7d3a9475b00a7ceb
+  metadata.gz: 2be9fb14d69ce82170e3ddbe0cbcf2f2428e1978544d8a7c11191ebd37cf0241
+  data.tar.gz: 2e40d6ad67ccfb269ee1ae9d3f47d024e90081da9881f757f22170751875fa69
 SHA512:
-  metadata.gz: 792f2a87bb8c1f78c8e7fef7242d9b42026473e9fcb2c8a586e5d1af04188f0026b7b7e0c300b3d9cc3d709a8a7efe0dc6050edd69df1af3b1c397f40a1b0fd8
-  data.tar.gz: 840b9619f535ea1f67d603de69d88e5fcf8ca324a9198b68f9e418f1ebde25bae9d40cfda6c65c8fce9321ae21a84b88ef91c57ae99105a95d191dbf28f1f0e5
+  metadata.gz: b7f419d9b1349a1afbf68999eecaa53391503cc793026228577fbcb40ac4958a35c539286f7c4c3c913992336dc797481f7c57f6aec9d58813671e24d1cd09ad
+  data.tar.gz: '0093bd2d0fbb0c1c8e7abee9d1a632f80d458b1dc0d1b22635f403230ed7c40a2be498915d8abed40bd4992295a1444a69c3e653ebf1d4cf106886c8a9d5a499'

data/CHANGES

@@ -1,4 +1,43 @@
-4.2.0 (unreleased)
+4.4.0 (Unreleased)
+=========================
+
+BiDi:
+  * Released selenium-devtools 0.103.1 to fix websocket dependency requirement
+  * Released selenium-devtools 0.104.0 (supports CDP v85, v102, v103, v104)
+  * Have network interceptor ignore cancelled requests (#10856)
+  * Improve websocket message handling
+
+Chromium:
+  * Prevent users from setting w3c: false and warn for true (thanks Tamsil Amani!)
+
+Ruby:
+  * Implement Virtual Authenticator (#10903, #10541) (thanks Tamsil Amani!)
+
+4.3.0 (2022-06-23)
+=========================
+
+BiDi:
+  * Released selenium-devtools 0.103.0 (supports CDP v85, v101, v102, v103)
+
+Ruby:
+  * Allow specifying which button is clicked in pointer action class methods
+  * Remove deprecated `Persistent` http class
+  * Remove deprecated HasRemoteStatus module
+  * Remove deprecated `Manager#new_window` and `Manager#logs`
+  * `ActionBuilder#move_to` no longer attempts to move to top left corner of element
+  * Remove deprecated support for sending Service parameters directly to Driver constructor
+  * Remove deprecated setters and getters for driver path on Browser modules
+  * Remove deprecated support for passing in options argument to Options class
+  * Allow `:options` parameter to take `Options` instance argument like other languages
+  * Remove deprecated support for `:desired_capabilities` & `:options` with `Hash` argument
+
+4.2.1 (2022-05-31)
+=========================
+
+Ruby
+  * Fix bug in setting default duration in Actions constructor
+
+4.2.0 (2022-05-27)
 =========================
 
 BiDi:

data/lib/selenium/server.rb

@@ -92,7 +92,7 @@ module Selenium
             download_server(redirected, destination)
           end
         rescue StandardError
-          FileUtils.rm download_file_name if File.exist? download_file_name
+          FileUtils.rm_rf download_file_name
           raise
         end
 

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

@@ -227,6 +227,9 @@ module Selenium
 
           options = browser_options[self.class::KEY]
           options['binary'] ||= binary_path if binary_path
+
+          check_w3c(options[:w3c]) if options.key?(:w3c)
+
           if @profile
             options['args'] ||= []
             options['args'] << "--user-data-dir=#{@profile.directory}"
@@ -237,6 +240,17 @@ module Selenium
           options['extensions'] = @encoded_extensions + @extensions.map { |ext| encode_extension(ext) }
         end
 
+        def check_w3c(w3c)
+          if w3c
+            WebDriver.logger.warn("Setting 'w3c: true' is redundant and will no longer be allowed", id: :w3c)
+            return
+          end
+
+          raise Error::InvalidArgumentError,
+                "Setting 'w3c: false' is not allowed.\n" \
+                "Please update to W3C Syntax: https://www.selenium.dev/blog/2022/legacy-protocol-support/"
+        end
+
         def binary_path
           Chrome.path
         end

data/lib/selenium/webdriver/chrome.rb

@@ -28,20 +28,6 @@ module Selenium
       autoload :Options, 'selenium/webdriver/chrome/options'
       autoload :Service, 'selenium/webdriver/chrome/service'
 
-      def self.driver_path=(path)
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome#driver_path=',
-                                   'Selenium::WebDriver::Chrome::Service#driver_path=',
-                                   id: :driver_path
-        Selenium::WebDriver::Chrome::Service.driver_path = path
-      end
-
-      def self.driver_path
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome#driver_path',
-                                   'Selenium::WebDriver::Chrome::Service#driver_path',
-                                   id: :driver_path
-        Selenium::WebDriver::Chrome::Service.driver_path
-      end
-
       def self.path=(path)
         Platform.assert_executable path
         @path = path

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

@@ -248,6 +248,15 @@ module Selenium
         bridge.execute_async_script(script, *args)
       end
 
+      #
+      # @return [VirtualAuthenticator]
+      # @see VirtualAuthenticator
+      #
+
+      def add_virtual_authenticator(options)
+        bridge.add_virtual_authenticator(options)
+      end
+
       #-------------------------------- sugar  --------------------------------
 
       #
@@ -307,71 +316,29 @@ module Selenium
 
       attr_reader :bridge
 
-      def create_bridge(**opts)
-        opts[:url] ||= service_url(opts)
-        caps = opts.delete(:capabilities)
-        # NOTE: This is deprecated
-        cap_array = caps.is_a?(Hash) ? [caps] : Array(caps)
-
-        desired_capabilities = opts.delete(:desired_capabilities)
-        if desired_capabilities
-          WebDriver.logger.deprecate(':desired_capabilities as a parameter for driver initialization',
-                                     ':capabilities with an Array value of capabilities/options if necessary',
-                                     id: :desired_capabilities)
-          desired_capabilities = Remote::Capabilities.new(desired_capabilities) if desired_capabilities.is_a?(Hash)
-          cap_array << desired_capabilities
-        end
-
-        options = opts.delete(:options)
-        if options
-          WebDriver.logger.deprecate(':options as a parameter for driver initialization',
-                                     ':capabilities with an Array of value capabilities/options if necessary',
-                                     id: :browser_options)
-          cap_array << options
+      def create_bridge(capabilities: nil, options: nil, url: nil, service: nil, http_client: nil)
+        Remote::Bridge.new(http_client: http_client,
+                           url: url || service_url(service)).tap do |bridge|
+          generated_caps = options ? options.as_json : generate_capabilities(capabilities)
+          bridge.create_session(generated_caps)
         end
-
-        capabilities = generate_capabilities(cap_array)
-
-        bridge_opts = {http_client: opts.delete(:http_client), url: opts.delete(:url)}
-        raise ArgumentError, "Unable to create a driver with parameters: #{opts}" unless opts.empty?
-
-        bridge = Remote::Bridge.new(**bridge_opts)
-
-        bridge.create_session(capabilities)
-        bridge
       end
 
-      def generate_capabilities(cap_array)
-        cap_array.map { |cap|
+      def generate_capabilities(capabilities)
+        Array(capabilities).map { |cap|
           if cap.is_a? Symbol
             cap = Remote::Capabilities.send(cap)
-          elsif cap.is_a? Hash
-            new_message = 'Capabilities instance initialized with the Hash, or build values with Options class'
-            WebDriver.logger.deprecate("passing a Hash value to :capabilities",
-                                       new_message,
-                                       id: :capabilities_hash)
-            cap = Remote::Capabilities.new(cap)
           elsif !cap.respond_to? :as_json
             msg = ":capabilities parameter only accepts objects responding to #as_json which #{cap.class} does not"
             raise ArgumentError, msg
           end
-          cap&.as_json
+          cap.as_json
         }.inject(:merge) || Remote::Capabilities.send(browser || :new)
       end
 
-      def service_url(opts)
-        service_config = opts.delete(:service)
-        %i[driver_opts driver_path port].each do |key|
-          next unless opts.key? key
-
-          WebDriver.logger.deprecate(":#{key}", ':service with an instance of Selenium::WebDriver::Service',
-                                     id: "service_#{key}".to_sym)
-        end
-        service_config ||= Service.send(browser,
-                                        args: opts.delete(:driver_opts),
-                                        path: opts.delete(:driver_path),
-                                        port: opts.delete(:port))
-        @service = service_config.launch
+      def service_url(service)
+        service ||= Service.send(browser)
+        @service = service.launch
         @service.uri
       end
 

data/lib/selenium/webdriver/common/driver_extensions/has_network_interception.rb

@@ -61,75 +61,10 @@ module Selenium
         #
 
         def intercept(&block)
-          devtools.network.set_cache_disabled(cache_disabled: true)
-          devtools.fetch.on(:request_paused) do |params|
-            id = params['requestId']
-            if params.key?('responseStatusCode') || params.key?('responseErrorReason')
-              intercept_response(id, params, &pending_response_requests.delete(id))
-            else
-              intercept_request(id, params, &block)
-            end
-          end
-          devtools.fetch.enable(patterns: [{requestStage: 'Request'}, {requestStage: 'Response'}])
+          @interceptor ||= DevTools::NetworkInterceptor.new(devtools)
+          @interceptor.intercept(&block)
         end
 
-        private
-
-        def pending_response_requests
-          @pending_response_requests ||= {}
-        end
-
-        def intercept_request(id, params, &block)
-          original = DevTools::Request.from(id, params)
-          mutable = DevTools::Request.from(id, params)
-
-          block.call(mutable) do |&continue| # rubocop:disable Performance/RedundantBlockCall
-            pending_response_requests[id] = continue
-
-            if original == mutable
-              devtools.fetch.continue_request(request_id: id)
-            else
-              devtools.fetch.continue_request(
-                request_id: id,
-                url: mutable.url,
-                method: mutable.method,
-                post_data: mutable.post_data,
-                headers: mutable.headers.map do |k, v|
-                  {name: k, value: v}
-                end
-              )
-            end
-          end
-        end
-
-        def intercept_response(id, params)
-          return devtools.fetch.continue_request(request_id: id) unless block_given?
-
-          body = fetch_response_body(id)
-          original = DevTools::Response.from(id, body, params)
-          mutable = DevTools::Response.from(id, body, params)
-          yield mutable
-
-          if original == mutable
-            devtools.fetch.continue_request(request_id: id)
-          else
-            devtools.fetch.fulfill_request(
-              request_id: id,
-              body: (Base64.strict_encode64(mutable.body) if mutable.body),
-              response_code: mutable.code,
-              response_headers: mutable.headers.map do |k, v|
-                {name: k, value: v}
-              end
-            )
-          end
-        end
-
-        def fetch_response_body(id)
-          devtools.fetch.get_response_body(request_id: id).dig('result', 'body')
-        rescue Error::WebDriverError
-          # CDP fails to get body on certain responses (301) and raises:
-          # Can only get response body on requests captured after headers received.
-        end
       end # HasNetworkInterception
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/interactions/pointer_actions.rb

@@ -28,7 +28,7 @@ module Selenium
       #
 
       def default_move_duration
-        @default_move_duration ||= @duration / 1000 # convert ms to seconds
+        @default_move_duration ||= @duration / 1000.0 # convert ms to seconds
       end
 
       #
@@ -68,9 +68,8 @@ module Selenium
       end
 
       #
-      # Moves the pointer to the middle of the given element.
-      # its location is calculated using getBoundingClientRect.
-      # Then the pointer is moved to optional offset coordinates from the element.
+      # Moves the pointer to the in-view center point of the given element.
+      # Then the pointer is moved to optional offset coordinates.
       #
       # The element is not scrolled into view.
       # MoveTargetOutOfBoundsError will be raised if element with offset is outside the viewport
@@ -88,32 +87,19 @@ module Selenium
       #   driver.action.move_to(el, 100, 100).perform
       #
       # @param [Selenium::WebDriver::Element] element to move to.
-      # @param [Integer] right_by Optional offset from the top-left corner. A negative value means
-      #   coordinates to the left of the element.
-      # @param [Integer] down_by Optional offset from the top-left corner. A negative value means
-      #   coordinates above the element.
+      # @param [Integer] right_by Optional offset from the in-view center of the
+      #   element. A negative value means coordinates to the left of the center.
+      # @param [Integer] down_by Optional offset from the in-view center of the
+      #   element. A negative value means coordinates to the top of the center.
       # @param [Symbol || String] device optional name of the PointerInput device to move.
       # @return [ActionBuilder] A self reference.
       #
 
       def move_to(element, right_by = nil, down_by = nil, device: nil, duration: default_move_duration, **opts)
         pointer = pointer_input(device)
-        if right_by || down_by
-          WebDriver.logger.warn("moving to an element with offset currently tries to use
-the top left corner of the element as the origin; in Selenium 4.3 it will use the in-view
-center point of the element as the origin.")
-          size = element.size
-          left_offset = (size[:width] / 2).to_i
-          top_offset = (size[:height] / 2).to_i
-          left = -left_offset + (right_by || 0)
-          top = -top_offset + (down_by || 0)
-        else
-          left = 0
-          top = 0
-        end
         pointer.create_pointer_move(duration: duration,
-                                    x: left,
-                                    y: top,
+                                    x: right_by || 0,
+                                    y: down_by || 0,
                                     origin: element,
                                     **opts)
         tick(pointer)
@@ -192,9 +178,9 @@ center point of the element as the origin.")
       # @return [ActionBuilder] A self reference.
       #
 
-      def click_and_hold(element = nil, device: nil)
+      def click_and_hold(element = nil, button: nil, device: nil)
         move_to(element, device: device) if element
-        pointer_down(:left, device: device)
+        pointer_down(button || :left, device: device)
         self
       end
 
@@ -211,8 +197,8 @@ center point of the element as the origin.")
       # @return [ActionBuilder] A self reference.
       #
 
-      def release(device: nil)
-        pointer_up(:left, device: device)
+      def release(button: nil, device: nil)
+        pointer_up(button || :left, device: device)
         self
       end
 
@@ -238,10 +224,10 @@ center point of the element as the origin.")
       # @return [ActionBuilder] A self reference.
       #
 
-      def click(element = nil, device: nil)
+      def click(element = nil, button: nil, device: nil)
         move_to(element, device: device) if element
-        pointer_down(:left, device: device)
-        pointer_up(:left, device: device)
+        pointer_down(button || :left, device: device)
+        pointer_up(button || :left, device: device)
         self
       end
 
@@ -296,10 +282,7 @@ center point of the element as the origin.")
       #
 
       def context_click(element = nil, device: nil)
-        move_to(element, device: device) if element
-        pointer_down(:right, device: device)
-        pointer_up(:right, device: device)
-        self
+        click(element, button: :right, device: device)
       end
 
       #

data/lib/selenium/webdriver/common/interactions/wheel_actions.rb

@@ -28,7 +28,7 @@ module Selenium
       #
 
       def default_scroll_duration
-        @default_scroll_duration ||= @duration / 1000 # convert ms to seconds
+        @default_scroll_duration ||= @duration / 1000.0 # convert ms to seconds
       end
 
       #

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

@@ -104,33 +104,6 @@ module Selenium
         @timeouts ||= Timeouts.new(@bridge)
       end
 
-      def logs
-        WebDriver.logger.deprecate('Manager#logs', 'Chrome::Driver#logs')
-        @logs ||= Logs.new(@bridge)
-      end
-
-      #
-      # @param type [Symbol] Supports two values: :tab and :window.
-      # @return [String] The value of the window handle
-      #
-      def new_window(type = :tab)
-        WebDriver.logger.deprecate('Manager#new_window', 'TargetLocator#new_window', id: :new_window) do
-          'e.g., `driver.switch_to.new_window(:tab)`'
-        end
-        case type
-        when :tab, :window
-          result = @bridge.new_window(type)
-          unless result.key?('handle')
-            raise UnknownError, "the driver did not return a handle. " \
-                                "The returned result: #{result.inspect}"
-          end
-          result['handle']
-        else
-          raise ArgumentError, "invalid argument for type. Got: '#{type.inspect}'. " \
-                               "Try :tab or :window"
-        end
-      end
-
       def window
         @window ||= Window.new(@bridge)
       end

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

@@ -66,17 +66,10 @@ module Selenium
 
       attr_accessor :options
 
-      def initialize(options: nil, **opts)
+      def initialize(**opts)
         self.class.set_capabilities
 
-        @options = if options
-                     WebDriver.logger.deprecate(":options as keyword for initializing #{self.class}",
-                                                "custom values directly in #new constructor",
-                                                id: :options_options)
-                     opts.merge(options)
-                   else
-                     opts
-                   end
+        @options = opts
         @options[:browser_name] = self.class::BROWSER
       end
 

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

@@ -32,7 +32,7 @@ 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. "\
+          WebDriver.logger.warn "name used for saved screenshot does not match file type. " \
                                 "It should end with .png extension",
                                 id: :screenshot
         end

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

@@ -0,0 +1,83 @@
+# 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_method :resident_credential?, :resident_credential
+
+      def initialize(id:, resident_credential:, rp_id:, private_key:, user_handle: nil, sign_count: 0)
+        @id = id
+        @resident_credential = resident_credential
+        @rp_id = rp_id
+        @user_handle = user_handle
+        @private_key = private_key
+        @sign_count = sign_count
+      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,73 @@
+# 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