protocol-http2 0.11.3 → 0.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b022547ae1f667d447eacb064d19730d31172074f190b86918fbf1f98a815fd
-  data.tar.gz: 8ae5a803210cffae68a5742724e6eaf3dd3525151ad3a2a44f22dc8167dc6058
+  metadata.gz: 1f02e8cbaee2f19317b390dc39177277184fe4a991b6780dcac1196303f63f2f
+  data.tar.gz: b10e1e173deddc82eb51f1f06d12df54b0c468b5db5154e13f0b01a2347ed182
 SHA512:
-  metadata.gz: 429cf7a735c1a99a525cb33ad0e0ffbf0b4e8b52c776bfa365bff6095f585e0cde7574698521153ab068ecca5e57ccde04375a7265b2caee47309cf4b7f5f32d
-  data.tar.gz: 29a1f37e144a4713471a73df47f3c2b56b32bd3ef79b83e2da874a77d6a5f28eb8f3800d9208abc93a8d73cb78489e4d8ab18f75602e1f82b4059141bf9457b6
+  metadata.gz: b326149b77c6064f93eb206aed282668ad2163f93f073ccba935e8c84c4e608d90ccc1d9f17841e88794915594e91aaaeb73b42c39175440a2603ed65a825275
+  data.tar.gz: f844428f6a8755569e915edf5089a56d039d21076e391c13d2766be0ceffbddbb58ea285ba143aac7f8668626c0b8509d7d37e15c80f891bcc402bef313c4987

data/lib/protocol/http2/connection.rb

@@ -20,13 +20,14 @@
 
 require_relative 'framer'
 require_relative 'dependency'
+require_relative 'flow_controlled'
 
 require 'protocol/hpack'
 
 module Protocol
 	module HTTP2
 		class Connection
-			include FlowControl
+			include FlowControlled
 			
 			def initialize(framer, local_stream_id)
 				super()
@@ -465,6 +466,15 @@ module Protocol
 				end
 			end
 			
+			# Traverse active streams in order of priority and allow them to consume the available flow-control window.
+			# @param amount [Integer] the amount of data to write. Defaults to the current window capacity.
+			def consume_window(size = self.available_size)
+				# Return if there is no window to consume:
+				return unless size > 0
+				
+				@dependency.consume_window(size)
+			end
+			
 			def receive_window_update(frame)
 				if frame.connection?
 					super

data/lib/protocol/http2/dependency.rb

@@ -18,14 +18,12 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'flow_control'
-
 module Protocol
 	module HTTP2
 		DEFAULT_WEIGHT = 16
 		
 		class Dependency
-			def initialize(connection, id, dependent_id = 0, weight = DEFAULT_WEIGHT, children = nil)
+			def initialize(connection, id, dependent_id = 0, weight = DEFAULT_WEIGHT)
 				@connection = connection
 				@id = id
 				
@@ -33,8 +31,18 @@ module Protocol
 				@dependent_id = dependent_id
 				@weight = weight
 				
-				# A cache of dependencies that have child.dependent_id = self.id
-				@children = children
+				@children = nil
+				
+				# Cache of any associated stream:
+				@stream = nil
+				
+				# Cache of children for window allocation:
+				@total_weight = 0
+				@ordered_children = nil
+			end
+			
+			def <=> other
+				@weight <=> other.weight
 			end
 			
 			def irrelevant?
@@ -62,34 +70,36 @@ module Protocol
 			attr_accessor :weight
 			
 			def stream
-				@connection.streams[@id]
+				@stream ||= @connection.streams[@id]
 			end
 			
-			def streams
-				if @children
-					# TODO this O(N) operation affects performance.
-					# It would be better to maintain a sorted list of children streams.
-					@children.map{|id, dependency| dependency.stream}.compact
-				end
+			def clear_cache!
+				@ordered_children = nil
 			end
 			
 			def add_child(dependency)
 				@children ||= {}
 				@children[dependency.id] = dependency
+				
+				self.clear_cache!
 			end
 			
 			def remove_child(dependency)
 				@children&.delete(dependency.id)
+				
+				self.clear_cache!
 			end
 			
 			def exclusive_child(parent)
 				parent.children = @children
+				parent.clear_cache!
 				
 				@children.each_value do |child|
 					child.dependent_id = parent.id
 				end
 				
 				@children = {parent.id => parent}
+				self.clear_cache!
 				
 				parent.dependent_id = @id
 			end
@@ -125,6 +135,8 @@ module Protocol
 					@dependent_id = dependent_id
 					
 					self.parent.add_child(self)
+				else
+					self.parent&.clear_cache!
 				end
 			end
 			
@@ -146,6 +158,34 @@ module Protocol
 			def receive_priority(frame)
 				self.process_priority(frame.unpack)
 			end
+			
+			def ordered_children
+				unless @ordered_children
+					if @children and !@children.empty?
+						@ordered_children = @children.values.sort
+						@total_weight = @ordered_children.sum(&:weight)
+					end
+				end
+				
+				return @ordered_children
+			end
+			
+			# Traverse active streams in order of priority and allow them to consume the available flow-control window.
+			# @param amount [Integer] the amount of data to write. Defaults to the current window capacity.
+			def consume_window(size)
+				# If there is an associated stream, give it priority:
+				if stream = self.stream
+					return if stream.window_updated(size)
+				end
+				
+				# Otherwise, allow the dependent children to use up the available window:
+				self.ordered_children&.each do |child|
+					# Compute the proportional allocation:
+					allocated = (child.weight * size) / @total_weight
+					
+					child.consume_window(allocated) if allocated > 0
+				end
+			end
 		end
 	end
 end

data/lib/protocol/http2/{flow_control.rb → flow_controlled.rb}

@@ -23,7 +23,7 @@ require_relative 'extensions/sum'
 
 module Protocol
 	module HTTP2
-		module FlowControl
+		module FlowControlled
 			def available_size
 				@remote_window.available
 			end
@@ -98,35 +98,9 @@ module Protocol
 			# The window has been expanded by the given amount.
 			# @param size [Integer] the maximum amount of data to send.
 			# @return [Boolean] whether the window update was used or not.
-			def window_updated(size = self.available_size)
+			def window_updated(size)
 				return false
 			end
-			
-			# Traverse active streams in order of priority and allow them to consume the available flow-control window.
-			# @todo This function can get slow when there are a lot of children [INEFFICIENT].
-			# @param amount [Integer] the amount of data to write. Defaults to the current window capacity.
-			def consume_window(size = self.available_size)
-				# Don't consume more than the available window size:
-				size = [self.available_size, size].min
-				# puts "consume_window(#{size}) local_window=#{@local_window} remote_window=#{@remote_window}"
-				
-				# Return if there is no window to consume:
-				return unless size > 0
-				
-				# Allow the current flow-controlled instance to use up the window:
-				if !self.window_updated(size) and children = self.children
-					children = children.sort_by(&:weight)
-					
-					# This must always be at least >= `children.size`, since stream weight can't be 0.
-					total = children.sum(&:weight)
-					
-					children.each do |child|
-						# Compute the proportional allocation:
-						allocated = (child.weight * size) / total
-						child.consume_window(allocated)
-					end
-				end
-			end
 		end
 	end
 end

data/lib/protocol/http2/stream.rb

@@ -72,7 +72,7 @@ module Protocol
 		#
 		# State transition methods use a trailing "!".
 		class Stream
-			include FlowControl
+			include FlowControlled
 			
 			def self.create(connection, id)
 				stream = self.new(connection, id)
@@ -124,10 +124,6 @@ module Protocol
 				@dependency.parent = stream.dependency
 			end
 			
-			def children
-				@dependency&.streams
-			end
-			
 			# The stream is being closed because the connection is being closed.
 			def close(error = nil)
 			end

data/lib/protocol/http2/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module HTTP2
-		VERSION = "0.11.3"
+		VERSION = "0.11.4"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http2
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.11.4
 platform: ruby
 authors:
 - Samuel Williams
@@ -118,7 +118,7 @@ files:
 - lib/protocol/http2/error.rb
 - lib/protocol/http2/extensions/sum.rb
 - lib/protocol/http2/extensions/unpack.rb
-- lib/protocol/http2/flow_control.rb
+- lib/protocol/http2/flow_controlled.rb
 - lib/protocol/http2/frame.rb
 - lib/protocol/http2/framer.rb
 - lib/protocol/http2/goaway_frame.rb
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A low level implementation of the HTTP/2 protocol.