http-2-next 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b8760a4af91eae4da3ae631c99b68cef2130cc0758ac7c91420bffe53582e55
+  data.tar.gz: ced41c1e91b125dd4ea957d026b27ccec5cd2aa79ca6376883f829c52199e758
+SHA512:
+  metadata.gz: a3f421c1e495cb9bed15a3635dfdae9996074a77e221f1a3e5ebd75be0df0e154ab395ffc3caf3e333749b2fd4350ec226941f84c55c9c99ef023f18fe1da002
+  data.tar.gz: 4f0af698fbd7ac5a94b03fba9b93f47c6d8c34d0e44469a63dcec27609932a45e2b59f6ed08a8e55441d14756a238a8f0bea08ae795e3494e061f82d0a4668cf

data/README.md

@@ -0,0 +1,302 @@
+# HTTP-2-Next
+
+[![Gem Version](https://badge.fury.io/rb/http-2.svg)](http://rubygems.org/gems/http-2)
+[![Build status](https://gitlab.com/honeyryderchuck/http-2-next/badges/master/pipeline.svg)](https://gitlab.com/honeyryderchuck/http-2-next/commits/master)
+[![coverage report](https://gitlab.com/honeyryderchuck/httpx/badges/master/coverage.svg)](https://honeyryderchuck.gitlab.io/http-2-next/coverage/#_AllFiles)
+
+**Attention!** This is a fork of the [http-2](https://github.com/igrigorik/http-2) gem.
+
+Pure Ruby, framework and transport agnostic, implementation of HTTP/2 protocol and HPACK header compression with support for:
+
+
+* [Binary framing](https://hpbn.co/http2/#binary-framing-layer) parsing and encoding
+* [Stream multiplexing](https://hpbn.co/http2/#streams-messages-and-frames) and [prioritization](https://hpbn.co/http2/#stream-prioritization)
+* Connection and stream [flow control](https://hpbn.co/http2/#flow-control)
+* [Header compression](https://hpbn.co/http2/#header-compression) and [server push](https://hpbn.co/http2/#server-push)
+* Connection and stream management
+* And more... see [API docs](https://www.rubydoc.info/gems/http-2-next)
+
+Protocol specifications:
+
+* [Hypertext Transfer Protocol Version 2 (RFC 7540)](https://httpwg.github.io/specs/rfc7540.html)
+* [HPACK: Header Compression for HTTP/2 (RFC 7541)](https://httpwg.github.io/specs/rfc7541.html)
+
+
+## Getting started
+
+```bash
+$> gem install http-2-next
+```
+
+This implementation makes no assumptions as how the data is delivered: it could be a regular Ruby TCP socket, your custom eventloop, or whatever other transport you wish to use - e.g. ZeroMQ, [avian carriers](http://www.ietf.org/rfc/rfc1149.txt), etc.
+
+Your code is responsible for feeding data into the parser, which performs all of the necessary HTTP/2 decoding, state management and the rest, and vice versa, the parser will emit bytes (encoded HTTP/2 frames) that you can then route to the destination. Roughly, this works as follows:
+
+```ruby
+require 'http/2/next'
+HTTP2 = HTTP2Next
+
+socket = YourTransport.new
+
+conn = HTTP2::Client.new
+conn.on(:frame) {|bytes| socket << bytes }
+
+while bytes = socket.read
+ conn << bytes
+end
+```
+
+Checkout provided [client](example/client.rb) and [server](example/server.rb) implementations for basic examples.
+
+
+### Connection lifecycle management
+
+Depending on the role of the endpoint you must initialize either a [Client](lib/http/2/next/client.rb) or a [Server](lib/http/2/next/server.rb) object. Doing so picks the appropriate header compression / decompression algorithms and stream management logic. From there, you can subscribe to connection level events, or invoke appropriate APIs to allocate new streams and manage the lifecycle. For example:
+
+```ruby
+HTTP2 = HTTP2Next
+# - Server ---------------
+server = HTTP2::Server.new
+
+server.on(:stream) { |stream| ... } # process inbound stream
+server.on(:frame)  { |bytes| ... }  # encoded HTTP/2 frames
+
+server.ping { ... } # run liveness check, process pong response
+server.goaway # send goaway frame to the client
+
+# - Client ---------------
+client = HTTP2::Client.new
+client.on(:promise) { |stream| ... } # process push promise
+
+stream = client.new_stream # allocate new stream
+stream.headers({':method' => 'post', ...}, end_stream: false)
+stream.data(payload, end_stream: true)
+```
+
+Events emitted by the connection object:
+
+<table>
+  <tr>
+    <td><b>:promise</b></td>
+    <td>client role only, fires once for each new push promise</td>
+  </tr>
+  <tr>
+    <td><b>:stream</b></td>
+    <td>server role only, fires once for each new client stream</td>
+  </tr>
+  <tr>
+    <td><b>:frame</b></td>
+    <td>fires once for every encoded HTTP/2 frame that needs to be sent to the peer</td>
+  </tr>
+</table>
+
+
+### Stream lifecycle management
+
+A single HTTP/2 connection can [multiplex multiple streams](https://hpbn.co/http2/#request-and-response-multiplexing) in parallel: multiple requests and responses can be in flight simultaneously and stream data can be interleaved and prioritized. Further, the specification provides a well-defined lifecycle for each stream (see below).
+
+The good news is, all of the stream management, and state transitions, and error checking is handled by the library. All you have to do is subscribe to appropriate events (marked with ":" prefix in diagram below) and provide your application logic to handle request and response processing.
+
+```
+                      +--------+
+                 PP   |        |   PP
+             ,--------|  idle  |--------.
+            /         |        |         \
+           v          +--------+          v
+    +----------+          |           +----------+
+    |          |          | H         |          |
+,---|:reserved |          |           |:reserved |---.
+|   | (local)  |          v           | (remote) |   |
+|   +----------+      +--------+      +----------+   |
+|      | :active      |        |      :active |      |
+|      |      ,-------|:active |-------.      |      |
+|      | H   /   ES   |        |   ES   \   H |      |
+|      v    v         +--------+         v    v      |
+|   +-----------+          |          +-----------+  |
+|   |:half_close|          |          |:half_close|  |
+|   |  (remote) |          |          |  (local)  |  |
+|   +-----------+          |          +-----------+  |
+|        |                 v                |        |
+|        |    ES/R    +--------+    ES/R    |        |
+|        `----------->|        |<-----------'        |
+| R                   | :close |                   R |
+`-------------------->|        |<--------------------'
+                      +--------+
+```
+
+For sake of example, let's take a look at a simple server implementation:
+
+```ruby
+HTTP2 = HTTP2Next
+
+conn = HTTP2::Server.new
+
+# emits new streams opened by the client
+conn.on(:stream) do |stream|
+  stream.on(:active) { } # fires when stream transitions to open state
+  stream.on(:close)  { } # stream is closed by client and server
+
+  stream.on(:headers) { |head| ... } # header callback
+  stream.on(:data) { |chunk| ... }   # body payload callback
+
+  # fires when client terminates its request (i.e. request finished)
+  stream.on(:half_close) do
+
+    # ... generate_response
+
+    # send response
+    stream.headers({
+      ":status" => 200,
+      "content-type" => "text/plain"
+    })
+
+    # split response between multiple DATA frames
+    stream.data(response_chunk, end_stream: false)
+    stream.data(last_chunk)
+  end
+end
+```
+
+Events emitted by the [Stream object](lib/http/2/next/stream.rb):
+
+<table>
+  <tr>
+    <td><b>:reserved</b></td>
+    <td>fires exactly once when a push stream is initialized</td>
+  </tr>
+  <tr>
+    <td><b>:active</b></td>
+    <td>fires exactly once when the stream become active and is counted towards the open stream limit</td>
+  </tr>
+  <tr>
+    <td><b>:headers</b></td>
+    <td>fires once for each received header block (multi-frame blocks are reassembled before emitting this event)</td>
+  </tr>
+  <tr>
+    <td><b>:data</b></td>
+    <td>fires once for every DATA frame (no buffering)</td>
+  </tr>
+  <tr>
+    <td><b>:half_close</b></td>
+    <td>fires exactly once when the opposing peer closes its end of connection (e.g. client indicating that request is finished, or server indicating that response is finished)</td>
+  </tr>
+  <tr>
+    <td><b>:close</b></td>
+    <td>fires exactly once when both peers close the stream, or if the stream is reset</td>
+  </tr>
+  <tr>
+    <td><b>:priority</b></td>
+    <td>fires once for each received priority update (server only)</td>
+  </tr>
+</table>
+
+
+### Prioritization
+
+Each HTTP/2 [stream has a priority value](https://hpbn.co/http2/#stream-prioritization) that can be sent when the new stream is initialized, and optionally reprioritized later:
+
+```ruby
+HTTP2 = HTTP2Next
+
+client = HTTP2::Client.new
+
+default_priority_stream = client.new_stream
+custom_priority_stream = client.new_stream(priority: 42)
+
+# sometime later: change priority value
+custom_priority_stream.reprioritize(32000) # emits PRIORITY frame
+```
+
+On the opposite side, the server can optimize its stream processing order or resource allocation by accessing the stream priority value (`stream.priority`).
+
+
+### Flow control
+
+Multiplexing multiple streams over the same TCP connection introduces contention for shared bandwidth resources. Stream priorities can help determine the relative order of delivery, but priorities alone are insufficient to control how the resource allocation is performed between multiple streams. To address this, HTTP/2 provides a simple mechanism for [stream and connection flow control](https://hpbn.co/http2/#flow-control).
+
+Connection and stream flow control is handled by the library: all streams are initialized with the default window size (64KB), and send/receive window updates are automatically processed - i.e. window is decremented on outgoing data transfers, and incremented on receipt of window frames. Similarly, if the window is exceeded, then data frames are automatically buffered until window is updated.
+
+The only thing left is for your application to specify the logic as to when to emit window updates:
+
+```ruby
+conn.buffered_amount     # check amount of buffered data
+conn.window              # check current window size
+conn.window_update(1024) # increment connection window by 1024 bytes
+
+stream.buffered_amount     # check amount of buffered data
+stream.window              # check current window size
+stream.window_update(2048) # increment stream window by 2048 bytes
+```
+
+
+### Server push
+
+An HTTP/2 server can [send multiple replies](https://hpbn.co/http2/#server-push) to a single client request. To do so, first it emits a "push promise" frame which contains the headers of the promised resource, followed by the response to the original request, as well as promised resource payloads (which may be interleaved). A simple example is in order:
+
+```ruby
+HTTP2 = HTTP2Next
+
+conn = HTTP2::Server.new
+
+conn.on(:stream) do |stream|
+  stream.on(:headers) { |head| ... }
+  stream.on(:data) { |chunk| ... }
+
+  # fires when client terminates its request (i.e. request finished)
+  stream.on(:half_close) do
+    promise_header = { ':method' => 'GET',
+                       ':authority' => 'localhost',
+                       ':scheme' => 'https',
+                       ':path' => "/other_resource" }
+
+    # initiate server push stream
+    push_stream = nil
+    stream.promise(promise_header) do |push|
+      push.headers({...})
+      push_stream = push
+    end
+
+    # send response
+    stream.headers({
+      ":status" => 200,
+      "content-type" => "text/plain"
+    })
+
+    # split response between multiple DATA frames
+    stream.data(response_chunk, end_stream: false)
+    stream.data(last_chunk)
+    
+    # now send the previously promised data
+    push_stream.data(push_data)
+  end
+end
+```
+
+When a new push promise stream is sent by the server, the client is notified via the `:promise` event:
+
+```ruby
+HTTP2 = HTTP2Next
+
+conn = HTTP2::Client.new
+conn.on(:promise) do |push|
+  # process push stream
+end
+```
+
+The client can cancel any given push stream (via `.close`), or disable server push entirely by sending the appropriate settings frame:
+
+```ruby
+client.settings(settings_enable_push: 0)
+```
+### Specs
+
+To run specs:
+
+```ruby
+rake
+```
+
+### License
+
+(MIT License) - Copyright (c) 2013-2019 Ilya Grigorik ![GA](https://www.google-analytics.com/__utm.gif?utmac=UA-71196-9&utmhn=github.com&utmdt=HTTP2&utmp=/http-2/readme)
+(MIT License) - Copyright (c) 2019 Tiago Cardoso ![GA](https://www.google-analytics.com/__utm.gif?utmac=UA-71196-9&utmhn=github.com&utmdt=HTTP2&utmp=/http-2/readme)

data/lib/http/2/next.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "http/2/next/version"
+require "http/2/next/error"
+require "http/2/next/emitter"
+require "http/2/next/buffer"
+require "http/2/next/flow_buffer"
+require "http/2/next/huffman"
+require "http/2/next/huffman_statemachine"
+require "http/2/next/compressor"
+require "http/2/next/framer"
+require "http/2/next/connection"
+require "http/2/next/client"
+require "http/2/next/server"
+require "http/2/next/stream"

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module HTTP2Next
+  # Binary buffer wraps String.
+  #
+  class Buffer
+    extend Forwardable
+
+    def_delegators :@buffer, :ord, :encoding, :setbyte, :unpack,
+                   :size, :each_byte, :to_str, :to_s, :length, :inspect,
+                   :[], :[]=, :empty?, :bytesize, :include?
+
+    UINT32 = "N"
+    private_constant :UINT32
+
+    # Forces binary encoding on the string
+    def initialize(str = "".b)
+      str = str.dup if str.frozen?
+      @buffer = str.force_encoding(Encoding::BINARY)
+    end
+
+    # Emulate StringIO#read: slice first n bytes from the buffer.
+    #
+    # @param n [Integer] number of bytes to slice from the buffer
+    def read(n)
+      Buffer.new(@buffer.slice!(0, n))
+    end
+
+    # Emulate StringIO#getbyte: slice first byte from buffer.
+    def getbyte
+      read(1).ord
+    end
+
+    def slice!(*args)
+      Buffer.new(@buffer.slice!(*args))
+    end
+
+    def slice(*args)
+      Buffer.new(@buffer.slice(*args))
+    end
+
+    def force_encoding(*args)
+      @buffer = @buffer.force_encoding(*args)
+    end
+
+    def ==(other)
+      @buffer == other
+    end
+
+    def +(other)
+      @buffer += other
+    end
+
+    # Emulate String#getbyte: return nth byte from buffer.
+    def readbyte(n)
+      @buffer[n].ord
+    end
+
+    # Slice unsigned 32-bit integer from buffer.
+    # @return [Integer]
+    def read_uint32
+      read(4).unpack(UINT32).first
+    end
+
+    # Ensures that data that is added is binary encoded as well,
+    # otherwise this could lead to the Buffer instance changing its encoding.
+    %i[<< prepend].each do |mutating_method|
+      define_method(mutating_method) do |string|
+        string = string.dup if string.frozen?
+        @buffer.send mutating_method, string.force_encoding(Encoding::BINARY)
+
+        self
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module HTTP2Next
+  # HTTP 2.0 client connection class that implements appropriate header
+  # compression / decompression algorithms and stream management logic.
+  #
+  # Your code is responsible for driving the client object, which in turn
+  # performs all of the necessary HTTP 2.0 encoding / decoding, state
+  # management, and the rest. A simple example:
+  #
+  # @example
+  #     socket = YourTransport.new
+  #
+  #     conn = HTTP2Next::Client.new
+  #     conn.on(:frame) {|bytes| socket << bytes }
+  #
+  #     while bytes = socket.read
+  #       conn << bytes
+  #     end
+  #
+  class Client < Connection
+    # Initialize new HTTP 2.0 client object.
+    def initialize(**settings)
+      @stream_id    = 1
+      @state        = :waiting_connection_preface
+
+      @local_role   = :client
+      @remote_role  = :server
+
+      super
+    end
+
+    # Send an outgoing frame. Connection and stream flow control is managed
+    # by Connection class.
+    #
+    # @see Connection
+    # @param frame [Hash]
+    def send(frame)
+      send_connection_preface
+      super(frame)
+    end
+
+    def receive(frame)
+      send_connection_preface
+      super(frame)
+    end
+
+    # sends the preface and initializes the first stream in half-closed state
+    def upgrade
+      raise ProtocolError unless @stream_id == 1
+
+      send_connection_preface
+      new_stream(state: :half_closed_local)
+    end
+
+    # Emit the connection preface if not yet
+    def send_connection_preface
+      return unless @state == :waiting_connection_preface
+
+      @state = :connected
+      emit(:frame, CONNECTION_PREFACE_MAGIC)
+
+      payload = @local_settings.reject { |k, v| v == SPEC_DEFAULT_CONNECTION_SETTINGS[k] }
+      settings(payload)
+    end
+
+    def self.settings_header(**settings)
+      frame = Framer.new.generate(type: :settings, stream: 0, payload: settings)
+      Base64.urlsafe_encode64(frame[9..-1])
+    end
+  end
+end