capybara 3.8.1 → 3.33.0

data/lib/capybara/selenium/driver.rb

@@ -4,29 +4,55 @@ require 'uri'
 require 'English'
 
 class Capybara::Selenium::Driver < Capybara::Driver::Base
+  include Capybara::Selenium::Find
+
   DEFAULT_OPTIONS = {
     browser: :firefox,
-    clear_local_storage: false,
-    clear_session_storage: false
+    clear_local_storage: nil,
+    clear_session_storage: nil
   }.freeze
-  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage].freeze
+  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze
   attr_reader :app, :options
 
-  def self.load_selenium
-    require 'selenium-webdriver'
-    warn "Warning: You're using an unsupported version of selenium-webdriver, please upgrade." if Gem.loaded_specs['selenium-webdriver'].version < Gem::Version.new('3.5.0')
-  rescue LoadError => err
-    raise err if err.message !~ /selenium-webdriver/
-    raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
+  class << self
+    def load_selenium
+      require 'selenium-webdriver'
+      require 'capybara/selenium/logger_suppressor'
+      require 'capybara/selenium/patches/atoms'
+      require 'capybara/selenium/patches/is_displayed'
+      require 'capybara/selenium/patches/action_pauser'
+      if Gem.loaded_specs['selenium-webdriver'].version < Gem::Version.new('3.5.0')
+        warn "Warning: You're using an unsupported version of selenium-webdriver, please upgrade."
+      end
+    rescue LoadError => e
+      raise e unless e.message.match?(/selenium-webdriver/)
+
+      raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
+    end
+
+    attr_reader :specializations
+
+    def register_specialization(browser_name, specialization)
+      @specializations ||= {}
+      @specializations[browser_name] = specialization
+    end
   end
 
   def browser
-    @browser ||= begin
-      processed_options = options.reject { |key, _val| SPECIAL_OPTIONS.include?(key) }
-      Selenium::WebDriver.for(options[:browser], processed_options).tap do |driver|
-        specialize_driver(driver)
-        setup_exit_handler
+    unless @browser
+      options[:http_client] ||= begin
+        require 'capybara/selenium/patches/persistent_client'
+        if options[:timeout]
+          ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])
+        else
+          ::Capybara::Selenium::PersistentClient.new
+        end
       end
+      processed_options = options.reject { |key, _val| SPECIAL_OPTIONS.include?(key) }
+      @browser = Selenium::WebDriver.for(options[:browser], processed_options)
+
+      specialize_driver
+      setup_exit_handler
     end
     @browser
   end
@@ -59,6 +85,8 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def html
     browser.page_source
+  rescue Selenium::WebDriver::Error::JavascriptError => e
+    raise unless e.message.match?(/documentElement is null/)
   end
 
   def title
@@ -69,14 +97,6 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     browser.current_url
   end
 
-  def find_xpath(selector)
-    browser.find_elements(:xpath, selector).map(&method(:build_node))
-  end
-
-  def find_css(selector)
-    browser.find_elements(:css, selector).map(&method(:build_node))
-  end
-
   def wait?; true; end
   def needs_server?; true; end
 
@@ -106,37 +126,34 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     navigated = false
     timer = Capybara::Helpers.timer(expire_in: 10)
     begin
-      unless navigated
-        # Only trigger a navigation if we haven't done it already, otherwise it
-        # can trigger an endless series of unload modals
-        clear_browser_state
-        @browser.navigate.to('about:blank')
-      end
+      # Only trigger a navigation if we haven't done it already, otherwise it
+      # can trigger an endless series of unload modals
+      reset_browser_state unless navigated
       navigated = true
-
       # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload
-      until find_xpath('/html/body/*').empty?
-        raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?
-        sleep 0.05
-      end
-    rescue Selenium::WebDriver::Error::UnhandledAlertError, Selenium::WebDriver::Error::UnexpectedAlertOpenError
+      wait_for_empty_page(timer)
+    rescue *unhandled_alert_errors
       # This error is thrown if an unhandled alert is on the page
       # Firefox appears to automatically dismiss this alert, chrome does not
       # We'll try to accept it
-      begin
-        @browser.switch_to.alert.accept
-        sleep 0.25 # allow time for the modal to be handled
-      rescue modal_error
-        # The alert is now gone.
-        # If navigation has not occurred attempt again and accept alert
-        # since FF may have dismissed the alert at first attempt.
-        navigate_with_accept('about:blank') if current_url != 'about:blank'
-      end
+      accept_unhandled_reset_alert
       # try cleaning up the browser again
       retry
     end
   end
 
+  def frame_obscured_at?(x:, y:)
+    frame = @frame_handles[current_window_handle].last
+    return false unless frame
+
+    switch_to_frame(:parent)
+    begin
+      frame.base.obscured?(x: x, y: y)
+    ensure
+      switch_to_frame(frame)
+    end
+  end
+
   def switch_to_frame(frame)
     handles = @frame_handles[current_window_handle]
     case frame
@@ -147,7 +164,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
       handles.pop
       browser.switch_to.parent_frame
     else
-      handles << frame.native
+      handles << frame
       browser.switch_to.frame(frame.native)
     end
   end
@@ -184,6 +201,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def close_window(handle)
     raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first
+
     within_given_window(handle) do
       browser.close
     end
@@ -193,7 +211,10 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     browser.window_handles
   end
 
-  def open_new_window
+  def open_new_window(kind = :tab)
+    browser.manage.new_window(kind)
+  rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError
+    # If not supported by the driver or browser default to using JS
     browser.execute_script('window.open();')
   end
 
@@ -203,7 +224,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def accept_modal(_type, **options)
     yield if block_given?
-    modal = find_modal(options)
+    modal = find_modal(**options)
 
     modal.send_keys options[:with] if options[:with]
 
@@ -214,7 +235,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def dismiss_modal(_type, **options)
     yield if block_given?
-    modal = find_modal(options)
+    modal = find_modal(**options)
     message = modal.text
     modal.dismiss
     message
@@ -222,31 +243,39 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def quit
     @browser&.quit
-  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED # rubocop:disable Lint/HandleExceptions
+  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED
     # Browser must have already gone
-  rescue Selenium::WebDriver::Error::UnknownError => err
-    unless silenced_unknown_error_message?(err.message) # Most likely already gone
+  rescue Selenium::WebDriver::Error::UnknownError => e
+    unless silenced_unknown_error_message?(e.message) # Most likely already gone
       # probably already gone but not sure - so warn
-      warn "Ignoring Selenium UnknownError during driver quit: #{err.message}"
+      warn "Ignoring Selenium UnknownError during driver quit: #{e.message}"
     end
   ensure
     @browser = nil
   end
 
   def invalid_element_errors
-    [
-      ::Selenium::WebDriver::Error::StaleElementReferenceError,
-      ::Selenium::WebDriver::Error::UnhandledError,
-      ::Selenium::WebDriver::Error::ElementNotVisibleError,
-      ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around a race condition that can occur with chromedriver and #go_back/#go_forward
-      ::Selenium::WebDriver::Error::ElementNotInteractableError,
-      ::Selenium::WebDriver::Error::ElementClickInterceptedError,
-      ::Selenium::WebDriver::Error::InvalidElementStateError,
-      ::Selenium::WebDriver::Error::ElementNotSelectableError,
-      ::Selenium::WebDriver::Error::ElementNotSelectableError,
-      ::Selenium::WebDriver::Error::NoSuchElementError, # IE
-      ::Selenium::WebDriver::Error::InvalidArgumentError # IE
-    ]
+    @invalid_element_errors ||= begin
+      [
+        ::Selenium::WebDriver::Error::StaleElementReferenceError,
+        ::Selenium::WebDriver::Error::ElementNotInteractableError,
+        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition
+        ::Selenium::WebDriver::Error::ElementClickInterceptedError,
+        ::Selenium::WebDriver::Error::NoSuchElementError, # IE
+        ::Selenium::WebDriver::Error::InvalidArgumentError # IE
+      ].tap do |errors|
+        unless selenium_4?
+          ::Selenium::WebDriver.logger.suppress_deprecations do
+            errors.concat [
+              ::Selenium::WebDriver::Error::UnhandledError,
+              ::Selenium::WebDriver::Error::ElementNotVisibleError,
+              ::Selenium::WebDriver::Error::InvalidElementStateError,
+              ::Selenium::WebDriver::Error::ElementNotSelectableError
+            ]
+          end
+        end
+      end
+    end
   end
 
   def no_such_window_error
@@ -255,29 +284,56 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
 private
 
+  def selenium_4?
+    defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)
+  end
+
   def native_args(args)
     args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }
   end
 
   def clear_browser_state
-    @browser.manage.delete_all_cookies
+    delete_all_cookies
     clear_storage
-  rescue Selenium::WebDriver::Error::UnhandledError # rubocop:disable Lint/HandleExceptions
+  rescue *clear_browser_state_errors
     # delete_all_cookies fails when we've previously gone
     # to about:blank, so we rescue this error and do nothing
     # instead.
   end
 
+  def clear_browser_state_errors
+    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError]
+  end
+
+  def unhandled_alert_errors
+    @unhandled_alert_errors ||= with_legacy_error(
+      [Selenium::WebDriver::Error::UnexpectedAlertOpenError],
+      'UnhandledAlertError'
+    )
+  end
+
+  def delete_all_cookies
+    @browser.manage.delete_all_cookies
+  end
+
   def clear_storage
-    clear_session_storage if options[:clear_session_storage]
-    clear_local_storage if options[:clear_local_storage]
+    clear_session_storage unless options[:clear_session_storage] == false
+    clear_local_storage unless options[:clear_local_storage] == false
+  rescue Selenium::WebDriver::Error::JavascriptError
+    # session/local storage may not be available if on non-http pages (e.g. about:blank)
   end
 
   def clear_session_storage
     if @browser.respond_to? :session_storage
       @browser.session_storage.clear
     else
-      warn 'sessionStorage clear requested but is not available for this driver'
+      begin
+        @browser&.execute_script('window.sessionStorage.clear()')
+      rescue # rubocop:disable Style/RescueStandardError
+        unless options[:clear_session_storage].nil?
+          warn 'sessionStorage clear requested but is not supported by this driver'
+        end
+      end
     end
   end
 
@@ -285,7 +341,13 @@ private
     if @browser.respond_to? :local_storage
       @browser.local_storage.clear
     else
-      warn 'localStorage clear requested but is not available for this driver'
+      begin
+        @browser&.execute_script('window.localStorage.clear()')
+      rescue # rubocop:disable Style/RescueStandardError
+        unless options[:clear_local_storage].nil?
+          warn 'localStorage clear requested but is not supported by this driver'
+        end
+      end
     end
   end
 
@@ -293,7 +355,7 @@ private
     @browser.navigate.to(url)
     sleep 0.1 # slight wait for alert
     @browser.switch_to.alert.accept
-  rescue modal_error # rubocop:disable Lint/HandleExceptions
+  rescue modal_error
     # alert now gone, should mean navigation happened
   end
 
@@ -323,16 +385,35 @@ private
     begin
       wait.until do
         alert = @browser.switch_to.alert
-        regexp = text.is_a?(Regexp) ? text : Regexp.escape(text.to_s)
-        alert.text.match(regexp) ? alert : nil
+        regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))
+        matched = alert.text.match?(regexp)
+        unless matched
+          raise Capybara::ModalNotFound, "Unable to find modal dialog with #{text} - found '#{alert.text}' instead."
+        end
+
+        alert
       end
-    rescue Selenium::WebDriver::Error::TimeOutError
+    rescue *find_modal_errors
       raise Capybara::ModalNotFound, "Unable to find modal dialog#{" with #{text}" if text}"
     end
   end
 
+  def find_modal_errors
+    @find_modal_errors ||= with_legacy_error([Selenium::WebDriver::Error::TimeoutError], 'TimeOutError')
+  end
+
+  def with_legacy_error(errors, legacy_error)
+    errors.tap do |errs|
+      unless selenium_4?
+        ::Selenium::WebDriver.logger.suppress_deprecations do
+          errs << Selenium::WebDriver::Error.const_get(legacy_error)
+        end
+      end
+    end
+  end
+
   def silenced_unknown_error_message?(msg)
-    silenced_unknown_error_messages.any? { |regex| msg =~ regex }
+    silenced_unknown_error_messages.any? { |regex| msg.match? regex }
   end
 
   def silenced_unknown_error_messages
@@ -344,7 +425,7 @@ private
     when Array
       arg.map { |arr| unwrap_script_result(arr) }
     when Hash
-      arg.each { |key, value| arg[key] = unwrap_script_result(value) }
+      arg.transform_values! { |value| unwrap_script_result(value) }
     when Selenium::WebDriver::Element
       build_node(arg)
     else
@@ -352,17 +433,22 @@ private
     end
   end
 
-  def build_node(native_node)
-    ::Capybara::Selenium::Node.new(self, native_node)
+  def find_context
+    browser
+  end
+
+  def build_node(native_node, initial_cache = {})
+    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)
+  end
+
+  def bridge
+    browser.send(:bridge)
   end
 
-  def specialize_driver(sel_driver)
-    case sel_driver.browser
-    when :chrome
-      extend ChromeDriver
-    when :firefox
-      require 'capybara/selenium/patches/pause_duration_fix' if sel_driver.capabilities['moz:geckodriverVersion']&.start_with?('0.22.')
-      extend MarionetteDriver if sel_driver.capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
+  def specialize_driver
+    browser_type = browser.browser
+    Capybara::Selenium::Driver.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality
+      extend specialization
     end
   end
 
@@ -375,7 +461,38 @@ private
       exit @exit_status if @exit_status # Force exit with stored status
     end
   end
+
+  def reset_browser_state
+    clear_browser_state
+    @browser.navigate.to('about:blank')
+  end
+
+  def wait_for_empty_page(timer)
+    until find_xpath('/html/body/*').empty?
+      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?
+
+      sleep 0.01
+
+      # It has been observed that it is possible that asynchronous JS code in
+      # the application under test can navigate the browser away from about:blank
+      # if the timing is just right. Ensure we are still at about:blank...
+      @browser.navigate.to('about:blank') unless current_url == 'about:blank'
+    end
+  end
+
+  def accept_unhandled_reset_alert
+    @browser.switch_to.alert.accept
+    sleep 0.25 # allow time for the modal to be handled
+  rescue modal_error
+    # The alert is now gone.
+    # If navigation has not occurred attempt again and accept alert
+    # since FF may have dismissed the alert at first attempt.
+    navigate_with_accept('about:blank') if current_url != 'about:blank'
+  end
 end
 
 require 'capybara/selenium/driver_specializations/chrome_driver'
-require 'capybara/selenium/driver_specializations/marionette_driver'
+require 'capybara/selenium/driver_specializations/firefox_driver'
+require 'capybara/selenium/driver_specializations/internet_explorer_driver'
+require 'capybara/selenium/driver_specializations/safari_driver'
+require 'capybara/selenium/driver_specializations/edge_driver'

data/lib/capybara/selenium/driver_specializations/chrome_driver.rb

@@ -1,28 +1,35 @@
 # frozen_string_literal: true
 
 require 'capybara/selenium/nodes/chrome_node'
+require 'capybara/selenium/patches/logs'
 
 module Capybara::Selenium::Driver::ChromeDriver
+  def self.extended(base)
+    bridge = base.send(:bridge)
+    bridge.extend Capybara::Selenium::ChromeLogs unless bridge.respond_to?(:log)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    base.options[:native_displayed] = false if base.options[:native_displayed].nil?
+  end
+
   def fullscreen_window(handle)
     within_given_window(handle) do
-      begin
-        super
-      rescue NoMethodError => err
-        raise unless err.message =~ /full_screen_window/
-        bridge = browser.send(:bridge)
-        result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
-        result['value']
-      end
+      super
+    rescue NoMethodError => e
+      raise unless e.message.match?(/full_screen_window/)
+
+      result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
+      result['value']
     end
   end
 
   def resize_window_to(handle, width, height)
     super
-  rescue Selenium::WebDriver::Error::UnknownError => err
-    raise unless err.message =~ /failed to change window state/
+  rescue Selenium::WebDriver::Error::UnknownError => e
+    raise unless e.message.match?(/failed to change window state/)
+
     # Chromedriver doesn't wait long enough for state to change when coming out of fullscreen
     # and raises unnecessary error. Wait a bit and try again.
-    sleep 0.5
+    sleep 0.25
     super
   end
 
@@ -32,12 +39,79 @@ module Capybara::Selenium::Driver::ChromeDriver
 
     switch_to_window(window_handles.first)
     window_handles.slice(1..-1).each { |win| close_window(win) }
-    super
+    return super if chromedriver_version < 73
+
+    timer = Capybara::Helpers.timer(expire_in: 10)
+    begin
+      clear_storage unless uniform_storage_clear?
+      @browser.navigate.to('about:blank')
+      wait_for_empty_page(timer)
+    rescue *unhandled_alert_errors
+      accept_unhandled_reset_alert
+      retry
+    end
+
+    execute_cdp('Storage.clearDataForOrigin', origin: '*', storageTypes: storage_types_to_clear)
   end
 
 private
 
-  def build_node(native_node)
-    ::Capybara::Selenium::ChromeNode.new(self, native_node)
+  def storage_types_to_clear
+    types = ['cookies']
+    types << 'local_storage' if clear_all_storage?
+    types.join(',')
+  end
+
+  def clear_all_storage?
+    storage_clears.none? false
+  end
+
+  def uniform_storage_clear?
+    storage_clears.uniq { |s| s == false }.length <= 1
+  end
+
+  def storage_clears
+    options.values_at(:clear_session_storage, :clear_local_storage)
+  end
+
+  def clear_storage
+    # Chrome errors if attempt to clear storage on about:blank
+    # In W3C mode it crashes chromedriver
+    url = current_url
+    super unless url.nil? || url.start_with?('about:')
+  end
+
+  def delete_all_cookies
+    execute_cdp('Network.clearBrowserCookies')
+  rescue *cdp_unsupported_errors
+    # If the CDP clear isn't supported do original limited clear
+    super
+  end
+
+  def cdp_unsupported_errors
+    @cdp_unsupported_errors ||= [Selenium::WebDriver::Error::WebDriverError]
+  end
+
+  def execute_cdp(cmd, params = {})
+    if browser.respond_to? :execute_cdp
+      browser.execute_cdp(cmd, **params)
+    else
+      args = { cmd: cmd, params: params }
+      result = bridge.http.call(:post, "session/#{bridge.session_id}/goog/cdp/execute", args)
+      result['value']
+    end
+  end
+
+  def build_node(native_node, initial_cache = {})
+    ::Capybara::Selenium::ChromeNode.new(self, native_node, initial_cache)
+  end
+
+  def chromedriver_version
+    @chromedriver_version ||= begin
+      caps = browser.capabilities
+      caps['chrome']&.fetch('chromedriverVersion', nil).to_f
+    end
   end
 end
+
+Capybara::Selenium::Driver.register_specialization :chrome, Capybara::Selenium::Driver::ChromeDriver