http-2 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf205c4c32086ed1a2ec2d784283e7e2c2c983d2
-  data.tar.gz: 272d84cd37cac57b38d391480795b39661fcb20a
+  metadata.gz: 5e4d8a543b24380552462863450caaa90dcc5d1f
+  data.tar.gz: 5948ffc6c3aa27f7d81bd86cd0ef62ad163e412f
 SHA512:
-  metadata.gz: 338b39a100523327a407abec0cf68586e079290626661e8d39c803dbee7eee1b958d3f70bdcbfb0712d7fd36db0cb315cb729a1704ce8b655485c7b02a2108fb
-  data.tar.gz: d34d0a7325076767c9c36a85319c733268a812968482ff4c81be7533b7467f0a7abfb99ad498bd707dd93a706438ba709b2356554aaa6a34af768290524599b9
+  metadata.gz: 32a27c2213a6c8b18b56f752495a938d65260c63644be63af58fd0aaf133795bf9e2748d23fe8b8c49bf96500e30a551ac0001001a1fe46a2082f06d8420dcc8
+  data.tar.gz: 2fdc75f407ecb70fb601a04d9c8fe5b76e23bebafc495e48bf2a1e3d96ada6d1784ed29a9c352cfa04027ebd5dace72779fc009b1cd0f87366cfab035c72f66a

data/.travis.yml

@@ -3,6 +3,7 @@ language: ruby
 rvm:
   - 2.1
   - 2.2
+  - 2.3.0
   - jruby-9.0.0.0
   - jruby-head
   - rbx-2

data/Gemfile

@@ -10,7 +10,7 @@ group :test do
   gem 'coveralls', require: false
   gem 'pry'
   gem 'pry-byebug', platform: :mri
-  gem 'rspec'
+  gem 'rspec', '~> 3.4.0'
   gem 'rspec-autotest'
   gem 'rubocop', '~> 0.30.0'
 end

data/example/client.rb

@@ -110,7 +110,8 @@ while !sock.closed? && !sock.eof?
   begin
     conn << data
   rescue => e
-    puts "Exception: #{e}, #{e.message} - closing socket."
+    puts "#{e.class} exception: #{e.message} - closing socket."
+    e.backtrace.each { |l| puts "\t" + l }
     sock.close
   end
 end

data/example/server.rb

@@ -45,7 +45,7 @@ loop do
     log = Logger.new(stream.id)
     req, buffer = {}, ''
 
-    stream.on(:active) { log.info 'cliend opened new stream' }
+    stream.on(:active) { log.info 'client opened new stream' }
     stream.on(:close)  { log.info 'stream closed' }
 
     stream.on(:headers) do |h|
@@ -89,7 +89,8 @@ loop do
     begin
       conn << data
     rescue => e
-      puts "Exception: #{e}, #{e.message} - closing socket."
+      puts "#{e.class} exception: #{e.message} - closing socket."
+      e.backtrace.each { |l| puts "\t" + l }
       sock.close
     end
   end

data/example/upgrade_server.rb

@@ -28,15 +28,17 @@ if options[:secure]
 end
 
 class UpgradeHandler
+  VALID_UPGRADE_METHODS = %w(GET OPTIONS)
+  UPGRADE_RESPONSE = <<-RESP
+HTTP/1.1 101 Switching Protocols
+Connection: Upgrade
+Upgrade: h2c
 
-  VALID_UPGRADE_METHODS = %w[GET OPTIONS]
-  UPGRADE_RESPONSE = ("HTTP/1.1 101 Switching Protocols\n" +
-                      "Connection: Upgrade\n" +
-                      "Upgrade: h2c\n\n").freeze
+RESP
 
   attr_reader :complete, :headers, :body, :parsing
 
-  def initialize conn, sock
+  def initialize(conn, sock)
     @conn, @sock = conn, sock
     @complete, @parsing = false, false
     @body = ''
@@ -46,23 +48,24 @@ class UpgradeHandler
   def <<(data)
     @parsing ||= true
     @parser << data
-    if complete
+    return unless complete
 
-      @sock.write UPGRADE_RESPONSE
+    @sock.write UPGRADE_RESPONSE
 
-      settings = headers['http2-settings']
-      request = {
-        ':scheme'    => 'http',
-        ':method'    => @parser.http_method,
-        ':authority' => headers['Host'],
-        ':path'      => @parser.request_url
-      }.merge(headers)
+    settings = headers['http2-settings']
+    request = {
+      ':scheme'    => 'http',
+      ':method'    => @parser.http_method,
+      ':authority' => headers['Host'],
+      ':path'      => @parser.request_url,
+    }.merge(headers)
 
-      @conn.upgrade(settings, request, @body)
-    end
+    @conn.upgrade(settings, request, @body)
   end
 
-  def complete!; @complete = true; end
+  def complete!
+    @complete = true
+  end
 
   def on_headers_complete(headers)
     @headers = headers
@@ -73,11 +76,10 @@ class UpgradeHandler
   end
 
   def on_message_complete
-    raise unless VALID_UPGRADE_METHODS.include?(@parser.http_method)
+    fail unless VALID_UPGRADE_METHODS.include?(@parser.http_method)
     @parsing = false
     complete!
   end
-
 end
 
 loop do
@@ -122,7 +124,7 @@ loop do
         log.info "Processing h2c Upgrade request: #{req}"
 
         # Don't respond to OPTIONS...
-        if req[':method'] != "OPTIONS"
+        if req[':method'] != 'OPTIONS'
           response = 'Hello h2c world!'
           stream.headers({
             ':status' => '200',

data/http-2.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = spec.description
   spec.homepage      = 'https://github.com/igrigorik/http-2'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>=2.0.0'
+  spec.required_ruby_version = '>=2.1.0'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/http/2/buffer.rb

@@ -1,6 +1,11 @@
 module HTTP2
   # Simple binary buffer backed by string.
   #
+  # TODO: Refactor, it would be better if Buffer were not a String subclass,
+  # but rather wrap a string and only expose the mutating API needed so that
+  # the possible surface for things to go wrong stays controllable.
+  # - https://github.com/igrigorik/http-2/pull/46
+  #
   class Buffer < String
     UINT32 = 'N'.freeze
     private_constant :UINT32
@@ -30,5 +35,14 @@ module HTTP2
     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.
+    [:<<, :prepend].each do |mutating_method|
+      define_method(mutating_method) do |string|
+        string = string.dup if string.frozen?
+        super(string.force_encoding(Encoding::BINARY))
+      end
+    end
   end
 end

data/lib/http/2/connection.rb

@@ -321,7 +321,7 @@ module HTTP2
 
     rescue => e
       raise if e.is_a?(Error::Error)
-      connection_error
+      connection_error(e: e)
     end
     alias_method :<<, :receive
 
@@ -574,7 +574,7 @@ module HTTP2
       end
 
     rescue => e
-      connection_error(:compression_error, msg: e.message)
+      connection_error(:compression_error, e: e)
     end
 
     # Encode headers payload and update connection compressor state.
@@ -605,7 +605,8 @@ module HTTP2
       frames
 
     rescue => e
-      [connection_error(:compression_error, msg: e.message)]
+      connection_error(:compression_error, e: e)
+      nil
     end
 
     # Activates new incoming or outgoing stream and registers appropriate
@@ -642,12 +643,12 @@ module HTTP2
     # @option error [Symbol] :frame_too_large
     # @option error [Symbol] :compression_error
     # @param msg [String]
-    def connection_error(error = :protocol_error, msg: nil)
+    def connection_error(error = :protocol_error, msg: nil, e: nil)
       goaway(error) unless @state == :closed || @state == :new
 
       @state, @error = :closed, error
       klass = error.to_s.split('_').map(&:capitalize).join
-      fail Error.const_get(klass), msg
+      fail Error.const_get(klass), msg || e.message, e.backtrace || []
     end
   end
 end

data/lib/http/2/server.rb

@@ -72,12 +72,13 @@ module HTTP2
 
       # Process received HTTP2-Settings payload
       buf = HTTP2::Buffer.new Base64.urlsafe_decode64(settings)
-      buf.prepend(@framer.common_header(
+      header = @framer.common_header(
         length: buf.bytesize,
         type: :settings,
         stream: 0,
-        flags: []
-      ))
+        flags: [],
+      )
+      buf.prepend(header)
       receive(buf)
 
       # Activate stream (id: 1) with on HTTP/1.1 request parameters
@@ -98,7 +99,7 @@ module HTTP2
         stream << headers_frame
       else
         stream << headers_frame
-        stream << {type: :data, stream: 1, payload: body, flags: [:end_stream]}
+        stream << { type: :data, stream: 1, payload: body, flags: [:end_stream] }
       end
 
       # Mark h2c upgrade as finished

data/lib/http/2/version.rb

@@ -1,3 +1,3 @@
 module HTTP2
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.8.1'.freeze
 end

data/spec/buffer_spec.rb

@@ -7,6 +7,13 @@ RSpec.describe HTTP2::Buffer do
     expect(b.encoding.to_s).to eq 'ASCII-8BIT'
   end
 
+  it 'should force 8-bit encoding when adding data' do
+    b << 'émalgré'
+    expect(b.encoding.to_s).to eq 'ASCII-8BIT'
+    b.prepend('émalgré')
+    expect(b.encoding.to_s).to eq 'ASCII-8BIT'
+  end
+
   it 'should return bytesize of the buffer' do
     expect(b.size).to eq 9
   end

data/spec/helper.rb

@@ -1,6 +1,7 @@
 require 'active_support/core_ext/object/deep_dup'
 
 RSpec.configure(&:disable_monkey_patching!)
+RSpec::Expectations.configuration.warn_about_potential_false_positives = false
 
 require 'json'
 require 'coveralls'

data/spec/hpack_test_spec.rb

@@ -0,0 +1,84 @@
+require 'helper'
+require 'json'
+
+RSpec.describe HTTP2::Header do
+  folders = %w(
+    go-hpack
+    haskell-http2-diff
+    haskell-http2-diff-huffman
+    haskell-http2-linear
+    haskell-http2-linear-huffman
+    haskell-http2-naive
+    haskell-http2-naive-huffman
+    haskell-http2-static
+    haskell-http2-static-huffman
+    #hyper-hpack
+    nghttp2
+    nghttp2-16384-4096
+    nghttp2-change-table-size
+    node-http2-hpack
+  )
+
+  context 'Decompressor' do
+    folders.each do |folder|
+      next if folder =~ /#/
+      path = File.expand_path("hpack-test-case/#{folder}", File.dirname(__FILE__))
+      next unless Dir.exist?(path)
+      context "#{folder}" do
+        Dir.foreach(path) do |file|
+          next if file !~ /\.json/
+          it "should decode #{file}" do
+            story = JSON.parse(File.read("#{path}/#{file}"))
+            cases = story['cases']
+            table_size = cases[0]['header_table_size'] || 4096
+            @dc = Decompressor.new(table_size: table_size)
+            cases.each do |c|
+              wire = [c['wire']].pack('H*').force_encoding(Encoding::BINARY)
+              @emitted = @dc.decode(HTTP2::Buffer.new(wire))
+              headers = c['headers'].flat_map(&:to_a)
+              expect(@emitted).to eq headers
+            end
+          end
+        end
+      end
+    end
+  end
+
+  context 'Compressor' do
+    %w(
+      LINEAR
+      NAIVE
+      SHORTER
+      STATIC
+    ).each do |mode|
+      next if mode =~ /#/
+      ['', 'H'].each do |huffman|
+        encoding_mode = "#{mode}#{huffman}".to_sym
+        encoding_options = HTTP2::Header::EncodingContext.const_get(encoding_mode)
+        [4096, 512].each do |table_size|
+          options = { table_size: table_size }
+          options.update(encoding_options)
+
+          context "with #{mode}#{huffman} mode and table_size #{table_size}" do
+            path = File.expand_path('hpack-test-case/raw-data', File.dirname(__FILE__))
+            Dir.foreach(path) do |file|
+              next if file !~ /\.json/
+              it "should encode #{file}" do
+                story = JSON.parse(File.read("#{path}/#{file}"))
+                cases = story['cases']
+                @cc = Compressor  .new(options)
+                @dc = Decompressor.new(options)
+                cases.each do |c|
+                  headers = c['headers'].flat_map(&:to_a)
+                  wire = @cc.encode(headers)
+                  decoded = @dc.decode(HTTP2::Buffer.new(wire))
+                  expect(decoded).to eq headers
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-2
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Ilya Grigorik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2016-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ files:
 - spec/emitter_spec.rb
 - spec/framer_spec.rb
 - spec/helper.rb
+- spec/hpack_test_spec.rb
 - spec/huffman_spec.rb
 - spec/server_spec.rb
 - spec/stream_spec.rb
@@ -88,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -108,6 +109,7 @@ test_files:
 - spec/emitter_spec.rb
 - spec/framer_spec.rb
 - spec/helper.rb
+- spec/hpack_test_spec.rb
 - spec/huffman_spec.rb
 - spec/server_spec.rb
 - spec/stream_spec.rb