capybara 3.13.2 → 3.40.0

data/lib/capybara/selenium/node.rb

@@ -4,22 +4,22 @@
 
 require 'capybara/selenium/extensions/find'
 require 'capybara/selenium/extensions/scroll'
+require 'capybara/node/whitespace_normalizer'
 
 class Capybara::Selenium::Node < Capybara::Driver::Node
+  include Capybara::Node::WhitespaceNormalizer
   include Capybara::Selenium::Find
   include Capybara::Selenium::Scroll
 
   def visible_text
+    raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root?
+
     native.text
   end
 
   def all_text
-    text = driver.evaluate_script('arguments[0].textContent', self)
-    text.gsub(/[\u200b\u200e\u200f]/, '')
-        .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
-        .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
-        .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
-        .tr("\u00a0", ' ')
+    text = driver.evaluate_script('arguments[0].textContent', self) || ''
+    normalize_spacing(text)
   end
 
   def [](name)
@@ -37,9 +37,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def style(styles)
-    styles.each_with_object({}) do |style, result|
-      result[style] = native.css_value(style)
-    end
+    styles.to_h { |style| [style, native.css_value(style)] }
   end
 
   ##
@@ -53,12 +51,22 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   #   :none =>  append the new value to the existing value <br/>
   #   :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]
+  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>
+  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>
+  #   true => Rapid mode will be used regardless of input length<br/>
+  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain
+  #            Javascript interactions on form inputs<br/>
   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
 
     case tag_name
     when 'input'
-      case self[:type]
+      case type
       when 'radio'
         click
       when 'checkbox'
@@ -71,13 +79,17 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
         set_time(value)
       when 'datetime-local'
         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) if content_editable?
+      set_content_editable(value)
     end
   end
 
@@ -95,26 +107,45 @@ 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)
-  rescue StandardError => err
-    if err.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
-       err.message =~ /Other element would receive the click/
+    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)
+        action_pause(action, click_options.delay)
+        action.release
+      end
+    end
+  rescue StandardError => e
+    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
+       e.message.include?('Other element would receive the click')
       scroll_to_center
     end
 
-    raise err
+    raise e
   end
 
   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)
+      else
+        action.move_to(target) if target
+        action.pointer_down(:right).then do |act|
+          action_pause(act, click_options.delay)
+        end.pointer_up(:right)
+      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
@@ -127,15 +158,30 @@ 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(*_)
+    raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser'
   end
 
   def tag_name
-    native.tag_name.downcase
+    @tag_name ||=
+      if native.respond_to? :tag_name
+        native.tag_name.downcase
+      else
+        shadow_root? ? 'ShadowRoot' : 'Unknown'
+      end
   end
 
   def visible?; boolean_attr(native.displayed?); end
@@ -148,21 +194,33 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     return true unless native.enabled?
 
     # WebDriver only defines `disabled?` for form controls but fieldset makes sense too
-    tag_name == 'fieldset' && find_xpath('ancestor-or-self::fieldset[@disabled]').any?
+    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?
   end
 
   def content_editable?
-    native.attribute('isContentEditable')
-  end
-
-  def ==(other)
-    native == other.native
+    native.attribute('isContentEditable') == 'true'
   end
 
   def path
     driver.evaluate_script GET_XPATH_SCRIPT, self
   end
 
+  def obscured?(x: nil, y: nil)
+    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)
+    return true if res == true
+
+    driver.frame_obscured_at?(x: res['x'], y: res['y'])
+  end
+
+  def rect
+    native.rect
+  end
+
+  def shadow_root
+    root = native.shadow_root
+    root && build_node(native.shadow_root)
+  end
+
 protected
 
   def scroll_if_needed
@@ -172,6 +230,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)
@@ -197,29 +270,38 @@ 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
     elsif clear == :backspace
       # Clear field by sending the correct number of backspace keys.
       backspaces = [:backspace] * self.value.to_s.length
-      send_keys(*([:end] + backspaces + [value]))
+      send_keys(:end, *backspaces, value)
     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 "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..])
+      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?
+        if block
           yield action
         else
           click_options.coords? ? action.click : action.click(native)
@@ -228,21 +310,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?
@@ -267,8 +334,17 @@ private
     update_value_js(value.to_datetime_str)
   end
 
+  def set_color(value) # rubocop:disable Naming/AccessorMethodName
+    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 };
       if (document.activeElement !== arguments[0]){
         arguments[0].focus();
       }
@@ -281,32 +357,75 @@ 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
     # Ensure we are focused on the element
     click
 
-    driver.execute_script <<-JS, self
-      var range = document.createRange();
-      var sel = window.getSelection();
-      arguments[0].focus();
-      range.selectNodeContents(arguments[0]);
-      sel.removeAllRanges();
-      sel.addRange(range);
+    editable = driver.execute_script <<-JS, self
+      if (arguments[0].isContentEditable) {
+        var range = document.createRange();
+        var sel = window.getSelection();
+        arguments[0].focus();
+        range.selectNodeContents(arguments[0]);
+        sel.removeAllRanges();
+        sel.addRange(range);
+        return true;
+      }
+      return false;
     JS
 
     # The action api has a speed problem but both chrome and firefox 58 raise errors
     # if we use the faster direct send_keys.  For now just send_keys to the element
     # we've already focused.
     # native.send_keys(value.to_s)
-    browser_action.send_keys(value.to_s).perform
+    browser_action.send_keys(value.to_s).perform if editable
   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.coords?
+        if click_options.center_offset?
+          acts.move_to(native, *click_options.coords)
+        else
+          right_by, down_by = *click_options.coords
+          size = native.size
+          left_offset = (size[:width] / 2).to_i
+          top_offset = (size[:height] / 2).to_i
+          left = -left_offset + right_by
+          top = -top_offset + down_by
+          acts.move_to(native, left, top)
+        end
+      else
+        acts.move_to(native)
+      end
+    end
     modifiers_down(actions, click_options.keys)
     yield actions
     modifiers_up(actions, click_options.keys)
@@ -318,32 +437,49 @@ 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 action_pause(action, duration)
+    action.pause(device: action.pointer_inputs.first, duration: duration)
+  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
@@ -352,11 +488,36 @@ private
     self.class.new(driver, native_node, initial_cache)
   end
 
+  def attrs(*attr_names)
+    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']
+
+    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)
+      (function(el, names){
+        return names.map(function(name){
+          return el[name]
+        });
+      })(arguments[0], arguments[1]);
+    JS
+  end
+
+  def native_id
+    # Selenium 3 -> 4 changed the return of ref
+    type_or_id, id = native.ref
+    id || type_or_id
+  end
+
+  def shadow_root?
+    defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot)
+  end
+
   GET_XPATH_SCRIPT = <<~'JS'
     (function(el, xml){
       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;
@@ -381,6 +542,33 @@ private
     })(arguments[0], document)
   JS
 
+  OBSCURED_OR_OFFSET_SCRIPT = <<~JS
+    (function(el, x, y) {
+      var box = el.getBoundingClientRect();
+      if (x == null) x = box.width/2;
+      if (y == null) y = box.height/2 ;
+
+      var px = box.left + x,
+          py = box.top + y,
+          e = document.elementFromPoint(px, py);
+
+      if (!el.contains(e))
+        return true;
+
+      return { x: px, y: py };
+    })(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
@@ -398,7 +586,7 @@ private
     end
 
     def to_date_str
-      value.to_date.strftime('%Y-%m-%d')
+      value.to_date.iso8601
     end
 
     def timeable?
@@ -432,8 +620,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,29 +1,125 @@
 # 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
+      # React doesn't see the chromedriver element clear
+      send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?
+    end
+  end
 
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
-    super(value)
-  rescue ::Selenium::WebDriver::Error::ExpectedError => err
-    if err.message =~ /File not found : .+\n.+/m
-      raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload"
+    # 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){
+          arguments[0].value = null;
+        }
+      JS
+    end
+    super
+  end
+
+  def drop(*args)
+    html5_drop(*args)
+  end
+
+  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
+    if e.message.include?('element click intercepted')
+      raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message
     end
 
     raise
   end
 
-  def drag_to(element)
-    return super unless html5_draggable?
+  def disabled?
+    driver.evaluate_script("arguments[0].matches(':disabled, select:disabled *')", self)
+  end
 
-    html5_drag_to(element)
+  def select_option
+    # To optimize to only one check and then click
+    selected_or_disabled = driver.evaluate_script(<<~JS, self)
+      arguments[0].matches(':disabled, select:disabled *, :checked')
+    JS
+    click unless selected_or_disabled
+  end
+
+  def visible?
+    return super unless native_displayed?
+
+    begin
+      bridge.send(:execute, :is_element_displayed, id: native_id)
+    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 bridge
-    driver.browser.send(:bridge)
+  def perform_legacy_drag(element, drop_modifiers)
+    return super if chromedriver_fixed_actions_key_state? || 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 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 chromedriver_version
+    Gem::Version.new(capabilities['chrome']['chromedriverVersion'].split(' ')[0]) # rubocop:disable Style/RedundantArgument
+  end
+
+  def native_displayed?
+    (driver.options[:native_displayed] != false) &&
+      chromedriver_supports_displayed_endpoint? &&
+      (!ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS'])
   end
 end