http-2-next 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63f956f2326b803ec836c578b8f98326934897307bda409f2c639e5c88893689
-  data.tar.gz: fbb8a4486463e0e0e5c0d4ed04cf4120a73acdf169f99b99365a0805f89fe5c1
+  metadata.gz: 6a97513d9cfdae554f85ed0cbd3d0818ae0c3c6dc5bdf418a126d3a1993f1c52
+  data.tar.gz: a8712f76a43721ca5d67f281d2689853f7d6cf4ca224704e500c34ae03e10a53
 SHA512:
-  metadata.gz: 628b410fe470df16e61d11732c65553381bcb060f2fe2639af4889aff5d9e3a046ee55e1d67599e1c268dd38c3f4ff22f8fb257ee100a96ba384a9ea1e976726
-  data.tar.gz: 86e1148ca63e9d36745ab703ab29f174fdae5cb8473b167fa4f09138274899713cb57e7604c6ff51d0fae493ea98262b1d86adf94c42c0248e50721ae2f63add
+  metadata.gz: 303e98009c8a47229747659e4dfc4bd33636a52de907bc1164f1f33b4a4ba4a0e051459e30853cae3e88a5fdbb9b84d7e6fbbe387b51f8870e16d7923a28e757
+  data.tar.gz: c40a73c72fe006f2a371dda23adb7ba09dc11e791a4b7a7781a6e5e4593bbfd75e4a5a06e8e6b7755c1335857c84b3077430b6261337e039578f3978937f9e82

data/lib/http/2/next/base64.rb

@@ -16,6 +16,14 @@ elsif !defined?(Base64)
         str.unpack1("m")
       end
 
+      def strict_encode64(bin)
+        [bin].pack("m0")
+      end
+
+      def strict_decode64(str)
+        str.unpack1("m0")
+      end
+
       def urlsafe_encode64(bin, padding: true)
         str = strict_encode64(bin)
         str.chomp!("==") or str.chomp!("=") unless padding

data/lib/http/2/next/extensions.rb

@@ -21,4 +21,33 @@ module HTTP2Next
       end
     end
   end
+
+  # this mixin handles backwards-compatibility for the new packing options
+  # shipping with ruby 3.3 (see https://docs.ruby-lang.org/en/3.3/packed_data_rdoc.html)
+  module PackingExtensions
+    if RUBY_VERSION < "3.3.0"
+      def pack(array_to_pack, template, buffer:, offset: -1)
+        packed_str = array_to_pack.pack(template)
+        case offset
+        when -1
+          buffer << packed_str
+        when 0
+          buffer.prepend(packed_str)
+        else
+          buffer.insert(offset, packed_str)
+        end
+      end
+    else
+      def pack(array_to_pack, template, buffer:, offset: -1)
+        case offset
+        when -1
+          array_to_pack.pack(template, buffer: buffer)
+        when 0
+          buffer.prepend(array_to_pack.pack(template))
+        else
+          buffer.insert(offset, array_to_pack.pack(template))
+        end
+      end
+    end
+  end
 end

data/lib/http/2/next/framer.rb

@@ -7,6 +7,7 @@ module HTTP2Next
     using StringExtensions
 
     include Error
+    include PackingExtensions
 
     # Default value of max frame size (16384 bytes)
     DEFAULT_MAX_FRAME_SIZE = 2 << 13
@@ -123,10 +124,9 @@ module HTTP2Next
     # - http://tools.ietf.org/html/draft-ietf-httpbis-http2-16#section-4.1
     #
     # @param frame [Hash]
+    # @param buffer [String] buffer to pack bytes into
     # @return [String]
-    def common_header(frame)
-      header = []
-
+    def common_header(frame, buffer:)
       raise CompressionError, "Invalid frame type (#{frame[:type]})" unless FRAME_TYPES[frame[:type]]
 
       raise CompressionError, "Frame size is too large: #{frame[:length]}" if frame[:length] > @remote_max_frame_size
@@ -139,18 +139,18 @@ module HTTP2Next
         raise CompressionError, "Window increment (#{frame[:increment]}) is too large"
       end
 
-      header << (frame[:length] >> FRAME_LENGTH_HISHIFT)
-      header << (frame[:length] & FRAME_LENGTH_LOMASK)
-      header << FRAME_TYPES[frame[:type]]
-      header << frame[:flags].reduce(0) do |acc, f|
-        position = FRAME_FLAGS[frame[:type]][f]
-        raise CompressionError, "Invalid frame flag (#{f}) for #{frame[:type]}" unless position
-
-        acc | (1 << position)
-      end
-
-      header << frame[:stream]
-      header.pack(HEADERPACK) # 8+16,8,8,32
+      pack([
+             (frame[:length] >> FRAME_LENGTH_HISHIFT),
+             (frame[:length] & FRAME_LENGTH_LOMASK),
+             FRAME_TYPES[frame[:type]],
+             frame[:flags].reduce(0) do |acc, f|
+               position = FRAME_FLAGS[frame[:type]][f]
+               raise CompressionError, "Invalid frame flag (#{f}) for #{frame[:type]}" unless position
+
+               acc | (1 << position)
+             end,
+             frame[:stream]
+           ], HEADERPACK, buffer: buffer, offset: 0) # 8+16,8,8,32
     end
 
     # Decodes common 9-byte header.
@@ -200,8 +200,8 @@ module HTTP2Next
         end
 
         if frame[:flags].include? :priority
-          bytes << [(frame[:exclusive] ? EBIT : 0) | (frame[:dependency] & RBIT)].pack(UINT32)
-          bytes << [frame[:weight] - 1].pack(UINT8)
+          pack([(frame[:exclusive] ? EBIT : 0) | (frame[:dependency] & RBIT)], UINT32, buffer: bytes)
+          pack([frame[:weight] - 1], UINT8, buffer: bytes)
           length += 5
         end
 
@@ -213,12 +213,12 @@ module HTTP2Next
           raise CompressionError, "Must specify all of priority parameters for #{frame[:type]}"
         end
 
-        bytes << [(frame[:exclusive] ? EBIT : 0) | (frame[:dependency] & RBIT)].pack(UINT32)
-        bytes << [frame[:weight] - 1].pack(UINT8)
+        pack([(frame[:exclusive] ? EBIT : 0) | (frame[:dependency] & RBIT)], UINT32, buffer: bytes)
+        pack([frame[:weight] - 1], UINT8, buffer: bytes)
         length += 5
 
       when :rst_stream
-        bytes << pack_error(frame[:error])
+        pack_error(frame[:error], buffer: bytes)
         length += 4
 
       when :settings
@@ -233,13 +233,13 @@ module HTTP2Next
             raise CompressionError, "Unknown settings ID for #{k}" if k.nil?
           end
 
-          bytes << [k].pack(UINT16)
-          bytes << [v].pack(UINT32)
+          pack([k], UINT16, buffer: bytes)
+          pack([v], UINT32, buffer: bytes)
           length += 6
         end
 
       when :push_promise
-        bytes << [frame[:promise_stream] & RBIT].pack(UINT32)
+        pack([frame[:promise_stream] & RBIT], UINT32, buffer: bytes)
         bytes << frame[:payload]
         length += 4 + frame[:payload].bytesize
 
@@ -250,8 +250,8 @@ module HTTP2Next
         length += 8
 
       when :goaway
-        bytes << [frame[:last_stream] & RBIT].pack(UINT32)
-        bytes << pack_error(frame[:error])
+        pack([frame[:last_stream] & RBIT], UINT32, buffer: bytes)
+        pack_error(frame[:error], buffer: bytes)
         length += 8
 
         if frame[:payload]
@@ -260,7 +260,7 @@ module HTTP2Next
         end
 
       when :window_update
-        bytes << [frame[:increment] & RBIT].pack(UINT32)
+        pack([frame[:increment] & RBIT], UINT32, buffer: bytes)
         length += 4
 
       when :continuation
@@ -268,26 +268,26 @@ module HTTP2Next
         length += frame[:payload].bytesize
 
       when :altsvc
-        bytes << [frame[:max_age], frame[:port]].pack(UINT32 + UINT16)
+        pack([frame[:max_age], frame[:port]], UINT32 + UINT16, buffer: bytes)
         length += 6
         if frame[:proto]
           raise CompressionError, "Proto too long" if frame[:proto].bytesize > 255
 
-          bytes << [frame[:proto].bytesize].pack(UINT8)
+          pack([frame[:proto].bytesize], UINT8, buffer: bytes)
           bytes << frame[:proto]
           length += 1 + frame[:proto].bytesize
         else
-          bytes << [0].pack(UINT8)
+          pack([0], UINT8, buffer: bytes)
           length += 1
         end
         if frame[:host]
           raise CompressionError, "Host too long" if frame[:host].bytesize > 255
 
-          bytes << [frame[:host].bytesize].pack(UINT8)
+          pack([frame[:host].bytesize], UINT8, buffer: bytes)
           bytes << frame[:host]
           length += 1 + frame[:host].bytesize
         else
-          bytes << [0].pack(UINT8)
+          pack([0], UINT8, buffer: bytes)
           length += 1
         end
         if frame[:origin]
@@ -297,7 +297,7 @@ module HTTP2Next
 
       when :origin
         frame[:payload].each do |origin|
-          bytes << [origin.bytesize].pack(UINT16)
+          pack([origin.bytesize], UINT16, buffer: bytes)
           bytes << origin
           length += 2 + origin.bytesize
         end
@@ -319,7 +319,7 @@ module HTTP2Next
         end
 
         length += padlen
-        bytes.prepend([padlen -= 1].pack(UINT8))
+        pack([padlen -= 1], UINT8, buffer: bytes, offset: 0)
         frame[:flags] << :padded
 
         # Padding:  Padding octets that contain no application semantic value.
@@ -329,7 +329,7 @@ module HTTP2Next
       end
 
       frame[:length] = length
-      bytes.prepend(common_header(frame))
+      common_header(frame, buffer: bytes)
     end
 
     # Decodes complete HTTP/2 frame from provided buffer. If the buffer
@@ -456,14 +456,14 @@ module HTTP2Next
 
     private
 
-    def pack_error(error)
+    def pack_error(error, buffer:)
       unless error.is_a? Integer
         error = DEFINED_ERRORS[error]
 
         raise CompressionError, "Unknown error ID for #{error}" unless error
       end
 
-      [error].pack(UINT32)
+      pack([error], UINT32, buffer: buffer)
     end
 
     def unpack_error(error)

data/lib/http/2/next/header/compressor.rb

@@ -4,6 +4,8 @@ module HTTP2Next
   module Header
     # Responsible for encoding header key-value pairs using HPACK algorithm.
     class Compressor
+      include PackingExtensions
+
       # @param options [Hash] encoding options
       def initialize(options = {})
         @cc = EncodingContext.new(options)
@@ -29,10 +31,12 @@ module HTTP2Next
       #
       # @param i [Integer] value to encode
       # @param n [Integer] number of available bits
+      # @param buffer [String] buffer to pack bytes into
+      # @param offset [Integer] offset to insert packed bytes in buffer
       # @return [String] binary string
-      def integer(i, n)
+      def integer(i, n, buffer:, offset: 0)
         limit = (2**n) - 1
-        return [i].pack("C") if i < limit
+        return pack([i], "C", buffer: buffer, offset: offset) if i < limit
 
         bytes = []
         bytes.push limit unless n.zero?
@@ -44,7 +48,7 @@ module HTTP2Next
         end
 
         bytes.push i
-        bytes.pack("C*")
+        pack(bytes, "C*", buffer: buffer, offset: offset)
       end
 
       # Encodes provided value via string literal representation.
@@ -68,20 +72,16 @@ module HTTP2Next
       # @param str [String]
       # @return [String] binary string
       def string(str)
-        plain = nil
-        huffman = nil
-        plain = integer(str.bytesize, 7) << str.dup.force_encoding(Encoding::BINARY) unless @cc.options[:huffman] == :always
-        unless @cc.options[:huffman] == :never
-          huffman = Huffman.new.encode(str)
-          huffman = integer(huffman.bytesize, 7) << huffman
-          huffman.setbyte(0, huffman.ord | 0x80)
-        end
         case @cc.options[:huffman]
         when :always
-          huffman
+          huffman_string(str)
         when :never
-          plain
+          plain_string(str)
         else
+          huffman = huffman_string(str)
+
+          plain = plain_string(str)
+
           huffman.bytesize < plain.bytesize ? huffman : plain
         end
       end
@@ -96,14 +96,14 @@ module HTTP2Next
 
         case h[:type]
         when :indexed
-          buffer << integer(h[:name] + 1, rep[:prefix])
+          integer(h[:name] + 1, rep[:prefix], buffer: buffer)
         when :changetablesize
-          buffer << integer(h[:value], rep[:prefix])
+          integer(h[:value], rep[:prefix], buffer: buffer)
         else
           if h[:name].is_a? Integer
-            buffer << integer(h[:name] + 1, rep[:prefix])
+            integer(h[:name] + 1, rep[:prefix], buffer: buffer)
           else
-            buffer << integer(0, rep[:prefix])
+            integer(0, rep[:prefix], buffer: buffer)
             buffer << string(h[:name])
           end
 
@@ -132,6 +132,26 @@ module HTTP2Next
 
         buffer
       end
+
+      private
+
+      # @param str [String]
+      # @return [String] binary string
+      def huffman_string(str)
+        huffman = Huffman.new.encode(str)
+        integer(huffman.bytesize, 7, buffer: huffman, offset: 0)
+        huffman.setbyte(0, huffman.ord | 0x80)
+        huffman
+      end
+
+      # @param str [String]
+      # @return [String] binary string
+      def plain_string(str)
+        plain = "".b
+        integer(str.bytesize, 7, buffer: plain)
+        plain << str.dup.force_encoding(Encoding::BINARY)
+        plain
+      end
     end
   end
 end

data/lib/http/2/next/header/huffman.rb

@@ -13,6 +13,7 @@ module HTTP2Next
       using StringExtensions
 
       include Error
+      include PackingExtensions
 
       BITS_AT_ONCE = 4
       EOS = 256

data/lib/http/2/next/server.rb

@@ -80,13 +80,15 @@ module HTTP2Next
       # Process received HTTP2-Settings payload
       buf = "".b
       buf << Base64.urlsafe_decode64(settings.to_s)
-      header = @framer.common_header(
-        length: buf.bytesize,
-        type: :settings,
-        stream: 0,
-        flags: []
+      @framer.common_header(
+        {
+          length: buf.bytesize,
+          type: :settings,
+          stream: 0,
+          flags: []
+        },
+        buffer: buf
       )
-      buf.prepend(header)
       receive(buf)
 
       # Activate stream (id: 1) with on HTTP/1.1 request parameters

data/lib/http/2/next/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTP2Next
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/sig/extensions.rbs

@@ -0,0 +1,5 @@
+module HTTP2Next
+  module PackingExtensions
+    def pack: (Array[Integer] array_to_pack, String template, buffer: String, ?offset: Integer) -> String
+  end
+end

data/sig/framer.rbs

@@ -1,5 +1,7 @@
 module HTTP2Next
   class Framer
+    include PackingExtensions
+
     DEFAULT_MAX_FRAME_SIZE: Integer
 
     MAX_STREAM_ID: Integer
@@ -33,7 +35,7 @@ module HTTP2Next
 
     attr_accessor remote_max_frame_size: Integer
 
-    def common_header: (frame) -> String
+    def common_header: (frame, buffer: String) -> String
 
     def read_common_frame: (String) -> frame
 
@@ -45,7 +47,7 @@ module HTTP2Next
 
     def initialize: (?Integer local_max_frame_size, ?Integer remote_max_frame_size) -> untyped
 
-    def pack_error: (Integer | Symbol error) -> String
+    def pack_error: (Integer | Symbol error, buffer: String) -> String
 
     def unpack_error: (Integer) -> (Symbol | Integer)
   end

data/sig/header/compressor.rbs

@@ -1,23 +1,27 @@
 module HTTP2Next
   module Header
     class Compressor
+      include PackingExtensions
+
       @cc: EncodingContext
 
       def table_size=: (Integer) -> void
 
-      def integer: (Integer, Integer) -> String
+      def integer: (Integer, Integer, buffer: String, ?offset: Integer) -> String
 
       def string: (String) -> String
 
-      def header: (header_command, String) -> String
-                | (header_command) -> String
+      def header: (header_command, ?String) -> String
 
       def encode: (Enumerable[header_pair]) -> String
 
       private
 
-      def initialize: (context_hash options) -> untyped
-                    | () -> untyped
+      def initialize: (?context_hash options) -> void
+
+      def huffman_string: (String str) -> String
+
+      def plain_string: (String str) -> String
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-2-next
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Tiago Cardoso
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies: []
 description: Pure-ruby HTTP 2.0 protocol implementation
 email:
@@ -43,6 +43,7 @@ files:
 - sig/connection.rbs
 - sig/emitter.rbs
 - sig/error.rbs
+- sig/extensions.rbs
 - sig/flow_buffer.rbs
 - sig/frame_buffer.rbs
 - sig/framer.rbs