Merge pull request #159 from rubycdp/fix-122-pending-connections

Fix #122 avoid reached server, but there are pending connections

Author: route

README.md

@@ -157,6 +157,9 @@ Ferrum::Browser.new(options)
   * `:timeout` (Numeric) - The number of seconds we'll wait for a response when
       communicating with browser. Default is 5.
   * `:js_errors` (Boolean) - When true, JavaScript errors get re-raised in Ruby.
+  * `:pending_connection_errors` (Boolean) - When main frame is still waiting for slow responses while timeout is
+      reached `PendingConnectionsError` is raised. It's better to figure out why you have slow responses and fix or
+      block them rather than turn this setting off. Default is true.
   * `:browser_name` (Symbol) - `:chrome` by default, only experimental support
       for `:firefox` for now.
   * `:browser_path` (String) - Path to Chrome binary, you can also set ENV

lib/ferrum.rb

@@ -10,17 +10,20 @@ class NoSuchTargetError   < Error; end
   class NotImplementedError < Error; end
 
   class StatusError < Error
+    def initialize(url, message = nil)
+      super(message || "Request to #{url} failed to reach server, check DNS and server status")
+    end
+  end
+
+  class PendingConnectionsError < StatusError
     attr_reader :pendings
 
     def initialize(url, pendings = [])
       @pendings = pendings
-      message = if pendings.empty?
-                  "Request to #{url} failed to reach server, check DNS and/or server status"
-                else
-                  "Request to #{url} reached server, but there are still pending connections: #{pendings.join(', ')}"
-                end
 
-      super(message)
+      message = "Request to #{url} reached server, but there are still pending connections: #{pendings.join(', ')}"
+
+      super(url, message)
     end
   end
 

lib/ferrum/browser.rb

@@ -29,7 +29,7 @@ class Browser
                 on goto] => :page
     delegate %i[default_user_agent] => :process
 
-    attr_reader :client, :process, :contexts, :logger, :js_errors,
+    attr_reader :client, :process, :contexts, :logger, :js_errors, :pending_connection_errors,
                 :slowmo, :base_url, :options, :window_size, :ws_max_receive_size
     attr_writer :timeout
 
@@ -44,6 +44,7 @@ def initialize(options = nil)
       @logger, @timeout, @ws_max_receive_size =
         @options.values_at(:logger, :timeout, :ws_max_receive_size)
       @js_errors = @options.fetch(:js_errors, false)
+      @pending_connection_errors = @options.fetch(:pending_connection_errors, true)
       @slowmo = @options[:slowmo].to_f
 
       if @options.key?(:base_url)

lib/ferrum/page.rb

@@ -78,8 +78,10 @@ def go_to(url = nil)
       end
       response["frameId"]
     rescue TimeoutError
-      pendings = network.traffic.select(&:pending?).map { |e| e.request.url }
-      raise StatusError.new(options[:url], pendings) unless pendings.empty?
+      if @browser.pending_connection_errors
+        pendings = network.traffic.select(&:pending?).map { |e| e.request.url }
+        raise PendingConnectionsError.new(options[:url], pendings) unless pendings.empty?
+      end
     end
     alias goto go_to
 

spec/browser_spec.rb

@@ -283,7 +283,10 @@ module Ferrum
       end
 
       it "handles when DNS incorrect" do
-        expect { browser.go_to("http://nope:#{port}/") }.to raise_error(Ferrum::StatusError)
+        expect { browser.go_to("http://nope:#{port}/") }.to raise_error(
+          Ferrum::StatusError,
+          %r{Request to http://nope:\d+/ failed to reach server, check DNS and server status}
+        )
       end
 
       it "has a descriptive message when DNS incorrect" do
@@ -292,7 +295,7 @@ module Ferrum
           browser.go_to(url)
         }.to raise_error(
           Ferrum::StatusError,
-          %(Request to #{url} failed to reach server, check DNS and/or server status)
+          %r{Request to http://nope:#{port}/ failed to reach server, check DNS and server status}
         )
       end
 
@@ -303,8 +306,8 @@ module Ferrum
           expect {
             browser.go_to("/ferrum/visit_timeout")
           }.to raise_error(
-            Ferrum::StatusError,
-            %r{there are still pending connections: http://.*/ferrum/really_slow}
+            Ferrum::PendingConnectionsError,
+            %r{Request to http://.*/ferrum/visit_timeout reached server, but there are still pending connections: http://.*/ferrum/really_slow}
           )
         ensure
           browser.timeout = old_timeout
@@ -319,8 +322,8 @@ module Ferrum
           expect {
             browser.go_to("/ferrum/really_slow")
           }.to raise_error(
-            Ferrum::StatusError,
-            %r{there are still pending connections: http://.*/ferrum/really_slow}
+            Ferrum::PendingConnectionsError,
+            %r{Request to http://.*/ferrum/really_slow reached server, but there are still pending connections: http://.*/ferrum/really_slow}
           )
         ensure
           browser.timeout = prev_timeout
@@ -336,6 +339,16 @@ module Ferrum
           browser.timeout = old_timeout
         end
       end
+
+      it "does not report open resources when pending_connection_errors is set to false" do
+        begin
+          browser = Browser.new(base_url: base_url, pending_connection_errors: false, timeout: 0.1)
+
+          expect { browser.go_to("/ferrum/really_slow") }.not_to raise_error
+        ensure
+          browser&.quit
+        end
+      end
     end
 
     it "allows the driver to have a fixed port" do