capybara 3.29.0 → 3.37.1

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

@@ -18,14 +18,16 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     # 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 > 0)){
+        if (arguments[0].multiple && arguments[0].files.length){
           arguments[0].value = null;
         }
       JS
     end
     super
   rescue *file_errors => e
-    raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload" if e.message.match?(/File not found : .+\n.+/m)
+    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
@@ -34,13 +36,15 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     html5_drop(*args)
   end
 
-  def click(*)
+  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
-    raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message if e.message.match?(/element click intercepted/)
+    if e.message.include?('element click intercepted')
+      raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message
+    end
 
     raise
   end
@@ -61,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
@@ -69,11 +73,31 @@ class Capybara::Selenium::ChromeNode < 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 perform_legacy_drag(element)
+  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
@@ -86,12 +110,7 @@ private
     end
   end
 
-  def w3c?
-    (defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)) ||
-      capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
-  end
-
-  def browser_version(to_float = true)
+  def browser_version(to_float: true)
     caps = capabilities
     ver = (caps[:browser_version] || caps[:version])
     ver = ver.to_f if to_float
@@ -99,19 +118,15 @@ private
   end
 
   def chromedriver_fixed_actions_key_state?
-    Gem::Version.new(chromedriver_version) >= Gem::Version.new('76.0.3809.68')
+    Gem::Requirement.new('>= 76.0.3809.68').satisfied_by?(chromedriver_version)
   end
 
   def chromedriver_supports_displayed_endpoint?
-    Gem::Version.new(chromedriver_version) >= Gem::Version.new('76.0.3809.25')
+    Gem::Requirement.new('>= 76.0.3809.25').satisfied_by?(chromedriver_version)
   end
 
   def chromedriver_version
-    capabilities['chrome']['chromedriverVersion'].split(' ')[0]
-  end
-
-  def capabilities
-    driver.browser.capabilities
+    Gem::Version.new(capabilities['chrome']['chromedriverVersion'].split(' ')[0]) # rubocop:disable Style/RedundantArgument
   end
 
   def native_displayed?

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

@@ -18,14 +18,16 @@ class Capybara::Selenium::EdgeNode < Capybara::Selenium::Node
     # 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 > 0)){
+        if (arguments[0].multiple && arguments[0].files.length){
           arguments[0].value = null;
         }
       JS
     end
     super
   rescue *file_errors => e
-    raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload" if e.message.match?(/File not found : .+\n.+/m)
+    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
@@ -67,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

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

@@ -14,7 +14,7 @@ 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
@@ -26,7 +26,7 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
   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 > 0)){
+      if (arguments[0].multiple && arguments[0].files.length){
         arguments[0].value = null;
       }
     JS
@@ -40,11 +40,16 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
     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? { |arg| arg.is_a? Array }
+    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none?(Array)
+
+    native.click unless focused?
 
-    native.click
     _send_keys(args).perform
   end
 
@@ -71,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
@@ -85,7 +90,7 @@ private
     (driver.options[:native_displayed] != false) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']
   end
 
-  def click_with_options(click_options)
+  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?

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

@@ -14,7 +14,7 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
       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
@@ -43,7 +43,7 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
     return '' unless visible?
 
     vis_text = driver.execute_script('return arguments[0].innerText', self)
-    vis_text.gsub(/\ +/, ' ')
+    vis_text.squeeze(' ')
             .gsub(/[\ \n]*\n[\ \n]*/, "\n")
             .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
             .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
@@ -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

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

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

@@ -6,10 +6,10 @@ 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
+        File.read(File.expand_path("../../atoms/#{key}.min.js", __FILE__))
+      rescue Errno::ENOENT
+        super
+      end
     end
     @atoms[function]
   end

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

@@ -27,17 +27,15 @@ module Capybara
 
       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
+          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|
-          begin
-            ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
-          rescue KeyError
-            next
-          end
+          ::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

data/lib/capybara/server/animation_disabler.rb

@@ -16,16 +16,20 @@ 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 = format(DISABLE_JS_MARKUP_TEMPLATE,
+                                    selector: self.class.selector_for(Capybara.disable_animation))
       end
 
       def call(env)
         @status, @headers, @body = @app.call(env)
         return [@status, @headers, @body] unless html_content?
 
+        nonces = directive_nonces.transform_values { |nonce| "nonce=\"#{nonce}\"" if nonce && !nonce.empty? }
         response = Rack::Response.new([], @status, @headers)
 
-        @body.each { |html| response.write insert_disable(html) }
+        @body.each { |html| response.write insert_disable(html, nonces) }
         @body.close if @body.respond_to?(:close)
 
         response.finish
@@ -33,26 +37,45 @@ module Capybara
 
     private
 
-      attr_reader :disable_markup
+      attr_reader :disable_css_markup, :disable_js_markup
 
       def html_content?
         /html/.match?(@headers['Content-Type'])
       end
 
-      def insert_disable(html)
-        html.sub(%r{(</head>)}, 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 defer>(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;
-          }
-        </style>
-      HTML
+      def directive_nonces
+        @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
     end
   end
 end

data/lib/capybara/server/checker.rb

@@ -29,7 +29,7 @@ module Capybara
       end
 
       def https_request(&block)
-        make_request(ssl_options, &block)
+        make_request(**ssl_options, &block)
       end
 
       def make_request(**options, &block)

data/lib/capybara/server/middleware.rb

@@ -4,19 +4,25 @@ module Capybara
   class Server
     class Middleware
       class Counter
-        attr_reader :value
-
         def initialize
-          @value = 0
+          @value = []
           @mutex = Mutex.new
         end
 
-        def increment
-          @mutex.synchronize { @value += 1 }
+        def increment(uri)
+          @mutex.synchronize { @value.push(uri) }
+        end
+
+        def decrement(uri)
+          @mutex.synchronize { @value.delete_at(@value.index(uri) || @value.length) }
+        end
+
+        def positive?
+          @mutex.synchronize { @value.length.positive? }
         end
 
-        def decrement
-          @mutex.synchronize { @value -= 1 }
+        def value
+          @mutex.synchronize { @value.dup }
         end
       end
 
@@ -31,8 +37,12 @@ module Capybara
         @server_errors = server_errors
       end
 
+      def pending_requests
+        @counter.value
+      end
+
       def pending_requests?
-        @counter.value.positive?
+        @counter.positive?
       end
 
       def clear_error
@@ -43,14 +53,16 @@ module Capybara
         if env['PATH_INFO'] == '/__identify__'
           [200, {}, [@app.object_id.to_s]]
         else
-          @counter.increment
+          request_uri = env['REQUEST_URI']
+          @counter.increment(request_uri)
+
           begin
             @extended_app.call(env)
           rescue *@server_errors => e
             @error ||= e
             raise e
           ensure
-            @counter.decrement
+            @counter.decrement(request_uri)
           end
         end
       end

data/lib/capybara/server.rb

@@ -24,7 +24,9 @@ module Capybara
                    host: Capybara.server_host,
                    reportable_errors: Capybara.server_errors,
                    extra_middleware: [])
-      warn 'Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments' unless deprecated_options.empty?
+      unless deprecated_options.empty?
+        warn 'Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments'
+      end
       @app = app
       @extra_middleware = extra_middleware
       @server_thread = nil # suppress warnings
@@ -61,7 +63,7 @@ module Capybara
     def wait_for_pending_requests
       timer = Capybara::Helpers.timer(expire_in: 60)
       while pending_requests?
-        raise 'Requests did not finish in 60 seconds' if timer.expired?
+        raise "Requests did not finish in 60 seconds: #{middleware.pending_requests}" if timer.expired?
 
         sleep 0.01
       end
@@ -106,7 +108,17 @@ module Capybara
 
     def find_available_port(host)
       server = TCPServer.new(host, 0)
-      server.addr[1]
+      port = server.addr[1]
+      server.close
+
+      # Workaround issue where some platforms (mac, ???) when passed a host
+      # of '0.0.0.0' will return a port that is only available on one of the
+      # ip addresses that resolves to, but the next binding to that port requires
+      # that port to be available on all ips
+      server = TCPServer.new(host, port)
+      port
+    rescue Errno::EADDRINUSE
+      retry
     ensure
       server&.close
     end

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].freeze
+                 predicates_wait default_normalize_ws w3c_click_offset enable_aria_role].freeze
 
     attr_accessor(*OPTIONS)
 
@@ -37,6 +37,8 @@ module Capybara
     #   See {Capybara.configure}
     # @!method enable_aria_label
     #   See {Capybara.configure}
+    # @!method enable_aria_role
+    #   See {Capybara.configure}
     # @!method save_path
     #   See {Capybara.configure}
     # @!method asset_host
@@ -79,14 +81,18 @@ module Capybara
 
     remove_method :app_host=
     def app_host=(url)
-      raise ArgumentError, "Capybara.app_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
+      unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
+        raise ArgumentError, "Capybara.app_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}."
+      end
 
       @app_host = url
     end
 
     remove_method :default_host=
     def default_host=(url)
-      raise ArgumentError, "Capybara.default_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
+      unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
+        raise ArgumentError, "Capybara.default_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}."
+      end
 
       @default_host = url
     end
@@ -94,7 +100,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.
     #

data/lib/capybara/session/matchers.rb

@@ -13,14 +13,14 @@ module Capybara
     #     @param string [String]           The string that the current 'path' should equal
     #   @overload $0(regexp, **options)
     #     @param regexp [Regexp]           The regexp that the current 'path' should match to
-    #   @option options [Boolean] :url (true if `string` ia a full url, otherwise false) Whether the compare should be done against the full current url or just the path
+    #   @option options [Boolean] :url (true if `string` is a full url, otherwise false) Whether the comparison should be done against the full current url or just the path
     #   @option options [Boolean] :ignore_query (false)  Whether the query portion of the current url/path should be ignored
     #   @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time that Capybara will wait for the current url/path to eq/match given string/regexp argument
     # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
     # @return [true]
     #
-    def assert_current_path(path, **options)
-      _verify_current_path(path, options) do |query|
+    def assert_current_path(path, **options, &optional_filter_block)
+      _verify_current_path(path, optional_filter_block, **options) do |query|
         raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
       end
     end
@@ -35,8 +35,8 @@ module Capybara
     # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
     # @return [true]
     #
-    def assert_no_current_path(path, **options)
-      _verify_current_path(path, options) do |query|
+    def assert_no_current_path(path, **options, &optional_filter_block)
+      _verify_current_path(path, optional_filter_block, **options) do |query|
         raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self)
       end
     end
@@ -50,8 +50,8 @@ module Capybara
     # @macro current_path_query_params
     # @return [Boolean]
     #
-    def has_current_path?(path, **options)
-      make_predicate(options) { assert_current_path(path, options) }
+    def has_current_path?(path, **options, &optional_filter_block)
+      make_predicate(options) { assert_current_path(path, **options, &optional_filter_block) }
     end
 
     ##
@@ -63,14 +63,14 @@ module Capybara
     # @macro current_path_query_params
     # @return [Boolean]
     #
-    def has_no_current_path?(path, **options)
-      make_predicate(options) { assert_no_current_path(path, options) }
+    def has_no_current_path?(path, **options, &optional_filter_block)
+      make_predicate(options) { assert_no_current_path(path, **options, &optional_filter_block) }
     end
 
   private
 
-    def _verify_current_path(path, options)
-      query = Capybara::Queries::CurrentPathQuery.new(path, options)
+    def _verify_current_path(path, filter_block, **options)
+      query = Capybara::Queries::CurrentPathQuery.new(path, **options, &filter_block)
       document.synchronize(query.wait) do
         yield(query)
       end