protocol-http2 0.21.0 → 0.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90e7e77b799044d635c41f870e4d852fb8b9c3e51e5e637e70400420fa318c4f
-  data.tar.gz: f2d9106c992e4503e36c5f3b4d57859744cd0281bcd8f261b7d902b7574e7cfd
+  metadata.gz: b23c19aa916a6d23a22b7f49fddc73fa91dd86957222178866a1389f74b4a037
+  data.tar.gz: b957666cdcf46c542baaebce6ec86d29d449ee80de4b4c98ca0409956b14b909
 SHA512:
-  metadata.gz: 2b181f107bb843771deeb1d546a58315643faea3abcfa8f5a37198e2bf301a25f33d58d140879e676ac3928f932ed9b4a64325613b62e6b9e1297cc31264ef17
-  data.tar.gz: 89ed0a08306f0e6a1835afc1867fac8c9f0c01c28aeb4828eec3f2611f90244ddbf2be01faaf15f775ed30457b044f7a8956bede2cb0f83de913d1945524eccf
+  metadata.gz: 2673eba3eafe1131725b5212beb8a3fc2c2cfd98c0b62753aecf6f1b8729f6c7e402a4d6b194ec4719e60d7489ec4c007b76e034c09573d972806aa6f9ac81ca
+  data.tar.gz: 2d8473793aced6539d345c58274dc48665aaa29160a08fdca034d839036ef201d0dd2e05c90c33d54564e157200151fc36469a9a5feb9f679884e5ebc323d6ac

data/lib/protocol/http2/client.rb

@@ -28,16 +28,14 @@ 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?
 					
 					read_frame do |frame|
-						raise ProtocolError, "First frame must be #{SettingsFrame}, but got #{frame.class}" unless frame.is_a? SettingsFrame
+						unless frame.is_a? SettingsFrame
+							raise ProtocolError, "First frame must be #{SettingsFrame}, but got #{frame.class}"
+						end
 					end
 				else
 					raise ProtocolError, "Cannot send connection preface in state #{@state}"

data/lib/protocol/http2/connection.rb

@@ -8,6 +8,7 @@ require_relative "framer"
 require_relative "flow_controlled"
 
 require "protocol/hpack"
+require "protocol/http/header/priority"
 
 module Protocol
 	module HTTP2
@@ -400,6 +401,19 @@ module Protocol
 				raise ProtocolError, "Unable to receive push promise!"
 			end
 			
+			def receive_priority_update(frame)
+				if frame.stream_id != 0
+					raise ProtocolError, "Invalid stream id: #{frame.stream_id}"
+				end
+				
+				stream_id, value = frame.unpack
+				
+				# Apparently you can set the priority of idle streams, but I'm not sure why that makes sense, so for now let's ignore it.
+				if stream = @streams[stream_id]
+					stream.priority = Protocol::HTTP::Header::Priority.new(value)
+				end
+			end
+			
 			def client_stream_id?(id)
 				id.odd?
 			end

data/lib/protocol/http2/framer.rb

@@ -14,6 +14,7 @@ require_relative "ping_frame"
 require_relative "goaway_frame"
 require_relative "window_update_frame"
 require_relative "continuation_frame"
+require_relative "priority_update_frame"
 
 module Protocol
 	module HTTP2
@@ -21,7 +22,7 @@ module Protocol
 		FRAMES = [
 			DataFrame,
 			HeadersFrame,
-			nil, # PriorityFrame is deprecated / removed.
+			nil, # PriorityFrame is deprecated and ignored, instead consider using PriorityUpdateFrame instead.
 			ResetStreamFrame,
 			SettingsFrame,
 			PushPromiseFrame,
@@ -29,6 +30,13 @@ module Protocol
 			GoawayFrame,
 			WindowUpdateFrame,
 			ContinuationFrame,
+			nil,
+			nil,
+			nil,
+			nil,
+			nil,
+			nil,
+			PriorityUpdateFrame,
 		].freeze
 		
 		# Default connection "fast-fail" preamble string as defined by the spec.

data/lib/protocol/http2/priority_update_frame.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024-2025, by Samuel Williams.
+
+require_relative "frame"
+require_relative "padded"
+require_relative "continuation_frame"
+
+module Protocol
+	module HTTP2
+		# The PRIORITY_UPDATE frame is used by clients to signal the initial priority of a response, or to reprioritize a response or push stream. It carries the stream ID of the response and the priority in ASCII text, using the same representation as the Priority header field value.
+		# 
+		# +-+-------------+-----------------------------------------------+
+		# |R|                 Prioritized Stream ID (31)                  |
+		# +-+-----------------------------+-------------------------------+
+		# |                    Priority Field Value (*)                 ...
+		# +---------------------------------------------------------------+
+		#
+		class PriorityUpdateFrame < Frame
+			TYPE = 0x10
+			FORMAT = "N".freeze
+			
+			def unpack
+				data = super
+				
+				prioritized_stream_id = data.unpack1(FORMAT)
+				
+				return prioritized_stream_id, data.byteslice(4, data.bytesize - 4)
+			end
+			
+			def pack(prioritized_stream_id, data, **options)
+				super([prioritized_stream_id].pack(FORMAT) + data, **options)
+			end
+			
+			def apply(connection)
+				connection.receive_priority_update(self)
+			end
+		end
+	end
+end

data/lib/protocol/http2/server.rb

@@ -28,10 +28,6 @@ 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

@@ -27,8 +27,22 @@ module Protocol
 				:maximum_header_list_size=,
 				nil,
 				:enable_connect_protocol=,
+				:no_rfc7540_priorities=,
 			]
 			
+			def initialize
+				# These limits are taken from the RFC:
+				# https://tools.ietf.org/html/rfc7540#section-6.5.2
+				@header_table_size = 4096
+				@enable_push = 1
+				@maximum_concurrent_streams = 0xFFFFFFFF
+				@initial_window_size = 0xFFFF # 2**16 - 1
+				@maximum_frame_size = 0x4000 # 2**14
+				@maximum_header_list_size = 0xFFFFFFFF
+				@enable_connect_protocol = 0
+				@no_rfc7540_priorities = 0
+			end
+			
 			# Allows the sender to inform the remote endpoint of the maximum size of the header compression table used to decode header blocks, in octets.
 			attr_accessor :header_table_size
 			
@@ -91,16 +105,18 @@ module Protocol
 				@enable_connect_protocol == 1
 			end
 			
-			def initialize
-				# These limits are taken from the RFC:
-				# https://tools.ietf.org/html/rfc7540#section-6.5.2
-				@header_table_size = 4096
-				@enable_push = 1
-				@maximum_concurrent_streams = 0xFFFFFFFF
-				@initial_window_size = 0xFFFF # 2**16 - 1
-				@maximum_frame_size = 0x4000 # 2**14
-				@maximum_header_list_size = 0xFFFFFFFF
-				@enable_connect_protocol = 0
+			attr :no_rfc7540_priorities
+			
+			def no_rfc7540_priorities= value
+				if value == 0 or value == 1
+					@no_rfc7540_priorities = value
+				else
+					raise ProtocolError, "Invalid value for no_rfc7540_priorities: #{value}"
+				end
+			end
+			
+			def no_rfc7540_priorities?
+				@no_rfc7540_priorities == 1
 			end
 			
 			def update(changes)
@@ -110,40 +126,6 @@ module Protocol
 					end
 				end
 			end
-			
-			def difference(other)
-				changes = []
-				
-				if @header_table_size != other.header_table_size
-					changes << [HEADER_TABLE_SIZE, @header_table_size]
-				end
-				
-				if @enable_push != other.enable_push
-					changes << [ENABLE_PUSH, @enable_push]
-				end
-				
-				if @maximum_concurrent_streams != other.maximum_concurrent_streams
-					changes << [MAXIMUM_CONCURRENT_STREAMS, @maximum_concurrent_streams]
-				end
-				
-				if @initial_window_size != other.initial_window_size
-					changes << [INITIAL_WINDOW_SIZE, @initial_window_size]
-				end
-				
-				if @maximum_frame_size != other.maximum_frame_size
-					changes << [MAXIMUM_FRAME_SIZE, @maximum_frame_size]
-				end
-				
-				if @maximum_header_list_size != other.maximum_header_list_size
-					changes << [MAXIMUM_HEADER_LIST_SIZE, @maximum_header_list_size]
-				end
-				
-				if @enable_connect_protocol != other.enable_connect_protocol
-					changes << [ENABLE_CONNECT_PROTOCOL, @enable_connect_protocol]
-				end
-				
-				return changes
-			end
 		end
 		
 		class PendingSettings

data/lib/protocol/http2/stream.rb

@@ -76,6 +76,8 @@ module Protocol
 				
 				@local_window = Window.new(@connection.local_settings.initial_window_size)
 				@remote_window = Window.new(@connection.remote_settings.initial_window_size)
+				
+				@priority = nil
 			end
 			
 			# The connection this stream belongs to.
@@ -90,6 +92,9 @@ module Protocol
 			attr :local_window
 			attr :remote_window
 			
+			# @attribute [Protocol::HTTP::Header::Priority | Nil] the priority of the stream.
+			attr_accessor :priority
+			
 			def maximum_frame_size
 				@connection.available_frame_size
 			end
@@ -136,10 +141,6 @@ 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)
 					

data/lib/protocol/http2/version.rb

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

data/lib/traces/provider/protocol/http2/framer.rb

@@ -1,25 +1,31 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require "traces/provider"
 require_relative "../../../../protocol/http2/framer"
 
 Traces::Provider(Protocol::HTTP2::Framer) do
 	def write_connection_preface
+		return super unless Traces.active?
+		
 		Traces.trace("protocol.http2.framer.write_connection_preface") do
 			super
 		end
 	end
 	
 	def read_connection_preface
+		return super unless Traces.active?
+		
 		Traces.trace("protocol.http2.framer.read_connection_preface") do
 			super
 		end
 	end
 	
 	def write_frame(frame)
+		return super unless Traces.active?
+		
 		attributes = {
 			"frame.length" => frame.length,
 			"frame.class" => frame.class.name,
@@ -34,6 +40,8 @@ Traces::Provider(Protocol::HTTP2::Framer) do
 	end
 	
 	def read_frame(...)
+		return super unless Traces.active?
+		
 		Traces.trace("protocol.http2.framer.read_frame") do |span|
 			super.tap do |frame|
 				span["frame.length"] = frame.length
@@ -45,6 +53,8 @@ Traces::Provider(Protocol::HTTP2::Framer) do
 	end
 	
 	def flush
+		return super unless Traces.active?
+		
 		Traces.trace("protocol.http2.framer.flush") do
 			super
 		end

data/license.md

@@ -1,9 +1,10 @@
 # MIT License
 
-Copyright, 2019-2024, by Samuel Williams.  
+Copyright, 2019-2025, by Samuel Williams.  
 Copyright, 2019, by Yuta Iwama.  
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2023, by Marco Concetto Rudilosso.  
+Copyright, 2024, by Adam Petro.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -4,88 +4,15 @@ Provides a low-level implementation of the HTTP/2 protocol.
 
 [![Development Status](https://github.com/socketry/protocol-http2/workflows/Test/badge.svg)](https://github.com/socketry/protocol-http2/actions?workflow=Test)
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-``` ruby
-gem 'protocol-http2'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install protocol-http2
-
 ## Usage
 
-Here is a basic HTTP/2 client:
+Please see the [project documentation](https://socketry.github.io/protocol-http2/) for more details.
+
+  - [Getting Started](https://socketry.github.io/protocol-http2/guides/getting-started/index) - This guide explains how to use the `protocol-http2` gem to implement a basic HTTP/2 client.
 
-``` ruby
-require 'async'
-require 'async/io/stream'
-require 'async/http/endpoint'
-require 'protocol/http2/client'
+## See Also
 
-Async do
-	endpoint = Async::HTTP::Endpoint.parse("https://www.google.com/search?q=kittens")
-	
-	peer = endpoint.connect
-	
-	puts "Connected to #{peer.inspect}"
-	
-	# IO Buffering...
-	stream = Async::IO::Stream.new(peer)
-	
-	framer = Protocol::HTTP2::Framer.new(stream)
-	client = Protocol::HTTP2::Client.new(framer)
-	
-	puts "Sending connection preface..."
-	client.send_connection_preface
-	
-	puts "Creating stream..."
-	stream = client.create_stream
-	
-	headers = [
-		[":scheme", endpoint.scheme],
-		[":method", "GET"],
-		[":authority", "www.google.com"],
-		[":path", endpoint.path],
-		["accept", "*/*"],
-	]
-	
-	puts "Sending request on stream id=#{stream.id} state=#{stream.state}..."
-	stream.send_headers(headers, Protocol::HTTP2::END_STREAM)
-	
-	puts "Waiting for response..."
-	$count = 0
-	
-	def stream.process_headers(frame)
-		headers = super
-		puts "Got response headers: #{headers} (#{frame.end_stream?})"
-	end
-	
-	def stream.receive_data(frame)
-		data = super
-		
-		$count += data.scan(/kittens/).count
-		
-		puts "Got response data: #{data.bytesize}"
-	end
-	
-	until stream.closed?
-		frame = client.read_frame
-	end
-	
-	puts "Got #{$count} kittens!"
-	
-	puts "Closing client..."
-	client.close
-end
-```
+  - [Async::HTTP](https://github.com/socketry/async-http) - A high-level HTTP client and server implementation.
 
 ## Contributing
 

data/releases.md

@@ -1,7 +1,9 @@
 # Releases
 
-## Unreleased
+## v0.22.0
 
-### Remove Priority Frame and Dependency Tracking
+### Added Priority Update Frame and Stream Priority
 
-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.
+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, and this includes `Stream#send_headers` which no longer takes `priority` as the first argument.
+
+Optional per-request priority can be set using the `priority` header instead, and this value can be manipulated using the priority update frame.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http2
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.1
 platform: ruby
 authors:
 - Samuel Williams
 - Yuta Iwama
+- Adam Petro
 - Marco Concetto Rudilosso
 - Olle Jonsson
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-11-28 00:00:00.000000000 Z
+date: 2025-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-hpack
@@ -62,16 +62,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.47'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
-description:
-email:
+        version: '0.47'
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -89,6 +87,7 @@ files:
 - lib/protocol/http2/headers_frame.rb
 - lib/protocol/http2/padded.rb
 - lib/protocol/http2/ping_frame.rb
+- lib/protocol/http2/priority_update_frame.rb
 - lib/protocol/http2/push_promise_frame.rb
 - lib/protocol/http2/reset_stream_frame.rb
 - lib/protocol/http2/server.rb
@@ -108,7 +107,6 @@ licenses:
 metadata:
   documentation_uri: https://socketry.github.io/protocol-http2/
   source_code_uri: https://github.com/socketry/protocol-http2.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A low level implementation of the HTTP/2 protocol.
 test_files: []