protocol-http2 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80a795de54c7f452a70b82f310c4f0aa3bda4bd15f034f548114a41bfc8d1649
-  data.tar.gz: 496e203587367c71ce4b0298ba96492d5ce4892842fdcbf57796031556ca3f1a
+  metadata.gz: 90e7e77b799044d635c41f870e4d852fb8b9c3e51e5e637e70400420fa318c4f
+  data.tar.gz: f2d9106c992e4503e36c5f3b4d57859744cd0281bcd8f261b7d902b7574e7cfd
 SHA512:
-  metadata.gz: e4b587ae75dc73dbd99ff3bc20cafe6c55cb329ab275bac187572730de5d5365f2f8c521d88b32bffb80363736cf0cdc62d579d2495872f13982b4f1cd1fdfa0
-  data.tar.gz: f2964d07b204b702ded73b1a3df961dad07c95989e78311732d4264184b59a6671f7bb81511e1d196c1dd9ccf18f81db1fd8064607c3156550191dc7cec8a5d2
+  metadata.gz: 2b181f107bb843771deeb1d546a58315643faea3abcfa8f5a37198e2bf301a25f33d58d140879e676ac3928f932ed9b4a64325613b62e6b9e1297cc31264ef17
+  data.tar.gz: 89ed0a08306f0e6a1835afc1867fac8c9f0c01c28aeb4828eec3f2611f90244ddbf2be01faaf15f775ed30457b044f7a8956bede2cb0f83de913d1945524eccf

data/lib/protocol/http2/client.rb

@@ -28,6 +28,10 @@ module Protocol
 				if @state == :new
 					@framer.write_connection_preface
 					
+					# We don't support RFC7540 priorities:
+					settings = settings.to_a
+					settings << [Settings::NO_RFC7540_PRIORITIES, 1]
+					
 					send_settings(settings)
 					
 					yield if block_given?

data/lib/protocol/http2/connection.rb

@@ -5,7 +5,6 @@
 # Copyright, 2023, by Marco Concetto Rudilosso.
 
 require_relative "framer"
-require_relative "dependency"
 require_relative "flow_controlled"
 
 require "protocol/hpack"
@@ -23,10 +22,6 @@ module Protocol
 				# Hash(Integer, Stream)
 				@streams = {}
 				
-				# Hash(Integer, Dependency)
-				@dependency = Dependency.new(self, 0)
-				@dependencies = {0 => @dependency}
-				
 				@framer = framer
 				
 				# The next stream id to use:
@@ -95,7 +90,6 @@ module Protocol
 			
 			def delete(id)
 				@streams.delete(id)
-				@dependencies[id]&.delete!
 			end
 			
 			# Close the underlying framer and all streams.
@@ -402,22 +396,6 @@ module Protocol
 				end
 			end
 			
-			def send_priority(stream_id, priority)
-				frame = PriorityFrame.new(stream_id)
-				frame.pack(priority)
-				
-				write_frame(frame)
-			end
-			
-			# Sets the priority for an incoming stream.
-			def 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)
 				raise ProtocolError, "Unable to receive push promise!"
 			end
@@ -470,23 +448,17 @@ 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.
+			# Traverse active streams and allow them to consume the available flow-control window.
+			# @parameter 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
 				
-				# Console.info(self) do |buffer|
-				# 	@dependencies.each do |id, dependency|
-				# 		buffer.puts "- #{dependency}"
-				# 	end
-				# 
-				# 	buffer.puts
-				# 
-				# 	@dependency.print_hierarchy(buffer)
-				# end
-				
-				@dependency.consume_window(size)
+				@streams.each_value do |stream|
+					if stream.active?
+						stream.window_updated(size)
+					end
+				end
 			end
 			
 			def receive_window_update(frame)

data/lib/protocol/http2/flow_controlled.rb

@@ -78,7 +78,7 @@ module Protocol
 			end
 			
 			# The window has been expanded by the given amount.
-			# @param size [Integer] the maximum amount of data to send.
+			# @parameter size [Integer] the maximum amount of data to send.
 			# @return [Boolean] whether the window update was used or not.
 			def window_updated(size)
 				return false

data/lib/protocol/http2/frame.rb

@@ -34,7 +34,7 @@ module Protocol
 			# The base class does not have any specific type index:
 			TYPE = nil
 			
-			# @param length [Integer] the length of the payload, or nil if the header has not been read yet.
+			# @parameter length [Integer] the length of the payload, or nil if the header has not been read yet.
 			def initialize(stream_id = 0, flags = 0, type = self.class::TYPE, length = nil, payload = nil)
 				@stream_id = stream_id
 				@flags = flags
@@ -134,7 +134,7 @@ module Protocol
 			
 			# Decodes common 9-byte header.
 			#
-			# @param buffer [String]
+			# @parameter buffer [String]
 			def self.parse_header(buffer)
 				length_hi, length_lo, type, flags, stream_id = buffer.unpack(HEADER_FORMAT)
 				length = (length_hi << LENGTH_HISHIFT) | length_lo

data/lib/protocol/http2/framer.rb

@@ -7,7 +7,6 @@ require_relative "error"
 
 require_relative "data_frame"
 require_relative "headers_frame"
-require_relative "priority_frame"
 require_relative "reset_stream_frame"
 require_relative "settings_frame"
 require_relative "push_promise_frame"
@@ -22,7 +21,7 @@ module Protocol
 		FRAMES = [
 			DataFrame,
 			HeadersFrame,
-			PriorityFrame,
+			nil, # PriorityFrame is deprecated / removed.
 			ResetStreamFrame,
 			SettingsFrame,
 			PushPromiseFrame,

data/lib/protocol/http2/headers_frame.rb

@@ -6,7 +6,6 @@
 require_relative "frame"
 require_relative "padded"
 require_relative "continuation_frame"
-require_relative "priority_frame"
 
 module Protocol
 	module HTTP2
@@ -41,23 +40,16 @@ module Protocol
 				data = super
 				
 				if priority?
-					priority = Priority.unpack(data)
+					# We no longer support priority frames, so strip the data:
 					data = data.byteslice(5, data.bytesize - 5)
 				end
 				
-				return priority, data
+				return data
 			end
 			
-			def pack(priority, data, *arguments, **options)
+			def pack(data, *arguments, **options)
 				buffer = String.new.b
 				
-				if priority
-					buffer << priority.pack
-					set_flags(PRIORITY)
-				else
-					clear_flags(PRIORITY)
-				end
-				
 				buffer << data
 				
 				super(buffer, *arguments, **options)

data/lib/protocol/http2/server.rb

@@ -28,6 +28,10 @@ module Protocol
 				if @state == :new
 					@framer.read_connection_preface
 					
+					# We don't support RFC7540 priorities:
+					settings = settings.to_a
+					settings << [Settings::NO_RFC7540_PRIORITIES, 1]
+					
 					send_settings(settings)
 					
 					read_frame do |frame|

data/lib/protocol/http2/settings_frame.rb

@@ -15,6 +15,7 @@ module Protocol
 			MAXIMUM_FRAME_SIZE = 0x5
 			MAXIMUM_HEADER_LIST_SIZE = 0x6
 			ENABLE_CONNECT_PROTOCOL = 0x8
+			NO_RFC7540_PRIORITIES = 0x9
 			
 			ASSIGN = [
 				nil,

data/lib/protocol/http2/stream.rb

@@ -4,7 +4,6 @@
 # Copyright, 2019-2024, by Samuel Williams.
 
 require_relative "connection"
-require_relative "dependency"
 
 module Protocol
 	module HTTP2
@@ -77,8 +76,6 @@ module Protocol
 				
 				@local_window = Window.new(@connection.local_settings.initial_window_size)
 				@remote_window = Window.new(@connection.remote_settings.initial_window_size)
-				
-				@dependency = Dependency.create(@connection, @id)
 			end
 			
 			# The connection this stream belongs to.
@@ -90,27 +87,9 @@ module Protocol
 			# Stream state, e.g. `idle`, `closed`.
 			attr_accessor :state
 			
-			attr :dependency
-			
 			attr :local_window
 			attr :remote_window
 			
-			def weight
-				@dependency.weight
-			end
-			
-			def priority
-				@dependency.priority
-			end
-			
-			def priority= priority
-				@dependency.priority = priority
-			end
-			
-			def parent=(stream)
-				@dependency.parent = stream.dependency
-			end
-			
 			def maximum_frame_size
 				@connection.available_frame_size
 			end
@@ -141,13 +120,13 @@ module Protocol
 				@state == :idle or @state == :reserved_local or @state == :open or @state == :half_closed_remote
 			end
 			
-			private def write_headers(priority, headers, flags = 0)
+			private def write_headers(headers, flags = 0)
 				frame = HeadersFrame.new(@id, flags)
 				
 				@connection.write_frames do |framer|
 					data = @connection.encode_headers(headers)
 					
-					frame.pack(priority, data, maximum_size: @connection.maximum_frame_size)
+					frame.pack(data, maximum_size: @connection.maximum_frame_size)
 					
 					framer.write_frame(frame)
 				end
@@ -157,6 +136,10 @@ module Protocol
 			
 			# 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(*arguments)
+				if arguments.first.nil?
+					arguments.shift # Remove nil priority.
+				end
+				
 				if @state == :idle
 					frame = write_headers(*arguments)
 					
@@ -236,7 +219,7 @@ module Protocol
 			end
 			
 			# Transition the stream into the closed state.
-			# @param error_code [Integer] the error code if the stream was closed due to a stream reset.
+			# @parameter error_code [Integer] the error code if the stream was closed due to a stream reset.
 			def close!(error_code = nil)
 				@state = :closed
 				@connection.delete(@id)
@@ -265,11 +248,7 @@ module Protocol
 			
 			def process_headers(frame)
 				# Receiving request headers:
-				priority, data = frame.unpack
-				
-				if priority
-					@dependency.process_priority(priority)
-				end
+				data = frame.unpack
 				
 				@connection.decode_headers(data)
 			end
@@ -401,7 +380,7 @@ module Protocol
 			end
 			
 			# Server push is semantically equivalent to a server responding to a request; however, in this case, that request is also sent by the server, as a PUSH_PROMISE frame.
-			# @param headers [Hash] contains a complete set of request header fields that the server attributes to the request.
+			# @parameter headers [Hash] contains a complete set of request header fields that the server attributes to the request.
 			def send_push_promise(headers)
 				if @state == :open or @state == :half_closed_remote
 					promised_stream = self.create_push_promise_stream(headers)
@@ -427,7 +406,6 @@ module Protocol
 				headers = @connection.decode_headers(data)
 				
 				stream = self.accept_push_promise_stream(promised_stream_id, headers)
-				stream.parent = self
 				stream.reserved_remote!
 				
 				return stream, headers

data/lib/protocol/http2/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP2
-		VERSION = "0.20.0"
+		VERSION = "0.21.0"
 	end
 end

data/lib/protocol/http2/window.rb

@@ -9,7 +9,7 @@ module Protocol
 			# When an HTTP/2 connection is first established, new streams are created with an initial flow-control window size of 65,535 octets. The connection flow-control window is also 65,535 octets.
 			DEFAULT_CAPACITY = 0xFFFF
 			
-			# @param capacity [Integer] The initial window size, typically from the settings.
+			# @parameter capacity [Integer] The initial window size, typically from the settings.
 			def initialize(capacity = DEFAULT_CAPACITY)
 				# This is the main field required:
 				@available = capacity

data/readme.md

@@ -58,7 +58,7 @@ Async do
 	]
 	
 	puts "Sending request on stream id=#{stream.id} state=#{stream.state}..."
-	stream.send_headers(nil, headers, Protocol::HTTP2::END_STREAM)
+	stream.send_headers(headers, Protocol::HTTP2::END_STREAM)
 	
 	puts "Waiting for response..."
 	$count = 0

data/releases.md

@@ -0,0 +1,7 @@
+# Releases
+
+## Unreleased
+
+### Remove Priority Frame and Dependency Tracking
+
+HTTP/2 has deprecated the priority frame and stream dependency tracking. This feature has been effectively removed from the protocol. As a consequence, the internal implementation is greatly simplified. The `Protocol::HTTP2::Stream` class no longer tracks dependencies or priorities, and this includes `Stream#send_headers` which no longer takes `priority` as the first argument.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http2
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-11-09 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-hpack
@@ -81,7 +81,6 @@ 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/flow_controlled.rb
 - lib/protocol/http2/frame.rb
@@ -90,7 +89,6 @@ files:
 - lib/protocol/http2/headers_frame.rb
 - lib/protocol/http2/padded.rb
 - lib/protocol/http2/ping_frame.rb
-- lib/protocol/http2/priority_frame.rb
 - lib/protocol/http2/push_promise_frame.rb
 - lib/protocol/http2/reset_stream_frame.rb
 - lib/protocol/http2/server.rb
@@ -103,6 +101,7 @@ files:
 - lib/traces/provider/protocol/http2/framer.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/protocol-http2
 licenses:
 - MIT

data/lib/protocol/http2/dependency.rb

@@ -1,245 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
-
-module Protocol
-	module HTTP2
-		DEFAULT_WEIGHT = 16
-		
-		class Dependency
-			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
-				
-				@parent = nil
-				@children = nil
-				
-				@weight = weight
-				
-				# 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 == other
-				@id == other.id
-			end
-			
-			# The connection this stream belongs to.
-			attr :connection
-			
-			# Stream ID (odd for client initiated streams, even otherwise).
-			attr :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
-			
-			def stream
-				@stream ||= @connection.streams[@id]
-			end
-			
-			def clear_cache!
-				@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
-				
-				if @ordered_children
-					# Binary search for insertion point:
-					index = @ordered_children.bsearch_index do |child|
-						child.weight >= dependency.weight
-					end
-					
-					if index
-						@ordered_children.insert(index, dependency)
-					else
-						@ordered_children.push(dependency)
-					end
-					
-					@total_weight += dependency.weight
-				end
-			end
-			
-			def remove_child(dependency)
-				@children&.delete(dependency.id)
-				
-				if @ordered_children
-					# Don't do a linear search here, it can be slow. Instead, the child's parent will be set to `nil`, and we check this in {#consume_window} using `delete_if`.
-					# @ordered_children.delete(dependency)
-					@total_weight -= dependency.weight
-				end
-			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
-				
-				@children&.each_value do |child|
-					child.parent = parent
-				end
-				
-				parent.clear_cache!
-				
-				@children = {parent.id => parent}
-				self.clear_cache!
-				
-				parent.parent = 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
-				
-				# 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
-			
-			# 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, @parent.id, @weight)
-			end
-			
-			def send_priority(priority)
-				@connection.send_priority(@id, priority)
-			end
-			
-			def receive_priority(frame)
-				self.process_priority(frame.unpack)
-			end
-			
-			def total_weight
-				self.ordered_children
-				
-				return @total_weight
-			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&.delete_if do |child|
-					if child.parent
-						# Compute the proportional allocation:
-						allocated = (child.weight * size) / @total_weight
-						
-						child.consume_window(allocated) if allocated > 0
-						
-						false
-					else
-						true
-					end
-				end
-			end
-			
-			def inspect
-				"\#<#{self.class} id=#{@id} parent id=#{@parent&.id} weight=#{@weight} #{@children&.size || 0} children>"
-			end
-			
-			def print_hierarchy(output = $stderr, indent: 0)
-				output.puts "#{"\t" * indent}#{self.inspect}"
-				@children&.each_value do |child|
-					child.print_hierarchy(output, indent: indent+1)
-				end
-			end
-		end
-	end
-end

data/lib/protocol/http2/priority_frame.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
-
-require_relative "frame"
-
-module Protocol
-	module HTTP2
-		VALID_WEIGHT = (1..256)
-		
-		# Stream Dependency:  A 31-bit stream identifier for the stream that
-		# this stream depends on (see Section 5.3).  This field is only
-		# present if the PRIORITY flag is set.
-		class Priority < Struct.new(:exclusive, :stream_dependency, :weight)
-			FORMAT = "NC".freeze
-			EXCLUSIVE = 1 << 31
-			
-			# All streams are initially assigned a non-exclusive dependency on stream 0x0.  Pushed streams (Section 8.2) initially depend on their associated stream.  In both cases, streams are assigned a default weight of 16.
-			def self.default(stream_dependency = 0, weight = 16)
-				self.new(false, stream_dependency, weight)
-			end
-			
-			def self.unpack(data)
-				stream_dependency, weight = data.unpack(FORMAT)
-				
-				# Weight:  An unsigned 8-bit integer representing a priority weight for the stream (see Section 5.3).  Add one to the value to obtain a weight between 1 and 256.  This field is only present if the PRIORITY flag is set.
-				return self.new(stream_dependency & EXCLUSIVE != 0, stream_dependency & ~EXCLUSIVE, weight + 1)
-			end
-			
-			def pack
-				if exclusive
-					stream_dependency = self.stream_dependency | EXCLUSIVE
-				else
-					stream_dependency = self.stream_dependency
-				end
-				
-				return [stream_dependency, self.weight - 1].pack(FORMAT)
-			end
-			
-			def weight= value
-				if VALID_WEIGHT.include?(value)
-					super
-				else
-					raise ArgumentError, "Weight #{value} must be between 1-256!"
-				end
-			end
-		end
-		
-		# The PRIORITY frame specifies the sender-advised priority of a stream. It can be sent in any stream state, including idle or closed streams.
-		#
-		# +-+-------------------------------------------------------------+
-		# |E|                  Stream Dependency (31)                     |
-		# +-+-------------+-----------------------------------------------+
-		# |   Weight (8)  |
-		# +-+-------------+
-		#
-		class PriorityFrame < Frame
-			TYPE = 0x2
-			
-			def pack priority
-				super priority.pack
-			end
-			
-			def unpack
-				Priority.unpack(super)
-			end
-			
-			def apply(connection)
-				connection.receive_priority(self)
-			end
-			
-			def read_payload(stream)
-				super
-				
-				if @length != 5
-					raise FrameSizeError, "Invalid frame length"
-				end
-			end
-		end
-	end
-end