selenium-webdriver 4.0.0.beta2 → 4.0.0.rc2

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,27 @@ module Selenium
       #
 
       def property(name)
-        bridge.element_property self, name
+        bridge.element_property @id, name
+      end
+
+      #
+      # Gets the computed WAI-ARIA role of element
+      #
+      # @return [String]
+      #
+
+      def aria_role
+        bridge.element_aria_role @id
+      end
+
+      #
+      # Gets the computed WAI-ARIA label of element.
+      #
+      # @return [String]
+      #
+
+      def accessible_name
+        bridge.element_aria_label @id
       end
 
       #
@@ -297,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  --------------------------------
 
       #
@@ -316,14 +346,13 @@ module Selenium
       #
       alias_method :[], :attribute
 
-      #
-      # for SearchContext and execute_script
       #
       # @api private
+      # @see SearchContext
       #
 
       def ref
-        @id
+        [:element, @id]
       end
 
       #
@@ -359,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
 
@@ -109,12 +111,11 @@ module Selenium
       def as_json(*)
         options = @options.dup
 
-        w3c_options = options.select { |key, _val| W3C_OPTIONS.include?(key) }
-        options.delete_if { |key, _val| W3C_OPTIONS.include?(key) }
+        w3c_options = process_w3c_options(options)
 
         self.class::CAPABILITIES.each do |capability_alias, capability_name|
           capability_value = options.delete(capability_alias)
-          options[capability_name] = capability_value unless capability_value.nil?
+          options[capability_name] = capability_value if !capability_value.nil? && !options.key?(capability_name)
         end
         browser_options = defined?(self.class::KEY) ? {self.class::KEY => options} : options
 
@@ -124,6 +125,17 @@ 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?(key) }
+        w3c_options[:unhandled_prompt_behavior] &&= w3c_options[:unhandled_prompt_behavior]&.to_s&.tr('_', ' ')
+        options.delete_if { |key, _val| w3c?(key) }
+        w3c_options
+      end
+
       def process_browser_options(_browser_options)
         nil
       end
@@ -134,12 +146,7 @@ module Selenium
 
       def generate_as_json(value, camelize_keys: true)
         if value.is_a?(Hash)
-          value.each_with_object({}) do |(key, val), hash|
-            next if val.respond_to?(:empty?) && val.empty?
-
-            key = convert_json_key(key, camelize: camelize_keys)
-            hash[key] = generate_as_json(val, camelize_keys: camelize?(key))
-          end
+          process_json_hash(value, camelize_keys)
         elsif value.respond_to?(:as_json)
           value.as_json
         elsif value.is_a?(Array)
@@ -151,6 +158,16 @@ module Selenium
         end
       end
 
+      def process_json_hash(value, camelize_keys)
+        value.each_with_object({}) do |(key, val), hash|
+          next if val.respond_to?(:empty?) && val.empty?
+
+          camelize = camelize_keys ? camelize?(key) : false
+          key = convert_json_key(key, camelize: camelize)
+          hash[key] = generate_as_json(val, camelize_keys: camelize)
+        end
+      end
+
       def convert_json_key(key, camelize: true)
         key = key.to_s if key.is_a?(Symbol)
         key = camel_case(key) if camelize
@@ -162,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/proxy.rb

@@ -141,10 +141,10 @@ module Selenium
 
       def as_json(*)
         json_result = {
-          'proxyType' => TYPES[type],
+          'proxyType' => TYPES[type].downcase,
           'ftpProxy' => ftp,
           'httpProxy' => http,
-          'noProxy' => no_proxy,
+          'noProxy' => no_proxy.is_a?(String) ? no_proxy.split(', ') : no_proxy,
           'proxyAutoconfigUrl' => pac,
           'sslProxy' => ssl,
           'autodetect' => auto_detect,

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,37 +65,26 @@ module Selenium
         arr << Errno::EALREADY if Platform.wsl?
       }.freeze
 
-      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
+      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
 
       def socket_writable?(sock)

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

@@ -24,38 +24,41 @@ module Selenium
     #
     module TakesScreenshot
       #
-      # Save a PNG screenshot to the given path
+      # Save a PNG screenshot of the viewport to the given path
       #
       # @api public
       #
 
-      def save_screenshot(png_path)
+      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",
                                 id: :screenshot
         end
-        File.open(png_path, 'wb') { |f| f << screenshot_as(:png) }
+        File.open(png_path, 'wb') { |f| f << screenshot_as(:png, full_page: full_page) }
       end
 
       #
       # Return a PNG screenshot in the given format as a string
       #
       # @param [:base64, :png] format
+      # @param [Boolean] full_page allows taking full page screenshots if supported
       # @return String screenshot
       #
       # @api public
 
-      def screenshot_as(format)
+      def screenshot_as(format, full_page: false)
         case format
         when :base64
-          screenshot
+          full_page ? full_screenshot : screenshot
         when :png
-          screenshot.unpack1('m')
+          screenshot_as(:base64, full_page: full_page).unpack1('m')
         else
           raise Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
         end
+      rescue NameError
+        raise Error::UnsupportedOperationError, "Full Page Screenshots are not supported for #{inspect}"
       end
 
     end # TakesScreenshot

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

@@ -44,6 +44,34 @@ module Selenium
         @bridge.switch_to_parent_frame
       end
 
+      #
+      # Switch to a new top-level browsing context
+      #
+      # @param type either :tab or :window
+      #
+
+      def new_window(type = :window)
+        unless %i[window tab].include?(type)
+          raise ArgumentError, "Valid types are :tab and :window, received: #{type.inspect}"
+        end
+
+        handle = @bridge.new_window(type)['handle']
+
+        if block_given?
+          execute_and_close = proc do
+            yield(self)
+            begin
+              @bridge.close
+            rescue Error::NoSuchWindowError
+              # window already closed
+            end
+          end
+          window(handle, &execute_and_close)
+        else
+          window(handle)
+        end
+      end
+
       #
       # switch to the given window handle
       #

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

@@ -19,10 +19,6 @@
 
 module Selenium
   module WebDriver
-    #
-    # @api beta This API may be changed or removed in a future release.
-    #
-
     class Window
       #
       # @api private

data/lib/selenium/webdriver/common.rb

@@ -58,18 +58,26 @@ require 'selenium/webdriver/common/driver_extensions/has_remote_status'
 require 'selenium/webdriver/common/driver_extensions/has_network_conditions'
 require 'selenium/webdriver/common/driver_extensions/has_network_connection'
 require 'selenium/webdriver/common/driver_extensions/has_network_interception'
+require 'selenium/webdriver/common/driver_extensions/has_apple_permissions'
 require 'selenium/webdriver/common/driver_extensions/has_permissions'
 require 'selenium/webdriver/common/driver_extensions/has_debugger'
+require 'selenium/webdriver/common/driver_extensions/has_context'
 require 'selenium/webdriver/common/driver_extensions/prints_page'
 require 'selenium/webdriver/common/driver_extensions/uploads_files'
+require 'selenium/webdriver/common/driver_extensions/full_page_screenshot'
 require 'selenium/webdriver/common/driver_extensions/has_addons'
 require 'selenium/webdriver/common/driver_extensions/has_devtools'
 require 'selenium/webdriver/common/driver_extensions/has_authentication'
 require 'selenium/webdriver/common/driver_extensions/has_logs'
 require 'selenium/webdriver/common/driver_extensions/has_log_events'
+require 'selenium/webdriver/common/driver_extensions/has_pinned_scripts'
+require 'selenium/webdriver/common/driver_extensions/has_cdp'
+require 'selenium/webdriver/common/driver_extensions/has_casting'
+require 'selenium/webdriver/common/driver_extensions/has_launching'
 require 'selenium/webdriver/common/keys'
 require 'selenium/webdriver/common/profile_helper'
 require 'selenium/webdriver/common/options'
 require 'selenium/webdriver/common/takes_screenshot'
 require 'selenium/webdriver/common/driver'
 require 'selenium/webdriver/common/element'
+require 'selenium/webdriver/common/shadow_root'

data/lib/selenium/webdriver/devtools/pinned_script.rb

@@ -0,0 +1,59 @@
+# 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 DevTools
+      class PinnedScript
+
+        attr_accessor :key, :devtools_identifier, :script
+
+        def initialize(script)
+          @key = SecureRandom.alphanumeric
+          @script = script
+        end
+
+        #
+        # @api private
+        #
+
+        def callable
+          "function __webdriver_#{key}(arguments) { #{script} }"
+        end
+
+        #
+        # @api private
+        #
+
+        def to_json(*)
+          %{"return __webdriver_#{key}(arguments)"}
+        end
+
+        #
+        # @api private
+        #
+
+        def remove
+          "__webdriver_#{key} = undefined"
+        end
+
+      end # PinnedScript
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/request.rb

@@ -22,33 +22,43 @@ module Selenium
     class DevTools
       class Request
 
-        attr_reader :url, :method, :headers
+        attr_accessor :url, :method, :headers, :post_data
+        attr_reader :id
 
-        def initialize(devtools:, id:, url:, method:, headers:)
-          @devtools = devtools
+        #
+        # Creates request from DevTools message.
+        # @api private
+        #
+
+        def self.from(id, params)
+          new(
+            id: id,
+            url: params.dig('request', 'url'),
+            method: params.dig('request', 'method'),
+            headers: params.dig('request', 'headers'),
+            post_data: params.dig('request', 'postData')
+          )
+        end
+
+        def initialize(id:, url:, method:, headers:, post_data:)
           @id = id
           @url = url
           @method = method
           @headers = headers
+          @post_data = post_data
         end
 
-        def continue
-          @devtools.fetch.continue_request(request_id: @id)
-        end
-
-        def respond(code: 200, headers: {}, body: '')
-          @devtools.fetch.fulfill_request(
-            request_id: @id,
-            body: Base64.strict_encode64(body),
-            response_code: code,
-            response_headers: headers.map do |k, v|
-              {name: k, value: v}
-            end
-          )
+        def ==(other)
+          self.class == other.class &&
+            id == other.id &&
+            url == other.url &&
+            method == other.method &&
+            headers == other.headers &&
+            post_data == other.post_data
         end
 
         def inspect
-          %(#<#{self.class.name} @method="#{method}" @url="#{url}")
+          %(#<#{self.class.name} @id="#{id}" @method="#{method}" @url="#{url}")
         end
 
       end # Request