net-http2 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ca19f3b01ed565929287e4db629d7c5a3c1522e
-  data.tar.gz: d31dc0fc2f7cf652dcc8bdac6fcc8b31b6721797
+  metadata.gz: 1d1bbb7eb0d7324fb63a671d0f8fbc2075b6a625
+  data.tar.gz: 9d4dd0e9e5131ac605292030235b9a68a8087b83
 SHA512:
-  metadata.gz: b0b94a8d7e38e0fed916585ff63b8f1686e0cf0ae0107dced66a7de8199155ac62484366fd1808ba2bfeb5e6fc02fb2bcd4cabab061ecfa2833a6bf1621ef22b
-  data.tar.gz: f88d758b5174c933832c003ce996f0a97277bf0b24da7ba517825bcb2eb4a898b8773f56b008fe256eb247ca0a659117a8cc04be0f22f463145e60fb414ab117
+  metadata.gz: 1db0898b540554278ee5a3789bafae4aac29e9a8075fdfbd26c0aca57f360136b9c3c4c60f57b0ff412030ad87c2878b5890f4e9df255535a73ddf7535609ef4
+  data.tar.gz: 064cdc09d94dbd1e13623ae2a42b5cb5f695344f83ed60faadfab7aa1e9f7c721099e8fc8187133f9cbb36523f89142a1672c6071b8bf937b9ca342c954d4ada

data/README.md

@@ -95,6 +95,16 @@ client.close
  NetHttp2::Client.new("https://nghttp2.org", ssl_context: ctx)
  ```
 
+ * **on(event, &block)**
+
+Allows to set a callback for the client. The only available event is `:error`, which allows to set a callback when an error is raised at socket level, hence in the underlying socket thread.
+
+```ruby
+client.on(:error) { |exception| puts "Exception has been raised: #{exception}" }
+```
+
+> It is RECOMMENDED to set the `:error` callback: if none is defined, the underlying socket thread may raise an error in the main thread at unexpected execution times. 
+
  * **uri** → **`URI`**
 
  Returns the URI of the endpoint.
@@ -202,7 +212,10 @@ The real benefit of HTTP/2 is being able to receive body and header streams. Ins
 
 
 ## Thread-Safety
-NetHttp2 is thread-safe.
+NetHttp2 is thread-safe. However, some caution is imperative:
+
+  * The async callbacks will be executed in a different thread, so ensure that your code in the callbacks is thread-safe.
+  * Errors in the underlying socket loop thread will be raised in the main thread at unexpected execution times, unless you specify the `:error` callback on the Client (recommended).
 
 ## Contributing
 So you want to contribute? That's great! Please follow the guidelines below. It will make it easier to get merged in.

data/lib/http2_patch.rb

@@ -0,0 +1,49 @@
+require 'http/2/connection'
+
+# We are currently locked to using the Http2 library v0.8.2 since v0.8.3 still has some compatibility issues:
+# <https://github.com/igrigorik/http-2/issues/92>
+#
+# However, v0.8.2 had a memory leak that was reported in the following issues:
+# <https://github.com/igrigorik/http-2/issues/73>
+# <https://github.com/ostinelli/net-http2/issues/7>
+#
+# Hence, this is a temporary monkey-patch to the HTTP2 library in order to solve the mentioned leak
+# while waiting to fix the issues on v0.8.3.
+
+module HTTP2
+
+  class Connection
+
+    private
+
+    def activate_stream(id: nil, **args)
+      connection_error(msg: 'Stream ID already exists') if @streams.key?(id)
+
+      stream = Stream.new({ connection: self, id: id }.merge(args))
+
+      # Streams that are in the "open" state, or either of the "half closed"
+      # states count toward the maximum number of streams that an endpoint is
+      # permitted to open.
+      stream.once(:active) { @active_stream_count += 1 }
+
+      @streams_recently_closed ||= {}
+      stream.once(:close) do
+        @active_stream_count -= 1
+
+        @streams_recently_closed.delete_if do |closed_stream_id, v|
+          to_be_deleted = (Time.now - v) > 15
+          @streams.delete(closed_stream_id) if to_be_deleted
+          to_be_deleted
+        end
+
+        @streams_recently_closed[id] = Time.now
+      end
+
+      stream.on(:promise, &method(:promise)) if self.is_a? Server
+      stream.on(:frame, &method(:send))
+      stream.on(:window_update, &method(:window_update))
+
+      @streams[id] = stream
+    end
+  end
+end

data/lib/net-http2.rb

@@ -1,3 +1,4 @@
+require 'net-http2/callbacks'
 require 'net-http2/client'
 require 'net-http2/response'
 require 'net-http2/request'
@@ -5,6 +6,8 @@ require 'net-http2/socket'
 require 'net-http2/stream'
 require 'net-http2/version'
 
+require 'http2_patch'
+
 module NetHttp2
   raise "Cannot require NetHttp2, unsupported engine '#{RUBY_ENGINE}'" unless RUBY_ENGINE == "ruby"
 end

data/lib/net-http2/callbacks.rb

@@ -0,0 +1,22 @@
+module NetHttp2
+
+  module Callbacks
+
+    def on(event, &block)
+      raise ArgumentError, 'on event must provide a block' unless block_given?
+
+      @callback_events        ||= {}
+      @callback_events[event] ||= []
+      @callback_events[event] << block
+    end
+
+    def emit(event, arg)
+      return unless @callback_events && @callback_events[event]
+      @callback_events[event].each { |b| b.call(arg) }
+    end
+
+    def callback_events
+      @callback_events || {}
+    end
+  end
+end

data/lib/net-http2/client.rb

@@ -9,6 +9,9 @@ module NetHttp2
   PROXY_SETTINGS_KEYS = [:proxy_addr, :proxy_port, :proxy_user, :proxy_pass]
 
   class Client
+
+    include Callbacks
+
     attr_reader :uri
 
     def initialize(url, options={})
@@ -101,17 +104,25 @@ module NetHttp2
           rescue EOFError
             # socket closed
             init_vars
-            raise SocketError.new 'Socket was remotely closed'
+            callback_or_raise SocketError.new('Socket was remotely closed')
 
           rescue Exception => e
             # error on socket
             init_vars
-            raise e
+            callback_or_raise e
           end
         end.tap { |t| t.abort_on_exception = true }
       end
     end
 
+    def callback_or_raise(exception)
+      if callback_events.keys.include?(:error)
+        emit(:error, exception)
+      else
+        raise exception
+      end
+    end
+
     def socket_loop
 
       ensure_sent_before_receiving

data/lib/net-http2/request.rb

@@ -4,6 +4,8 @@ module NetHttp2
 
   class Request
 
+    include Callbacks
+
     DEFAULT_TIMEOUT = 60
 
     attr_reader :method, :uri, :path, :params, :body, :timeout
@@ -30,11 +32,13 @@ module NetHttp2
       @headers.merge!(':authority' => "#{@uri.host}:#{@uri.port}") unless @headers[':authority']
 
       if @body
-        @headers.merge!('content-length' => @body.bytesize.to_s)
+        @headers.merge!('content-length' => @body.bytesize)
       else
         @headers.delete('content-length')
       end
 
+      @headers.update(@headers) { |_k, v| v.to_s }
+
       @headers
     end
 
@@ -44,18 +48,6 @@ module NetHttp2
       path
     end
 
-    def on(event, &block)
-      raise ArgumentError, 'on event must provide a block' unless block_given?
-
-      @events[event] ||= []
-      @events[event] << block
-    end
-
-    def emit(event, arg)
-      return unless @events[event]
-      @events[event].each { |b| b.call(arg) }
-    end
-
     private
 
     # The to_param and to_query code here below is a free adaptation from the original code in:

data/lib/net-http2/version.rb

@@ -1,3 +1,3 @@
 module NetHttp2
-  VERSION = "0.14.1"
+  VERSION = '0.15.0'.freeze
 end

data/net-http2.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "http-2", "~> 0.8.2"
+  spec.add_dependency "http-2", "0.8.2"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: net-http2
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Roberto Ostinelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-30 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.2
 - !ruby/object:Gem::Dependency
@@ -84,7 +84,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/http2_patch.rb
 - lib/net-http2.rb
+- lib/net-http2/callbacks.rb
 - lib/net-http2/client.rb
 - lib/net-http2/request.rb
 - lib/net-http2/response.rb