capybara 3.3.0 → 3.40.0

data/lib/capybara/selenium/node.rb

@@ -1,17 +1,25 @@
 # frozen_string_literal: true
 
+# Selenium specific implementation of the Capybara::Driver::Node API
+
+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.execute_script("return 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)
@@ -21,17 +29,15 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def value
-    if tag_name == "select" && multiple?
-      native.find_elements(:css, "option:checked").map { |n| n[:value] || n.text }
+    if tag_name == 'select' && multiple?
+      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }
     else
       native[:value]
     end
   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
 
   ##
@@ -45,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'
@@ -63,38 +79,47 @@ 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
 
   def select_option
-    native.click unless selected? || disabled?
+    click unless selected? || disabled?
   end
 
   def unselect_option
-    raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box." unless select_node.multiple?
-    native.click if selected?
+    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?
+
+    click if selected?
   end
 
   def click(keys = [], **options)
-    if keys.empty? && !coords?(options)
-      native.click
-    else
-      scroll_if_needed do
-        action_with_modifiers(keys, options) do |a|
-          coords?(options) ? a.click : a.click(native)
-        end
+    click_options = ClickOptions.new(keys, options)
+    return native.click if click_options.empty?
+
+    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 =~ /Other element would receive the click/
+       e.message.include?('Other element would receive the click')
       scroll_to_center
     end
 
@@ -102,18 +127,26 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def right_click(keys = [], **options)
-    scroll_if_needed do
-      action_with_modifiers(keys, options) do |a|
-        coords?(options) ? a.context_click : a.context_click(native)
+    click_options = ClickOptions.new(keys, options)
+    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)
-    scroll_if_needed do
-      action_with_modifiers(keys, options) do |a|
-        coords?(options) ? a.double_click : a.double_click(native)
-      end
+    click_options = ClickOptions.new(keys, options)
+    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
 
@@ -122,15 +155,33 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def hover
-    scroll_if_needed { driver.browser.action.move_to(native).perform }
+    scroll_if_needed { browser_action.move_to(native).perform }
+  end
+
+  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 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 drag_to(element)
-    scroll_if_needed { driver.browser.action.drag_and_drop(native, element.native).perform }
+  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
@@ -140,56 +191,78 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   alias :checked? :selected?
 
   def disabled?
-    !native.enabled?
+    return true unless native.enabled?
+
+    # WebDriver only defines `disabled?` for form controls but fieldset makes sense too
+    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?
   end
 
   def content_editable?
-    native.attribute('isContentEditable')
+    native.attribute('isContentEditable') == 'true'
   end
 
-  def find_xpath(locator)
-    native.find_elements(:xpath, locator).map { |n| self.class.new(driver, n) }
+  def path
+    driver.evaluate_script GET_XPATH_SCRIPT, self
   end
 
-  def find_css(locator)
-    native.find_elements(:css, locator).map { |n| self.class.new(driver, n) }
+  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 ==(other)
-    native == other.native
+  def rect
+    native.rect
   end
 
-  def path
-    path = find_xpath(XPath.ancestor_or_self).reverse
-
-    result = []
-    default_ns = path.last[:namespaceURI]
-    while (node = path.shift)
-      parent = path.first
-      selector = node[:tagName]
-      if node[:namespaceURI] != default_ns
-        selector = XPath.child.where((XPath.local_name == selector) & (XPath.namespace_uri == node[:namespaceURI])).to_s
-        selector
-      end
+  def shadow_root
+    root = native.shadow_root
+    root && build_node(native.shadow_root)
+  end
 
-      if parent
-        siblings = parent.find_xpath(selector)
-        selector += "[#{siblings.index(node) + 1}]" unless siblings.size == 1
-      end
-      result.push selector
-    end
+protected
 
-    '/' + result.reverse.join('/')
+  def scroll_if_needed
+    yield
+  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError
+    scroll_to_center
+    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 coords?(options)
-    options[:x] && options[:y]
+  def sibling_index(parent, node, selector)
+    siblings = parent.find_xpath(selector)
+    case siblings.size
+    when 0
+      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)
+    when 1
+      '' # index not necessary when only one matching element
+    else
+      idx = siblings.index(node)
+      # Element may not be found in the siblings if it has gone away
+      idx.nil? ? '[ERROR]' : "[#{idx + 1}]"
+    end
   end
 
   def boolean_attr(val)
-    val && (val != "false")
+    val && (val != 'false')
   end
 
   # a reference to the select node if this is an option node
@@ -197,68 +270,81 @@ private
     find_xpath(XPath.ancestor(:select)[1]).first
   end
 
-  def set_text(value, clear: nil, **_unused)
-    if value.to_s.empty? && clear.nil?
+  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
-      native.send_keys(*(backspaces + [value.to_s]))
-    elsif clear == :none
-      native.send_keys(value.to_s)
+      send_keys(:end, *backspaces, value)
     elsif clear.is_a? Array
-      native.send_keys(*clear, value.to_s)
+      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
-      native.send_keys(value.to_s)
+      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 scroll_if_needed
-    yield
-  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError
-    scroll_to_center
-    yield
+  def auto_rapid_set_length
+    30
   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
+  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
+          yield action
+        else
+          click_options.coords? ? action.click : action.click(native)
+        end
+      end
     end
   end
 
   def set_date(value) # rubocop:disable Naming/AccessorMethodName
-    return set_text(value) if value.is_a?(String) || !value.respond_to?(:to_date)
+    value = SettableValue.new(value)
+    return set_text(value) unless value.dateable?
+
     # TODO: this would be better if locale can be detected and correct keystrokes sent
-    update_value_js(value.to_date.strftime('%Y-%m-%d'))
+    update_value_js(value.to_date_str)
   end
 
   def set_time(value) # rubocop:disable Naming/AccessorMethodName
-    return set_text(value) if value.is_a?(String) || !value.respond_to?(:to_time)
+    value = SettableValue.new(value)
+    return set_text(value) unless value.timeable?
+
     # TODO: this would be better if locale can be detected and correct keystrokes sent
-    update_value_js(value.to_time.strftime('%H:%M'))
+    update_value_js(value.to_time_str)
   end
 
   def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName
-    return set_text(value) if value.is_a?(String) || !value.respond_to?(:to_time)
+    value = SettableValue.new(value)
+    return set_text(value) unless value.timeable?
+
     # TODO: this would be better if locale can be detected and correct keystrokes sent
-    update_value_js(value.to_time.strftime('%Y-%m-%dT%H:%M'))
+    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();
       }
@@ -271,64 +357,280 @@ 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
 
-    script = <<-JS
-      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
-    driver.execute_script script, self
 
     # 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)
-    driver.browser.action.send_keys(value.to_s).perform
-  end
-
-  def action_with_modifiers(keys, x: nil, y: nil)
-    actions = driver.browser.action
-    actions.move_to(native, x, y)
-    modifiers_down(actions, keys)
+    browser_action.send_keys(value.to_s).perform if editable
+  end
+
+  def action_with_modifiers(click_options)
+    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, keys)
+    modifiers_up(actions, click_options.keys)
     actions.perform
   ensure
-    a = driver.browser.action
-    a.release_actions if a.respond_to?(:release_actions)
+    act = browser_action
+    act.release_actions if act.respond_to?(:release_actions)
   end
 
   def modifiers_down(actions, keys)
-    keys.each do |key|
-      key = case key
-      when :ctrl then :control
-      when :command, :cmd then :meta
-      else
-        key
-      end
-      actions.key_down(key)
-    end
+    each_key(keys) { |key| actions.key_down(key) }
+    actions
   end
 
   def modifiers_up(actions, keys)
-    keys.each do |key|
-      key = case key
+    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 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
-      actions.key_up(key)
     end
   end
+
+  def each_key(keys, &block)
+    normalize_keys(keys).each(&block)
+  end
+
+  def find_context
+    native
+  end
+
+  def build_node(native_node, initial_cache = {})
+    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;
+        while(tempitem2) {
+          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name
+            pos += 1;
+          }
+          tempitem2 = tempitem2.previousSibling;
+        }
+
+        if (el.namespaceURI != xml.documentElement.namespaceURI) {
+          xpath = "*[local-name()='"+el.nodeName+"' and namespace-uri()='"+(el.namespaceURI===null?'':el.namespaceURI)+"']["+pos+']'+'/'+xpath;
+        } else {
+          xpath = el.nodeName.toUpperCase()+"["+pos+"]/"+xpath;
+        }
+
+        el = el.parentNode;
+      }
+      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;
+      xpath = xpath.replace(/\/$/, '');
+      return xpath;
+    })(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
+
+    def initialize(value)
+      @value = value
+    end
+
+    def to_s
+      value.to_s
+    end
+
+    def dateable?
+      !value.is_a?(String) && value.respond_to?(:to_date)
+    end
+
+    def to_date_str
+      value.to_date.iso8601
+    end
+
+    def timeable?
+      !value.is_a?(String) && value.respond_to?(:to_time)
+    end
+
+    def to_time_str
+      value.to_time.strftime('%H:%M')
+    end
+
+    def to_datetime_str
+      value.to_time.strftime('%Y-%m-%dT%H:%M')
+    end
+  end
+  private_constant :SettableValue
+
+  # ClickOptions encapsulates click option logic
+  class ClickOptions
+    attr_reader :keys, :options
+
+    def initialize(keys, options)
+      @keys = keys
+      @options = options
+    end
+
+    def coords?
+      options[:x] && options[:y]
+    end
+
+    def coords
+      [options[:x], options[:y]]
+    end
+
+    def center_offset?
+      options[:offset] == :center
+    end
+
+    def empty?
+      keys.empty? && !coords? && delay.zero?
+    end
+
+    def delay
+      options[:delay] || 0
+    end
+  end
+  private_constant :ClickOptions
 end