h2 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e62e384940a1e408102e4e518942c1245ce374f82007c858d9de5a0b286c2301
-  data.tar.gz: d3fc7f3d111b3786cb50c58f862b32dad713557ae69cf18233cd1eda7ca0d5be
+  metadata.gz: 9a9868c3d9496207683352704cd152a9d5426ff42cd3aa30035a56981596e957
+  data.tar.gz: 43e60980d431d769835d4bb15de0cacbb5676c250b1e461c31e4f88c89734c48
 SHA512:
-  metadata.gz: 907a28fb440862cbc3a6a9dbb80db39408f3635f4aa4983358bba508617ddbb8fcb9da0a30b3601a614f4ea7a79ff4cceece1b7d1c687b6afc3e663ad5d4459d
-  data.tar.gz: 317f75c090f2f54526a2bff4b2e8b7d298ab7f6bf8f4653e9bd5ac2916f333133e26a7b47d357c447a7a0a6741468b99733e1212c71ee018f4698c51b0ea5eaf
+  metadata.gz: 19e4e75141869144f1ed7b6abf8b6faeb61d00db6466d02ec5264ec7d95ddada0de2914b071dc13a5293885189fea5cb9b235515fc8e282218244d19b5eea08a
+  data.tar.gz: 50a36bbc351d0dca3cc81750800e2a5085e403bc6019a8620cef8ec5d8977c4e227dcd994656365eb9d75ae03d4fdb0dd9d2e740f2eeccbdf636210f8952dd50

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 h2 changelog
 ============
 
+### 0.6.1 27 jul 2018
+
+* fix race between reading and sending first frame
+* make `port:` default to 443 for `H2::Client.new`
+
 ### 0.6.0 25 jul 2018
 
 * update server API - kwargs

data/Gemfile

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

data/exe/h2

@@ -9,7 +9,6 @@ require 'colored'
 require 'optparse'
 
 begin # {{{
-  raise LoadError if ARGV.include?('--dev')
   require 'h2'
 rescue LoadError
   $: << File.expand_path('../../lib', __FILE__)
@@ -59,10 +58,6 @@ OptionParser.new do |o|
     options[:debug] = true
   end
 
-  o.on '--dev', 'load lib from source tree' do
-    # handled above for reasons
-  end
-
   o.on '-g', '--goaway', 'send GOAWAY frame when stream is complete' do
     options[:goaway] = true
   end
@@ -142,8 +137,8 @@ end
 
 puts s.body
 
-c.goaway if options[:goaway]
 c.block! if options[:block]
+c.goaway if options[:goaway]
 c.close
 
 # }}}

data/lib/h2.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'http/2'
+require 'logger'
 require 'uri'
 require 'h2/version'
 
@@ -28,8 +29,21 @@ module H2
     :put
   ]
 
+  Logger = ::Logger.new STDOUT
+
   class << self
 
+    # turn on extra verbose debug logging
+    #
+    def verbose!
+      @verbose = true
+    end
+
+    def verbose?
+      @verbose = false unless defined?(@verbose)
+      @verbose
+    end
+
     # convenience wrappers to make requests with HTTP methods
     #
     # @see H2.request
@@ -120,6 +134,33 @@ module H2
 
   end
 
+  module FrameDebugger
+
+    def self.included base
+      H2.verbose!
+      base::PARSER_EVENTS.push :frame_sent, :frame_received
+    end
+
+    def on_frame_sent f
+      Logger.debug "Sent frame: #{truncate_frame(f).inspect}"
+    end
+
+    def on_frame_received f
+      Logger.debug "Received frame: #{truncate_frame(f).inspect}"
+    end
+
+    private
+
+    def truncate_string s
+      (String === s && s.length > 64) ? "#{s[0,64]}..." : s
+    end
+
+    def truncate_frame f
+      f.reduce({}) { |h, (k, v)| h[k] = truncate_string(v); h }
+    end
+
+  end
+
 end
 
 require 'h2/client'

data/lib/h2/client.rb

@@ -7,16 +7,18 @@ module H2
     include Blockable
     include On
 
-    CONNECTION_EVENTS = [
+    PARSER_EVENTS = [
       :close,
       :frame,
       :goaway,
       :promise
     ]
 
-    ALPN_PROTOCOLS           = ['h2']
-    DEFAULT_MAXLEN           = 4096
-    RE_IP_ADDR               = Regexp.union Resolv::IPv4::Regex, Resolv::IPv6::Regex
+    # include FrameDebugger
+
+    ALPN_PROTOCOLS = ['h2']
+    DEFAULT_MAXLEN = 4096
+    RE_IP_ADDR     = Regexp.union Resolv::IPv4::Regex, Resolv::IPv6::Regex
 
     attr_accessor :last_stream
     attr_reader :client, :reader, :scheme, :socket, :streams
@@ -24,14 +26,14 @@ module H2
     # create a new h2 client
     #
     # @param [String] host IP address or hostname
-    # @param [Integer] port TCP port
+    # @param [Integer] port TCP port (default: 443)
     # @param [String,URI] url full URL to parse (optional: existing +URI+ instance)
     # @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: nil, url: nil, tls: {}
+    def initialize host: nil, port: 443, url: nil, tls: {}
       raise ArgumentError if url.nil? && (host.nil? || port.nil?)
 
       if url
@@ -52,11 +54,12 @@ module H2
       @socket  = tls_socket @socket if @tls
       @client  = HTTP2::Client.new
 
+      @first   = true
+      @reading = false
+
       init_blocking
       yield self if block_given?
       bind_events
-
-      read
     end
 
     # @return true if the connection is closed
@@ -76,6 +79,14 @@ 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!
@@ -98,7 +109,7 @@ module H2
     # binds all connection events to their respective on_ handlers
     #
     def bind_events
-      CONNECTION_EVENTS.each do |e|
+      PARSER_EVENTS.each do |e|
         @client.on(e){|*a| __send__ "on_#{e}", *a}
       end
     end
@@ -194,6 +205,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: this is the override point for celluloid actor pool or concurrent
     #       ruby threadpool support
     #
@@ -202,6 +215,7 @@ module H2
     def read maxlen = DEFAULT_MAXLEN
       main = Thread.current
       @reader = Thread.new do
+        reading!
         begin
           _read maxlen
         rescue => e
@@ -230,7 +244,7 @@ module H2
             begin
               @client << data
             rescue HTTP2::Error::ProtocolError => pe
-              STDERR.puts 'mystery protocol error!'
+              STDERR.puts "protocol error: #{pe.message}"
               STDERR.puts pe.backtrace.map {|l| "\t" + l}
             end
           end
@@ -286,6 +300,9 @@ module H2
         @socket.write bytes
       end
       @socket.flush
+
+      @first = false if @first
+      read unless @first or @reading
     end
 
     # fake exceptionless IO for writing on older ruby versions

data/lib/h2/client/celluloid.rb

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

data/lib/h2/client/concurrent.rb

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

data/lib/h2/server.rb

@@ -1,5 +1,4 @@
 require 'celluloid/current'
-require 'logger'
 require 'reel'
 require 'h2/reel/ext'
 require 'h2'
@@ -8,8 +7,6 @@ module H2
 
   CONTENT_LENGTH_KEY = 'content-length'
 
-  Logger = ::Logger.new STDOUT
-
   class << self
 
     def alpn?
@@ -21,17 +18,6 @@ module H2
       @jruby = RUBY_ENGINE == 'jruby'
     end
 
-    # turn on extra verbose debug logging
-    #
-    def verbose!
-      @verbose = true
-    end
-
-    def verbose?
-      @verbose = false unless defined?(@verbose)
-      @verbose
-    end
-
   end
 
   # base H2 server, a direct subclass of +Reel::Server+

data/lib/h2/server/connection.rb

@@ -13,12 +13,12 @@ module H2
       #
       PARSER_EVENTS = [
         :frame,
-        :frame_sent,
-        :frame_received,
         :stream,
         :goaway
       ]
 
+      # include FrameDebugger
+
       attr_reader :parser, :server, :socket
 
       def initialize socket:, server:
@@ -94,7 +94,7 @@ module H2
 
         rescue => e
           Logger.error "Exception: #{e.message} - closing socket"
-          STDERR.puts e.backtrace
+          STDERR.puts e.backtrace if H2.verbose?
           close
 
         end
@@ -107,24 +107,12 @@ module H2
       # called by +@parser+ with a binary frame to write to the +@socket+
       #
       def on_frame bytes
-        Logger.debug "Writing bytes: #{truncate_string(bytes.unpack("H*").first)}" if H2.verbose?
-
-        # N.B. this is the important bit
-        #
         @socket.write bytes
       rescue IOError, Errno::EPIPE => e
         Logger.error e.message
         close
       end
 
-      def on_frame_sent f
-        Logger.debug "Sent frame: #{truncate_frame(f).inspect}" if H2.verbose?
-      end
-
-      def on_frame_received f
-        Logger.debug "Received frame: #{truncate_frame(f).inspect}" if H2.verbose?
-      end
-
       # the +@parser+ calls this when a new stream has been initiated by the
       # client
       #
@@ -138,16 +126,6 @@ module H2
         close
       end
 
-      private
-
-      def truncate_string s
-        (String === s && s.length > 64) ? "#{s[0,64]}..." : s
-      end
-
-      def truncate_frame f
-        f.reduce({}) { |h, (k, v)| h[k] = truncate_string(v); h }
-      end
-
     end
   end
 end

data/lib/h2/version.rb

@@ -1,5 +1,5 @@
 module H2
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 
   class << self
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: h2
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Kenichi Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-25 00:00:00.000000000 Z
+date: 2018-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2