raptor 0.22.3 → 0.23.0

data/lib/raptor/control_server.rb

@@ -19,9 +19,10 @@ module Raptor
     # @rbs @client: Atom
     # @rbs @thread: Thread?
 
-    # Creates a control server for `url` without binding it.
+    # Creates a new ControlServer for `url` without binding it.
     #
     # @param url [String] `unix://` URL to listen on
+    # @yield for each stats request
     # @yieldreturn [Hash] cluster statistics
     # @return [void]
     # @raise [ArgumentError] if the URL is not a Unix socket
@@ -131,7 +132,7 @@ module Raptor
     # @rbs (UNIXSocket client) -> void
     def handle(client)
       request_line = client.gets
-      while line = client.gets
+      while (line = client.gets)
         break if line == "\r\n"
       end
 

data/lib/raptor/detached_body.rb

@@ -66,6 +66,7 @@ module Raptor
     #
     # @param max_buffer_size [Integer] maximum body bytes waiting to be written
     # @return [void]
+    # @raise [ArgumentError] if `max_buffer_size` is not positive
     #
     # @rbs (?max_buffer_size: Integer) -> void
     def initialize(max_buffer_size: DEFAULT_MAX_BUFFER_SIZE)
@@ -84,6 +85,7 @@ module Raptor
     # Registers a callback that runs on the request thread once the server
     # accepts the response stream.
     #
+    # @yield once the response stream opens
     # @yieldparam stream [DetachedBody] the opened response stream
     # @return [DetachedBody]
     #
@@ -95,6 +97,7 @@ module Raptor
 
     # Registers a callback for when the response stream closes.
     #
+    # @yield once the response stream closes
     # @yieldparam reason [Symbol] why the stream closed
     # @return [DetachedBody]
     #
@@ -108,6 +111,7 @@ module Raptor
     #
     # @param chunk [String] response body bytes
     # @return [Symbol] `:accepted`, `:full`, or `:closed`
+    # @raise [TypeError] if the chunk is not a String
     #
     # @rbs (String chunk) -> Symbol
     def try_write(chunk)
@@ -150,7 +154,7 @@ module Raptor
       result
     end
 
-    # Finishes the body after all accepted bytes have been written.
+    # Marks the body complete; the stream finishes once buffered bytes are written.
     #
     # @param trailers [Hash] trailing response headers
     # @return [void]
@@ -158,7 +162,7 @@ module Raptor
     # @rbs (?trailers: Hash[String, String | Array[String]]) -> void
     def close(trailers: {})
       trailers = trailers.to_h do |name, value|
-        value = value.is_a?(Array) ? value.map { _1.dup.freeze }.freeze : value.dup.freeze
+        value = value.is_a?(Array) ? value.map { |item| item.dup.freeze }.freeze : value.dup.freeze
         [name.dup.freeze, value]
       end.freeze
       wake = false

data/lib/raptor/http.rb

@@ -20,7 +20,7 @@ module Raptor
     REMOTE_ADDR = "REMOTE_ADDR"
     REQUEST_URI = "REQUEST_URI"
     SERVER_SOFTWARE = "SERVER_SOFTWARE"
-    SERVER_SOFTWARE_VALUE = "Raptor/#{Raptor::VERSION}".freeze
+    SERVER_SOFTWARE_VALUE = "Raptor/#{VERSION}".freeze
 
     class WriteError < StandardError
       # @rbs () -> String
@@ -56,6 +56,7 @@ module Raptor
           bytes += socket.write_nonblock(bytes.zero? ? string : string.byteslice(bytes..-1))
         rescue IO::WaitWritable
           raise WriteError unless socket.wait_writable(timeout)
+
           retry
         rescue IOError
           raise WriteError
@@ -79,9 +80,10 @@ module Raptor
       return if total.zero?
 
       begin
-        written = Raptor::VectorIO.writev_nonblock(socket, strings)
+        written = VectorIO.writev_nonblock(socket, strings)
       rescue IO::WaitWritable
         raise WriteError unless socket.wait_writable(timeout)
+
         retry
       rescue IOError
         raise WriteError
@@ -113,7 +115,7 @@ module Raptor
     # @rbs (Hash[String, untyped] env_template, Integer? max_body_size) -> ^(Hash[Symbol, untyped]) -> Hash[Symbol, untyped]
     def self.parser_worker(env_template, max_body_size)
       proc do |data|
-        Raptor::Http1.parse(data, env_template, max_body_size)
+        Http1.parse(data, env_template, max_body_size)
       end
     end
 
@@ -121,12 +123,12 @@ module Raptor
     # registration order, rescuing any that raise.
     #
     # @param env [Hash, nil] the Rack environment
-    # @param status [Integer, nil] the response status code
+    # @param status [Object, nil] the status returned by the app, if any
     # @param headers [Hash, nil] the response headers
     # @param error [Exception, nil] any error raised during processing, or nil on success
     # @return [void]
     #
-    # @rbs (Hash[String, untyped]? env, Integer? status, Hash[String, String | Array[String]]? headers, Exception? error) -> void
+    # @rbs (Hash[String, untyped]? env, untyped status, Hash[String, String | Array[String]]? headers, Exception? error) -> void
     def self.call_response_finished(env, status, headers, error)
       return unless env && env[Rack::RACK_RESPONSE_FINISHED].is_a?(Array)