capybara 2.18.0 → 3.39.2

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

@@ -0,0 +1,141 @@
+# 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
+    # 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 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 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_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 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
+      if defined? ::Selenium::WebDriver::Error::ExpectedError # Selenium < 4
+        [::Selenium::WebDriver::Error::ExpectedError]
+      else
+        []
+      end
+    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::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) &&
+      (w3c? && chromedriver_supports_displayed_endpoint?) &&
+      (!ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS'])
+  end
+end

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

@@ -0,0 +1,126 @@
+# 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_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 file_errors
+    @file_errors = ::Selenium::WebDriver.logger.suppress_deprecations do
+      if defined? ::Selenium::WebDriver::Error::ExpectedError # Selenium < 4
+        [::Selenium::WebDriver::Error::ExpectedError]
+      else
+        []
+      end
+    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

@@ -0,0 +1,136 @@
+# 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
+  rescue ::Selenium::WebDriver::Error::ElementNotInteractableError
+    if tag_name == 'tr'
+      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)
+    end
+    raise
+  end
+
+  def disabled?
+    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
+    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
+    path_names = value.to_s.empty? ? [] : Array(value)
+    if (fd = bridge.file_detector) && !driver.browser.respond_to?(:upload)
+      path_names.map! { |path| upload(fd.call([path])) || path }
+    end
+    path_names.each { |path| native.send_keys(path) }
+  end
+
+  def focused?
+    driver.evaluate_script('arguments[0] == document.activeElement', self)
+  end
+
+  def send_keys(*args)
+    # https://github.com/mozilla/geckodriver/issues/846
+    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none?(Array)
+
+    native.click unless focused?
+
+    _send_keys(args).perform
+  end
+
+  def drop(*args)
+    html5_drop(*args)
+  end
+
+  def hover
+    return super unless browser_version >= 65.0
+
+    # work around issue 2156 - https://github.com/teamcapybara/capybara/issues/2156
+    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_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
+
+private
+
+  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?
+    super
+  end
+
+  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
+      down_keys.press(keys)
+      actions.key_down(keys)
+    when String
+      # https://bugzilla.mozilla.org/show_bug.cgi?id=1405370
+      keys = keys.upcase if (browser_version < 64.0) && down_keys&.include?(:shift)
+      actions.send_keys(keys)
+    when Symbol
+      actions.send_keys(keys)
+    when Array
+      down_keys.push
+      keys.each { |sub_keys| _send_keys(sub_keys, actions, down_keys) }
+      down_keys.pop.reverse_each { |key| actions.key_up(key) }
+    else
+      raise ArgumentError, 'Unknown keys type'
+    end
+    actions
+  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)
+
+    file = ::Selenium::WebDriver::Zipper.zip_file(local_file)
+    bridge.http.call(:post, "session/#{bridge.session_id}/file", file: file)['value']
+  end
+
+  def browser_version
+    driver.browser.capabilities[:browser_version].to_f
+  end
+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

@@ -0,0 +1,118 @@
+# 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
+
+  def click(keys = [], **options)
+    # driver.execute_script('arguments[0].scrollIntoViewIfNeeded({block: "center"})', self)
+    super
+  rescue ::Selenium::WebDriver::Error::ElementNotInteractableError
+    if tag_name == 'tr'
+      warn 'You are attempting to click a table row which has issues in safaridriver - ' \
+           '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)
+    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
+    # 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
+    driver.execute_script("arguments[0].closest('select').scrollIntoView()", self)
+    super
+  end
+
+  def visible_text
+    return '' unless visible?
+
+    vis_text = driver.execute_script('return arguments[0].innerText', self)
+    vis_text.squeeze(' ')
+            .gsub(/[\ \n]*\n[\ \n]*/, "\n")
+            .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
+            .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
+            .tr("\u00a0", ' ')
+  end
+
+  def disabled?
+    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?
+    super
+  end
+
+  def send_keys(*args)
+    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
+  end
+
+  def set_text(value, clear: nil, **_unused)
+    value = value.to_s
+    if clear == :backspace
+      # Clear field by sending the correct number of backspace keys.
+      backspaces = [:backspace] * self.value.to_s.length
+      send_keys([:control, 'e'], *backspaces, value)
+    else
+      super.tap do
+        # React doesn't see the safaridriver element clear
+        send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?
+      end
+    end
+  end
+
+  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
+
+private
+
+  def _send_keys(keys, actions = browser_action, down_keys = ModifierKeysStack.new)
+    case keys
+    when *MODIFIER_KEYS
+      down_keys.press(keys)
+      actions.key_down(keys)
+    when String
+      keys = keys.upcase if down_keys&.include?(:shift)
+      actions.send_keys(keys)
+    when Symbol
+      actions.send_keys(keys)
+    when Array
+      down_keys.push
+      keys.each { |sub_keys| _send_keys(sub_keys, actions, down_keys) }
+      down_keys.pop.reverse_each { |key| actions.key_up(key) }
+    else
+      raise ArgumentError, 'Unknown keys type'
+    end
+    actions
+  end
+
+  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

data/lib/capybara/selenium/patches/action_pauser.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActionPauser
+  def initialize(mouse, keyboard)
+    super
+    @devices[:pauser] = Pauser.new
+  end
+
+  def pause(duration)
+    @actions << [:pauser, :pause, [duration]]
+    self
+  end
+
+  class Pauser
+    def pause(duration)
+      sleep duration
+    end
+  end
+
+  private_constant :Pauser
+end
+
+if defined?(Selenium::WebDriver::VERSION) && (Gem::Version.new(Selenium::WebDriver::VERSION) < Gem::Version.new('4')) &&
+   defined?(Selenium::WebDriver::ActionBuilder)
+  Selenium::WebDriver::ActionBuilder.prepend(ActionPauser)
+end

data/lib/capybara/selenium/patches/atoms.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CapybaraAtoms
+private
+
+  def read_atom(function)
+    @atoms ||= Hash.new do |hash, key|
+      hash[key] = begin
+        File.read(File.expand_path("../../atoms/#{key}.min.js", __FILE__))
+      rescue Errno::ENOENT
+        super
+      end
+    end
+    @atoms[function]
+  end
+end
+
+Selenium::WebDriver::Remote::Bridge.prepend CapybaraAtoms unless ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']

data/lib/capybara/selenium/patches/is_displayed.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Selenium
+    module IsDisplayed
+      def commands(command)
+        case command
+        when :is_element_displayed
+          [:get, 'session/:session_id/element/:id/displayed']
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/capybara/selenium/patches/logs.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Selenium
+    module ChromeLogs
+      LOG_MSG = <<~MSG
+        Chromedriver 75+ defaults to W3C mode. Please upgrade to chromedriver >= \
+        75.0.3770.90 if you need to access logs while in W3C compliant mode.
+      MSG
+
+      COMMANDS = {
+        get_available_log_types: [:get, 'session/:session_id/se/log/types'],
+        get_log: [:post, 'session/:session_id/se/log'],
+        get_log_legacy: [:post, 'session/:session_id/log']
+      }.freeze
+
+      def commands(command)
+        COMMANDS[command] || super
+      end
+
+      def available_log_types
+        types = execute :get_available_log_types
+        Array(types).map(&:to_sym)
+      rescue ::Selenium::WebDriver::Error::UnknownCommandError
+        raise NotImplementedError, LOG_MSG
+      end
+
+      def log(type)
+        data = begin
+          execute :get_log, {}, type: type.to_s
+        rescue ::Selenium::WebDriver::Error::UnknownCommandError
+          execute :get_log_legacy, {}, type: type.to_s
+        end
+
+        Array(data).map do |l|
+          ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
+        rescue KeyError
+          next
+        end
+      rescue ::Selenium::WebDriver::Error::UnknownCommandError
+        raise NotImplementedError, LOG_MSG
+      end
+    end
+  end
+end

data/lib/capybara/selenium/patches/pause_duration_fix.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module PauseDurationFix
+  def encode
+    super.tap { |output| output[:duration] ||= 0 }
+  end
+end
+
+Selenium::WebDriver::Interactions::Pause.prepend PauseDurationFix

data/lib/capybara/selenium/patches/persistent_client.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Selenium
+    class PersistentClient < ::Selenium::WebDriver::Remote::Http::Default
+      def close
+        super
+        @http.finish if @http&.started?
+      end
+
+    private
+
+      def http
+        super.tap do |http|
+          http.start unless http.started?
+        end
+      end
+    end
+  end
+end