http-2 0.6.3 → 0.7.0

data/spec/hpack_test_spec.rb

@@ -0,0 +1,83 @@
+require "helper"
+require 'json'
+
+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__))
+      Dir.exists?(path) or next
+      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
+            context = story['context'] ? story['context'].to_sym : :request
+            @dc = Decompressor.new(table_size: table_size)
+            cases.each do |c|
+              wire = [c['wire']].pack("H*").force_encoding('binary')
+              @emitted = @dc.decode(HTTP2::Buffer.new(wire))
+              headers = c['headers'].flat_map(&:to_a)
+              @emitted.should 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|
+        [4096, 512].each do |table_size|
+          context "with #{mode}#{huffman} mode and table_size #{table_size}" do
+            options = eval("HTTP2::Header::#{mode}#{huffman}")
+            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']
+                context = story['context'] ? story['context'].to_sym : :request
+                @cc = Compressor  .new(table_size: table_size)
+                @dc = Decompressor.new(table_size: table_size)
+                cases.each do |c|
+                  headers = c['headers'].flat_map(&:to_a)
+                  wire = @cc.encode(headers)
+                  decoded = @dc.decode(HTTP2::Buffer.new(wire))
+                  decoded.should eq headers
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/huffman_spec.rb

@@ -0,0 +1,68 @@
+require "helper"
+
+describe HTTP2::Header::Huffman do
+  huffman_examples = [# plain, encoded
+    ["www.example.com", "f1e3c2e5f23a6ba0ab90f4ff"],
+    ["no-cache",        "a8eb10649cbf"],
+    ["Mon, 21 Oct 2013 20:13:21 GMT", "d07abe941054d444a8200595040b8166e082a62d1bff"],
+  ]
+  context "encode" do
+    before(:all) { @encoder = HTTP2::Header::Huffman.new }
+    huffman_examples.each do |plain, encoded|
+      it "should encode #{plain} into #{encoded}" do
+        @encoder.encode(plain).unpack("H*").first.should eq encoded
+      end
+    end
+  end
+  context "decode" do
+    before(:all) { @encoder = HTTP2::Header::Huffman.new }
+    huffman_examples.each do |plain, encoded|
+      it "should decode #{encoded} into #{plain}" do
+        @encoder.decode(HTTP2::Buffer.new([encoded].pack("H*"))).should eq plain
+      end
+    end
+
+    [
+      "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:16.0) Gecko/20100101 Firefox/16.0",
+      "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+      "http://www.craigslist.org/about/sites/",
+      "cl_b=AB2BKbsl4hGM7M4nH5PYWghTM5A; cl_def_lang=en; cl_def_hp=shoals",
+      "image/png,image/*;q=0.8,*/*;q=0.5",
+      "BX=c99r6jp89a7no&b=3&s=q4; localization=en-us%3Bus%3Bus",
+      "UTF-8でエンコードした日本語文字列",
+    ].each do |string|
+      it "should encode then decode '#{string}' into the same" do
+        s = string.dup.force_encoding('binary')
+        encoded = @encoder.encode(s)
+        @encoder.decode(HTTP2::Buffer.new(encoded)).should eq s
+      end
+    end
+
+    it "should encode/decode all_possible 2-byte sequences" do
+      (2**16).times do |n|
+        str = [n].pack("V")[0,2].force_encoding('binary')
+        @encoder.decode(HTTP2::Buffer.new(@encoder.encode(str))).should eq str
+      end
+    end
+
+    it "should raise when input is shorter than expected" do
+      plain, encoded = huffman_examples[0]
+      encoded = [encoded].pack("H*")
+      expect { @encoder.decode(HTTP2::Buffer.new(encoded[0...-1])) }.to raise_error(/EOS invalid/)
+    end
+    it "should raise when input is not padded by 1s" do
+      plain, encoded = ["www.example.com", "f1e3c2e5f23a6ba0ab90f4fe"] # note the fe at end
+      encoded = [encoded].pack("H*")
+      expect { @encoder.decode(HTTP2::Buffer.new(encoded)) }.to raise_error(/EOS invalid/)
+    end
+    it "should raise when exceedingly padded" do
+      plain, encoded = ["www.example.com", "e7cf9bebe89b6fb16fa9b6ffff"] # note the extra ff
+      encoded = [encoded].pack("H*")
+      expect { @encoder.decode(HTTP2::Buffer.new(encoded)) }.to raise_error(/EOS invalid/)
+    end
+    it "should raise when EOS is explicitly encoded" do
+      encoded = ["1c7fffffffff"].pack("H*") # a b EOS
+      expect { @encoder.decode(HTTP2::Buffer.new(encoded)) }.to raise_error(/EOS found/)
+    end
+  end
+end

data/spec/server_spec.rb

@@ -15,7 +15,7 @@ describe HTTP2::Server do
     it "should emit SETTINGS on new connection" do
       frames = []
       @srv.on(:frame) { |recv| frames << recv }
-      @srv << CONNECTION_HEADER
+      @srv << CONNECTION_PREFACE_MAGIC
 
       f.parse(frames[0])[:type].should eq :settings
     end
@@ -23,14 +23,15 @@ describe HTTP2::Server do
     it "should initialize client with custom connection settings" do
       frames = []
 
-      @srv = Server.new(streams: 200, window: 2**10)
+      @srv = Server.new(settings_max_concurrent_streams: 200,
+                        settings_initial_window_size:    2**10)
       @srv.on(:frame) { |recv| frames << recv }
-      @srv << CONNECTION_HEADER
+      @srv << CONNECTION_PREFACE_MAGIC
 
       frame = f.parse(frames[0])
       frame[:type].should eq :settings
-      frame[:payload][:settings_max_concurrent_streams].should eq 200
-      frame[:payload][:settings_initial_window_size].should eq 2**10
+      frame[:payload].should include([:settings_max_concurrent_streams, 200])
+      frame[:payload].should include([:settings_initial_window_size, 2**10])
     end
   end
 
@@ -40,7 +41,7 @@ describe HTTP2::Server do
 
     @srv.on(:stream) do |stream|
       expect {
-        stream.promise({}) {}
+        stream.promise(':method' => 'GET') {}
       }.to_not raise_error
     end
 

data/spec/stream_spec.rb

@@ -12,8 +12,8 @@ describe HTTP2::Stream do
     end
 
     it "should set custom stream priority" do
-      stream = @client.new_stream(priority: 3)
-      stream.priority.should eq 3
+      stream = @client.new_stream(weight: 3, dependency: 2, exclusive: true)
+      stream.weight.should eq 3
     end
 
     context "reserved (local)" do
@@ -55,8 +55,8 @@ describe HTTP2::Stream do
       end
 
       it "should reprioritize stream on PRIORITY" do
-        @stream.receive PRIORITY.merge({priority: 30})
-        @stream.priority.should eq 30
+        expect { @stream.receive PRIORITY }.to_not raise_error
+        @stream.weight.should eq 20
       end
     end
 
@@ -95,8 +95,8 @@ describe HTTP2::Stream do
       end
 
       it "should reprioritize stream on PRIORITY" do
-        @stream.send PRIORITY
-        @stream.priority.should eq 15
+        expect { @stream.send PRIORITY }.to_not raise_error
+        @stream.weight.should eq 20
       end
     end
 
@@ -116,7 +116,7 @@ describe HTTP2::Stream do
       end
 
       it "should transition to half closed (local) if sending END_STREAM" do
-        [DATA, HEADERS, CONTINUATION].each do |frame|
+        [DATA, HEADERS].each do |frame|
           s, f = @stream.dup, frame.dup
           f[:flags] = [:end_stream]
 
@@ -126,7 +126,7 @@ describe HTTP2::Stream do
       end
 
       it "should transition to half closed (remote) if receiving END_STREAM" do
-        [DATA, HEADERS, CONTINUATION].each do |frame|
+        [DATA, HEADERS].each do |frame|
           s, f = @stream.dup, frame.dup
           f[:flags] = [:end_stream]
 
@@ -173,8 +173,8 @@ describe HTTP2::Stream do
         sp.receive HEADERS
         sr.send HEADERS
 
-        openp.should be_true
-        openr.should be_true
+        openp.should be_truthy
+        openr.should be_truthy
       end
 
       it "should not emit :active on transition from open" do
@@ -202,8 +202,8 @@ describe HTTP2::Stream do
         sp.receive RST_STREAM
         sr.close
 
-        closep.should be_true
-        closer.should be_true
+        closep.should be_truthy
+        closer.should be_truthy
       end
 
       it "should emit :close after frame is processed" do
@@ -236,7 +236,7 @@ describe HTTP2::Stream do
       before(:each) { @stream.send HEADERS_END_STREAM }
 
       it "should raise error on attempt to send frames" do
-        (FRAME_TYPES - [RST_STREAM]).each do |frame|
+        (FRAME_TYPES - [PRIORITY, RST_STREAM]).each do |frame|
           expect { @stream.dup.send frame }.to raise_error StreamError
         end
       end
@@ -267,6 +267,11 @@ describe HTTP2::Stream do
         @stream.state.should eq :half_closed_local
       end
 
+      it "should reprioritize stream on PRIORITY" do
+        expect { @stream.send PRIORITY }.to_not raise_error
+        @stream.weight.should eq 20
+      end
+
       it "should emit :half_close event on transition" do
         order = []
         stream = @client.new_stream
@@ -286,7 +291,7 @@ describe HTTP2::Stream do
         @stream.receive RST_STREAM
 
         @stream.state.should eq :closed
-        closed.should be_true
+        closed.should be_truthy
       end
     end
 
@@ -294,7 +299,7 @@ describe HTTP2::Stream do
       before(:each) { @stream.receive HEADERS_END_STREAM }
 
       it "should raise STREAM_CLOSED error on reciept of frames" do
-        (FRAME_TYPES - [RST_STREAM, WINDOW_UPDATE]).each do |frame|
+        (FRAME_TYPES - [PRIORITY, RST_STREAM, WINDOW_UPDATE]).each do |frame|
           expect {
             @stream.dup.receive frame
           }.to raise_error(StreamClosed)
@@ -302,7 +307,7 @@ describe HTTP2::Stream do
       end
 
       it "should transition to closed if END_STREAM flag is sent" do
-        [DATA, HEADERS, CONTINUATION].each do |frame|
+        [DATA, HEADERS].each do |frame|
           s, f = @stream.dup, frame.dup
           f[:flags] = [:end_stream]
 
@@ -327,6 +332,11 @@ describe HTTP2::Stream do
         @stream.state.should eq :half_closed_remote
       end
 
+      it "should reprioritize stream on PRIORITY" do
+        expect { @stream.receive PRIORITY }.to_not raise_error
+        @stream.weight.should eq 20
+      end
+
       it "should emit :half_close event on transition" do
         order = []
         stream = @client.new_stream
@@ -346,7 +356,7 @@ describe HTTP2::Stream do
         @stream.close
 
         @stream.state.should eq :closed
-        closed.should be_true
+        closed.should be_truthy
       end
     end
 
@@ -358,7 +368,7 @@ describe HTTP2::Stream do
         end
 
         it "should raise STREAM_CLOSED on attempt to send frames" do
-          (FRAME_TYPES - [RST_STREAM]).each do |frame|
+          (FRAME_TYPES - [PRIORITY, RST_STREAM]).each do |frame|
             expect {
               @stream.dup.send frame
             }.to raise_error(StreamClosed)
@@ -366,20 +376,28 @@ describe HTTP2::Stream do
         end
 
         it "should raise STREAM_CLOSED on receipt of frame" do
-          (FRAME_TYPES - [RST_STREAM]).each do |frame|
+          (FRAME_TYPES - [PRIORITY, RST_STREAM, WINDOW_UPDATE]).each do |frame|
             expect {
               @stream.dup.receive frame
             }.to raise_error(StreamClosed)
           end
         end
 
-        it "should allow RST_STREAM to be sent" do
+        it "should allow PRIORITY, RST_STREAM to be sent" do
+          expect { @stream.send PRIORITY }.to_not raise_error
           expect { @stream.send RST_STREAM }.to_not raise_error
         end
 
-        it "should not send RST_STREAM on receipt of RST_STREAM" do
+        it "should allow PRIORITY, RST_STREAM to be received" do
+          expect { @stream.receive PRIORITY }.to_not raise_error
           expect { @stream.receive RST_STREAM }.to_not raise_error
         end
+
+        it "should reprioritize stream on PRIORITY" do
+          expect { @stream.receive PRIORITY }.to_not raise_error
+          @stream.weight.should eq 20
+        end
+
       end
 
       context "local closed via RST_STREAM frame" do
@@ -407,40 +425,45 @@ describe HTTP2::Stream do
           # We're auto RST'ing PUSH streams in connection class, hence
           # skipping this transition for now.
         #end
+
       end
 
-     context "local closed via END_STREAM flag" do
-        before(:each) do
-          @stream.send HEADERS  # open
-          @stream.send DATA     # contains end_stream flag
-        end
+      # FIXME: Isn't this test same as "half closed (local)"?
+      # context "local closed via END_STREAM flag" do
+      #   before(:each) do
+      #     @stream.send HEADERS  # open
+      #     @stream.send DATA     # contains end_stream flag
+      #   end
+
+      #   it "should ignore received frames" do
+      #     FRAME_TYPES.each do |frame|
+      #       expect { @stream.dup.receive frame }.to_not raise_error
+      #     end
+      #   end
+      # end
 
-        it "should ignore received frames" do
-          FRAME_TYPES.each do |frame|
-            expect { @stream.dup.receive frame }.to_not raise_error
-          end
-        end
-      end
     end
   end # end stream states
 
+  # TODO: add test cases to ensure on(:priority) emitted after close
+
   context "flow control" do
     it "should initialize to default flow control window" do
-      @stream.window.should eq DEFAULT_FLOW_WINDOW
+      @stream.remote_window.should eq DEFAULT_FLOW_WINDOW
     end
 
     it "should update window size on DATA frames only" do
       @stream.send HEADERS # go to open
-      @stream.window.should eq DEFAULT_FLOW_WINDOW
+      @stream.remote_window.should eq DEFAULT_FLOW_WINDOW
 
       (FRAME_TYPES - [DATA,PING,GOAWAY,SETTINGS]).each do |frame|
         s = @stream.dup
         s.send frame
-        s.window.should eq DEFAULT_FLOW_WINDOW
+        s.remote_window.should eq DEFAULT_FLOW_WINDOW
       end
 
       @stream.send DATA
-      @stream.window.should eq DEFAULT_FLOW_WINDOW - DATA[:payload].bytesize
+      @stream.remote_window.should eq DEFAULT_FLOW_WINDOW - DATA[:payload].bytesize
     end
 
     it "should update window size on receipt of WINDOW_UPDATE" do
@@ -448,14 +471,14 @@ describe HTTP2::Stream do
       @stream.send DATA
       @stream.receive WINDOW_UPDATE
 
-      @stream.window.should eq (
+      @stream.remote_window.should eq (
         DEFAULT_FLOW_WINDOW - DATA[:payload].bytesize + WINDOW_UPDATE[:increment]
       )
     end
 
     it "should observe session flow control" do
       settings, data = SETTINGS.dup, DATA.dup
-      settings[:payload] = { settings_initial_window_size: 1000 }
+      settings[:payload] = [[:settings_initial_window_size, 1000]]
       settings[:stream] = 0
 
       framer = Framer.new
@@ -464,17 +487,17 @@ describe HTTP2::Stream do
       s1 = @client.new_stream
       s1.send HEADERS
       s1.send data.merge({payload: "x" * 900, flags: []})
-      s1.window.should eq 100
+      s1.remote_window.should eq 100
 
       s1.send data.merge({payload: "x" * 200})
-      s1.window.should eq 0
+      s1.remote_window.should eq 0
       s1.buffered_amount.should eq 100
 
       @client << framer.generate(WINDOW_UPDATE.merge({
         stream: s1.id, increment: 1000
       }))
       s1.buffered_amount.should eq 0
-      s1.window.should eq 900
+      s1.remote_window.should eq 900
     end
   end
 
@@ -482,17 +505,17 @@ describe HTTP2::Stream do
     it ".reprioritize should emit PRIORITY frame" do
       @stream.should_receive(:send) do |frame|
         frame[:type].should eq :priority
-        frame[:priority].should eq 30
+        frame[:weight].should eq 30
       end
 
-      @stream.reprioritize 30
+      @stream.reprioritize weight: 30
     end
 
     it ".reprioritize should raise error if invoked by server" do
       srv = Server.new
       stream = srv.new_stream
 
-      expect { stream.reprioritize(10) }.to raise_error(StreamError)
+      expect { stream.reprioritize(weight: 10) }.to raise_error(StreamError)
     end
 
     it ".headers should emit HEADERS frames" do
@@ -528,7 +551,7 @@ describe HTTP2::Stream do
     end
 
     it ".data should split large DATA frames" do
-      data = "x" * HTTP2::MAX_FRAME_SIZE * 2
+      data = "x" * 16384 * 2
 
       @stream.stub(:send)
       @stream.should_receive(:send).exactly(3).times
@@ -564,7 +587,7 @@ describe HTTP2::Stream do
     end
 
     it "should emit received headers via on(:headers)" do
-      headers, recv = {"header" => "value"}, nil
+      headers, recv = [["header", "value"]], nil
       @srv.on(:stream) do |stream|
         stream.on(:headers) {|h| recv = h}
       end
@@ -585,16 +608,21 @@ describe HTTP2::Stream do
       @client_stream.data(payload)
     end
 
-    it "should emit received priority via on(:priority)" do
-      new_priority, recv = 15, 0
+    it "should emit received priority parameters via on(:priority)" do
+      new_weight, new_dependency = 15, @client_stream.id + 2
+      callback_called = false
       @srv.on(:stream) do |stream|
         stream.on(:priority) do |pri|
-          pri.should eq new_priority
+          callback_called = true
+          pri.is_a?(Hash).should be
+          pri[:weight].should eq new_weight
+          pri[:dependency].should eq new_dependency
         end
       end
 
       @client_stream.headers({"key" => "value"})
-      @client_stream.reprioritize(new_priority)
+      @client_stream.reprioritize(weight: new_weight, dependency: new_dependency)
+      callback_called.should be
     end
 
     context "push" do
@@ -604,7 +632,6 @@ describe HTTP2::Stream do
           @server_stream = stream
         end
 
-        # @srv << @frm.generate(SETTINGS)
         @client_stream.headers({"key" => "value"})
       end
 
@@ -643,7 +670,7 @@ describe HTTP2::Stream do
         end
 
         it "client: headers > active > headers > .. > data > close" do
-          order, headers = [], {}
+          order, headers = [], []
           @client.on(:promise) do |push|
             order << :reserved
 
@@ -654,7 +681,7 @@ describe HTTP2::Stream do
 
             push.on(:headers) do |h|
               order << :headers
-              headers.merge!(h)
+              headers += h
             end
 
             push.id.should be_even
@@ -665,7 +692,7 @@ describe HTTP2::Stream do
             push.data("somedata")
           end
 
-          headers.should eq({"key" => "val", "key2" => "val2"})
+          headers.should eq([["key", "val"], ["key2", "val2"]])
           order.should eq [:reserved, :headers, :active, :headers,
                            :half_close, :data, :close]
         end