capybara 3.23.0 → 3.35.3

data/lib/capybara/selenium/logger_suppressor.rb

@@ -8,8 +8,14 @@ module Capybara
         super
       end
 
-      def deprecate(*)
-        super unless @suppress_for_capybara
+      def deprecate(*args, **opts, &block)
+        return if @suppress_for_capybara
+
+        if opts.empty?
+          super(*args, &block) # support Selenium 3
+        else
+          super
+        end
       end
 
       def suppress_deprecations

data/lib/capybara/selenium/node.rb

@@ -54,7 +54,9 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   #   :backspace => send backspace keystrokes to clear the field <br/>
   #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]
   def set(value, **options)
-    raise ArgumentError, "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}" if value.is_a?(Array) && !multiple?
+    if value.is_a?(Array) && !multiple?
+      raise ArgumentError, "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}"
+    end
 
     tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }
     @tag_name ||= tag_name
@@ -76,11 +78,13 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
         set_datetime_local(value)
       when 'color'
         set_color(value)
+      when 'range'
+        set_range(value)
       else
-        set_text(value, options)
+        set_text(value, **options)
       end
     when 'textarea'
-      set_text(value, options)
+      set_text(value, **options)
     else
       set_content_editable(value)
     end
@@ -100,10 +104,23 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     click_options = ClickOptions.new(keys, options)
     return native.click if click_options.empty?
 
-    click_with_options(click_options)
+    perform_with_options(click_options) do |action|
+      target = click_options.coords? ? nil : native
+      if click_options.delay.zero?
+        action.click(target)
+      else
+        action.click_and_hold(target)
+        if w3c?
+          action.pause(action.pointer_inputs.first, click_options.delay)
+        else
+          action.pause(click_options.delay)
+        end
+        action.release
+      end
+    end
   rescue StandardError => e
     if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
-       e.message.match?(/Other element would receive the click/)
+       e.message.include?('Other element would receive the click')
       scroll_to_center
     end
 
@@ -112,14 +129,26 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
 
   def right_click(keys = [], **options)
     click_options = ClickOptions.new(keys, options)
-    click_with_options(click_options) do |action|
-      click_options.coords? ? action.context_click : action.context_click(native)
+    perform_with_options(click_options) do |action|
+      target = click_options.coords? ? nil : native
+      if click_options.delay.zero?
+        action.context_click(target)
+      elsif w3c?
+        action.move_to(target) if target
+        action.pointer_down(:right)
+              .pause(action.pointer_inputs.first, click_options.delay)
+              .pointer_up(:right)
+      else
+        raise ArgumentError, 'Delay is not supported when right clicking with legacy (non-w3c) selenium driver'
+      end
     end
   end
 
   def double_click(keys = [], **options)
     click_options = ClickOptions.new(keys, options)
-    click_with_options(click_options) do |action|
+    raise ArgumentError, "double_click doesn't support a delay option" unless click_options.delay.zero?
+
+    perform_with_options(click_options) do |action|
       click_options.coords? ? action.double_click : action.double_click(native)
     end
   end
@@ -132,11 +161,17 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     scroll_if_needed { browser_action.move_to(native).perform }
   end
 
-  def drag_to(element, **)
+  def drag_to(element, drop_modifiers: [], **)
+    drop_modifiers = Array(drop_modifiers)
     # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary
     # which means Seleniums `drag_and_drop` is now broken - do it manually
     scroll_if_needed { browser_action.click_and_hold(native).perform }
-    element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
+    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
+    element.scroll_if_needed do
+      keys_down = modifiers_down(browser_action, drop_modifiers)
+      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)
+      keys_up.perform
+    end
   end
 
   def drop(*_)
@@ -179,6 +214,10 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     driver.frame_obscured_at?(x: res['x'], y: res['y'])
   end
 
+  def rect
+    native.rect
+  end
+
 protected
 
   def scroll_if_needed
@@ -188,6 +227,21 @@ protected
     yield
   end
 
+  def scroll_to_center
+    script = <<-'JS'
+      try {
+        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});
+      } catch(e) {
+        arguments[0].scrollIntoView(true);
+      }
+    JS
+    begin
+      driver.execute_script(script, self)
+    rescue StandardError
+      # Swallow error if scrollIntoView with options isn't supported
+    end
+  end
+
 private
 
   def sibling_index(parent, node, selector)
@@ -213,7 +267,7 @@ private
     find_xpath(XPath.ancestor(:select)[1]).first
   end
 
-  def set_text(value, clear: nil, **_unused)
+  def set_text(value, clear: nil, rapid: nil, **_unused)
     value = value.to_s
     if value.empty? && clear.nil?
       native.clear
@@ -224,15 +278,24 @@ private
     elsif clear.is_a? Array
       send_keys(*clear, value)
     else
-      # Clear field by JavaScript assignment of the value property.
-      # Script can change a readonly element which user input cannot, so
-      # don't execute if readonly.
-      driver.execute_script "if (!arguments[0].readOnly){ arguments[0].value = '' }", self unless clear == :none
-      send_keys(value)
+      driver.execute_script 'arguments[0].select()', self unless clear == :none
+      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)
+        send_keys(value[0..3])
+        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]
+        send_keys(value[-3..-1])
+      else
+        send_keys(value)
+      end
     end
   end
 
-  def click_with_options(click_options)
+  def auto_rapid_set_length
+    30
+  end
+
+  def perform_with_options(click_options, &block)
+    raise ArgumentError, 'A block must be provided' unless block
+
     scroll_if_needed do
       action_with_modifiers(click_options) do |action|
         if block_given?
@@ -244,21 +307,6 @@ private
     end
   end
 
-  def scroll_to_center
-    script = <<-'JS'
-      try {
-        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});
-      } catch(e) {
-        arguments[0].scrollIntoView(true);
-      }
-    JS
-    begin
-      driver.execute_script(script, self)
-    rescue StandardError # rubocop:disable Lint/HandleExceptions
-      # Swallow error if scrollIntoView with options isn't supported
-    end
-  end
-
   def set_date(value) # rubocop:disable Naming/AccessorMethodName
     value = SettableValue.new(value)
     return set_text(value) unless value.dateable?
@@ -287,6 +335,10 @@ private
     update_value_js(value)
   end
 
+  def set_range(value) # rubocop:disable Naming/AccessorMethodName
+    update_value_js(value)
+  end
+
   def update_value_js(value)
     driver.execute_script(<<-JS, self, value)
       if (arguments[0].readOnly) { return };
@@ -302,8 +354,31 @@ private
   end
 
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
-    path_names = value.to_s.empty? ? [] : value
-    native.send_keys(Array(path_names).join("\n"))
+    with_file_detector do
+      path_names = value.to_s.empty? ? [] : value
+      file_names = Array(path_names).map do |pn|
+        Pathname.new(pn).absolute? ? pn : File.expand_path(pn)
+      end.join("\n")
+      native.send_keys(file_names)
+    end
+  end
+
+  def with_file_detector
+    if driver.options[:browser] == :remote &&
+       bridge.respond_to?(:file_detector) &&
+       bridge.file_detector.nil?
+      begin
+        bridge.file_detector = lambda do |(fn, *)|
+          str = fn.to_s
+          str if File.exist?(str)
+        end
+        yield
+      ensure
+        bridge.file_detector = nil
+      end
+    else
+      yield
+    end
   end
 
   def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName
@@ -331,7 +406,13 @@ private
   end
 
   def action_with_modifiers(click_options)
-    actions = browser_action.move_to(native, *click_options.coords)
+    actions = browser_action.tap do |acts|
+      if click_options.center_offset? && click_options.coords?
+        acts.move_to(native).move_by(*click_options.coords)
+      else
+        acts.move_to(native, *click_options.coords)
+      end
+    end
     modifiers_down(actions, click_options.keys)
     yield actions
     modifiers_up(actions, click_options.keys)
@@ -343,32 +424,50 @@ private
 
   def modifiers_down(actions, keys)
     each_key(keys) { |key| actions.key_down(key) }
+    actions
   end
 
   def modifiers_up(actions, keys)
     each_key(keys) { |key| actions.key_up(key) }
+    actions
   end
 
   def browser
     driver.browser
   end
 
+  def bridge
+    browser.send(:bridge)
+  end
+
   def browser_action
     browser.action
   end
 
-  def each_key(keys)
-    keys.each do |key|
-      key = case key
+  def capabilities
+    browser.capabilities
+  end
+
+  def w3c?
+    (defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)) ||
+      capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
+  end
+
+  def normalize_keys(keys)
+    keys.map do |key|
+      case key
       when :ctrl then :control
       when :command, :cmd then :meta
       else
         key
       end
-      yield key
     end
   end
 
+  def each_key(keys, &block)
+    normalize_keys(keys).each(&block)
+  end
+
   def find_context
     native
   end
@@ -394,6 +493,9 @@ private
       var xpath = '';
     	var pos, tempitem2;
 
+      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {
+        return "(: Shadow DOM element - no XPath :)";
+      };
       while(el !== xml.documentElement) {
         pos = 0;
         tempitem2 = el;
@@ -435,6 +537,16 @@ private
     })(arguments[0], arguments[1], arguments[2])
   JS
 
+  RAPID_APPEND_TEXT = <<~'JS'
+    (function(el, value) {
+      value = el.value + value;
+      if (el.maxLength && el.maxLength != -1){
+        value = value.slice(0, el.maxLength);
+      }
+      el.value = value;
+    })(arguments[0], arguments[1])
+  JS
+
   # SettableValue encapsulates time/date field formatting
   class SettableValue
     attr_reader :value
@@ -486,8 +598,16 @@ private
       [options[:x], options[:y]]
     end
 
+    def center_offset?
+      options[:offset] == :center
+    end
+
     def empty?
-      keys.empty? && !coords?
+      keys.empty? && !coords? && delay.zero?
+    end
+
+    def delay
+      options[:delay] || 0
     end
   end
   private_constant :ClickOptions

data/lib/capybara/selenium/nodes/chrome_node.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'capybara/selenium/extensions/html5_drag'
+require 'capybara/selenium/extensions/file_input_click_emulation'
 
 class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
   include Html5Drag
+  include FileInputClickEmulation
 
   def set_text(value, clear: nil, **_unused)
     super.tap do
@@ -16,14 +18,16 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set
     if browser_version >= 75.0
       driver.execute_script(<<~JS, self)
-        if (arguments[0].multiple && (arguments[0].files.length > 0)){
+        if (arguments[0].multiple && arguments[0].files.length){
           arguments[0].value = null;
         }
       JS
     end
     super
   rescue *file_errors => e
-    raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload" if e.message.match?(/File not found : .+\n.+/m)
+    if e.message.match?(/File not found : .+\n.+/m)
+      raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload"
+    end
 
     raise
   end
@@ -32,11 +36,15 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     html5_drop(*args)
   end
 
-  def click(*)
+  def click(*, **)
     super
+  rescue ::Selenium::WebDriver::Error::ElementClickInterceptedError
+    raise
   rescue ::Selenium::WebDriver::Error::WebDriverError => e
     # chromedriver 74 (at least on mac) raises the wrong error for this
-    raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message if e.message.match?(/element click intercepted/)
+    if e.message.include?('element click intercepted')
+      raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message
+    end
 
     raise
   end
@@ -53,25 +61,77 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     click unless selected_or_disabled
   end
 
+  def visible?
+    return super unless native_displayed?
+
+    begin
+      bridge.send(:execute, :is_element_displayed, id: native.ref)
+    rescue Selenium::WebDriver::Error::UnknownCommandError
+      # If the is_element_displayed command is unknown, no point in trying again
+      driver.options[:native_displayed] = false
+      super
+    end
+  end
+
+  def send_keys(*args)
+    args.chunk { |inp| inp.is_a?(String) && inp.match?(/\p{Emoji Presentation}/) }
+        .each do |contains_emoji, inputs|
+      if contains_emoji
+        inputs.join.grapheme_clusters.chunk { |gc| gc.match?(/\p{Emoji Presentation}/) }
+              .each do |emoji, clusters|
+          if emoji
+            driver.send(:execute_cdp, 'Input.insertText', text: clusters.join)
+          else
+            super(clusters.join)
+          end
+        end
+      else
+        super(*inputs)
+      end
+    end
+  end
+
 private
 
+  def perform_legacy_drag(element, drop_modifiers)
+    return super if chromedriver_fixed_actions_key_state? || !w3c? || element.obscured?
+
+    raise ArgumentError, 'Modifier keys are not supported while dragging in this version of Chrome.' unless drop_modifiers.empty?
+
+    # W3C Chrome/chromedriver < 77 doesn't maintain mouse button state across actions API performs
+    # https://bugs.chromium.org/p/chromedriver/issues/detail?id=2981
+    browser_action.release.perform
+    browser_action.click_and_hold(native).move_to(element.native).release.perform
+  end
+
   def file_errors
     @file_errors = ::Selenium::WebDriver.logger.suppress_deprecations do
       [::Selenium::WebDriver::Error::ExpectedError]
     end
   end
 
-  def bridge
-    driver.browser.send(:bridge)
+  def browser_version(to_float: true)
+    caps = capabilities
+    ver = (caps[:browser_version] || caps[:version])
+    ver = ver.to_f if to_float
+    ver
+  end
+
+  def chromedriver_fixed_actions_key_state?
+    Gem::Requirement.new('>= 76.0.3809.68').satisfied_by?(chromedriver_version)
+  end
+
+  def chromedriver_supports_displayed_endpoint?
+    Gem::Requirement.new('>= 76.0.3809.25').satisfied_by?(chromedriver_version)
   end
 
-  def w3c?
-    (defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)) ||
-      driver.browser.capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
+  def chromedriver_version
+    Gem::Version.new(capabilities['chrome']['chromedriverVersion'].split(' ')[0]) # rubocop:disable Style/RedundantArgument
   end
 
-  def browser_version
-    caps = driver.browser.capabilities
-    (caps[:browser_version] || caps[:version]).to_f
+  def native_displayed?
+    (driver.options[:native_displayed] != false) &&
+      (w3c? && chromedriver_supports_displayed_endpoint?) &&
+      (!ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS'])
   end
 end