Refactor Reactor and Client request buffering

Refactor Reactor into a more generic IO-with-timeout monitor,
using Queue and SortedSet to simplify the implementation.
Move request-buffering logic into Server#reactor_wakeup.
Fixes bug in managing timeouts on clients.
Move, update and rewrite documentation to match updated class structure.

History.md

@@ -59,6 +59,7 @@
   * JSON parse cluster worker stats instead of regex (#2124)
   * Support parallel tests in verbose progress reporting (#2223)
   * Refactor error handling in server accept loop (#2239)
+  * Refactor Reactor and Client request buffering (#2279)
 
 ## 4.3.4/4.3.5 and 3.12.5/3.12.6 / 2020-05-22
 

lib/puma/client.rb

@@ -104,6 +104,15 @@ def set_timeout(val)
       @timeout_at = Time.now + val
     end
 
+    # Number of seconds until the timeout elapses.
+    def timeout
+      [@timeout_at - Time.now, 0].max
+    end
+
+    def <=>(other)
+      @timeout_at <=> other.timeout_at
+    end
+
     def reset(fast_check=true)
       @parser.reset
       @read_header = true
@@ -251,14 +260,16 @@ def finish(timeout)
         rescue ThreadPool::ForceShutdown
           nil
         end
-        unless can_read
-          write_error(408) if in_data_phase
-          raise ConnectionError
-        end
+        timeout! unless can_read
       end
       true
     end
 
+    def timeout!
+      write_error(408) if in_data_phase
+      raise ConnectionError
+    end
+
     def write_error(status_code)
       begin
         @io << ERROR_RESPONSE[status_code]

lib/puma/queue_close.rb

@@ -0,0 +1,24 @@
+# Queue#close was added in Ruby 2.3.
+# Add a simple implementation for earlier Ruby versions.
+unless Queue.instance_methods.include?(:close)
+  class ClosedQueueError < StandardError; end
+  module Puma
+    module QueueClose
+      def initialize
+        @closed = false
+        super
+      end
+      def close
+        @closed = true
+      end
+      def closed?
+        @closed
+      end
+      def push(object)
+        raise ClosedQueueError if @closed
+        super
+      end
+    end
+    Queue.prepend QueueClose
+  end
+end