capybara 3.16.1 → 3.33.0

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
@@ -13,22 +15,105 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
   end
 
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
-    super(value)
-  rescue ::Selenium::WebDriver::Error::ExpectedError => err
-    raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload" if err.message.match?(/File not found : .+\n.+/m)
+    # 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
+  rescue *file_errors => e
+    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
 
-  def drag_to(element)
-    return super unless html5_draggable?
+  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.match?(/element click intercepted/)
+      raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message
+    end
 
-    html5_drag_to(element)
+    raise
+  end
+
+  def disabled?
+    driver.evaluate_script("arguments[0].matches(':disabled, select:disabled *')", self)
+  end
+
+  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.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
 
 private
 
-  def bridge
-    driver.browser.send(:bridge)
+  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 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::Version.new(chromedriver_version) >= Gem::Version.new('76.0.3809.68')
+  end
+
+  def chromedriver_supports_displayed_endpoint?
+    Gem::Version.new(chromedriver_version) >= Gem::Version.new('76.0.3809.25')
+  end
+
+  def chromedriver_version
+    capabilities['chrome']['chromedriverVersion'].split(' ')[0]
+  end
+
+  def native_displayed?
+    (driver.options[:native_displayed] != false) &&
+      (w3c? && chromedriver_supports_displayed_endpoint?) &&
+      (!ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS'])
   end
 end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'capybara/selenium/extensions/html5_drag'
+
+class Capybara::Selenium::EdgeNode < Capybara::Selenium::Node
+  include Html5Drag
+
+  def set_text(value, clear: nil, **_unused)
+    return super unless chrome_edge?
+
+    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
+    # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set
+    if chrome_edge?
+      driver.execute_script(<<~JS, self)
+        if (arguments[0].multiple && arguments[0].files.length){
+          arguments[0].value = null;
+        }
+      JS
+    end
+    super
+  rescue *file_errors => e
+    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
+
+  def drop(*args)
+    return super unless chrome_edge?
+
+    html5_drop(*args)
+  end
+
+  def click(*)
+    super
+  rescue Selenium::WebDriver::Error::InvalidArgumentError => e
+    tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }
+    if tag_name == 'input' && type == 'file'
+      raise Selenium::WebDriver::Error::InvalidArgumentError, "EdgeChrome can't click on file inputs.\n#{e.message}"
+    end
+
+    raise
+  end
+
+  def disabled?
+    return super unless chrome_edge?
+
+    driver.evaluate_script("arguments[0].matches(':disabled, select:disabled *')", self)
+  end
+
+  def select_option
+    return super unless chrome_edge?
+
+    # 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 chrome_edge? && 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
+
+private
+
+  def file_errors
+    @file_errors = ::Selenium::WebDriver.logger.suppress_deprecations do
+      [::Selenium::WebDriver::Error::ExpectedError]
+    end
+  end
+
+  def browser_version
+    @browser_version ||= begin
+      caps = driver.browser.capabilities
+      (caps[:browser_version] || caps[:version]).to_f
+    end
+  end
+
+  def chrome_edge?
+    browser_version >= 75
+  end
+
+  def native_displayed?
+    (driver.options[:native_displayed] != false) &&
+      # chromedriver_supports_displayed_endpoint? &&
+      (!ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS'])
+  end
+end

data/lib/capybara/selenium/nodes/firefox_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::FirefoxNode < Capybara::Selenium::Node
   include Html5Drag
+  include FileInputClickEmulation
 
   def click(keys = [], **options)
     super
@@ -12,28 +14,22 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
       warn 'You are attempting to click a table row which has issues in geckodriver/marionette - '\
            'see https://github.com/mozilla/geckodriver/issues/1228. Your test should probably be '\
            'clicking on a table cell like a user would. Clicking the first cell in the row instead.'
-      return find_css('th:first-child,td:first-child')[0].click(keys, options)
+      return find_css('th:first-child,td:first-child')[0].click(keys, **options)
     end
     raise
   end
 
   def disabled?
-    # Not sure exactly what version of FF fixed the below issue, but it is definitely fixed in 61+
-    return super unless browser_version < 61.0
-
-    return true if super
-
-    # workaround for selenium-webdriver/geckodriver reporting elements as enabled when they are nested in disabling elements
-    if %w[option optgroup].include? tag_name
-      find_xpath('parent::*[self::optgroup or self::select]')[0].disabled?
-    else
-      !find_xpath(DISABLED_BY_FIELDSET_XPATH).empty?
-    end
+    driver.evaluate_script("arguments[0].matches(':disabled, select:disabled *')", self)
   end
 
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
     # By default files are appended so we have to clear here if its multiple and already set
-    native.clear if multiple? && driver.evaluate_script('arguments[0].files', self).any?
+    driver.execute_script(<<~JS, self)
+      if (arguments[0].multiple && arguments[0].files.length){
+        arguments[0].value = null;
+      }
+    JS
     return super if browser_version >= 62.0
 
     # Workaround lack of support for multiple upload by uploading one at a time
@@ -46,16 +42,14 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
 
   def send_keys(*args)
     # https://github.com/mozilla/geckodriver/issues/846
-    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none? { |arg| arg.is_a? Array }
+    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none?(Array)
 
     native.click
     _send_keys(args).perform
   end
 
-  def drag_to(element)
-    return super unless (browser_version >= 62.0) && html5_draggable?
-
-    html5_drag_to(element)
+  def drop(*args)
+    html5_drop(*args)
   end
 
   def hover
@@ -65,9 +59,33 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
     scroll_if_needed { browser_action.move_to(native, 0, 0).move_to(native).perform }
   end
 
+  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.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
+
 private
 
-  def click_with_options(click_options)
+  def native_displayed?
+    (driver.options[:native_displayed] != false) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']
+  end
+
+  def perform_with_options(click_options)
     # Firefox/marionette has an issue clicking with offset near viewport edge
     # scroll element to middle just in case
     scroll_to_center if click_options.coords?
@@ -99,10 +117,6 @@ private
     actions
   end
 
-  def bridge
-    driver.browser.send(:bridge)
-  end
-
   def upload(local_file)
     return nil unless local_file
     raise ArgumentError, "You may only upload files: #{local_file.inspect}" unless File.file?(local_file)
@@ -114,40 +128,4 @@ private
   def browser_version
     driver.browser.capabilities[:browser_version].to_f
   end
-
-  DISABLED_BY_FIELDSET_XPATH = XPath.generate do |x|
-    x.parent(:fieldset)[
-      x.attr(:disabled)
-    ] + x.ancestor[
-      ~x.self(:legend) |
-      x.preceding_sibling(:legend)
-    ][
-      x.parent(:fieldset)[
-        x.attr(:disabled)
-      ]
-    ]
-  end.to_s.freeze
-
-  class ModifierKeysStack
-    def initialize
-      @stack = []
-    end
-
-    def include?(key)
-      @stack.flatten.include?(key)
-    end
-
-    def press(key)
-      @stack.last.push(key)
-    end
-
-    def push
-      @stack.push []
-    end
-
-    def pop
-      @stack.pop
-    end
-  end
-  private_constant :ModifierKeysStack
 end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'capybara/selenium/extensions/html5_drag'
+
+class Capybara::Selenium::IENode < Capybara::Selenium::Node
+  def disabled?
+    # super
+    # optimize to one script call
+    driver.evaluate_script <<~JS.delete("\n"), self
+      arguments[0].msMatchesSelector('
+        :disabled,
+        select:disabled *,
+        optgroup:disabled *,
+        fieldset[disabled],
+        fieldset[disabled] > *:not(legend),
+        fieldset[disabled] > *:not(legend) *,
+        fieldset[disabled] > legend:nth-of-type(n+2),
+        fieldset[disabled] > legend:nth-of-type(n+2) *
+      ')
+    JS
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # require 'capybara/selenium/extensions/html5_drag'
+require 'capybara/selenium/extensions/modifier_keys_stack'
 
 class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
   # include Html5Drag
@@ -16,11 +17,21 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
       return find_css('th:first-child,td:first-child')[0].click(keys, options)
     end
     raise
+  rescue ::Selenium::WebDriver::Error::WebDriverError => e
+    raise unless e.instance_of? ::Selenium::WebDriver::Error::WebDriverError
+
+    # Safari doesn't return a specific error here - assume it's an ElementNotInteractableError
+    raise ::Selenium::WebDriver::Error::ElementNotInteractableError,
+          'Non distinct error raised in #click, translated to ElementNotInteractableError for retry'
   end
 
   def select_option
-    driver.execute_script("arguments[0].closest('select').scrollIntoView()", self)
-    super
+    # To optimize to only one check and then click
+    selected_or_disabled = driver.execute_script(<<~JS, self)
+      arguments[0].closest('select').scrollIntoView();
+      return arguments[0].matches(':disabled, select:disabled *, :checked');
+    JS
+    click unless selected_or_disabled
   end
 
   def unselect_option
@@ -40,14 +51,7 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
   end
 
   def disabled?
-    return true if super || (self[:disabled] == 'true')
-
-    # workaround for safaridriver reporting elements as enabled when they are nested in disabling elements
-    if %w[option optgroup].include? tag_name
-      find_xpath('parent::*[self::optgroup or self::select]')[0].disabled?
-    else
-      !find_xpath(DISABLED_BY_FIELDSET_XPATH).empty?
-    end
+    driver.evaluate_script("arguments[0].matches(':disabled, select:disabled *')", self)
   end
 
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
@@ -57,7 +61,9 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
   end
 
   def send_keys(*args)
-    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none? { |arg| arg.is_a? Array }
+    if args.none? { |arg| arg.is_a?(Array) || (arg.is_a?(Symbol) && MODIFIER_KEYS.include?(arg)) }
+      return super(*args.map { |arg| arg == :space ? ' ' : arg })
+    end
 
     native.click
     _send_keys(args).perform
@@ -77,32 +83,16 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
     end
   end
 
-private
-
-  def bridge
-    driver.browser.send(:bridge)
+  def hover
+    # Workaround issue where hover would sometimes fail - possibly due to mouse not having moved
+    scroll_if_needed { browser_action.move_to(native, 0, 0).move_to(native).perform }
   end
 
-  DISABLED_BY_FIELDSET_XPATH = XPath.generate do |x|
-    x.parent(:fieldset)[
-      x.attr(:disabled)
-    ] + x.ancestor[
-      ~x.self(:legend) |
-      x.preceding_sibling(:legend)
-    ][
-      x.parent(:fieldset)[
-        x.attr(:disabled)
-      ]
-    ]
-  end.to_s.freeze
+private
 
   def _send_keys(keys, actions = browser_action, down_keys = ModifierKeysStack.new)
     case keys
-    when :control, :left_control, :right_control,
-         :alt, :left_alt, :right_alt,
-         :shift, :left_shift, :right_shift,
-         :meta, :left_meta, :right_meta,
-         :command
+    when *MODIFIER_KEYS
       down_keys.press(keys)
       actions.key_down(keys)
     when String
@@ -120,26 +110,9 @@ private
     actions
   end
 
-  class ModifierKeysStack
-    def initialize
-      @stack = []
-    end
-
-    def include?(key)
-      @stack.flatten.include?(key)
-    end
-
-    def press(key)
-      @stack.last.push(key)
-    end
-
-    def push
-      @stack.push []
-    end
-
-    def pop
-      @stack.pop
-    end
-  end
-  private_constant :ModifierKeysStack
+  MODIFIER_KEYS = %i[control left_control right_control
+                     alt left_alt right_alt
+                     shift left_shift right_shift
+                     meta left_meta right_meta
+                     command].freeze
 end