http-2 0.10.2 → 0.12.0

data/lib/http/2/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTP2
   # Default connection and stream flow control window (64KB).
   DEFAULT_FLOW_WINDOW = 65_535
@@ -10,28 +12,28 @@ module HTTP2
 
   # Default values for SETTINGS frame, as defined by the spec.
   SPEC_DEFAULT_CONNECTION_SETTINGS = {
-    settings_header_table_size:       4096,
-    settings_enable_push:             1,                     # enabled for servers
-    settings_max_concurrent_streams:  Framer::MAX_STREAM_ID, # unlimited
-    settings_initial_window_size:     65_535,
-    settings_max_frame_size:          16_384,
-    settings_max_header_list_size:    2**31 - 1,             # unlimited
+    settings_header_table_size: 4096,
+    settings_enable_push: 1, # enabled for servers
+    settings_max_concurrent_streams: Framer::MAX_STREAM_ID, # unlimited
+    settings_initial_window_size: 65_535,
+    settings_max_frame_size: 16_384,
+    settings_max_header_list_size: (2**31) - 1 # unlimited
   }.freeze
 
   DEFAULT_CONNECTION_SETTINGS = {
-    settings_header_table_size:       4096,
-    settings_enable_push:             1,                     # enabled for servers
-    settings_max_concurrent_streams:  100,
-    settings_initial_window_size:     65_535,
-    settings_max_frame_size:          16_384,
-    settings_max_header_list_size:    2**31 - 1,             # unlimited
+    settings_header_table_size: 4096,
+    settings_enable_push: 1, # enabled for servers
+    settings_max_concurrent_streams: 100,
+    settings_initial_window_size: 65_535,
+    settings_max_frame_size: 16_384,
+    settings_max_header_list_size: (2**31) - 1 # unlimited
   }.freeze
 
   # Default stream priority (lower values are higher priority).
-  DEFAULT_WEIGHT    = 16
+  DEFAULT_WEIGHT = 16
 
   # Default connection "fast-fail" preamble string as defined by the spec.
-  CONNECTION_PREFACE_MAGIC = "PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n".freeze
+  CONNECTION_PREFACE_MAGIC = "PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n"
 
   # Time to hold recently closed streams until purge (seconds)
   RECENTLY_CLOSED_STREAMS_TTL = 15
@@ -43,7 +45,7 @@ module HTTP2
   # Note that this class should not be used directly. Instead, you want to
   # use either Client or Server class to drive the HTTP 2.0 exchange.
   #
-  # rubocop:disable ClassLength
+  # rubocop:disable Metrics/ClassLength
   class Connection
     include FlowBuffer
     include Emitter
@@ -55,12 +57,11 @@ module HTTP2
     # Size of current connection flow control window (by default, set to
     # infinity, but is automatically updated on receipt of peer settings).
     attr_reader :local_window
-    attr_reader :remote_window
+    attr_reader :remote_window, :remote_settings
     alias window local_window
 
     # Current settings value for local and peer
     attr_reader :local_settings
-    attr_reader :remote_settings
 
     # Pending settings value
     #  Sent but not ack'ed settings
@@ -76,8 +77,8 @@ module HTTP2
       @local_settings  = DEFAULT_CONNECTION_SETTINGS.merge(settings)
       @remote_settings = SPEC_DEFAULT_CONNECTION_SETTINGS.dup
 
-      @compressor   = Header::Compressor.new(settings)
-      @decompressor = Header::Decompressor.new(settings)
+      @compressor   = Header::Compressor.new(**settings)
+      @decompressor = Header::Decompressor.new(**settings)
 
       @active_stream_count = 0
       @streams = {}
@@ -110,8 +111,8 @@ module HTTP2
     # @param window [Integer]
     # @param parent [Stream]
     def new_stream(**args)
-      fail ConnectionClosed if @state == :closed
-      fail StreamLimitExceeded if @active_stream_count >= @remote_settings[:settings_max_concurrent_streams]
+      raise ConnectionClosed if @state == :closed
+      raise StreamLimitExceeded if @active_stream_count >= @remote_settings[:settings_max_concurrent_streams]
 
       stream = activate_stream(id: @stream_id, **args)
       @stream_id += 2
@@ -140,10 +141,10 @@ module HTTP2
     # @param payload [String]
     def goaway(error = :no_error, payload = nil)
       last_stream = if (max = @streams.max)
-        max.first
-      else
-        0
-      end
+                      max.first
+                    else
+                      0
+                    end
 
       send(type: :goaway, last_stream: last_stream,
            error: error, payload: payload)
@@ -188,18 +189,17 @@ module HTTP2
       # SETTINGS frame. Server connection header is SETTINGS frame only.
       if @state == :waiting_magic
         if @recv_buffer.size < 24
-          if !CONNECTION_PREFACE_MAGIC.start_with? @recv_buffer
-            fail HandshakeError
-          else
-            return # maybe next time
-          end
+          raise HandshakeError unless CONNECTION_PREFACE_MAGIC.start_with? @recv_buffer
+
+          return # maybe next time
+
         elsif @recv_buffer.read(24) == CONNECTION_PREFACE_MAGIC
           # MAGIC is OK.  Send our settings
           @state = :waiting_connection_preface
           payload = @local_settings.reject { |k, v| v == SPEC_DEFAULT_CONNECTION_SETTINGS[k] }
           settings(payload)
         else
-          fail HandshakeError
+          raise HandshakeError
         end
       end
 
@@ -209,9 +209,7 @@ module HTTP2
         # Header blocks MUST be transmitted as a contiguous sequence of frames
         # with no interleaved frames of any other type, or from any other stream.
         unless @continuation.empty?
-          unless frame[:type] == :continuation && frame[:stream] == @continuation.first[:stream]
-            connection_error
-          end
+          connection_error unless frame[:type] == :continuation && frame[:stream] == @continuation.first[:stream]
 
           @continuation << frame
           return unless frame[:flags].include? :end_headers
@@ -238,7 +236,7 @@ module HTTP2
           when :headers
             # When server receives even-numbered stream identifier,
             # the endpoint MUST respond with a connection error of type PROTOCOL_ERROR.
-            connection_error if frame[:stream].even? && self.is_a?(Server)
+            connection_error if frame[:stream].even? && is_a?(Server)
 
             # The last frame in a sequence of HEADERS/CONTINUATION
             # frames MUST have the END_HEADERS flag set.
@@ -258,10 +256,10 @@ module HTTP2
             stream = @streams[frame[:stream]]
             if stream.nil?
               stream = activate_stream(
-                id:         frame[:stream],
-                weight:     frame[:weight] || DEFAULT_WEIGHT,
+                id: frame[:stream],
+                weight: frame[:weight] || DEFAULT_WEIGHT,
                 dependency: frame[:dependency] || 0,
-                exclusive:  frame[:exclusive] || false,
+                exclusive: frame[:exclusive] || false
               )
               emit(:stream, stream)
             end
@@ -333,10 +331,10 @@ module HTTP2
               # unused or closed parent stream.
               when :priority
                 stream = activate_stream(
-                  id:         frame[:stream],
-                  weight:     frame[:weight] || DEFAULT_WEIGHT,
+                  id: frame[:stream],
+                  weight: frame[:weight] || DEFAULT_WEIGHT,
                   dependency: frame[:dependency] || 0,
-                  exclusive:  frame[:exclusive] || false,
+                  exclusive: frame[:exclusive] || false
                 )
 
                 emit(:stream, stream)
@@ -358,9 +356,9 @@ module HTTP2
           end
         end
       end
-
     rescue StandardError => e
       raise if e.is_a?(Error::Error)
+
       connection_error(e: e)
     end
 
@@ -381,17 +379,15 @@ module HTTP2
       if frame[:type] == :data
         send_data(frame, true)
 
-      else
+      elsif frame[:type] == :rst_stream && frame[:error] == :protocol_error
         # An endpoint can end a connection at any time. In particular, an
         # endpoint MAY choose to treat a stream error as a connection error.
-        if frame[:type] == :rst_stream && frame[:error] == :protocol_error
-          goaway(frame[:error])
-        else
-          # HEADERS and PUSH_PROMISE may generate CONTINUATION. Also send
-          # RST_STREAM that are not protocol errors
-          frames = encode(frame)
-          frames.each { |f| emit(:frame, f) }
-        end
+        goaway(frame[:error])
+      else
+        # HEADERS and PUSH_PROMISE may generate CONTINUATION. Also send
+        # RST_STREAM that are not protocol errors
+        frames = encode(frame)
+        frames.each { |f| emit(:frame, f) }
       end
     end
 
@@ -401,10 +397,10 @@ module HTTP2
     # @return [Array of Buffer] encoded frame
     def encode(frame)
       frames = if frame[:type] == :headers || frame[:type] == :push_promise
-        encode_headers(frame) # HEADERS and PUSH_PROMISE may create more than one frame
-      else
-        [frame]               # otherwise one frame
-      end
+                 encode_headers(frame) # HEADERS and PUSH_PROMISE may create more than one frame
+               else
+                 [frame] # otherwise one frame
+               end
 
       frames.map { |f| @framer.generate(f) }
     end
@@ -460,9 +456,7 @@ module HTTP2
           # 4.  The ALTSVC HTTP/2 Frame
           # An ALTSVC frame on stream 0 with empty (length 0) "Origin"
           # information is invalid and MUST be ignored.
-          if frame[:origin] && !frame[:origin].empty?
-            emit(frame[:type], frame)
-          end
+          emit(frame[:type], frame) if frame[:origin] && !frame[:origin].empty?
         when :blocked
           emit(frame[:type], frame)
         else
@@ -495,9 +489,7 @@ module HTTP2
           when :client
             # Any value other than 0 or 1 MUST be treated as a
             # connection error (Section 5.4.1) of type PROTOCOL_ERROR.
-            unless v.zero? || v == 1
-              return ProtocolError.new("invalid #{key} value")
-            end
+            return ProtocolError.new("invalid #{key} value") unless v.zero? || v == 1
           end
         when :settings_max_concurrent_streams
           # Any value is valid
@@ -505,18 +497,14 @@ module HTTP2
           # Values above the maximum flow control window size of 2^31-1 MUST
           # be treated as a connection error (Section 5.4.1) of type
           # FLOW_CONTROL_ERROR.
-          unless v <= 0x7fffffff
-            return FlowControlError.new("invalid #{key} value")
-          end
+          return FlowControlError.new("invalid #{key} value") unless v <= 0x7fffffff
         when :settings_max_frame_size
           # The initial value is 2^14 (16,384) octets.  The value advertised
           # by an endpoint MUST be between this initial value and the maximum
           # allowed frame size (2^24-1 or 16,777,215 octets), inclusive.
           # Values outside this range MUST be treated as a connection error
           # (Section 5.4.1) of type PROTOCOL_ERROR.
-          unless v >= 16_384 && v <= 16_777_215
-            return ProtocolError.new("invalid #{key} value")
-          end
+          return ProtocolError.new("invalid #{key} value") unless v >= 16_384 && v <= 16_777_215
         when :settings_max_header_list_size
           # Any value is valid
           # else # ignore unknown settings
@@ -536,12 +524,12 @@ module HTTP2
       #   local: previously sent and pended our settings should be effective
       #   remote: just received peer settings should immediately be effective
       settings, side = if frame[:flags].include?(:ack)
-        # Process pending settings we have sent.
-        [@pending_settings.shift, :local]
-      else
-        connection_error(check) if validate_settings(@remote_role, frame[:payload])
-        [frame[:payload], :remote]
-      end
+                         # Process pending settings we have sent.
+                         [@pending_settings.shift, :local]
+                       else
+                         connection_error if validate_settings(@remote_role, frame[:payload])
+                         [frame[:payload], :remote]
+                       end
 
       settings.each do |key, v|
         case side
@@ -565,14 +553,14 @@ module HTTP2
           case side
           when :local
             @local_window = @local_window - @local_window_limit + v
-            @streams.each do |_id, stream|
+            @streams.each_value do |stream|
               stream.emit(:local_window, stream.local_window - @local_window_limit + v)
             end
 
             @local_window_limit = v
           when :remote
             @remote_window = @remote_window - @remote_window_limit + v
-            @streams.each do |_id, stream|
+            @streams.each_value do |stream|
               # Event name is :window, not :remote_window
               stream.emit(:window, stream.remote_window - @remote_window_limit + v)
             end
@@ -593,7 +581,8 @@ module HTTP2
           # nothing to do
 
         when :settings_max_frame_size
-          # nothing to do
+          # update framer max_frame_size
+          @framer.max_frame_size = v
 
           # else # ignore unknown settings
         end
@@ -620,10 +609,7 @@ module HTTP2
     #
     # @param frame [Hash]
     def decode_headers(frame)
-      if frame[:payload].is_a? Buffer
-        frame[:payload] = @decompressor.decode(frame[:payload])
-      end
-
+      frame[:payload] = @decompressor.decode(frame[:payload]) if frame[:payload].is_a? Buffer
     rescue CompressionError => e
       connection_error(:compression_error, e: e)
     rescue ProtocolError => e
@@ -642,7 +628,7 @@ module HTTP2
 
       frames = []
 
-      while payload.bytesize > 0
+      while payload.bytesize.positive?
         cont = frame.dup
         cont[:type] = :continuation
         cont[:flags] = []
@@ -658,7 +644,6 @@ module HTTP2
       end
 
       frames
-
     rescue StandardError => e
       connection_error(:compression_error, e: e)
       nil
@@ -674,7 +659,7 @@ module HTTP2
     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))
+      stream = Stream.new(connection: self, id: id, **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
@@ -691,7 +676,7 @@ module HTTP2
         cleanup_recently_closed
       end
 
-      stream.on(:promise, &method(:promise)) if self.is_a? Server
+      stream.on(:promise, &method(:promise)) if is_a? Server
       stream.on(:frame,   &method(:send))
 
       @streams[id] = stream
@@ -704,6 +689,7 @@ module HTTP2
       @streams_recently_closed.each do |stream_id, ts|
         # Ruby Hash enumeration is ordered, so once fresh stream is met we can stop searching.
         break if now_ts - ts < RECENTLY_CLOSED_STREAMS_TTL
+
         to_delete << stream_id
       end
 
@@ -727,11 +713,12 @@ module HTTP2
     def connection_error(error = :protocol_error, msg: nil, e: nil)
       goaway(error) unless @state == :closed || @state == :new
 
-      @state, @error = :closed, error
+      @state = :closed
+      @error = error
       klass = error.to_s.split('_').map(&:capitalize).join
-      msg ||= e && e.message
-      backtrace = (e && e.backtrace) || []
-      fail Error.const_get(klass), msg, backtrace
+      msg ||= e&.message
+      backtrace = e&.backtrace || []
+      raise Error.const_get(klass), msg, backtrace
     end
     alias error connection_error
 
@@ -739,5 +726,5 @@ module HTTP2
       yield
     end
   end
-  # rubocop:enable ClassLength
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/http/2/emitter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTP2
   # Basic event emitter implementation with support for persistent and
   # one-time event callbacks.
@@ -8,7 +10,8 @@ module HTTP2
     # @param event [Symbol]
     # @param block [Proc] callback function
     def add_listener(event, &block)
-      fail ArgumentError, 'must provide callback' unless block_given?
+      raise ArgumentError, 'must provide callback' unless block_given?
+
       listeners(event.to_sym).push block
     end
     alias on add_listener

data/lib/http/2/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTP2
   # Stream, connection, and compressor exceptions.
   module Error

data/lib/http/2/flow_buffer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTP2
   # Implementation of stream and connection DATA flow control: frames may
   # be split and / or may be buffered based on current flow control window.
@@ -24,7 +26,7 @@ module HTTP2
       # current received window size + delta length is strictly larger than
       # local window size, it throws a flow control error.
       #
-      error(:flow_control_error) if @local_window < 0
+      error(:flow_control_error) if @local_window.negative?
 
       # Send WINDOW_UPDATE if the received window size goes over
       # the local window size / 2.
@@ -41,6 +43,7 @@ module HTTP2
       # until the receiver window is exhausted, after which he'll be
       # waiting for the WINDOW_UPDATE frame.
       return unless @local_window <= (window_max_size / 2)
+
       window_update(window_max_size - @local_window)
     end
 
@@ -59,10 +62,11 @@ module HTTP2
       # FIXME: Frames with zero length with the END_STREAM flag set (that
       # is, an empty DATA frame) MAY be sent if there is no available space
       # in either flow control window.
-      while @remote_window > 0 && !@send_buffer.empty?
+      while @remote_window.positive? && !@send_buffer.empty?
         frame = @send_buffer.shift
 
-        sent, frame_size = 0, frame[:payload].bytesize
+        sent = 0
+        frame_size = frame[:payload].bytesize
 
         if frame_size > @remote_window
           payload = frame.delete(:payload)
@@ -93,6 +97,7 @@ module HTTP2
 
     def process_window_update(frame)
       return if frame[:ignore]
+
       @remote_window += frame[:increment]
       send_data
     end