selenium-webdriver 4.0.0.beta4 → 4.0.0

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

@@ -112,8 +112,7 @@ module Selenium
 
           devtools.runtime.add_binding(name: '__webdriver_attribute')
           execute_script(mutation_listener)
-          script = devtools.page.add_script_to_evaluate_on_new_document(source: mutation_listener)
-          pinned_scripts[mutation_listener] = script['identifier']
+          devtools.page.add_script_to_evaluate_on_new_document(source: mutation_listener)
 
           devtools.runtime.on(:binding_called, &method(:log_mutation_event))
         end
@@ -139,10 +138,6 @@ module Selenium
           @mutation_listener ||= read_atom(:mutationListener)
         end
 
-        def pinned_scripts
-          @pinned_scripts ||= {}
-        end
-
       end # HasLogEvents
     end # DriverExtensions
   end # WebDriver

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

@@ -38,13 +38,30 @@ module Selenium
         # @param [Hash] conditions
         # @option conditions [Integer] :latency
         # @option conditions [Integer] :throughput
+        # @option conditions [Integer] :upload_throughput
+        # @option conditions [Integer] :download_throughput
         # @option conditions [Boolean] :offline
         #
 
         def network_conditions=(conditions)
+          conditions[:latency] ||= 0
+          unless conditions.key?(:throughput)
+            conditions[:download_throughput] ||= -1
+            conditions[:upload_throughput] ||= -1
+          end
+          conditions[:offline] = false unless conditions.key?(:offline)
+
           @bridge.network_conditions = conditions
         end
 
+        #
+        # Resets Chromium network emulation settings.
+        #
+
+        def delete_network_conditions
+          @bridge.delete_network_conditions
+        end
+
       end # HasNetworkConditions
     end # DriverExtensions
   end # WebDriver

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

@@ -28,39 +28,108 @@ module Selenium
         # a stubbed response instead.
         #
         # @example Log requests and pass through
-        #   driver.intercept do |request|
+        #   driver.intercept do |request, &continue|
         #     puts "#{request.method} #{request.url}"
-        #     request.continue
+        #     continue.call(request)
         #   end
         #
-        # @example Stub response for image requests
-        #   driver.intercept do |request|
+        # @example Stub requests for images
+        #   driver.intercept do |request, &continue|
         #     if request.url.match?(/\.png$/)
-        #       request.respond(body: File.read('myfile.png'))
-        #     else
-        #       request.continue
+        #       request.url = 'https://upload.wikimedia.org/wikipedia/commons/d/d5/Selenium_Logo.png'
         #     end
+        #     continue.call(request)
         #   end
         #
-        # @param [#call] block which is called when request is interecepted
-        # @yieldparam [DevTools::Request]
+        # @example Log responses and pass through
+        #   driver.intercept do |request, &continue|
+        #     continue.call(request) do |response|
+        #       puts "#{response.code} #{response.body}"
+        #     end
+        #   end
+        #
+        # @example Mutate specific response
+        #   driver.intercept do |request, &continue|
+        #     continue.call(request) do |response|
+        #       response.body << 'Added by Selenium!' if request.url.include?('/myurl')
+        #     end
+        #   end
+        #
+        # @param [Proc] block which is called when request is intercepted
+        # @yieldparam [DevTools::Request] request
+        # @yieldparam [Proc] continue block which proceeds with the request and optionally yields response
         #
 
-        def intercept
+        def intercept(&block)
           devtools.network.set_cache_disabled(cache_disabled: true)
           devtools.fetch.on(:request_paused) do |params|
-            request = DevTools::Request.new(
-              devtools: devtools,
-              id: params['requestId'],
-              url: params.dig('request', 'url'),
-              method: params.dig('request', 'method'),
-              headers: params.dig('request', 'headers')
+            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'}])
+        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
             )
-            yield request
           end
-          devtools.fetch.enable
         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/driver_extensions/has_permissions.rb

@@ -23,26 +23,26 @@ module Selenium
       module HasPermissions
 
         #
-        # Returns permissions.
+        # Set one permission.
         #
-        # @return [Hash]
+        # @param [String] name which permission to set
+        # @param [String] value what to set the permission to
         #
 
-        def permissions
-          @bridge.permissions
+        def add_permission(name, value)
+          @bridge.set_permission(name, value)
         end
 
         #
-        # Sets permissions.
+        # Set multiple permissions.
         #
-        # @example
-        #   driver.permissions = {'getUserMedia' => true}
-        #
-        # @param [Hash<Symbol, Boolean>] permissions
+        # @param [Hash] opt key/value pairs to set permissions
         #
 
-        def permissions=(permissions)
-          @bridge.permissions = permissions
+        def add_permissions(opt)
+          opt.each do |key, value|
+            @bridge.set_permission(key, value)
+          end
         end
 
       end # HasPermissions

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

@@ -0,0 +1,77 @@
+# 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
+    module DriverExtensions
+      module HasPinnedScripts
+
+        #
+        # Returns the list of all pinned scripts.
+        #
+        # @return [Array<DevTools::PinnedScript>]
+        #
+
+        def pinned_scripts
+          @pinned_scripts ||= []
+        end
+
+        #
+        # Pins JavaScript snippet that is available during the whole
+        # session on every page. This allows to store and call
+        # scripts without sending them over the wire every time.
+        #
+        # @example
+        #   script = driver.pin_script('return window.location.href')
+        #   driver.execute_script(script)
+        #   # navigate to a new page
+        #   driver.execute_script(script)
+        #
+        # @param [String] script
+        # @return [DevTools::PinnedScript]
+        #
+
+        def pin_script(script)
+          script = DevTools::PinnedScript.new(script)
+          pinned_scripts << script
+
+          devtools.page.enable
+          devtools.runtime.evaluate(expression: script.callable)
+          response = devtools.page.add_script_to_evaluate_on_new_document(source: script.callable)
+          script.devtools_identifier = response.dig('result', 'identifier')
+
+          script
+        end
+
+        #
+        # Unpins script making it undefined for the subsequent calls.
+        #
+        # @param [DevTools::PinnedScript]
+        #
+
+        def unpin_script(script)
+          devtools.runtime.evaluate(expression: script.remove)
+          devtools.page.remove_script_to_evaluate_on_new_document(identifier: script.devtools_identifier)
+          pinned_scripts.delete(script)
+        end
+
+      end # HasPinnedScripts
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

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

@@ -34,7 +34,7 @@ module Selenium
 
         def save_print_page(path, **options)
           File.open(path, 'wb') do |file|
-            content = Base64.decode64 print_page(options)
+            content = Base64.decode64 print_page(**options)
             file << content
           end
         end

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

@@ -143,7 +143,7 @@ module Selenium
       #
 
       def dom_attribute(name)
-        bridge.element_dom_attribute self, name
+        bridge.element_dom_attribute @id, name
       end
 
       #
@@ -157,7 +157,7 @@ module Selenium
       #
 
       def property(name)
-        bridge.element_property self, name
+        bridge.element_property @id, name
       end
 
       #
@@ -167,7 +167,7 @@ module Selenium
       #
 
       def aria_role
-        bridge.element_aria_role self
+        bridge.element_aria_role @id
       end
 
       #
@@ -177,7 +177,7 @@ module Selenium
       #
 
       def accessible_name
-        bridge.element_aria_label self
+        bridge.element_aria_label @id
       end
 
       #
@@ -317,6 +317,16 @@ module Selenium
         bridge.element_size @id
       end
 
+      #
+      # Returns the shadow root of an element.
+      #
+      # @return [WebDriver::ShadowRoot]
+      #
+
+      def shadow_root
+        bridge.shadow_root @id
+      end
+
       #-------------------------------- sugar  --------------------------------
 
       #
@@ -336,14 +346,13 @@ module Selenium
       #
       alias_method :[], :attribute
 
-      #
-      # for SearchContext and execute_script
       #
       # @api private
+      # @see SearchContext
       #
 
       def ref
-        @id
+        [:element, @id]
       end
 
       #
@@ -379,7 +388,7 @@ module Selenium
       end
 
       def screenshot
-        bridge.element_screenshot(self)
+        bridge.element_screenshot(@id)
       end
     end # Element
   end # WebDriver

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

@@ -61,6 +61,12 @@ module Selenium
 
       class StaleElementReferenceError < WebDriverError; end
 
+      #
+      # A command failed because the referenced shadow root is no longer attached to the DOM.
+      #
+
+      class DetachedShadowRootError < WebDriverError; end
+
       #
       # The target element is in an invalid state, rendering it impossible to interact with, for
       # example if you click a disabled element.
@@ -93,6 +99,12 @@ module Selenium
 
       class NoSuchWindowError < WebDriverError; end
 
+      #
+      # The element does not have a shadow root.
+      #
+
+      class NoSuchShadowRootError < WebDriverError; end
+
       #
       # An illegal attempt was made to set a cookie under a different domain than the current page.
       #

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

@@ -30,14 +30,14 @@ module Selenium
 
       def as_json(*)
         {
-          'level' => level,
           'timestamp' => timestamp,
+          'level' => level,
           'message' => message
         }
       end
 
       def to_s
-        "#{level} #{time}: #{message}"
+        "#{time} #{level}: #{message}"
       end
 
       def time

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

@@ -104,25 +104,19 @@ module Selenium
         @timeouts ||= Timeouts.new(@bridge)
       end
 
-      #
-      # @api beta This API may be changed or removed in a future release.
-      #
-
       def logs
         WebDriver.logger.deprecate('Manager#logs', 'Chrome::Driver#logs')
         @logs ||= Logs.new(@bridge)
       end
 
       #
-      # Create a new top-level browsing context
-      # https://w3c.github.io/webdriver/#new-window
       # @param type [Symbol] Supports two values: :tab and :window.
-      #  Use :tab if you'd like the new window to share an OS-level window
-      #  with the current browsing context.
-      #  Use :window otherwise
       # @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)
@@ -137,10 +131,6 @@ module Selenium
         end
       end
 
-      #
-      # @api beta This API may be changed or removed in a future release.
-      #
-
       def window
         @window ||= Window.new(@bridge)
       end

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

@@ -21,7 +21,8 @@ module Selenium
   module WebDriver
     class Options
       W3C_OPTIONS = %i[browser_name browser_version platform_name accept_insecure_certs page_load_strategy proxy
-                       set_window_rect timeouts unhandled_prompt_behavior strict_file_interactability].freeze
+                       set_window_rect timeouts unhandled_prompt_behavior strict_file_interactability
+                       web_socket_url].freeze
 
       class << self
         attr_reader :driver_path
@@ -90,7 +91,8 @@ module Selenium
       # @param [Boolean, String, Integer] value Value of the option
       #
 
-      def add_option(name, value)
+      def add_option(name, value = nil)
+        @options[name.keys.first] = name.values.first if value.nil? && name.is_a?(Hash)
         @options[name] = value
       end
 
@@ -123,10 +125,14 @@ module Selenium
 
       private
 
+      def w3c?(key)
+        W3C_OPTIONS.include?(key) || key.to_s.include?(':')
+      end
+
       def process_w3c_options(options)
-        w3c_options = options.select { |key, _val| W3C_OPTIONS.include?(key) }
+        w3c_options = options.select { |key, _val| w3c?(key) }
         w3c_options[:unhandled_prompt_behavior] &&= w3c_options[:unhandled_prompt_behavior]&.to_s&.tr('_', ' ')
-        options.delete_if { |key, _val| W3C_OPTIONS.include?(key) }
+        options.delete_if { |key, _val| w3c?(key) }
         w3c_options
       end
 
@@ -173,6 +179,8 @@ module Selenium
       def camel_case(str)
         str.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
       end
-    end # Options
+    end
+
+    # Options
   end # WebDriver
 end # Selenium

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

@@ -0,0 +1,87 @@
+# 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 ShadowRoot
+      ROOT_KEY = 'shadow-6066-11e4-a52e-4f735466cecf'
+
+      include SearchContext
+
+      #
+      # Creates a new shadow root
+      #
+      # @api private
+      #
+
+      def initialize(bridge, id)
+        @bridge = bridge
+        @id = id
+      end
+
+      def inspect
+        format '#<%<class>s:0x%<hash>x id=%<id>s>', class: self.class, hash: hash * 2, id: @id.inspect
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && ref == other.ref
+      end
+      alias_method :eql?, :==
+
+      def hash
+        @id.hash ^ @bridge.hash
+      end
+
+      #
+      # @api private
+      # @see SearchContext
+      #
+
+      def ref
+        [:shadow_root, @id]
+      end
+
+      #
+      # Convert to a ShadowRoot JSON Object for transmission over the wire.
+      # @see https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#basic-terms-and-concepts
+      #
+      # @api private
+      #
+
+      def to_json(*)
+        JSON.generate as_json
+      end
+
+      #
+      # For Rails 3 - http://jonathanjulian.com/2010/04/rails-to_json-or-as_json/
+      #
+      # @api private
+      #
+
+      def as_json(*)
+        {ROOT_KEY => @id}
+      end
+
+      private
+
+      attr_reader :bridge
+
+    end # ShadowRoot
+  end # WebDriver
+end # Selenium

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

@@ -65,26 +65,37 @@ module Selenium
         arr << Errno::EALREADY if Platform.wsl?
       }.freeze
 
-      def listening?
-        addr     = Socket.getaddrinfo(@host, @port, Socket::AF_INET, Socket::SOCK_STREAM)
-        sock     = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
-        sockaddr = Socket.pack_sockaddr_in(@port, addr[0][3])
-
-        begin
-          sock.connect_nonblock sockaddr
-        rescue Errno::EINPROGRESS
-          retry if socket_writable?(sock) && conn_completed?(sock)
-          raise Errno::ECONNREFUSED
-        rescue *CONNECTED_ERRORS
-          # yay!
+      if Platform.jruby?
+        # we use a plain TCPSocket here since JRuby has issues closing socket
+        # see https://github.com/jruby/jruby/issues/5709
+        def listening?
+          TCPSocket.new(@host, @port).close
+          true
+        rescue *NOT_CONNECTED_ERRORS
+          false
+        end
+      else
+        def listening?
+          addr     = Socket.getaddrinfo(@host, @port, Socket::AF_INET, Socket::SOCK_STREAM)
+          sock     = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+          sockaddr = Socket.pack_sockaddr_in(@port, addr[0][3])
+
+          begin
+            sock.connect_nonblock sockaddr
+          rescue Errno::EINPROGRESS
+            retry if socket_writable?(sock) && conn_completed?(sock)
+            raise Errno::ECONNREFUSED
+          rescue *CONNECTED_ERRORS
+            # yay!
+          end
+
+          sock.close
+          true
+        rescue *NOT_CONNECTED_ERRORS
+          sock&.close
+          WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}")
+          false
         end
-
-        sock.close
-        true
-      rescue *NOT_CONNECTED_ERRORS
-        sock&.close
-        WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}")
-        false
       end
 
       def socket_writable?(sock)