capybara 3.8.1 → 3.33.0

data/lib/capybara/server/checker.rb

@@ -25,11 +25,15 @@ module Capybara
     private
 
       def http_request(&block)
-        Net::HTTP.start(@host, @port, read_timeout: 2, &block)
+        make_request(read_timeout: 2, &block)
       end
 
       def https_request(&block)
-        Net::HTTP.start(@host, @port, ssl_options, &block)
+        make_request(**ssl_options, &block)
+      end
+
+      def make_request(**options, &block)
+        Net::HTTP.start(@host, @port, options.merge(max_retries: 0), &block)
       end
 
       def ssl_options

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 decrement
-          @mutex.synchronize { @value -= 1 }
+        def positive?
+          @mutex.synchronize { @value.length.positive? }
+        end
+
+        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,14 @@ module Capybara
         if env['PATH_INFO'] == '/__identify__'
           [200, {}, [@app.object_id.to_s]]
         else
-          @counter.increment
+          @counter.increment(env['REQUEST_URI'])
           begin
             @extended_app.call(env)
-          rescue *@server_errors => err
-            @error ||= err
-            raise err
+          rescue *@server_errors => e
+            @error ||= e
+            raise e
           ensure
-            @counter.decrement
+            @counter.decrement(env['REQUEST_URI'])
           end
         end
       end

data/lib/capybara/server.rb

@@ -8,6 +8,7 @@ require 'capybara/server/animation_disabler'
 require 'capybara/server/checker'
 
 module Capybara
+  # @api private
   class Server
     class << self
       def ports
@@ -17,8 +18,15 @@ module Capybara
 
     attr_reader :app, :port, :host
 
-    def initialize(app, *deprecated_options, port: Capybara.server_port, 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?
+    def initialize(app,
+                   *deprecated_options,
+                   port: Capybara.server_port,
+                   host: Capybara.server_host,
+                   reportable_errors: Capybara.server_errors,
+                   extra_middleware: [])
+      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
@@ -44,11 +52,10 @@ module Capybara
 
     def responsive?
       return false if @server_thread&.join(0)
+
       res = @checker.request { |http| http.get('/__identify__') }
 
-      if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
-        return res.body == app.object_id.to_s
-      end
+      return res.body == app.object_id.to_s if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
     rescue SystemCallError, Net::ReadTimeout, OpenSSL::SSL::SSLError
       false
     end
@@ -56,7 +63,8 @@ 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
     end
@@ -72,6 +80,7 @@ module Capybara
         timer = Capybara::Helpers.timer(expire_in: 60)
         until responsive?
           raise 'Rack application timed out during boot' if timer.expired?
+
           @server_thread.join(0.1)
         end
       end
@@ -79,6 +88,10 @@ module Capybara
       self
     end
 
+    def base_url
+      "http#{'s' if using_ssl?}://#{host}:#{port}"
+    end
+
   private
 
     def middleware
@@ -95,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].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
@@ -59,6 +61,8 @@ module Capybara
     #   See {Capybara.configure}
     # @!method default_normalize_ws
     #   See {Capybara.configure}
+    # @!method w3c_click_offset
+    #   See {Capybara.configure}
 
     remove_method :server_host
 
@@ -77,20 +81,20 @@ 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}." if url && url !~ 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}." if url && url !~ URI::DEFAULT_PARSER.make_regexp
-      @default_host = url
-    end
+      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
 
-    remove_method :disable_animation=
-    def disable_animation=(bool_or_allowlist)
-      warn 'Capybara.disable_animation is a beta feature - it may change/disappear in a future point version' if bool_or_allowlist
-      @disable_animation = bool_or_allowlist
+      @default_host = url
     end
 
     remove_method :test_id=
@@ -100,7 +104,7 @@ module Capybara
     # This attribute will be checked by builtin selector types whenever id would normally be checked.
     # If `nil` then it will be ignored.
     #
-    #  @params [String, Symbol, nil] id Name of the attribute to use as the test id
+    # @param [String, Symbol, nil] id Name of the attribute to use as the test id
     #
     def test_id=(id)
       @test_id = id&.to_sym

data/lib/capybara/session/matchers.rb

@@ -6,7 +6,7 @@ module Capybara
     # Asserts that the page has the given path.
     # By default, if passed a full url this will compare against the full url,
     # if passed a path only the path+query portion will be compared, if passed a regexp
-    # the comparison will depend on the :url option
+    # the comparison will depend on the :url option (path+query by default)
     #
     # @!macro current_path_query_params
     #   @overload $0(string, **options)
@@ -20,7 +20,9 @@ module Capybara
     # @return [true]
     #
     def assert_current_path(path, **options)
-      _verify_current_path(path, options) { |query| raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self) }
+      _verify_current_path(path, **options) do |query|
+        raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
+      end
     end
 
     ##
@@ -34,7 +36,9 @@ module Capybara
     # @return [true]
     #
     def assert_no_current_path(path, **options)
-      _verify_current_path(path, options) { |query| raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self) }
+      _verify_current_path(path, **options) do |query|
+        raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self)
+      end
     end
 
     ##
@@ -47,7 +51,7 @@ module Capybara
     # @return [Boolean]
     #
     def has_current_path?(path, **options)
-      make_predicate(options) { assert_current_path(path, options) }
+      make_predicate(options) { assert_current_path(path, **options) }
     end
 
     ##
@@ -60,13 +64,13 @@ module Capybara
     # @return [Boolean]
     #
     def has_no_current_path?(path, **options)
-      make_predicate(options) { assert_no_current_path(path, options) }
+      make_predicate(options) { assert_no_current_path(path, **options) }
     end
 
   private
 
-    def _verify_current_path(path, options)
-      query = Capybara::Queries::CurrentPathQuery.new(path, options)
+    def _verify_current_path(path, **options)
+      query = Capybara::Queries::CurrentPathQuery.new(path, **options)
       document.synchronize(query.wait) do
         yield(query)
       end