selenium-webdriver 4.0.0.rc1 → 4.0.1

data/lib/selenium/webdriver/common.rb

@@ -58,8 +58,10 @@ 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'
@@ -70,6 +72,8 @@ 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'

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

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

@@ -0,0 +1,66 @@
+# 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 Response
+
+        attr_accessor :code, :body, :headers
+        attr_reader :id
+
+        #
+        # Creates response from DevTools message.
+        # @api private
+        #
+
+        def self.from(id, encoded_body, params)
+          new(
+            id: id,
+            code: params['responseStatusCode'],
+            body: (Base64.strict_decode64(encoded_body) if encoded_body),
+            headers: params['responseHeaders'].each_with_object({}) do |header, hash|
+              hash[header['name']] = header['value']
+            end
+          )
+        end
+
+        def initialize(id:, code:, body:, headers:)
+          @id = id
+          @code = code
+          @body = body
+          @headers = headers
+        end
+
+        def ==(other)
+          self.class == other.class &&
+            id == other.id &&
+            code == other.code &&
+            body == other.body &&
+            headers == other.headers
+        end
+
+        def inspect
+          %(#<#{self.class.name} @id="#{id}" @code="#{code}")
+        end
+
+      end # Response
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools.rb

@@ -20,22 +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
@@ -85,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
@@ -119,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

@@ -29,6 +29,7 @@ module Selenium
       class Driver < WebDriver::Driver
         EXTENSIONS = [DriverExtensions::HasAddons,
                       DriverExtensions::FullPageScreenshot,
+                      DriverExtensions::HasContext,
                       DriverExtensions::HasDevTools,
                       DriverExtensions::HasLogEvents,
                       DriverExtensions::HasNetworkInterception,
@@ -42,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,6 +23,8 @@ 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'],
           full_page_screenshot: [:get, 'session/:session_id/moz/screenshot/full']
@@ -33,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
@@ -46,6 +53,13 @@ module Selenium
           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)
@@ -150,6 +173,10 @@ module Selenium
                        Profile.from_name(profile)
                      end
         end
+
+        def camelize?(key)
+          key != :prefs
+        end
       end # Options
     end # Firefox
   end # WebDriver

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/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
 
         #
@@ -658,7 +657,7 @@ module Selenium
         # @see https://mathiasbynens.be/notes/css-escapes
         def escape_css(string)
           string = string.gsub(ESCAPE_CSS_REGEXP) { |match| "\\#{match}" }
-          string = "\\#{UNICODE_CODE_POINT + Integer(string[0])} #{string[1..-1]}" if string[0]&.match?(/[[:digit:]]/)
+          string = "\\#{UNICODE_CODE_POINT + Integer(string[0])} #{string[1..]}" if string[0]&.match?(/[[:digit:]]/)
 
           string
         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

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

@@ -114,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

@@ -52,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/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/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.0.0.rc1'
+    VERSION = '4.0.1'
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver.rb

@@ -23,6 +23,7 @@ require 'fileutils'
 require 'date'
 require 'json'
 require 'set'
+require 'uri'
 
 require 'selenium/webdriver/atoms'
 require 'selenium/webdriver/common'

data/selenium-webdriver.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   }
 
   s.required_rubygems_version = Gem::Requirement.new('> 1.3.1') if s.respond_to? :required_rubygems_version=
-  s.required_ruby_version = Gem::Requirement.new('>= 2.5')
+  s.required_ruby_version = Gem::Requirement.new('>= 2.6')
 
   s.files = [
     'CHANGES',
@@ -45,7 +45,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'childprocess', ['>= 0.5', '< 5.0']
-  s.add_runtime_dependency 'rexml', ['~> 3.2']
+  s.add_runtime_dependency 'rexml', ['~> 3.2', '>= 3.2.5']
   s.add_runtime_dependency 'rubyzip', ['>= 1.2.2']
 
   # childprocess requires ffi on windows but doesn't declare it in its dependencies

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-webdriver
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc1
+  version: 4.0.1
 platform: ruby
 authors:
 - Alex Rodionov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -39,6 +39,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -46,6 +49,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.5
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -252,10 +258,14 @@ files:
 - lib/selenium/webdriver/common/driver_extensions/downloads_files.rb
 - lib/selenium/webdriver/common/driver_extensions/full_page_screenshot.rb
 - lib/selenium/webdriver/common/driver_extensions/has_addons.rb
+- lib/selenium/webdriver/common/driver_extensions/has_apple_permissions.rb
 - lib/selenium/webdriver/common/driver_extensions/has_authentication.rb
+- lib/selenium/webdriver/common/driver_extensions/has_casting.rb
 - lib/selenium/webdriver/common/driver_extensions/has_cdp.rb
+- lib/selenium/webdriver/common/driver_extensions/has_context.rb
 - lib/selenium/webdriver/common/driver_extensions/has_debugger.rb
 - lib/selenium/webdriver/common/driver_extensions/has_devtools.rb
+- lib/selenium/webdriver/common/driver_extensions/has_launching.rb
 - lib/selenium/webdriver/common/driver_extensions/has_location.rb
 - lib/selenium/webdriver/common/driver_extensions/has_log_events.rb
 - lib/selenium/webdriver/common/driver_extensions/has_logs.rb
@@ -312,6 +322,7 @@ files:
 - lib/selenium/webdriver/devtools/mutation_event.rb
 - lib/selenium/webdriver/devtools/pinned_script.rb
 - lib/selenium/webdriver/devtools/request.rb
+- lib/selenium/webdriver/devtools/response.rb
 - lib/selenium/webdriver/edge.rb
 - lib/selenium/webdriver/edge/driver.rb
 - lib/selenium/webdriver/edge/features.rb
@@ -375,7 +386,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"