biryani 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68d7513a831a0ea2e4b4bf55400d1e1d464a5c16aa7577ba2c6c7937d0a62019
-  data.tar.gz: dad97d0529ef59f2e233da2a7042b6eeacbc95f77328ac0172ad45fcc24fd9db
+  metadata.gz: 1a92a6898bad6aab7de417a5eff15af74a99a41d33e380fd93447f8b15d77ba5
+  data.tar.gz: 473061a7d89df0b3956bc396a29102f76f6205b7e3795a452244f30f1f84da3e
 SHA512:
-  metadata.gz: eb4574ee23c377e4919f64f8c84d8798e3f52224788555456cac185e923694bc9dec8647a2e495727652aa398ca44ce1bb5dc4ef57b850f066c1621f0714dcde
-  data.tar.gz: efed6f174ab3a74b6fb33d110ed53cb6cd56fef824a928723800b78c7629b620ef6ee647138cdd22b3e8094235eb49b484e7a2a6c88c1e4c9d3fedac354768dc
+  metadata.gz: c76936ffedc6058d29c946a526217f47840248b0e7a1042a2fee816a3488f79aa2a848621f3c443d5d58eed16df8c3f013906fc3f34730eb71a24da6b2022287
+  data.tar.gz: e9b25fdf0d6d1481d12faae276941d80d8910361e0916f22d617b059982c3a56cc7310579e63c0b0466797181b2976eb4213b9650b613be55717f7d05060c250

data/.ruby-version

@@ -1 +1 @@
-4.0.7
+4.1-dev

data/conformance/server_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Server do
   before do
     @tcpserver = TCPServer.open(PORT)
 
-    Ractor.new(@tcpserver) do |socket|
+    r = Ractor.new do
       server = Server.new(
         Ractor.shareable_proc do |_, res|
           res.status = 200
@@ -12,8 +12,9 @@ RSpec.describe Server do
         end
       )
 
-      server.run(socket)
+      server.run(Ractor.receive)
     end
+    r.send(@tcpserver.dup, move: true)
   end
 
   let(:junit_report_file_path) do

data/example/sqlite3.rb

@@ -20,13 +20,13 @@ require 'biryani'
 #   |    DB_PORT.receive <---------------+-----------+--+---- DB_PORT.send                         |   |
 #   |    reply.send ---------------------+-----------+--+---> reply.receive                        |   |
 #   |                                    |           |  +------------------------------------------+   |
-#   |  Ractor.new(server, socket)        |           |                                                 |
+#   |  r.send(socket, move: true)        |           |                                                 |
 #   +----+-------------------------------+           +-------------------------------------------------+
 #        |                                                                                          ^
 #        v                                                                                          |
 #   +-- server Ractor ----------------------+       +-- connection Ractor (1 Ractor / connection) --+--+
 #   |  server.run(socket)                   |       |  Stream.new(tx, stream_id, proc)              |  |
-#   |    Ractor.new(socket.accept, @proc) --+------>|    Ractor.new(tx, stream_id, proc) -----------+  |
+#   |    r.send(io, move: true) ------------+------>|    Ractor.new(tx, stream_id, proc) -----------+  |
 #   +---------------------------------------+       +--------------------------------------------------+
 DB_PORT = Ractor::Port.new
 
@@ -159,7 +159,8 @@ server = Biryani::Server.new(
     App.call(req, res)
   end
 )
-Ractor.new(server, socket) { |s, sock| s.run(sock) }
+r = Ractor.new(server) { |s| s.run(Ractor.receive) }
+r.send(socket, move: true)
 DB.serve(path)
 
 # $ bundle exec ruby sqlite3.rb

data/lib/biryani/connection.rb

@@ -14,8 +14,10 @@ module Biryani
     CONNECTION_PREFACE_LENGTH = CONNECTION_PREFACE.length
     DEFAULT_HEADER_TABLE_SIZE = 4_096
     INITIAL_CONNECTION_WINDOW_SIZE = 65_535
+    LINGER_TIMEOUT = 5
 
-    private_constant :CONNECTION_PREFACE, :CONNECTION_PREFACE_LENGTH, :DEFAULT_HEADER_TABLE_SIZE, :INITIAL_CONNECTION_WINDOW_SIZE
+    private_constant :CONNECTION_PREFACE, :CONNECTION_PREFACE_LENGTH, :DEFAULT_HEADER_TABLE_SIZE, :INITIAL_CONNECTION_WINDOW_SIZE,
+                     :LINGER_TIMEOUT
     Ractor.make_shareable(CONNECTION_PREFACE)
     Ractor.make_shareable(CONNECTION_PREFACE_LENGTH)
 
@@ -47,32 +49,33 @@ module Biryani
 
       recv_loop(io.clone)
       select_loop(io)
+    rescue *PEER_CLOSED_ERRORS
+      # peer has already closed the connection
     rescue StandardError => e
       puts e.backtrace
-      self.class.do_send(io, Frame::Goaway.new(@streams_ctx.last_stream_id, ErrorCode::INTERNAL_ERROR, 'internal error'), true)
+      Biryani.ignore_peer_closed do
+        self.class.do_send(io, Frame::Goaway.new(@streams_ctx.last_stream_id, ErrorCode::INTERNAL_ERROR, 'internal error'), true)
+      end
     ensure
-      io.close_write
+      Biryani.ignore_peer_closed { io.close_write }
     end
 
     # @param io [IO]
     def recv_loop(io)
-      Ractor.new(io, @port) do |io_, port_|
-        loop do
-          obj = Frame.read(io_)
-          if obj.nil?
-            port_.send(:eof, move: true)
-            break
-          end
-
-          port_.send([:frame, obj], move: true)
-        end
+      r = Ractor.new(@port) do |port_|
+        io_ = Ractor.receive
+        Connection.recv_frames(io_, port_)
+      ensure
+        Biryani.ignore_peer_closed { io_&.close }
       end
+      r.send(io, move: true)
     end
 
     # @param io [IO]
     def select_loop(io)
       loop do
-        break if @recv_done && @streams_ctx.empty?
+        # After EOF, no frames arrive from the peer, so only half_closed_remote streams can still progress: by the handler's response.
+        break if closed? || (@recv_done && @streams_ctx.none_half_closed_remote?)
 
         case @port.receive
         in :eof
@@ -82,8 +85,6 @@ module Biryani
         in [:response, res, stream_id]
           handle_response(io, res, stream_id)
         end
-
-        break if closed?
       end
     end
 
@@ -236,6 +237,14 @@ module Biryani
     # @param res [HTTP::Response]
     # @param stream_id [Integer]
     def handle_response(io, res, stream_id)
+      ctx = @streams_ctx[stream_id]
+      # The RST_STREAM frame fully terminates the referenced stream and
+      # causes it to enter the "closed" state.  After receiving a RST_STREAM
+      # on a stream, the receiver MUST NOT send additional frames for that
+      # stream, except for PRIORITY.
+      # https://datatracker.ietf.org/doc/html/rfc9113#section-6.4-5
+      return if ctx.nil? || ctx.closed?
+
       fragment, data = self.class.http_response(res, @encoder)
       max_frame_size = @peer_settings[SettingsID::SETTINGS_MAX_FRAME_SIZE]
       self.class.send_headers(io, stream_id, fragment, data.empty?, max_frame_size, @streams_ctx)
@@ -360,6 +369,35 @@ module Biryani
       ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'invalid connection preface') if s != CONNECTION_PREFACE
     end
 
+    # @param io [IO]
+    # @param port [Ractor::Port]
+    def self.recv_frames(io, port)
+      loop do
+        obj = Frame.read(io)
+        break if obj.nil?
+
+        port.send([:frame, obj], move: true)
+      rescue Ractor::ClosedError
+        # the connection has finished before the peer closes
+        return linger(io)
+      end
+
+      port.send(:eof, move: true)
+    rescue Ractor::ClosedError
+      # the connection has finished after the peer closes
+    end
+
+    # Lingering close: discard incoming data until EOF so that close does not send RST.
+    #
+    # @param io [IO]
+    def self.linger(io)
+      Timeout.timeout(LINGER_TIMEOUT) do
+        loop { io.readpartial(16_384) }
+      end
+    rescue *PEER_CLOSED_ERRORS, Timeout::Error
+      # EOF, timeout, connection reset, etc.
+    end
+
     # @param stream_id [Integer]
     # @param data [String]
     # @param recv_window [Window]
@@ -377,7 +415,7 @@ module Biryani
       ctx.content << data
       if ctx.half_closed_remote?
         obj = http_request(stream_id, ctx.fragment, ctx.content, decoder)
-        ctx << nil if obj.is_a?(StreamError) # terminate the Stream Ractor waiting for a request
+        ctx << nil if Biryani.err?(obj) # terminate the Stream Ractor waiting for a request
         return obj if Biryani.err?(obj)
 
         ctx << obj
@@ -400,7 +438,7 @@ module Biryani
       ctx.fragment << headers.fragment
       if ctx.half_closed_remote?
         obj = http_request(headers.stream_id, ctx.fragment, ctx.content, decoder)
-        ctx << nil if obj.is_a?(StreamError) # terminate the Stream Ractor waiting for a request
+        ctx << nil if Biryani.err?(obj) # terminate the Stream Ractor waiting for a request
         return obj if Biryani.err?(obj)
 
         ctx << obj
@@ -475,13 +513,13 @@ module Biryani
     #
     # @return [HTTP::Request, ConnectionError, StreamError]
     def self.http_request(stream_id, fragment, content, decoder)
-      obj = decoder.decode(fragment)
-      return obj if Biryani.err?(obj)
-
-      fields = obj
+      fields = decoder.decode(fragment)
       builder = HTTP::RequestBuilder.new
       builder.fields(fields)
       builder.build(content)
+    rescue HPACK::Error::Error => e
+      # https://datatracker.ietf.org/doc/html/rfc9113#section-4.3-3
+      ConnectionError.new(ErrorCode::COMPRESSION_ERROR, e.message)
     rescue HTTP::Error::MalformedRequestError => e
       # https://datatracker.ietf.org/doc/html/rfc9113#section-8.1.1-3
       StreamError.new(ErrorCode::PROTOCOL_ERROR, stream_id, e.message)

data/lib/biryani/frame.rb

@@ -157,10 +157,13 @@ module Biryani
 
       payload_length, f_type, flags, stream_id = read_header(s)
       payload = io.read(payload_length)
-      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'invalid frame') if payload.bytesize != payload_length
+      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'invalid frame') if payload.nil? || payload.bytesize != payload_length
       return Frame::Unknown.new(f_type, flags, stream_id, payload) unless FRAME_MAP.key?(f_type)
 
       FRAME_MAP[f_type].read(payload, flags, stream_id)
+    rescue *PEER_CLOSED_ERRORS
+      # the peer has closed the connection (e.g. ECONNRESET): treat it as EOF
+      nil
     rescue StandardError
       ConnectionError.new(ErrorCode::FRAME_SIZE_ERROR, 'invalid frame')
     end

data/lib/biryani/hpack/decoder.rb

@@ -8,6 +8,8 @@ module Biryani
 
       # @param s [String]
       #
+      # @raise [HPACK::Error::Error]
+      #
       # @return [Array]
       def decode(s)
         Fields.decode(s.force_encoding(Encoding::ASCII_8BIT), @dynamic_table)

data/lib/biryani/hpack/dynamic_table.rb

@@ -51,7 +51,7 @@ module Biryani
       #
       # @return [Array] [name, value]
       def entry_at(index)
-        raise Error::HPACKDecodeError if index.zero? || index > STATIC_TABLE_SIZE + count_entries
+        raise Error::HPACKDecodeError, "invalid index #{index}" if index.zero? || index > STATIC_TABLE_SIZE + count_entries
 
         if index <= STATIC_TABLE_SIZE
           STATIC_TABLE[index - 1]

data/lib/biryani/hpack/field.rb

@@ -215,10 +215,11 @@ module Biryani
       # @return [nil]
       # @return [Integer]
       def self.decode_dynamic_table_size_update(io, cursor, dynamic_table)
-        raise Error::HPACKDecodeError unless cursor.zero? || (io.get_value(:U8, 0) & 0b00100000).positive? && Integer.decode(io, 5, 0)[1] == cursor
+        raise Error::HPACKDecodeError, 'misplaced dynamic table size update' \
+          unless cursor.zero? || (io.get_value(:U8, 0) & 0b00100000).positive? && Integer.decode(io, 5, 0)[1] == cursor
 
         max_size, c = Integer.decode(io, 5, cursor)
-        raise Error::HPACKDecodeError if max_size > dynamic_table.limit
+        raise Error::HPACKDecodeError, 'dynamic table size update exceeds the limit' if max_size > dynamic_table.limit
 
         dynamic_table.chomp!(max_size)
         [nil, c]

data/lib/biryani/hpack/huffman.rb

@@ -550,7 +550,7 @@ module Biryani
         (length * 8).times do |i|
           bits_len += 1
           bits += 1 if (bytes[i / 8] & (1 << 7 - (i % 8))).positive?
-          raise Error::HuffmanDecodeError if bits == EOS
+          raise Error::HuffmanDecodeError, 'EOS in huffman-encoded string' if bits == EOS
 
           if (chr = DECODE_TABLE[[bits, bits_len]])
             res << chr
@@ -560,7 +560,7 @@ module Biryani
             bits <<= 1
           end
         end
-        raise Error::HuffmanDecodeError if bits_len.positive? && bits != (2 << bits_len) - 2 || bits_len >= 8
+        raise Error::HuffmanDecodeError, 'invalid huffman padding' if bits_len.positive? && bits != (2 << bits_len) - 2 || bits_len >= 8
 
         res
       end

data/lib/biryani/hpack/integer.rb

@@ -1,6 +1,10 @@
 module Biryani
   module HPACK
     module Integer
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-7.4
+      MAX_DECODED_INTEGER = (1 << 32) - 1
+      private_constant :MAX_DECODED_INTEGER
+
       # if I < 2^N - 1, encode I on N bits
       # else
       #     encode (2^N - 1) on N bits
@@ -44,10 +48,14 @@ module Biryani
       # @param cursor [Integer]
       # @param n [Integer]
       #
+      # @raise [HPACKDecodeError]
+      #
       # @return [Integer]
       # @return [Integer]
       def self.decode(io, n, cursor)
         limit = (1 << n) - 1
+        raise Error::HPACKDecodeError, 'integer exceeds field block' if cursor >= io.size
+
         h = io.get_value(:U8, cursor)
         return [h & limit, cursor + 1] if (h & limit) != limit
 
@@ -55,8 +63,11 @@ module Biryani
         c = cursor + 1
         i = 0
         loop do
+          raise Error::HPACKDecodeError, 'integer exceeds field block' if c + i >= io.size
+
           byte = io.get_value(:U8, c + i)
           res += (byte & 127) << (i * 7)
+          raise Error::HPACKDecodeError, 'integer overflow' if res > MAX_DECODED_INTEGER
 
           break if (byte & 128).zero?
 

data/lib/biryani/hpack/string.rb

@@ -26,11 +26,18 @@ module Biryani
       # @param io [IO::Buffer]
       # @param cursor [Integer]
       #
+      # @raise [HPACKDecodeError]
+      # @raise [HuffmanDecodeError]
+      #
       # @return [String]
       # @return [Integer]
       def self.decode(io, cursor)
+        raise Error::HPACKDecodeError, 'string exceeds field block' if cursor >= io.size
+
         h = (io.get_value(:U8, cursor) & 0b10000000).positive?
         len, c = Integer.decode(io, 7, cursor)
+        raise Error::HPACKDecodeError, 'string exceeds field block' if c + len > io.size
+
         return [Huffman.decode(io, c, len), c + len] if h
 
         [io.get_string(c, len), c + len]

data/lib/biryani/server.rb

@@ -8,11 +8,15 @@ module Biryani
     # @param socket [Socket]
     def run(socket)
       loop do
-        Ractor.new(socket.accept, @proc) do |io, proc|
+        io = socket.accept
+        r = Ractor.new(@proc) do |proc|
+          io_ = Ractor.receive
           conn = Connection.new(proc)
-          conn.serve(io)
-          io.close
+          conn.serve(io_)
+        ensure
+          Biryani.ignore_peer_closed { io_&.close }
         end
+        r.send(io, move: true)
       end
     end
   end

data/lib/biryani/stream.rb

@@ -18,7 +18,11 @@ module Biryani
             res = HTTP::Response.internal_server_error
           end
 
-          tx.send([:response, res, stream_id], move: true)
+          begin
+            tx.send([:response, res, stream_id], move: true)
+          rescue Ractor::ClosedError
+            # the Connection has already finished, so discard the response
+          end
         end
       end
     end

data/lib/biryani/streams_context.rb

@@ -50,6 +50,11 @@ module Biryani
       @h.values.filter(&:active?).length
     end
 
+    # @return [Boolean]
+    def none_half_closed_remote?
+      @h.each_value.none?(&:half_closed_remote?)
+    end
+
     # @return [Integer, nil]
     def receiving_continuation_stream_id
       @h.find { |_, ctx| ctx.receiving_continuation? }&.first

data/lib/biryani/utils.rb

@@ -20,4 +20,13 @@ module Biryani
       obj
     end
   end
+
+  # Errors raised when the peer has already closed the connection (EOF, EPIPE, ECONNRESET, etc.)
+  PEER_CLOSED_ERRORS = Ractor.make_shareable([IOError, SystemCallError])
+
+  def self.ignore_peer_closed
+    yield
+  rescue *PEER_CLOSED_ERRORS
+    nil
+  end
 end

data/lib/biryani/version.rb

@@ -1,3 +1,3 @@
 module Biryani
-  VERSION = '0.0.15'.freeze
+  VERSION = '0.0.16'.freeze
 end

data/lib/biryani.rb

@@ -1,3 +1,4 @@
+require 'timeout'
 require 'uri'
 
 require_relative 'biryani/connection_error'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biryani
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - thekuwayama