selenium-webdriver 4.0.0.beta3 → 4.0.0.rc3

data/lib/selenium/webdriver/devtools.rb

@@ -20,21 +20,34 @@
 module Selenium
   module WebDriver
     class DevTools
+      RESPONSE_WAIT_TIMEOUT = 30
+      RESPONSE_WAIT_INTERVAL = 0.1
+
       autoload :ConsoleEvent, 'selenium/webdriver/devtools/console_event'
       autoload :ExceptionEvent, 'selenium/webdriver/devtools/exception_event'
       autoload :MutationEvent, 'selenium/webdriver/devtools/mutation_event'
+      autoload :PinnedScript, 'selenium/webdriver/devtools/pinned_script'
       autoload :Request, 'selenium/webdriver/devtools/request'
+      autoload :Response, 'selenium/webdriver/devtools/response'
 
       def initialize(url:)
+        @callback_threads = ThreadGroup.new
+
         @messages = []
         @session_id = nil
         @url = url
 
         process_handshake
-        attach_socket_listener
+        @socket_thread = attach_socket_listener
         start_session
       end
 
+      def close
+        @callback_threads.list.each(&:exit)
+        @socket_thread.exit
+        socket.close
+      end
+
       def callbacks
         @callbacks ||= Hash.new { |callbacks, event| callbacks[event] = [] }
       end
@@ -84,27 +97,24 @@ module Selenium
       end
 
       def attach_socket_listener
-        socket_listener = Thread.new do
+        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)
-              # Firefox will periodically fail on unparsable empty frame
-              break if frame.to_s.empty?
-
-              message = JSON.parse(frame.to_s)
-              @messages << message
-              WebDriver.logger.debug "DevTools <- #{message}"
+              message = process_frame(frame)
               next unless message['method']
 
+              params = message['params']
               callbacks[message['method']].each do |callback|
-                params = message['params'] # take in current thread!
-                Thread.new { callback.call(params) }
+                @callback_threads.add(callback_thread(params, &callback))
               end
             end
           end
         end
-        socket_listener.abort_on_exception = true
       end
 
       def start_session
@@ -118,8 +128,36 @@ module Selenium
         @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
+        WebDriver.logger.debug "DevTools <- #{message}"
+
+        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
+        end
+      end
+
       def wait
-        @wait ||= Wait.new(timeout: 10, interval: 0.1)
+        @wait ||= Wait.new(timeout: RESPONSE_WAIT_TIMEOUT, interval: RESPONSE_WAIT_INTERVAL)
       end
 
       def socket

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

@@ -27,6 +27,11 @@ module Selenium
         include WebDriver::Chrome::Features
 
         EDGE_COMMANDS = {
+          get_cast_sinks: [:get, 'session/:session_id/ms/cast/get_sinks'],
+          set_cast_sink_to_use: [:post, 'session/:session_id/ms/cast/set_sink_to_use'],
+          start_cast_tab_mirroring: [:post, 'session/:session_id/ms/cast/start_tab_mirroring'],
+          get_cast_issue_message: [:get, 'session/:session_id/ms/cast/get_issue_message'],
+          stop_casting: [:post, 'session/:session_id/ms/cast/stop_casting'],
           send_command: [:post, 'session/:session_id/ms/cdp/execute']
         }.freeze
 

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

@@ -28,6 +28,8 @@ module Selenium
 
       class Driver < WebDriver::Driver
         EXTENSIONS = [DriverExtensions::HasAddons,
+                      DriverExtensions::FullPageScreenshot,
+                      DriverExtensions::HasContext,
                       DriverExtensions::HasDevTools,
                       DriverExtensions::HasLogEvents,
                       DriverExtensions::HasNetworkInterception,
@@ -41,6 +43,10 @@ module Selenium
         private
 
         def devtools_url
+          if capabilities['moz:debuggerAddress'].nil?
+            raise(Error::WebDriverError, "DevTools is not supported by this version of Firefox; use v85 or higher")
+          end
+
           uri = URI("http://#{capabilities['moz:debuggerAddress']}")
           response = Net::HTTP.get(uri.hostname, '/json/version', uri.port)
 

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

@@ -23,8 +23,11 @@ module Selenium
       module Features
 
         FIREFOX_COMMANDS = {
+          get_context: [:get, 'session/:session_id/moz/context'],
+          set_context: [:post, 'session/:session_id/moz/context'],
           install_addon: [:post, 'session/:session_id/moz/addon/install'],
-          uninstall_addon: [:post, 'session/:session_id/moz/addon/uninstall']
+          uninstall_addon: [:post, 'session/:session_id/moz/addon/uninstall'],
+          full_page_screenshot: [:get, 'session/:session_id/moz/screenshot/full']
         }.freeze
 
         def commands(command)
@@ -32,6 +35,11 @@ module Selenium
         end
 
         def install_addon(path, temporary)
+          if @file_detector
+            local_file = @file_detector.call(path)
+            path = upload(local_file) if local_file
+          end
+
           payload = {path: path}
           payload[:temporary] = temporary unless temporary.nil?
           execute :install_addon, {}, payload
@@ -41,6 +49,17 @@ module Selenium
           execute :uninstall_addon, {}, {id: id}
         end
 
+        def full_screenshot
+          execute :full_page_screenshot
+        end
+
+        def context=(context)
+          execute :set_context, {}, {context: context}
+        end
+
+        def context
+          execute :get_context
+        end
       end # Bridge
     end # Firefox
   end # WebDriver

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

@@ -29,7 +29,11 @@ module Selenium
         CAPABILITIES = {binary: 'binary',
                         args: 'args',
                         log: 'log',
-                        prefs: 'prefs'}.freeze
+                        prefs: 'prefs',
+                        android_package: 'androidPackage',
+                        android_activity: 'androidActivity',
+                        android_device_serial: 'androidDeviceSerial',
+                        android_intent_arguments: 'androidIntentArguments'}.freeze
         BROWSER = 'firefox'
 
         # NOTE: special handling of 'profile' to validate when set instead of when used
@@ -131,6 +135,25 @@ module Selenium
           @options[:log] = {level: level}
         end
 
+        #
+        # Enables mobile browser use on Android.
+        #
+        # @see https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions#android
+        #
+        # @param [String] package The package name of the Chrome or WebView app.
+        # @param [String] serial_number The serial number of the device on which to launch the application.
+        #   If not specified and multiple devices are attached, an error will be returned.
+        # @param [String] activity The fully qualified class name of the activity to be launched.
+        # @param [Array] intent_arguments Arguments to launch the intent with.
+        #
+
+        def enable_android(package: 'org.mozilla.firefox', serial_number: nil, activity: nil, intent_arguments: nil)
+          @options[:android_package] = package
+          @options[:android_activity] = activity unless activity.nil?
+          @options[:android_device_serial] = serial_number unless serial_number.nil?
+          @options[:android_intent_arguments] = intent_arguments unless intent_arguments.nil?
+        end
+
         private
 
         def process_browser_options(browser_options)

data/lib/selenium/webdriver/firefox.rb

@@ -33,7 +33,6 @@ module Selenium
       autoload :Service, 'selenium/webdriver/firefox/service'
 
       DEFAULT_PORT = 7055
-      DEFAULT_ENABLE_NATIVE_EVENTS = Platform.os == :windows
       DEFAULT_SECURE_SSL = false
       DEFAULT_ASSUME_UNTRUSTED_ISSUER = true
       DEFAULT_LOAD_NO_FOCUS_LIB = false

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

@@ -39,7 +39,9 @@ module Selenium
           persistent_hover: 'enablePersistentHover',
           require_window_focus: 'requireWindowFocus',
           use_per_process_proxy: 'ie.usePerProcessProxy',
-          validate_cookie_document_type: 'ie.validateCookieDocumentType'
+          use_legacy_file_upload_dialog_handling: 'ie.useLegacyFileUploadDialogHandling',
+          attach_to_edge_chrome: 'ie.edgechromium',
+          edge_executable_path: 'ie.edgepath'
         }.freeze
         BROWSER = 'internet explorer'
 

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

@@ -25,7 +25,7 @@ module Selenium
         EXECUTABLE = 'IEDriverServer'
         MISSING_TEXT = <<~ERROR
           Unable to find IEDriverServer. Please download the server from
-          http://selenium-release.storage.googleapis.com/index.html and place it somewhere on your PATH.
+          https://www.selenium.dev/downloads/ and place it somewhere on your PATH.
           More info at https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver.
         ERROR
         SHUTDOWN_SUPPORTED = true

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

@@ -25,7 +25,7 @@ module Selenium
 
         PORT = 4444
 
-        attr_accessor :context, :http, :file_detector
+        attr_accessor :http, :file_detector
         attr_reader :capabilities
 
         #
@@ -93,17 +93,16 @@ module Selenium
           execute :get, {}, {url: url}
         end
 
-        def implicit_wait_timeout=(milliseconds)
-          timeout('implicit', milliseconds)
-        end
+        #
+        # timeouts
+        #
 
-        def script_timeout=(milliseconds)
-          timeout('script', milliseconds)
+        def timeouts
+          execute :get_timeouts, {}
         end
 
-        def timeout(type, milliseconds)
-          type = 'pageLoad' if type == 'page load'
-          execute :set_timeout, {}, {type => milliseconds}
+        def timeouts=(timeouts)
+          execute :set_timeout, {}, timeouts
         end
 
         #
@@ -269,7 +268,7 @@ module Selenium
         end
 
         def element_screenshot(element)
-          execute :take_element_screenshot, id: element.ref
+          execute :take_element_screenshot, id: element
         end
 
         #
@@ -431,7 +430,7 @@ module Selenium
         end
 
         def submit_element(element)
-          form = find_element_by('xpath', "./ancestor-or-self::form", element)
+          form = find_element_by('xpath', "./ancestor-or-self::form", [:element, element])
           execute_script("var e = arguments[0].ownerDocument.createEvent('Event');" \
                             "e.initEvent('submit', true, true);" \
                             'if (arguments[0].dispatchEvent(e)) { arguments[0].submit() }', form.as_json)
@@ -451,19 +450,19 @@ module Selenium
         end
 
         def element_dom_attribute(element, name)
-          execute :get_element_attribute, id: element.ref, name: name
+          execute :get_element_attribute, id: element, name: name
         end
 
         def element_property(element, name)
-          execute :get_element_property, id: element.ref, name: name
+          execute :get_element_property, id: element, name: name
         end
 
         def element_aria_role(element)
-          execute :get_element_aria_role, id: element.ref
+          execute :get_element_aria_role, id: element
         end
 
         def element_aria_label(element)
-          execute :get_element_aria_label, id: element.ref
+          execute :get_element_aria_label, id: element
         end
 
         def element_value(element)
@@ -524,13 +523,17 @@ module Selenium
 
         alias_method :switch_to_active_element, :active_element
 
-        def find_element_by(how, what, parent = nil)
+        def find_element_by(how, what, parent_ref = [])
           how, what = convert_locator(how, what)
 
           return execute_atom(:findElements, Support::RelativeLocator.new(what).as_json).first if how == 'relative'
 
-          id = if parent
-                 execute :find_child_element, {id: parent}, {using: how, value: what.to_s}
+          parent_type, parent_id = parent_ref
+          id = case parent_type
+               when :element
+                 execute :find_child_element, {id: parent_id}, {using: how, value: what.to_s}
+               when :shadow_root
+                 execute :find_shadow_child_element, {id: parent_id}, {using: how, value: what.to_s}
                else
                  execute :find_element, {}, {using: how, value: what.to_s}
                end
@@ -538,13 +541,17 @@ module Selenium
           Element.new self, element_id_from(id)
         end
 
-        def find_elements_by(how, what, parent = nil)
+        def find_elements_by(how, what, parent_ref = [])
           how, what = convert_locator(how, what)
 
           return execute_atom :findElements, Support::RelativeLocator.new(what).as_json if how == 'relative'
 
-          ids = if parent
-                  execute :find_child_elements, {id: parent}, {using: how, value: what.to_s}
+          parent_type, parent_id = parent_ref
+          ids = case parent_type
+                when :element
+                  execute :find_child_elements, {id: parent_id}, {using: how, value: what.to_s}
+                when :shadow_root
+                  execute :find_shadow_child_elements, {id: parent_id}, {using: how, value: what.to_s}
                 else
                   execute :find_elements, {}, {using: how, value: what.to_s}
                 end
@@ -552,6 +559,11 @@ module Selenium
           ids.map { |id| Element.new self, element_id_from(id) }
         end
 
+        def shadow_root(element)
+          id = execute :get_element_shadow_root, id: element
+          ShadowRoot.new self, shadow_root_id_from(id)
+        end
+
         private
 
         #
@@ -599,11 +611,15 @@ module Selenium
         end
 
         def element_id_from(id)
-          id['ELEMENT'] || id['element-6066-11e4-a52e-4f735466cecf']
+          id['ELEMENT'] || id[Element::ELEMENT_KEY]
+        end
+
+        def shadow_root_id_from(id)
+          id[ShadowRoot::ROOT_KEY]
         end
 
         def prepare_capabilities_payload(capabilities)
-          capabilities = {firstMatch: [capabilities]} if !capabilities['alwaysMatch'] && !capabilities['firstMatch']
+          capabilities = {alwaysMatch: capabilities} if !capabilities['alwaysMatch'] && !capabilities['firstMatch']
           {capabilities: capabilities}
         end
 

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

@@ -39,6 +39,7 @@ module Selenium
           :timeouts,
           :unhandled_prompt_behavior,
           :strict_file_interactability,
+          :web_socket_url,
 
           # remote-specific (webdriver.remote.sessionid)
           :remote_session_id
@@ -46,7 +47,7 @@ module Selenium
 
         (KNOWN - %i[proxy timeouts]).each do |key|
           define_method key do
-            @capabilities.fetch(key)
+            @capabilities[key]
           end
 
           define_method "#{key}=" do |value|
@@ -202,7 +203,7 @@ module Selenium
         end
 
         def proxy
-          @capabilities.fetch(:proxy)
+          @capabilities[:proxy]
         end
 
         def proxy=(proxy)
@@ -307,23 +308,13 @@ module Selenium
           when :platform
             value.to_s.upcase
           when :proxy
-            convert_proxy(value)
+            value&.as_json
           when :unhandled_prompt_behavior
             value.is_a?(Symbol) ? value.to_s.tr('_', ' ') : value
           else
             value
           end
         end
-
-        def convert_proxy(value)
-          return unless value
-
-          hash = value.as_json
-          hash['proxyType'] &&= hash['proxyType'].downcase
-          hash['noProxy'] = hash['noProxy'].split(', ') if hash['noProxy'].is_a?(String)
-
-          hash
-        end
       end # Capabilities
     end # Remote
   end # WebDriver

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

@@ -77,7 +77,10 @@ module Selenium
           find_elements: [:post, 'session/:session_id/elements'],
           find_child_element: [:post, 'session/:session_id/element/:id/element'],
           find_child_elements: [:post, 'session/:session_id/element/:id/elements'],
+          find_shadow_child_element: [:post, 'session/:session_id/shadow/:id/element'],
+          find_shadow_child_elements: [:post, 'session/:session_id/shadow/:id/elements'],
           get_active_element: [:get, 'session/:session_id/element/active'],
+          get_element_shadow_root: [:get, 'session/:session_id/element/:id/shadow'],
           is_element_selected: [:get, 'session/:session_id/element/:id/selected'],
           get_element_attribute: [:get, 'session/:session_id/element/:id/attribute/:name'],
           get_element_property: [:get, 'session/:session_id/element/:id/property/:name'],
@@ -111,6 +114,7 @@ module Selenium
           # timeouts
           #
 
+          get_timeouts: [:get, 'session/:session_id/timeouts'],
           set_timeout: [:post, 'session/:session_id/timeouts'],
 
           #

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

@@ -42,6 +42,7 @@ module Selenium
           end
           opts[:url] ||= "http://#{Platform.localhost}:4444/wd/hub"
           super
+          @bridge.file_detector = ->((filename, *)) { File.exist?(filename) && filename.to_s }
         end
 
         private
@@ -51,7 +52,8 @@ module Selenium
         end
 
         def devtools_version
-          capabilities['se:cdpVersion'].split('.').first
+          capabilities['se:cdpVersion']&.split('.')&.first ||
+            raise(Error::WebDriverError, "DevTools is not supported by the Remote Server")
         end
       end # Driver
     end # Remote

data/lib/selenium/webdriver/remote.rb

@@ -18,6 +18,7 @@
 # under the License.
 
 require 'uri'
+require 'selenium/webdriver/remote/server_error'
 
 module Selenium
   module WebDriver
@@ -25,7 +26,6 @@ module Selenium
       autoload :Bridge, 'selenium/webdriver/remote/bridge'
       autoload :Driver, 'selenium/webdriver/remote/driver'
       autoload :Response, 'selenium/webdriver/remote/response'
-      autoload :ServerError, 'selenium/webdriver/remote/server_error'
       autoload :Capabilities, 'selenium/webdriver/remote/capabilities'
       autoload :COMMANDS, 'selenium/webdriver/remote/commands'
       module Http

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

@@ -28,7 +28,7 @@ module Selenium
 
       class Driver < WebDriver::Driver
         EXTENSIONS = [DriverExtensions::HasDebugger,
-                      DriverExtensions::HasPermissions,
+                      DriverExtensions::HasApplePermissions,
                       DriverExtensions::HasWebStorage].freeze
 
         def browser

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

@@ -28,6 +28,13 @@ module Selenium
                         automatic_profiling: 'safari:automaticProfiling'}.freeze
         BROWSER = 'safari'
 
+        def add_option(name, value = nil)
+          key = name.is_a?(Hash) ? name.keys.first : name
+          raise ArgumentError, 'Safari does not support options that are not namespaced' unless key.to_s.include?(':')
+
+          super
+        end
+
       end # Options
     end # Safari
   end # WebDriver

data/lib/selenium/webdriver/support/cdp/domain.rb.erb

@@ -0,0 +1,63 @@
+# 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.
+
+# This file is automatically generated. Any changes will be lost!
+module Selenium
+  module DevTools
+    module <%= version %>
+      class <%= domain[:domain] %>
+        <% if domain[:events] %>
+        EVENTS = {
+          <% domain[:events].each do |event| %>
+          <%= h.snake_case(event[:name]) %>: '<%= event[:name] %>',
+          <% end %>
+        }.freeze
+        <% end %>
+
+        def initialize(devtools)
+          @devtools = devtools
+        end
+
+        def on(event, &block)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @devtools.callbacks["<%= domain[:domain] %>.#{event}"] << block
+        end
+
+        <% domain[:commands].each do |command| %>
+        <% if command[:parameters] %>
+        def <%= h.snake_case(command[:name]) %>(<%= h.kwargs(command[:parameters]) %>)
+        <% else %>
+        def <%= h.snake_case(command[:name]) %>
+        <% end %>
+          <% if command[:parameters] %>
+          @devtools.send_cmd('<%= domain[:domain] %>.<%= command[:name] %>',
+            <% until command[:parameters].empty? %>
+              <% parameter = command[:parameters].shift %>
+                             <%= parameter[:name] %>: <%= h.snake_case(parameter[:name]) %><%= command[:parameters].empty? ? ')' : ',' %>
+            <% end %>
+          <% else %>
+          @devtools.send_cmd('<%= domain[:domain] %>.<%= command[:name] %>')
+          <% end %>
+        end
+
+        <% end %>
+      end # <%= domain[:domain] %>
+    end # <%= version %>
+  end # DevTools
+end # Selenium