protocol-http2 0.11.5 → 0.11.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 478bea0c69707c0ef4e07443b9438e61b2522a0a46fa7287ada3c07bc3b60916
-  data.tar.gz: 38ca40af5bab92c1125665a88cae0f0fd6faef5852de8e523b58753d960ca07c
+  metadata.gz: 4d8810aec1217f41c16dc254d8a38839766d0a6717ef1d8483b2c21eaa367139
+  data.tar.gz: 88cb94b5292c4fa1f430de2ee625a11650cd5564bc11a8e2df47eda25f8ce685
 SHA512:
-  metadata.gz: 3f6e3913fab16fceb8567a716ca7d1b7576a2af6af52a4cdd4a2cd83a3ab8e51faa3d0f31b3e6bb2c9953055c1ead44386b3013405703dd606939113893393dc
-  data.tar.gz: 3a58fbefd9f02483e044226f05bac8d7939f03b4c65bfd28341a065bd80cb90d93110ebb6bcf3c13169f7c7ff800e2ba5076f551f3b7c9010cc4fd9856e3c245
+  metadata.gz: 7119f9553cb2289f9dda868dc50f2624fd1d1205a81293e3fa1ec159424f3566adf7c51eb597ae47a3e421fa0510278071284cc951b87930b496b861321160d6
+  data.tar.gz: 3a270e16a604ab0fd9b251443472a9ff952a7db25065bd7c29d35fa00cf48bfe8d8c163d35f27d75366ebea50acac3f91cb296feb869c678dce5597cfcf97204

data/.travis.yml

@@ -4,11 +4,10 @@ cache: bundler
 
 matrix:
   include:
-    - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6
-    - rvm: 2.7    
+    - rvm: 2.7
     - rvm: 2.6
       env: COVERAGE=PartialSummary,Coveralls
     - rvm: truffleruby

data/lib/protocol/http2/connection.rb

@@ -63,14 +63,6 @@ module Protocol
 				0
 			end
 			
-			def parent
-				nil
-			end
-			
-			def children
-				@dependency.streams
-			end
-			
 			def [] id
 				if id.zero?
 					self
@@ -113,10 +105,7 @@ module Protocol
 			
 			def delete(id)
 				@streams.delete(id)
-				
-				if dependency = @dependencies[id]
-					dependency.delete! if dependency.irrelevant?
-				end
+				@dependencies[id]&.delete!
 			end
 			
 			# Close the underlying framer and all streams.
@@ -145,20 +134,10 @@ module Protocol
 			end
 			
 			attr :streams
+			
 			attr :dependencies
 			
-			# Fetch (or create) the flow control windows for the specified stream id.
-			# @param id [Integer] the stream id.
-			def dependency_for(id)
-				@dependencies.fetch(id) do
-					dependency = Dependency.new(self, id)
-					
-					# TODO this might be irrelevant, if initially processing priority frame.
-					@dependency.add_child(dependency)
-					
-					@dependencies[id] = dependency
-				end
-			end
+			attr :dependency
 			
 			# 6.8. GOAWAY
 			# There is an inherent race condition between an endpoint starting new streams and the remote sending a GOAWAY frame. To deal with this case, the GOAWAY contains the stream identifier of the last peer-initiated stream that was or might be processed on the sending endpoint in this connection. For instance, if the server sends a GOAWAY frame, the identified stream is the highest-numbered stream initiated by the client.
@@ -341,6 +320,8 @@ module Protocol
 				
 				if stream = @streams[frame.stream_id]
 					stream.receive_data(frame)
+				elsif closed_stream_id?(frame.stream_id)
+					# This can occur if one end sent a stream reset, while the other end was sending a data frame. It's mostly harmless.
 				else
 					raise ProtocolError, "Cannot receive data for stream id #{frame.stream_id}"
 				end
@@ -415,10 +396,31 @@ module Protocol
 				write_frame(frame)
 			end
 			
+			def idle_stream_id?(id)
+				if id.even?
+					# Server-initiated streams are even.
+					if @local_stream_id.even?
+						id >= @local_stream_id
+					else
+						id > @remote_stream_id
+					end
+				elsif id.odd?
+					# Client-initiated streams are odd.
+					if @local_stream_id.odd?
+						id >= @local_stream_id
+					else
+						id > @remote_stream_id
+					end
+				end
+			end
+			
 			# Sets the priority for an incoming stream.
 			def receive_priority(frame)
-				dependency = dependency_for(frame.stream_id)
-				dependency.receive_priority(frame)
+				if dependency = @dependencies[frame.stream_id]
+					dependency.receive_priority(frame)
+				elsif idle_stream_id?(frame.stream_id)
+					Dependency.create(self, frame.stream_id, frame.unpack)
+				end
 			end
 			
 			def receive_push_promise(frame)
@@ -472,6 +474,16 @@ module Protocol
 				# Return if there is no window to consume:
 				return unless size > 0
 				
+				# Console.logger.debug(self) do |buffer|
+				# 	@dependencies.each do |id, dependency|
+				# 		buffer.puts "- #{dependency}"
+				# 	end
+				# 
+				# 	buffer.puts
+				# 
+				# 	@dependency.print_hierarchy(buffer)
+				# end
+				
 				@dependency.consume_window(size)
 			end
 			

data/lib/protocol/http2/dependency.rb

@@ -23,16 +23,44 @@ module Protocol
 		DEFAULT_WEIGHT = 16
 		
 		class Dependency
-			def initialize(connection, id, dependent_id = 0, weight = DEFAULT_WEIGHT)
+			def self.create(connection, id, priority = nil)
+				weight = DEFAULT_WEIGHT
+				exclusive = false
+				
+				if priority
+					if parent = connection.dependencies[priority.stream_dependency]
+						exclusive = priority.exclusive
+					end
+					
+					weight = priority.weight
+				end
+				
+				if parent.nil?
+					parent = connection.dependency
+				end
+				
+				dependency = self.new(connection, id, weight)
+				
+				connection.dependencies[id] = dependency
+				
+				if exclusive
+					parent.exclusive_child(dependency)
+				else
+					parent.add_child(dependency)
+				end
+				
+				return dependency
+			end
+			
+			def initialize(connection, id, weight = DEFAULT_WEIGHT)
 				@connection = connection
 				@id = id
 				
-				# Stream priority:
-				@dependent_id = dependent_id
-				@weight = weight
-				
+				@parent = nil
 				@children = nil
 				
+				@weight = weight
+				
 				# Cache of any associated stream:
 				@stream = nil
 				
@@ -45,26 +73,17 @@ module Protocol
 				@weight <=> other.weight
 			end
 			
-			def irrelevant?
-				(@weight == DEFAULT_WEIGHT) && (@children.nil? || @children.empty?)
-			end
-			
-			def delete!
-				@connection.dependencies.delete(@id)
-				self.parent&.remove_child(self)
-			end
-			
-			# Cache of dependent children.
-			attr_accessor :children
-			
 			# The connection this stream belongs to.
 			attr :connection
 			
 			# Stream ID (odd for client initiated streams, even otherwise).
 			attr :id
 			
-			# The stream id that this stream depends on, according to the priority.
-			attr_accessor :dependent_id
+			# The parent dependency.
+			attr_accessor :parent
+			
+			# The dependent children.
+			attr_accessor :children
 			
 			# The weight of the stream relative to other siblings.
 			attr_accessor :weight
@@ -77,10 +96,26 @@ module Protocol
 				@ordered_children = nil
 			end
 			
+			def delete!
+				@connection.dependencies.delete(@id)
+				
+				@parent.remove_child(self)
+				
+				@children&.each do |id, child|
+					parent.add_child(child)
+				end
+				
+				@connection = nil
+				@parent = nil
+				@children = nil
+			end
+			
 			def add_child(dependency)
 				@children ||= {}
 				@children[dependency.id] = dependency
 				
+				dependency.parent = self
+				
 				self.clear_cache!
 			end
 			
@@ -90,33 +125,24 @@ module Protocol
 				self.clear_cache!
 			end
 			
+			# An exclusive flag allows for the insertion of a new level of dependencies.  The exclusive flag causes the stream to become the sole dependency of its parent stream, causing other dependencies to become dependent on the exclusive stream.
+			# @param parent [Dependency] the dependency which will be inserted, taking control of all current children.
 			def exclusive_child(parent)
 				parent.children = @children
-				parent.clear_cache!
 				
-				@children.each_value do |child|
-					child.dependent_id = parent.id
+				@children&.each_value do |child|
+					child.parent = parent
 				end
 				
+				parent.clear_cache!
+				
 				@children = {parent.id => parent}
 				self.clear_cache!
 				
-				parent.dependent_id = @id
-			end
-			
-			def parent(id = @dependent_id)
-				@connection.dependency_for(id)
-			end
-			
-			def parent= dependency
-				self.parent&.remove_child(self)
-				
-				@dependent_id = dependency.id
-				
-				dependency.add_child(self)
+				parent.parent = self
 			end
 			
-			def process_priority priority
+			def process_priority(priority)
 				dependent_id = priority.stream_dependency
 				
 				if dependent_id == @id
@@ -125,18 +151,17 @@ module Protocol
 				
 				@weight = priority.weight
 				
-				if priority.exclusive
-					self.parent&.remove_child(self)
-					
-					self.parent(dependent_id).exclusive_child(self)
-				elsif dependent_id != @dependent_id
-					self.parent&.remove_child(self)
-					
-					@dependent_id = dependent_id
-					
-					self.parent.add_child(self)
-				else
-					self.parent&.clear_cache!
+				# We essentially ignore `dependent_id` if the dependency does not exist:
+				if parent = @connection.dependencies[dependent_id]
+					if priority.exclusive
+						@parent.remove_child(self)
+						
+						parent.exclusive_child(self)
+					elsif !@parent.equal?(parent)
+						@parent.remove_child(self)
+						
+						parent.add_child(self)
+					end
 				end
 			end
 			
@@ -148,7 +173,7 @@ module Protocol
 			
 			# The current local priority of the stream.
 			def priority(exclusive = false)
-				Priority.new(exclusive, @dependent_id, @weight)
+				Priority.new(exclusive, @parent.id, @weight)
 			end
 			
 			def send_priority(priority)
@@ -159,6 +184,12 @@ module Protocol
 				self.process_priority(frame.unpack)
 			end
 			
+			def total_weight
+				self.orderd_children
+				
+				return @total_weight
+			end
+			
 			def ordered_children
 				unless @ordered_children
 					if @children and !@children.empty?
@@ -186,6 +217,17 @@ module Protocol
 					child.consume_window(allocated) if allocated > 0
 				end
 			end
+			
+			def to_s
+				"\#<#{self.class} id=#{@id} parent id=#{@parent&.id} weight=#{@weight} #{@children&.size || 0} children>"
+			end
+			
+			def print_hierarchy(buffer, indent: 0)
+				buffer.puts "#{" " * indent}#{self}"
+				@children&.each_value do |child|
+					child.print_hierarchy(buffer, indent: indent+1)
+				end
+			end
 		end
 	end
 end

data/lib/protocol/http2/flow_controlled.rb

@@ -19,7 +19,6 @@
 # THE SOFTWARE.
 
 require_relative 'window_update_frame'
-require_relative 'extensions/sum'
 
 module Protocol
 	module HTTP2

data/lib/protocol/http2/frame.rb

@@ -21,9 +21,6 @@
 
 require_relative 'error'
 
-# This only exists to support Ruby 2.3:
-require_relative 'extensions/unpack'
-
 module Protocol
 	module HTTP2
 		END_STREAM = 0x1

data/lib/protocol/http2/headers_frame.rb

@@ -68,6 +68,9 @@ module Protocol
 				
 				if priority
 					buffer << priority.pack
+					set_flags(PRIORITY)
+				else
+					clear_flags(PRIORITY)
 				end
 				
 				buffer << data

data/lib/protocol/http2/stream.rb

@@ -91,7 +91,7 @@ module Protocol
 				@local_window = Window.new(@connection.local_settings.initial_window_size)
 				@remote_window = Window.new(@connection.remote_settings.initial_window_size)
 				
-				@dependency = @connection.dependency_for(@id)
+				@dependency = Dependency.create(@connection, @id)
 			end
 			
 			# The connection this stream belongs to.
@@ -163,9 +163,9 @@ module Protocol
 			end
 			
 			# The HEADERS frame is used to open a stream, and additionally carries a header block fragment. HEADERS frames can be sent on a stream in the "idle", "reserved (local)", "open", or "half-closed (remote)" state.
-			def send_headers(*args)
+			def send_headers(*arguments)
 				if @state == :idle
-					frame = write_headers(*args)
+					frame = write_headers(*arguments)
 					
 					if frame.end_stream?
 						@state = :half_closed_local
@@ -173,17 +173,17 @@ module Protocol
 						open!
 					end
 				elsif @state == :reserved_local
-					frame = write_headers(*args)
+					frame = write_headers(*arguments)
 					
 					@state = :half_closed_remote
 				elsif @state == :open
-					frame = write_headers(*args)
+					frame = write_headers(*arguments)
 					
 					if frame.end_stream?
 						@state = :half_closed_local
 					end
 				elsif @state == :half_closed_remote
-					frame = write_headers(*args)
+					frame = write_headers(*arguments)
 					
 					if frame.end_stream?
 						close!

data/lib/protocol/http2/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module HTTP2
-		VERSION = "0.11.5"
+		VERSION = "0.11.6"
 	end
 end

data/protocol-http2.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
 	
+	spec.required_ruby_version = '~> 2.4'
+	
 	spec.add_dependency "protocol-hpack", "~> 1.4"
 	spec.add_dependency "protocol-http", "~> 0.15"
 	

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http2
 version: !ruby/object:Gem::Version
-  version: 0.11.5
+  version: 0.11.6
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-21 00:00:00.000000000 Z
+date: 2020-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-hpack
@@ -116,8 +116,6 @@ files:
 - lib/protocol/http2/data_frame.rb
 - lib/protocol/http2/dependency.rb
 - lib/protocol/http2/error.rb
-- lib/protocol/http2/extensions/sum.rb
-- lib/protocol/http2/extensions/unpack.rb
 - lib/protocol/http2/flow_controlled.rb
 - lib/protocol/http2/frame.rb
 - lib/protocol/http2/framer.rb
@@ -144,16 +142,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A low level implementation of the HTTP/2 protocol.

data/lib/protocol/http2/extensions/sum.rb

@@ -1,37 +0,0 @@
-# Copyright, 2019, by Yuta Iwama.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-module Protocol
-	module HTTP2
-		module Extensions
-			module Sum
-				def sum(init = 0)
-					reduce(init) do |acc, v|
-						acc + (block_given? ? yield(v) : v)
-					end
-				end
-			end
-		end
-	end
-end
-
-unless Array.instance_methods.include?(:sum)
-	Array.prepend(Protocol::HTTP2::Extensions::Sum)
-end

data/lib/protocol/http2/extensions/unpack.rb

@@ -1,38 +0,0 @@
-# Copyright, 2019, by Yuta Iwama.
-# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require 'protocol/http/error'
-
-module Protocol
-	module HTTP2
-		module Extensions
-			module Unpack
-				def unpack1(template)
-					unpack(template).first
-				end
-			end
-		end
-	end
-end
-
-unless String.instance_methods.include?(:unpack1)
-	String.prepend(Protocol::HTTP2::Extensions::Unpack)
-end