http-2-next 0.2.3 → 0.4.0

data/lib/http/2/next/{huffman.rb → header/huffman.rb}

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "error"
+require_relative "../error"
+require_relative "../extensions"
 
 module HTTP2Next
   # Implementation of huffman encoding for HPACK
@@ -9,6 +10,8 @@ module HTTP2Next
   module Header
     # Huffman encoder/decoder
     class Huffman
+      using StringExtensions
+
       include Error
 
       BITS_AT_ONCE = 4
@@ -319,7 +322,7 @@ module HTTP2Next
         [0x3fffffff, 30]
       ].each(&:freeze).freeze
 
-      ENCODE_TABLE = CODES.map { |c, l| [c].pack("N").unpack("B*").first[-l..-1] }.each(&:freeze).freeze
+      ENCODE_TABLE = CODES.map { |c, l| [c].pack("N").unpack1("B*")[-l..-1] }.each(&:freeze).freeze
     end
   end
 end

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

@@ -79,7 +79,8 @@ module HTTP2Next
       receive(CONNECTION_PREFACE_MAGIC)
 
       # Process received HTTP2-Settings payload
-      buf = HTTP2Next::Buffer.new Base64.urlsafe_decode64(settings.to_s)
+      buf = "".b
+      buf << Base64.urlsafe_decode64(settings.to_s)
       header = @framer.common_header(
         length: buf.bytesize,
         type: :settings,
@@ -95,6 +96,7 @@ module HTTP2Next
 
       headers_frame = {
         type: :headers,
+        flags: [:end_headers],
         stream: 1,
         weight: DEFAULT_WEIGHT,
         dependency: 0,
@@ -103,7 +105,7 @@ module HTTP2Next
       }
 
       if body.empty?
-        headers_frame[:flags] = [:end_stream]
+        headers_frame[:flags] << [:end_stream]
         stream << headers_frame
       else
         stream << headers_frame
@@ -137,10 +139,11 @@ module HTTP2Next
 
     # Handle locally initiated server-push event emitted by the stream.
     #
-    # @param args [Array]
+    # @param parent [Stream]
+    # @param headers [Enumerable[String, String]]
+    # @param flags [Array[Symbol]]
     # @param callback [Proc]
-    def promise(*args)
-      parent, headers, flags = *args
+    def promise(parent, headers, flags)
       promise = new_stream(parent: parent)
       promise.send(
         type: :push_promise,

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

@@ -51,11 +51,10 @@ module HTTP2Next
 
     # Stream priority as set by initiator.
     attr_reader :weight
-    attr_reader :dependency
+    attr_reader :dependency, :remote_window
 
     # Size of current stream flow control window.
     attr_reader :local_window
-    attr_reader :remote_window
     alias window local_window
 
     # Reason why connection was closed.
@@ -75,7 +74,7 @@ module HTTP2Next
     # @param parent [Stream]
     # @param state [Symbol]
     def initialize(connection:, id:, weight: 16, dependency: 0, exclusive: false, parent: nil, state: :idle)
-      stream_error(:protocol_error, "stream can't depend on itself") if id == dependency
+      stream_error(:protocol_error, msg: "stream can't depend on itself") if id == dependency
 
       @connection = connection
       @id = id
@@ -164,7 +163,7 @@ module HTTP2Next
       return unless @_trailers
 
       trailers = frame[:payload]
-      return if trailers.is_a?(Buffer)
+      return unless trailers.respond_to?(:each)
 
       trailers.each do |field, _|
         @_trailers.delete(field)
@@ -174,7 +173,7 @@ module HTTP2Next
     end
 
     def calculate_content_length(data_length)
-      return unless @_content_length
+      return unless @_content_length && data_length
 
       @_content_length -= data_length
       return if @_content_length >= 0

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

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

data/lib/tasks/generate_huffman_table.rb

@@ -5,7 +5,7 @@ task :generate_table do
   HuffmanTable::Node.generate_state_table
 end
 
-require_relative "../http/2/next/huffman"
+require_relative "../http/2/next/header/huffman"
 
 # @private
 module HuffmanTable
@@ -13,9 +13,8 @@ module HuffmanTable
   EOS          = 256
 
   class Node
-    attr_accessor :next, :emit, :final, :depth
-    attr_accessor :transitions
-    attr_accessor :id
+    attr_accessor :next, :emit, :final, :depth, :transitions, :id
+
     @@id = 0 # rubocop:disable Style/ClassVars
     def initialize(depth)
       @next = [nil, nil]
@@ -38,6 +37,7 @@ module HuffmanTable
 
     class Transition
       attr_accessor :emit, :node
+
       def initialize(emit, node)
         @emit = emit
         @node = node

data/sig/client.rbs

@@ -0,0 +1,9 @@
+module HTTP2Next
+  class Client < Connection
+    def upgrade: () -> Stream
+
+    def send_connection_preface: () -> void
+
+    def self.settings_header: (settings_enum) -> String
+  end
+end

data/sig/connection.rbs

@@ -0,0 +1,73 @@
+module HTTP2Next
+  class Connection
+    include FlowBuffer
+    include Emitter
+
+    attr_reader state: Symbol
+
+    attr_reader local_window: Integer
+    attr_reader remote_window: Integer
+
+    alias window local_window
+
+    attr_reader remote_settings: settings_hash
+    attr_reader local_settings: settings_hash
+    attr_reader pending_settings: settings_hash
+
+    attr_reader active_stream_count: Integer
+
+    attr_writer max_streams: Integer
+
+    def closed?: () -> bool
+
+    def new_stream: (
+      ?weight: Integer,
+      ?dependency: Integer,
+      ?exclusive: bool,
+      ?parent: Stream?,
+      ?state: Symbol
+    ) -> Stream
+
+    def ping: (String) -> void
+            | (String) { () -> void } -> void
+
+    def goaway: (Symbol, String?) -> void
+              | (Symbol) -> void
+              | () -> void
+
+    def window_update: (Integer increment) -> void
+
+    def settings: (settings_enum) -> void
+
+    def receive: (string data) -> void
+    alias << receive
+
+    private
+
+    def initialize: (settings_hash) -> untyped
+
+    def send: (frame) -> void
+
+    def encode: (frame) -> Array[String]
+
+    def connection_frame?: (frame) -> bool
+
+    def connection_management: (frame) -> void
+
+    def ping_management: (frame) -> void
+
+    def validate_settings: (:client | :server, settings_enum) -> void
+
+    def connection_settings: (frame) -> void
+
+    def decode_headers: (frame) -> void
+
+    def encode_headers: (frame) -> Array[frame]
+
+    def activate_stream: (id: Integer, **untyped) -> void
+
+    def verify_stream_order: (Integer id) -> void
+
+    def verify_pseudo_headers: (frame, Array[String]) -> void
+  end
+end

data/sig/emitter.rbs

@@ -0,0 +1,13 @@
+module HTTP2Next
+  module Emitter
+    def on: (Symbol event) { (*untyped) -> void } -> void
+
+    def once: (Symbol event) { (*untyped) -> void } -> void
+
+    def emit: (Symbol event, *untyped args) ?{ (*untyped) -> void } -> void
+
+    private
+
+    def listeners: (Symbol event)  -> Array[Proc]
+  end
+end

data/sig/flow_buffer.rbs

@@ -0,0 +1,23 @@
+module HTTP2Next
+  module FlowBuffer
+    MAX_WINDOW_SIZE: Integer
+
+    def buffered_amount: () -> Integer
+
+    def flush: () -> void
+
+    private
+
+    def send_buffer: () -> FrameBuffer
+
+    def update_local_window: (frame) -> void
+
+    def calculate_window_update: (Integer) -> void
+
+    def send_data: () -> void
+                 | (frame?) -> void
+                 | (frame?, bool) -> void
+
+    def process_window_update: (frame: frame, ?encode: bool) -> void
+  end
+end

data/sig/frame_buffer.rbs

@@ -0,0 +1,13 @@
+module HTTP2Next
+  class FrameBuffer
+    attr_reader bytesize: Integer
+
+    @buffer: Array[String]
+
+    def <<: (frame) -> void
+
+    def empty?: () -> bool
+
+    def retrieve: (Integer) -> frame? 
+  end
+end

data/sig/framer.rbs

@@ -0,0 +1,25 @@
+module HTTP2Next
+  class Framer
+    attr_accessor local_max_frame_size: Integer
+    
+    attr_accessor remote_max_frame_size: Integer
+
+    def common_header: (frame) -> String
+
+    def read_common_frame: (String) -> frame
+
+    def generate: (frame) -> String
+
+    def parse: (String) -> frame?
+
+    private
+
+    def initialize: (Integer, Integer) -> untyped
+                  | (Integer) -> untyped
+                  | () -> untyped
+
+    def pack_error: (Integer | Symbol e) -> String
+
+    def unpack_error: (Integer) -> (Symbol | Integer)
+  end
+end

data/sig/header.rbs

@@ -0,0 +1,15 @@
+module HTTP2Next
+  module Header
+    type header_key = :type | :name | :value | :index
+    type header_value = Integer | String | :indexed | :changetablesize | :incremental | :noindex | :neverindexed
+
+    #type context_hash = {
+    #  huffman?: (:always | :never | :shorter),
+    #  index?: (:all | :static | :never),
+    #  table_size?: Integer
+    #}
+    type context_hash = Hash[Symbol, Symbol | Integer]
+
+    type header_command = Hash[header_key, header_value]
+  end
+end

data/sig/header/compressor.rbs

@@ -0,0 +1,23 @@
+module HTTP2Next
+  module Header
+    class Compressor
+      @cc: EncodingContext
+
+      def table_size=: (Integer) -> void
+
+      def integer: (Integer, Integer) -> String
+
+      def string: (String) -> String
+
+      def header: (header_command, String) -> String
+                | (header_command) -> String
+
+      def encode: (Enumerable[header_pair]) -> String
+
+      private
+
+      def initialize: (context_hash options) -> untyped
+                    | () -> untyped
+    end
+  end
+end

data/sig/header/decompressor.rbs

@@ -0,0 +1,22 @@
+module HTTP2Next
+  module Header
+    class Decompressor
+      @cc: EncodingContext
+
+      def table_size=: (Integer) -> void
+
+      def integer: (String, Integer) -> Integer
+
+      def string: (String) -> String
+
+      def header: (String) -> header_command
+
+      def decode: (String, frame?) -> Array[header_pair]
+                | (String) -> Array[header_pair]
+      private
+
+      def initialize: (context_hash options) -> untyped
+                    | () -> untyped
+    end
+  end
+end

data/sig/header/encoding_context.rbs

@@ -0,0 +1,34 @@
+module HTTP2Next
+  module Header
+    class EncodingContext
+      STATIC_TABLE: Array[header_pair]
+
+      attr_reader table: Array[header_pair]
+
+      attr_reader options: context_hash
+
+      def dup: () -> EncodingContext
+
+      def dereference: (Integer) -> header_pair
+
+      def process: (header_command cmd) -> header_pair?
+
+      def encode: (_Each[header_pair]) -> Array[header_command]
+
+      def addcmd: (String name, String value) -> header_command
+
+      def table_size=: (Integer) -> void
+
+      def current_table_size: () -> Integer
+
+      private
+
+      def initialize: (context_hash options) -> untyped
+                    | () -> untyped
+
+      def add_to_table: (header_pair) -> void
+
+      def size_check: (header_pair?) -> bool
+    end
+  end
+end

data/sig/header/huffman.rbs

@@ -0,0 +1,9 @@
+module HTTP2Next
+  module Header
+    class Huffman
+      def encode: (String str) -> String
+
+      def decode: (String str) -> String
+    end
+  end
+end

data/sig/next.rbs

@@ -0,0 +1,95 @@
+module HTTP2Next
+  DEFAULT_FLOW_WINDOW: Integer
+
+  DEFAULT_HEADER_SIZE: Integer
+
+  DEFAULT_MAX_CONCURRENT_STREAMS: Integer
+
+  type settings_hash = Hash[Symbol, Integer]
+
+  type settings_enum = Enumerable[Symbol, Integer]
+
+  SPEC_DEFAULT_CONNECTION_SETTINGS: settings_hash
+
+  DEFAULT_CONNECTION_SETTINGS: settings_hash
+
+  DEFAULT_WEIGHT: Integer
+
+  CONNECTION_PREFACE_MAGIC: String
+
+  REQUEST_MANDATORY_HEADERS: Array[Symbol]
+
+  RESPONSE_MANDATORY_HEADERS: Array[Symbol]
+
+  type header_pair = [String, String]
+
+  # # FRAMES
+  # type frame_control_flags = Array[:end_headers | :end_stream]
+
+  # # HEADERS
+  # type headers_frame = {
+  #   type: :headers, flags: frame_control_flags, stream: Integer, payload: Enumerable[header_pair],
+  #   ?method: Symbol, ?trailer: Array[String], ?content_length: Integer, ?padding: Integer
+  # }
+
+  # # DATA
+  # type data_frame = { type: :data, flags: frame_control_flags, stream: Integer, length: Integer, payload: String, ?padding: Integer }
+
+  # # PUSH_PROMISE
+  # type push_promise_frame = { type: :push_promise, promise_stream: Integer, flags: frame_control_flags, stream: Integer, ?method: Symbol, ?trailer: Array[String], ?content_length: Integer, payload: Enumerable[header_pair], ?padding: Integer }
+
+  # # SETTINGS
+  # type settings_frame = { type: :settings, stream: 0, payload: Array[[Symbol | Integer, Integer]] }
+
+  # # WINDOW_UPDATE
+  # type window_update_frame = { type: :window_update, stream: Integer, increment: Integer }
+
+  # # PRIORITY
+  # type priority_frame = { type: :priority, stream: Integer, dependency: Integer, exclusive: bool, weight: Integer }
+
+  # # ALTSVC
+  # type altsvc_frame = { type: :altsvc, stream: 0, max_age: Integer, port: Integer, proto: "String", host: String }
+
+  # # ORIGIN
+  # type origin_frame = { type: :origin, stream: 0, origin: Array[String] }
+
+  # # PING
+  # type ping_frame = { type: :ping, payload: String, length: Integer }
+
+  # # GOAWAY
+  # type goaway_frame = { type: :goaway, stream: 0, last_stream: Integer, error: Symbol? }
+
+  # type frame = headers_frame | data_frame | push_promise_frame |
+  #              settings_frame | window_update_frame | priority_frame | altsvc_frame |
+  #              origin_frame | ping_frame | goaway_frame
+
+  type frame_key = :type | :flags | :stream | :padding | :ignore |
+                   # headers
+                   :method | :trailer | :content_length |
+                   # data, settings, ping
+                   :payload | :length |
+                   # promise
+                   :promise_stream |
+                   # window_update
+                   :increment |
+                   # priority
+                   :dependency | :exclusive | :weight |
+                   # altsvc
+                   :max_age | :port | :proto | :host |
+                   # origin
+                   :origin |
+                   # goaway
+                   :last_stream | :error
+
+  type frame_value = Integer |
+                     Symbol | # type (:data, :headers)
+                     Array[Symbol] |
+                     String |
+                     bool |
+                     Array[String] |
+                     Array[[Symbol | Integer, Integer]] |
+                     Enumerable[header_pair] |
+                     nil
+
+  type frame = Hash[frame_key, frame_value]
+end