protocol-http2 0.10.4 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7ca4d904325a7bfe60c54aecf87ea7eab1d1addbfe0cdf38f1cead97e37be8c
-  data.tar.gz: 87eb242fecbeda4519aa85274d6d3199fd71965531d9ecf29d3e67dfc6081548
+  metadata.gz: 014c5404c1c741f09ed296d51da864e5e50ed7ecf336da2d2360fe8bed69fff8
+  data.tar.gz: 8f7e6fcbedfe36e3eaea28f8e1fabd7488c82f0465dad54927a1a9216a191465
 SHA512:
-  metadata.gz: f9991a66cd567b5f524675c49cc10aa01a002cef790c2de3ff90b8f63153deb008750e6b90d93497c97ef3aab18c13b7b243a2c72b01785399bd5fcc28ce5694
-  data.tar.gz: 1eb905670918fdff2eb57964fe7f229d8094a848e9e17b41c407a05ca74936e044c27e319170298f0e05c2247babdd785e68a52158a6dced281508114677e67d
+  metadata.gz: 2d9f8ff2e36fdabb2aa72afd3903d410d0d0ebc660a78a865de6610768629d682f41e90ea39ece505159a97f50a4b87d6cb061c99af2759e0a4901b8a3275f9f
+  data.tar.gz: c66a7bf1538d34011cb2b40aa8ea1502079c88c8709cd6969216da8b355f26b301fd6e58e65b8e296333a2b4fc5f68a552f02b14fe15d8bad4c40fc378e0b077

data/.travis.yml

@@ -8,6 +8,7 @@ matrix:
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6
+    - rvm: 2.7    
     - rvm: 2.6
       env: COVERAGE=PartialSummary,Coveralls
     - rvm: truffleruby

data/lib/protocol/http2/connection.rb

@@ -19,7 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'framer'
-require_relative 'flow_control'
+require_relative 'dependency'
 
 require 'protocol/hpack'
 
@@ -32,10 +32,13 @@ module Protocol
 				super()
 				
 				@state = :new
+				
+				# Hash(Integer, Stream)
 				@streams = {}
-				@children = {}
 				
-				@active = 0
+				# Hash(Integer, Dependency)
+				@dependency = Dependency.new(self, 0)
+				@dependencies = {0 => @dependency}
 				
 				@framer = framer
 				@local_stream_id = local_stream_id
@@ -59,6 +62,10 @@ module Protocol
 				nil
 			end
 			
+			def children
+				@dependency.streams
+			end
+			
 			def [] id
 				if id.zero?
 					self
@@ -99,24 +106,18 @@ module Protocol
 				@state == :closed
 			end
 			
-			# The stream has become active (i.e. not idle or closed).
-			def activate(stream)
-				@active += 1
-			end
-			
-			# The stream is no longer active (i.e. has become closed).
-			def deactivate(stream)
-				@active -= 1
-			end
-			
-			# The number of active streams.
-			def active_streams
-				@active
+			def delete(id)
+				@streams.delete(id)
+				
+				if dependency = @dependencies[id]
+					dependency.delete! if dependency.irrelevant?
+				end
 			end
 			
 			# Close the underlying framer and all streams.
 			def close(error = nil)
 				@framer.close
+				# @framer = nil
 				
 				@streams.each_value{|stream| stream.close(error)}
 			end
@@ -139,26 +140,19 @@ module Protocol
 			end
 			
 			attr :streams
-			attr :children
-			
-			def add_child(stream)
-				@children[stream.id] = stream
-			end
+			attr :dependencies
 			
-			def remove_child(stream)
-				@children.delete(stream.id)
-			end
-			
-			def exclusive_child(stream)
-				stream.children = @children
-				
-				@children.each_value do |child|
-					child.dependent_id = stream.id
+			# 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
-				
-				@children = {stream.id => stream}
-				
-				stream.dependent_id = 0
 			end
 			
 			# 6.8. GOAWAY
@@ -398,7 +392,7 @@ module Protocol
 						raise ProtocolError, "Invalid stream id: #{stream_id} <= #{@remote_stream_id}!"
 					end
 					
-					if self.active_streams.size < self.maximum_concurrent_streams
+					if @streams.size < self.maximum_concurrent_streams
 						stream = accept_stream(stream_id)
 						@remote_stream_id = stream_id
 						
@@ -418,13 +412,8 @@ module Protocol
 			
 			# Sets the priority for an incoming stream.
 			def receive_priority(frame)
-				if stream = @streams[frame.stream_id]
-					stream.receive_priority(frame)
-				else
-					# Stream doesn't exist yet.
-					stream = accept_stream(frame.stream_id)
-					stream.receive_priority(frame)
-				end
+				dependency = dependency_for(frame.stream_id)
+				dependency.receive_priority(frame)
 			end
 			
 			def receive_push_promise(frame)
@@ -450,7 +439,7 @@ module Protocol
 					rescue ProtocolError => error
 						stream.send_reset_stream(error.code)
 					end
-				else
+				elsif frame.stream_id > @remote_stream_id
 					# Receiving any frame other than HEADERS or PRIORITY on a stream in this state MUST be treated as a connection error of type PROTOCOL_ERROR.
 					raise ProtocolError, "Cannot update window of idle stream #{frame.stream_id}"
 				end

data/lib/protocol/http2/dependency.rb

@@ -0,0 +1,151 @@
+# Copyright, 2018, 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_relative 'flow_control'
+
+module Protocol
+	module HTTP2
+		DEFAULT_WEIGHT = 16
+		
+		class Dependency
+			def initialize(connection, id, dependent_id = 0, weight = DEFAULT_WEIGHT, children = nil)
+				@connection = connection
+				@id = id
+				
+				# Stream priority:
+				@dependent_id = dependent_id
+				@weight = weight
+				
+				# A cache of dependencies that have child.dependent_id = self.id
+				@children = children
+			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 weight of the stream relative to other siblings.
+			attr_accessor :weight
+			
+			def 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
+			end
+			
+			def add_child(dependency)
+				@children ||= {}
+				@children[dependency.id] = dependency
+			end
+			
+			def remove_child(dependency)
+				@children&.delete(dependency.id)
+			end
+			
+			def exclusive_child(parent)
+				parent.children = @children
+				
+				@children.each_value do |child|
+					child.dependent_id = parent.id
+				end
+				
+				@children = {parent.id => parent}
+				
+				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)
+			end
+			
+			def process_priority priority
+				dependent_id = priority.stream_dependency
+				
+				if dependent_id == @id
+					raise ProtocolError, "Stream priority for stream id #{@id} cannot depend on itself!"
+				end
+				
+				@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)
+				end
+			end
+			
+			# Change the priority of the stream both locally and remotely.
+			def priority= priority
+				send_priority(priority)
+				process_priority(priority)
+			end
+			
+			# The current local priority of the stream.
+			def priority(exclusive = false)
+				Priority.new(exclusive, @dependent_id, @weight)
+			end
+			
+			def send_priority(priority)
+				@connection.send_priority(@id, priority)
+			end
+			
+			def receive_priority(frame)
+				self.process_priority(frame.unpack)
+			end
+		end
+	end
+end

data/lib/protocol/http2/flow_control.rb

@@ -115,7 +115,7 @@ module Protocol
 				
 				# Allow the current flow-controlled instance to use up the window:
 				if !self.window_updated(size) and children = self.children
-					children = children.values.sort_by(&:weight)
+					children = children.sort_by(&:weight)
 					
 					# This must always be at least >= `children.size`, since stream weight can't be 0.
 					total = children.sum(&:weight)

data/lib/protocol/http2/stream.rb

@@ -19,7 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'connection'
-require_relative 'flow_control'
+require_relative 'dependency'
 
 module Protocol
 	module HTTP2
@@ -74,142 +74,63 @@ module Protocol
 		class Stream
 			include FlowControl
 			
-			def self.create(connection, id = connection.next_stream_id)
-				local_window = Window.new(connection.local_settings.initial_window_size)
-				remote_window = Window.new(connection.remote_settings.initial_window_size)
+			def self.create(connection, id)
+				stream = self.new(connection, id)
 				
-				stream = self.new(connection, id, local_window, remote_window)
-				
-				# Create new stream:
 				connection.streams[id] = stream
-				stream.parent.add_child(stream)
-				
-				return stream
-			end
-			
-			def self.replace(stream)
-				connection = stream.connection
-				stream.parent.remove_child(stream)
-				
-				stream = self.new(
-					connection, stream.id, stream.local_window, stream.remote_window,
-					stream.state, stream.dependent_id, stream.weight, stream.children
-				)
-				
-				# Replace existing stream:
-				connection.streams[stream.id] = stream
-				stream.parent.add_child(stream)
 				
 				return stream
 			end
 			
-			def self.accept(connection, id)
-				if stream = connection.streams[id]
-					self.replace(stream)
-				else
-					self.create(connection, id)
-				end
-			end
-			
-			def initialize(connection, id, local_window, remote_window, state = :idle, dependent_id = 0, weight = 16, children = nil)
+			def initialize(connection, id, state = :idle)
 				@connection = connection
 				@id = id
 				
-				@local_window = local_window
-				@remote_window = remote_window
-				
 				@state = state
 				
-				if active?
-					connnection.active(self)
-				end
-				
-				# Stream priority:
-				@dependent_id = dependent_id
-				@weight = weight
+				@local_window = Window.new(@connection.local_settings.initial_window_size)
+				@remote_window = Window.new(@connection.remote_settings.initial_window_size)
 				
-				# A cache of streams that have child.dependent_id = self.id
-				@children = children
+				@dependency = @connection.dependency_for(@id)
 			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
-
+			
 			# Stream state, e.g. `idle`, `closed`.
 			attr_accessor :state
 			
-			# The stream id that this stream depends on, according to the priority.
-			attr_accessor :dependent_id
-			
-			# The weight of the stream relative to other siblings.
-			attr_accessor :weight
+			attr :dependency
 			
 			attr :local_window
 			attr :remote_window
 			
-			def add_child(stream)
-				@children ||= {}
-				@children[stream.id] = stream
+			def weight
+				@dependency.weight
 			end
 			
-			def remove_child(stream)
-				@children.delete(stream.id)
+			def priority
+				@dependency.priority
 			end
 			
-			def exclusive_child(stream)
-				stream.children = @children
-				
-				@children.each_value do |child|
-					child.dependent_id = stream.id
-				end
-				
-				@children = {stream.id => stream}
-				
-				stream.dependent_id = @id
+			def priority= priority
+				@dependency.priority = priority
 			end
 			
-			def parent(id = @dependent_id)
-				@connection[id] || @connection.accept_stream(id)
+			def parent=(stream)
+				@dependency.parent = stream.dependency
 			end
 			
-			def parent= stream
-				self.parent&.remove_child(self)
-				
-				@dependent_id = stream.id
-				
-				stream.add_child(self)
-			end
-			
-			def process_priority priority
-				dependent_id = priority.stream_dependency
-				
-				if dependent_id == @id
-					raise ProtocolError, "Stream priority for stream id #{@id} cannot depend on itself!"
-				end
-				
-				@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)
-				end
+			def children
+				@dependency&.streams
 			end
 			
 			# The stream is being closed because the connection is being closed.
 			def close(error = nil)
+				@connection.delete(@id)
 			end
 			
 			def maximum_frame_size
@@ -315,7 +236,6 @@ module Protocol
 			def open!
 				if @state == :idle
 					@state = :open
-					@connection.activate(self)
 				else
 					raise ProtocolError, "Cannot open stream in state: #{@state}"
 				end
@@ -328,9 +248,6 @@ module Protocol
 			def close!(error_code = nil)
 				@state = :closed
 				
-				@connection.deactivate(self)
-				self.parent&.remove_child(self)
-				
 				if error_code
 					error = StreamError.new("Stream closed!", error_code)
 				end
@@ -353,7 +270,7 @@ module Protocol
 				end
 			end
 			
-			protected def process_headers(frame)
+			def process_headers(frame)
 				# Receiving request headers:
 				priority, data = frame.unpack
 				
@@ -376,23 +293,23 @@ module Protocol
 						open!
 					end
 					
-					return process_headers(frame)
+					process_headers(frame)
 				elsif @state == :reserved_remote
-					@state = :half_closed_local
+					process_headers(frame)
 					
-					return process_headers(frame)
+					@state = :half_closed_local
 				elsif @state == :open
+					process_headers(frame)
+					
 					if frame.end_stream?
 						@state = :half_closed_remote
 					end
-					
-					return process_headers(frame)
 				elsif @state == :half_closed_local
+					process_headers(frame)
+					
 					if frame.end_stream?
 						close!
 					end
-					
-					return process_headers(frame)
 				elsif self.closed?
 					ignore_headers(frame)
 				else
@@ -435,25 +352,6 @@ module Protocol
 				end
 			end
 			
-			# Change the priority of the stream both locally and remotely.
-			def priority= priority
-				send_priority(priority)
-				process_priority(priority)
-			end
-			
-			# The current local priority of the stream.
-			def priority(exclusive = false)
-				Priority.new(exclusive, @dependent_id, @weight)
-			end
-			
-			def send_priority(priority)
-				@connection.send_priority(@id, priority)
-			end
-			
-			def receive_priority(frame)
-				self.process_priority(frame.unpack)
-			end
-			
 			def ignore_reset_stream(frame)
 				# Async.logger.warn(self) {"Received reset stream (#{error_code}) in state: #{@state}!"}
 			end
@@ -493,7 +391,6 @@ module Protocol
 			def reserved_local!
 				if @state == :idle
 					@state = :reserved_local
-					@connection.activate(self)
 				else
 					raise ProtocolError, "Cannot reserve stream in state: #{@state}"
 				end
@@ -502,7 +399,6 @@ module Protocol
 			def reserved_remote!
 				if @state == :idle
 					@state = :reserved_remote
-					@connection.activate(self)
 				else
 					raise ProtocolError, "Cannot reserve stream in state: #{@state}"
 				end

data/lib/protocol/http2/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module HTTP2
-		VERSION = "0.10.4"
+		VERSION = "0.11.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http2
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.11.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-08 00:00:00.000000000 Z
+date: 2020-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-hpack
@@ -114,6 +114,7 @@ files:
 - lib/protocol/http2/connection.rb
 - lib/protocol/http2/continuation_frame.rb
 - 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
@@ -152,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.