capybara 3.35.2 → 3.39.2

data/lib/capybara/selenium/logger_suppressor.rb

@@ -3,7 +3,7 @@
 module Capybara
   module Selenium
     module DeprecationSuppressor
-      def initialize(*)
+      def initialize(...)
         @suppress_for_capybara = false
         super
       end
@@ -18,6 +18,10 @@ module Capybara
         end
       end
 
+      def warn(*args, **opts)
+        super unless @suppress_for_capybara
+      end
+
       def suppress_deprecations
         prev_suppress_for_capybara, @suppress_for_capybara = @suppress_for_capybara, true
         yield
@@ -27,7 +31,7 @@ module Capybara
     end
 
     module ErrorSuppressor
-      def for_code(*)
+      def for_code(...)
         ::Selenium::WebDriver.logger.suppress_deprecations do
           super
         end

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,6 +51,11 @@ 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)
     if value.is_a?(Array) && !multiple?
       raise ArgumentError, "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}"
@@ -110,11 +113,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
         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_pause(action, click_options.delay)
         action.release
       end
     end
@@ -135,9 +134,9 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
         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)
+        action.pointer_down(:right).then do |act|
+          action_pause(act, click_options.delay)
+        end.pointer_up(:right)
       else
         raise ArgumentError, 'Delay is not supported when right clicking with legacy (non-w3c) selenium driver'
       end
@@ -179,7 +178,12 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def tag_name
-    @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
@@ -199,10 +203,6 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     native.attribute('isContentEditable') == 'true'
   end
 
-  def ==(other)
-    native == other.native
-  end
-
   def path
     driver.evaluate_script GET_XPATH_SCRIPT, self
   end
@@ -218,6 +218,13 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     native.rect
   end
 
+  def shadow_root
+    raise 'You must be using Selenium 4.1+ for shadow_root support' unless native.respond_to? :shadow_root
+
+    root = native.shadow_root
+    root && build_node(native.shadow_root)
+  end
+
 protected
 
   def scroll_if_needed
@@ -228,7 +235,7 @@ protected
   end
 
   def scroll_to_center
-    script = <<-'JS'
+    script = <<-JS
       try {
         arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});
       } catch(e) {
@@ -274,7 +281,7 @@ private
     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
@@ -282,7 +289,7 @@ private
       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])
+        send_keys(value[-3..])
       else
         send_keys(value)
       end
@@ -298,7 +305,7 @@ private
 
     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)
@@ -407,10 +414,30 @@ private
 
   def action_with_modifiers(click_options)
     actions = browser_action.tap do |acts|
-      if click_options.center_offset? && click_options.coords?
-        acts.move_to(native).move_by(*click_options.coords)
+      if click_options.coords?
+        if click_options.center_offset?
+          if Gem::Version.new(Selenium::WebDriver::VERSION) >= Gem::Version.new('4.3')
+            acts.move_to(native, *click_options.coords)
+          else
+            ::Selenium::WebDriver.logger.suppress_deprecations do
+              acts.move_to(native).move_by(*click_options.coords)
+            end
+          end
+        elsif Gem::Version.new(Selenium::WebDriver::VERSION) >= Gem::Version.new('4.3')
+          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)
+        else
+          ::Selenium::WebDriver.logger.suppress_deprecations do
+            acts.move_to(native, *click_options.coords)
+          end
+        end
       else
-        acts.move_to(native, *click_options.coords)
+        acts.move_to(native)
       end
     end
     modifiers_down(actions, click_options.keys)
@@ -449,10 +476,22 @@ private
   end
 
   def w3c?
-    (defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)) ||
+    (defined?(Selenium::WebDriver::VERSION) && (Gem::Version.new(Selenium::WebDriver::VERSION) >= Gem::Version.new('4'))) ||
       capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
   end
 
+  def action_pause(action, duration)
+    if w3c?
+      if Gem::Version.new(Selenium::WebDriver::VERSION) >= Gem::Version.new('4.2')
+        action.pause(device: action.pointer_inputs.first, duration: duration)
+      else
+        action.pause(action.pointer_inputs.first, duration)
+      end
+    else
+      action.pause(duration)
+    end
+  end
+
   def normalize_keys(keys)
     keys.map do |key|
       case key
@@ -479,7 +518,7 @@ private
   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)
+    driver.evaluate_script <<~JS, self, attr_names.map(&:to_s)
       (function(el, names){
         return names.map(function(name){
           return el[name]
@@ -488,6 +527,16 @@ private
     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 = '';
@@ -520,7 +569,7 @@ private
     })(arguments[0], document)
   JS
 
-  OBSCURED_OR_OFFSET_SCRIPT = <<~'JS'
+  OBSCURED_OR_OFFSET_SCRIPT = <<~JS
     (function(el, x, y) {
       var box = el.getBoundingClientRect();
       if (x == null) x = box.width/2;
@@ -537,7 +586,7 @@ private
     })(arguments[0], arguments[1], arguments[2])
   JS
 
-  RAPID_APPEND_TEXT = <<~'JS'
+  RAPID_APPEND_TEXT = <<~JS
     (function(el, value) {
       value = el.value + value;
       if (el.maxLength && el.maxLength != -1){

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

@@ -65,7 +65,7 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     return super unless native_displayed?
 
     begin
-      bridge.send(:execute, :is_element_displayed, id: native.ref)
+      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
@@ -106,7 +106,11 @@ private
 
   def file_errors
     @file_errors = ::Selenium::WebDriver.logger.suppress_deprecations do
-      [::Selenium::WebDriver::Error::ExpectedError]
+      if defined? ::Selenium::WebDriver::Error::ExpectedError # Selenium < 4
+        [::Selenium::WebDriver::Error::ExpectedError]
+      else
+        []
+      end
     end
   end
 

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

@@ -38,7 +38,7 @@ class Capybara::Selenium::EdgeNode < Capybara::Selenium::Node
     html5_drop(*args)
   end
 
-  def click(*)
+  def click(*, **)
     super
   rescue Selenium::WebDriver::Error::InvalidArgumentError => e
     tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }
@@ -69,7 +69,7 @@ class Capybara::Selenium::EdgeNode < Capybara::Selenium::Node
     return super unless chrome_edge? && native_displayed?
 
     begin
-      bridge.send(:execute, :is_element_displayed, id: native.ref)
+      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
@@ -77,11 +77,33 @@ class Capybara::Selenium::EdgeNode < Capybara::Selenium::Node
     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
-      [::Selenium::WebDriver::Error::ExpectedError]
+      if defined? ::Selenium::WebDriver::Error::ExpectedError # Selenium < 4
+        [::Selenium::WebDriver::Error::ExpectedError]
+      else
+        []
+      end
     end
   end
 

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

@@ -11,8 +11,8 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
     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 '\
+      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
@@ -76,7 +76,7 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
     return super unless native_displayed?
 
     begin
-      bridge.send(:execute, :is_element_displayed, id: native.ref)
+      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

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

@@ -11,10 +11,10 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
     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. '\
+      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)
+      return find_css('th:first-child,td:first-child')[0].click(keys, **options)
     end
     raise
   rescue ::Selenium::WebDriver::Error::WebDriverError => e
@@ -74,7 +74,7 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
     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]))
+      send_keys([:control, 'e'], *backspaces, value)
     else
       super.tap do
         # React doesn't see the safaridriver element clear

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

@@ -20,7 +20,7 @@ module ActionPauser
   private_constant :Pauser
 end
 
-if defined?(::Selenium::WebDriver::VERSION) && (::Selenium::WebDriver::VERSION.to_f < 4) &&
-   defined?(::Selenium::WebDriver::ActionBuilder)
-  ::Selenium::WebDriver::ActionBuilder.prepend(ActionPauser)
+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

@@ -15,4 +15,4 @@ private
   end
 end
 
-::Selenium::WebDriver::Remote::Bridge.prepend CapybaraAtoms unless ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']
+Selenium::WebDriver::Remote::Bridge.prepend CapybaraAtoms unless ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']

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

@@ -6,4 +6,4 @@ module PauseDurationFix
   end
 end
 
-::Selenium::WebDriver::Interactions::Pause.prepend PauseDurationFix
+Selenium::WebDriver::Interactions::Pause.prepend PauseDurationFix

data/lib/capybara/server/animation_disabler.rb

@@ -16,48 +16,65 @@ module Capybara
 
       def initialize(app)
         @app = app
-        @disable_markup = format(DISABLE_MARKUP_TEMPLATE, selector: self.class.selector_for(Capybara.disable_animation))
+        @disable_css_markup = format(DISABLE_CSS_MARKUP_TEMPLATE,
+                                     selector: self.class.selector_for(Capybara.disable_animation))
+        @disable_js_markup = +DISABLE_JS_MARKUP_TEMPLATE
       end
 
       def call(env)
-        @status, @headers, @body = @app.call(env)
-        return [@status, @headers, @body] unless html_content?
+        status, headers, body = @app.call(env)
+        return [status, headers, body] unless html_content?(headers)
 
-        response = Rack::Response.new([], @status, @headers)
+        nonces = directive_nonces(headers).transform_values { |nonce| "nonce=\"#{nonce}\"" if nonce && !nonce.empty? }
+        response = Rack::Response.new([], status, headers)
 
-        @body.each { |html| response.write insert_disable(html) }
-        @body.close if @body.respond_to?(:close)
+        body.each { |html| response.write insert_disable(html, nonces) }
+        body.close if body.respond_to?(:close)
 
         response.finish
       end
 
     private
 
-      attr_reader :disable_markup
+      attr_reader :disable_css_markup, :disable_js_markup
 
-      def html_content?
-        /html/.match?(@headers['Content-Type'])
+      def html_content?(headers)
+        /html/.match?(headers['Content-Type']) # rubocop:todo Performance/StringInclude
       end
 
-      def insert_disable(html)
-        html.sub(%r{(</body>)}, "#{disable_markup}\\1")
+      def insert_disable(html, nonces)
+        html.sub(%r{(</head>)}, "<style #{nonces['style-src']}>#{disable_css_markup}</style>\\1")
+            .sub(%r{(</body>)}, "<script #{nonces['script-src']}>#{disable_js_markup}</script>\\1")
       end
 
-      DISABLE_MARKUP_TEMPLATE = <<~HTML
-        <script>
+      def directive_nonces(headers)
+        headers.fetch('Content-Security-Policy', '')
+               .split(';')
+               .map(&:split)
+               .to_h do |s|
+                 [
+                   s[0], s[1..].filter_map do |value|
+                     /^'nonce-(?<nonce>.+)'/ =~ value
+                     nonce
+                   end[0]
+                 ]
+               end
+      end
+
+      DISABLE_CSS_MARKUP_TEMPLATE = <<~CSS
+        %<selector>s, %<selector>s::before, %<selector>s::after {
+           transition: none !important;
+           animation-duration: 0s !important;
+           animation-delay: 0s !important;
+           scroll-behavior: auto !important;
+        }
+      CSS
+
+      DISABLE_JS_MARKUP_TEMPLATE = <<~SCRIPT
         //<![CDATA[
           (typeof jQuery !== 'undefined') && (jQuery.fx.off = true);
         //]]>
-        </script>
-        <style>
-          %<selector>s, %<selector>s::before, %<selector>s::after {
-             transition: none !important;
-             animation-duration: 0s !important;
-             animation-delay: 0s !important;
-             scroll-behavior: auto !important;
-          }
-        </style>
-      HTML
+      SCRIPT
     end
   end
 end

data/lib/capybara/server/middleware.rb

@@ -14,7 +14,7 @@ module Capybara
         end
 
         def decrement(uri)
-          @mutex.synchronize { @value.delete_at(@value.index(uri) || @value.length) }
+          @mutex.synchronize { @value.delete_at(@value.index(uri) || - 1) }
         end
 
         def positive?

data/lib/capybara/session/config.rb

@@ -8,7 +8,7 @@ module Capybara
                  automatic_reload match exact exact_text raise_server_errors visible_text_only
                  automatic_label_click enable_aria_label save_path asset_host default_host app_host
                  server_host server_port server_errors default_set_options disable_animation test_id
-                 predicates_wait default_normalize_ws w3c_click_offset enable_aria_role].freeze
+                 predicates_wait default_normalize_ws w3c_click_offset enable_aria_role default_retry_interval].freeze
 
     attr_accessor(*OPTIONS)
 
@@ -21,6 +21,8 @@ module Capybara
     #   See {Capybara.configure}
     # @!method default_max_wait_time
     #   See {Capybara.configure}
+    # @!method default_retry_interval
+    #   See {Capybara.configure}
     # @!method ignore_hidden_elements
     #   See {Capybara.configure}
     # @!method automatic_reload
@@ -100,7 +102,7 @@ module Capybara
     remove_method :test_id=
     ##
     #
-    # Set an attribue to be optionally matched against the locator for builtin selector types.
+    # Set an attribute to be optionally matched against the locator for builtin selector types.
     # This attribute will be checked by builtin selector types whenever id would normally be checked.
     # If `nil` then it will be ignored.
     #