h2 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a59b70f55abe247ca3ae333b72031a32f880fa1844bd8058585a4090bcc55969
-  data.tar.gz: d28023b7123b0819c1f540070831188fd99460f11fe9914c2d8c00c7e4dd4e6d
+  metadata.gz: b32f7af9ee3845b4a817610abf47cf8fdf4503fda1418b49ab323220fe1ccf49
+  data.tar.gz: 5a6fc19c1d0480c6f0eeddb808d61a09dbdb1582c4aa31125cbe6a8e4ba0b8a0
 SHA512:
-  metadata.gz: a7e502860f2f753ed37f419ba41b78c9399fe8a6278cbfe937ccd7c04f8da0c7fd53fdbc960454ac389a3b4a4073d3a39737a643fdf09235aac281b7f15f67eb
-  data.tar.gz: 2dfa20d7aafdc0e37cd61aba4c6a2d9696c4efb58de3786f87c628f08c65bb5437baebdc93dd2acd4f27abde49021f2ac82d58d06ea9d133359d6d9098c8c6b4
+  metadata.gz: 20820c02ce3c3459deb468854498e3bf362c19d1b0f032979d77d679f44803bbd81db8d780714e428e192b9bbead83114da031af2c2b5f7983b79075345ced2c
+  data.tar.gz: 236e9658e69e7fde118c0cc4b679b2deceb83bebe2a06c4c33aac14038a39232d20ca4cadfc995e34a885b3c808dd14faee3cdb47e9adbca587b218ebeb00732

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 h2 changelog
 ============
 
+### 0.8.0 10 aug 2018
+
+* fix read/settings ack race (https://httpwg.org/specs/rfc7540.html#ConnectionHeader)
+* add SSE/EventSource support
+
 ### 0.7.0 2 aug 2018
 
 * `Server::Stream::Request#path` now removes query string

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+gem 'http-2', path: '../http-2'
 
 group :concurrent_ruby do
   gem 'concurrent-ruby'

data/README.md

@@ -11,9 +11,10 @@ H2 uses:
 
 ## Server Usage
 
-Server API is currently optional, and must be required separately. The server
-uses [Celluloid::IO](https://github.com/celluloid/celluloid-io), but since this API is optional,
-celluloid-io must be separately added to `Gemfile`. It is currently based on `celluloid-io-0.17.3`.
+Server API is currently optional, so `h2/server` must be required separately.
+The server uses [Celluloid::IO](https://github.com/celluloid/celluloid-io), but
+h2's gemspec does not require it, so celluloid-io must be separately added to
+`Gemfile`. It is currently based on `celluloid-io-0.17.3`.
 
 ```ruby
 require 'h2/server'
@@ -29,7 +30,11 @@ stream = H2.get url: "http://#{addr}:#{port}", tls: false
 stream.body #=> "hello, world!\n"
 ```
 
-See [examples](https://github.com/kenichi/h2/tree/master/examples/server/).
+See more server examples:
+
+* [HTTPS Hello World](https://github.com/kenichi/h2/blob/master/examples/server/https_hello_world.rb)
+* [Push Promises](https://github.com/kenichi/h2/blob/master/examples/server/push_promise.rb)
+* [SSE/EventSource](https://github.com/kenichi/h2/blob/master/examples/server/sse.rb)
 
 ## Client Usage
 

data/examples/server/https_hello_world.rb

@@ -8,6 +8,9 @@ port       = 1234
 addr       = Socket.getaddrinfo('localhost', port).first[3]
 certs_dir  = File.expand_path '../../../tmp/certs', __FILE__
 
+# if not using SNI, we may pass the underlying opts directly, and the same TLS
+# cert/key will be used for all incoming connections.
+#
 tls = {
   cert: certs_dir + '/server.crt',
   key:  certs_dir + '/server.key',

data/examples/server/sse.rb

@@ -30,8 +30,13 @@ s = H2::Server::HTTPS.new host: addr, port: port, sni: sni do |connection|
       stream.respond status: 404
 
     when '/events'
-      es = stream.to_eventsource
-      event_sources << es
+      if stream.request.method == :delete
+        event_sources.each &:close
+        event_sources.clear
+        stream.respond status: 200
+      else
+        event_sources << stream.to_eventsource
+      end
 
     when '/msg'
       if stream.request.method == :post

data/exe/h2

@@ -58,10 +58,24 @@ OptionParser.new do |o|
     options[:debug] = true
   end
 
+  o.on '-sse', '--eventsource', 'send event-stream headers and print messages as they arrive' do
+    options[:headers]['accept'] = H2::EVENT_SOURCE_CONTENT_TYPE
+  end
+
   o.on '-g', '--goaway', 'send GOAWAY frame when stream is complete' do
     options[:goaway] = true
   end
 
+  o.on '-h', '--help', 'show this help/usage' do
+    puts o
+    exit
+  end
+
+  o.on '-H [VALUE]', '--header [VALUE]', String, 'include header in request (format: "key: value")' do |h|
+    kv = h.split(':').map &:strip
+    options[:headers][kv[0]] = kv[1]
+  end
+
   o.on '-v', '--verbose', 'turn on verbosity' do
     options[:verbose] = true
   end
@@ -135,7 +149,12 @@ if options[:verbose]
   s.headers.each {|k,v| puts "<< #{k}: #{v}".yellow}
 end
 
-puts s.body
+if s.eventsource?
+  s.body {|e| puts e}
+else
+  puts s.body
+end
+
 c.block! if options[:block] or !s.pushes.empty?
 s.pushes.each do |p|
   puts "push promise: #{p.headers[':path']}"

data/lib/h2/client/celluloid.rb

@@ -9,7 +9,6 @@ module H2
         include ::Celluloid
 
         def read client, maxlen = DEFAULT_MAXLEN
-          client.reading!
           client._read maxlen
         end
       end

data/lib/h2/client/concurrent.rb

@@ -18,7 +18,7 @@ module H2
       def read maxlen = DEFAULT_MAXLEN
         main = Thread.current
         @reader = self.class.thread_pool.post do
-          reading!
+          @read_gate.block!
           begin
             _read maxlen
           rescue => e

data/lib/h2/client.rb

@@ -10,6 +10,7 @@ module H2
     PARSER_EVENTS = [
       :close,
       :frame,
+      :frame_sent,
       :goaway,
       :promise
     ]
@@ -28,12 +29,13 @@ module H2
     # @param [String] host IP address or hostname
     # @param [Integer] port TCP port (default: 443)
     # @param [String,URI] url full URL to parse (optional: existing +URI+ instance)
+    # @param [Boolean] lazy if true, awaits first stream to initiate connection (default: true)
     # @param [Hash,FalseClass] tls TLS options (optional: +false+ do not use TLS)
     # @option tls [String] :cafile path to CA file
     #
     # @return [H2::Client]
     #
-    def initialize host: nil, port: 443, url: nil, tls: {}
+    def initialize host: nil, port: 443, url: nil, lazy: true, tls: {}
       raise ArgumentError if url.nil? && (host.nil? || port.nil?)
 
       if url
@@ -48,24 +50,34 @@ module H2
         @scheme = tls ? 'https' : 'http'
       end
 
-      @tls     = tls
-      @streams = {}
-      @socket  = TCPSocket.new(@host, @port)
-      @socket  = tls_socket @socket if @tls
-      @client  = HTTP2::Client.new
-
-      @first   = true
-      @reading = false
+      @tls       = tls
+      @streams   = {}
+      @client    = HTTP2::Client.new
+      @read_gate = ReadGate.new
 
       init_blocking
       yield self if block_given?
       bind_events
+
+      connect unless lazy
+    end
+
+    # initiate the connection
+    #
+    def connect
+      @socket = TCPSocket.new(@host, @port)
+      @socket = tls_socket @socket if @tls
+      read
+    end
+
+    def connected?
+      !!@socket
     end
 
     # @return true if the connection is closed
     #
     def closed?
-      @socket.closed?
+      connected? && @socket.closed?
     end
 
     # close the connection
@@ -79,14 +91,6 @@ module H2
       @socket.eof?
     end
 
-    def reading?
-      @mutex.synchronize { @reading }
-    end
-
-    def reading!
-      @mutex.synchronize { @reading = true }
-    end
-
     # send a goaway frame and wait until the connection is closed
     #
     def goaway!
@@ -137,9 +141,10 @@ module H2
     # @return [H2::Stream]
     #
     def request method:, path:, headers: {}, params: {}, body: nil, &block
+      connect unless connected?
       s = @client.new_stream
-      stream = add_stream method: method, path: path, stream: s, &block
       add_params params, path unless params.empty?
+      stream = add_stream method: method, path: path, stream: s, &block
 
       h = build_headers method: method, path: path, headers: headers
       s.headers h, end_stream: body.nil?
@@ -205,7 +210,8 @@ module H2
     # creates a new +Thread+ to read the given number of bytes each loop from
     # the current +@socket+
     #
-    # NOTE: initial client frames (settings, etc) should be sent first!
+    # NOTE: initial client frames (settings, etc) should be sent first, since
+    #       this is a separate thread, take care to block until this happens
     #
     # NOTE: this is the override point for celluloid actor pool or concurrent
     #       ruby threadpool support
@@ -215,7 +221,7 @@ module H2
     def read maxlen = DEFAULT_MAXLEN
       main = Thread.current
       @reader = Thread.new do
-        reading!
+        @read_gate.block!
         begin
           _read maxlen
         rescue => e
@@ -300,9 +306,17 @@ module H2
         @socket.write bytes
       end
       @socket.flush
+    end
 
-      @first = false if @first
-      read unless @first or @reading
+    # frame_sent callback for parser: used to wait for initial settings frame
+    # to be sent by the client (post-connection-preface) before the read thread
+    # responds to server settings frame with ack
+    #
+    def on_frame_sent frame
+      if @read_gate.first && frame[:type] == :settings
+        @read_gate.first = false
+        @read_gate.unblock!
+      end
     end
 
     # fake exceptionless IO for writing on older ruby versions
@@ -402,5 +416,16 @@ module H2
 
     prepend ExceptionlessIO if H2.exceptionless_io?
 
+    class ReadGate
+      include Blockable
+
+      attr_accessor :first
+
+      def initialize
+        init_blocking
+        @first = true
+      end
+    end
+
   end
 end

data/lib/h2/server/stream/event_source.rb

@@ -7,8 +7,8 @@ module H2
         DATA_TEMPL  = "data: %s\n\n"
         EVENT_TEMPL = "event: %s\n#{DATA_TEMPL}"
         SSE_HEADER  = {
-          STATUS_KEY    => '200',
-          :content_type => 'text/event-stream'
+          STATUS_KEY => '200',
+          CONTENT_TYPE_KEY => EVENT_SOURCE_CONTENT_TYPE
         }
 
         # build and return +EventSource+ instance, ready for pushing out data
@@ -35,7 +35,7 @@ module H2
         #
         def check_accept_header
           accept = @stream.request.headers['accept']
-          unless accept == SSE_HEADER[:content_type]
+          unless accept == SSE_HEADER[CONTENT_TYPE_KEY]
             raise StreamError, "invalid header accept: #{accept}"
           end
         end

data/lib/h2/stream.rb

@@ -32,6 +32,8 @@ module H2
       @pushes  = Set.new
       @stream  = stream
 
+      @eventsource = false
+
       init_blocking
       yield self if block_given?
       bind_events
@@ -61,6 +63,13 @@ module H2
       @push
     end
 
+    # @return [Boolean] true if this +Stream+ is connected to an +EventSource+
+    #
+    def eventsource?
+      block!
+      @eventsource
+    end
+
     # add a push promise +Stream+ to this +Stream+'s list of "child" pushes
     #
     def add_push stream
@@ -91,8 +100,16 @@ module H2
     # @return [String] response headers (blocks)
     #
     def body
-      block!
-      @body
+      if @eventsource
+        loop do
+          event = @body.pop
+          break if event == :close
+          yield event
+        end
+      else
+        block!
+        @body
+      end
     end
 
     # binds all stream events to their respective on_ handlers
@@ -102,6 +119,7 @@ module H2
         @parent.add_push self if @parent && push?
         @client.last_stream = self
         @closed = true
+        @body << :close if @eventsource
         unblock!
         on :close
       end
@@ -112,6 +130,7 @@ module H2
 
       @stream.on(:data) do |d|
         on :data, d
+        unblock! if @eventsource
         @body << d
       end
     end
@@ -119,10 +138,20 @@ module H2
     # builds +Hash+ from associative array, merges into response headers
     #
     def add_headers h
+      check_event_source h
       h = Hash[h]
       on :headers, h
       @headers.merge! h
-      @headers
+    end
+
+    # checks for event source headers and reconfigures +@body+
+    #
+    def check_event_source h
+      return if @eventsource
+      if h.any? {|e| e[0] == CONTENT_TYPE_KEY && e[1] == EVENT_SOURCE_CONTENT_TYPE }
+        @eventsource = true
+        @body = Queue.new
+      end
     end
 
     # @return [Hash] a simple +Hash+ with +:headers+ and +:body+ keys/values

data/lib/h2/version.rb

@@ -1,5 +1,5 @@
 module H2
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 
   class << self
 

data/lib/h2.rb

@@ -29,6 +29,9 @@ module H2
     :put
   ]
 
+  CONTENT_TYPE_KEY          = 'content-type'
+  EVENT_SOURCE_CONTENT_TYPE = 'text/event-stream'
+
   Logger = ::Logger.new STDOUT
 
   class << self
@@ -108,11 +111,11 @@ module H2
       @mutex.synchronize { @condition.wait @mutex, timeout } if @condition
     end
 
-    def unblock!
+    def unblock! remove_condition: true
       return unless @condition
       @mutex.synchronize do
         @condition.broadcast
-        @condition = nil
+        @condition = nil if remove_condition
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: h2
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Kenichi Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-02 00:00:00.000000000 Z
+date: 2018-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2