protocol-htty 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba295c47e02345ba7101c3958786fc21fd7187294abe6fef0f39a6677baf9be3
-  data.tar.gz: 2fcb179db305375b86b5196ed149c0ef1eed4fb52c7d06447b0a5e68d4dd16a4
+  metadata.gz: 957aa78a655ceb3136db0acd1614010a25d1cda14b6e0861e6ebfb371870b739
+  data.tar.gz: d70de3f0375aef142f90beca94c2bd50f9986bbc6bfaf2920ea64dae13185467
 SHA512:
-  metadata.gz: 4132b7c507a0b285f772c91bca4ddbcb315d5faccfeafd28c6907df4553ad5a20190299e9d924c75a946819e656205b603bcae69b6bc61d1e20b08f5e437f60f
-  data.tar.gz: 3149badd26c592217168140c69b654190fdad74d6884b9ef4e729ff9e8a1f4b342f284bec1b1759698d53a15c4c11858e666654d6b7de0cc47e07f44854d45bd
+  metadata.gz: cdc24469f4d8bad151261849af0a4bd85b5ca86d2f6f007404e131cf90ab18f6fd279a82634a46565f3ffa19337c698741103c64220b7c89a8c1261d44652eea
+  data.tar.gz: 750995dc4c72f1eb9026bbba25795c8b5489d734d48e93edae8cabad4af12b4bc6a69746550e044f10ceaac2eab3f15fc6e2dddb08a919eccbc953c12c833ef3

data/lib/protocol/htty/stream.rb

@@ -3,8 +3,6 @@
 # Released under the MIT License.
 # Copyright, 2026, by Samuel Williams.
 
-require "io/stream"
-
 module Protocol
 	module HTTY
 		# Transport an opaque byte stream after the HTTY bootstrap handshake.
@@ -15,8 +13,12 @@ module Protocol
 			BOOTSTRAP_PREFIX = "+H"
 			RAW_MODE = "raw"
 			
-			def self.open(stream, bootstrap: nil, mode: RAW_MODE)
-				stream = self.new(::IO::Stream(stream))
+			def self.open(input, output, bootstrap: nil, mode: RAW_MODE)
+				stream = self.new(input, output)
+				
+				# Disable buffering:
+				input.sync = true
+				output.sync = true
 				
 				case bootstrap
 				when :write
@@ -32,23 +34,26 @@ module Protocol
 				return stream
 			end
 			
-			# Create a stream on top of a raw byte-preserving transport.
-			# @parameter stream [IO::Stream] The duplex byte stream used after bootstrap.
-			def initialize(stream)
-				@stream = stream
+			# Create a stream on top of raw byte-preserving endpoints.
+			# @parameter input [IO] The readable endpoint.
+			# @parameter output [IO] The writable endpoint.
+			def initialize(input, output)
+				@input = input
+				@output = output
 				@local_closed = false
 			end
 			
-			attr :stream
+			attr :input
+			attr :output
 			
-			# Return the underlying duplex stream.
+			# Return the underlying output stream.
 			def io
-				@stream
+				@output
 			end
 			
 			def write_bootstrap(mode = RAW_MODE)
-				@stream.write("#{DCS}#{BOOTSTRAP_PREFIX}#{mode}#{ST}")
-				@stream.flush
+				@output.write("#{DCS}#{BOOTSTRAP_PREFIX}#{mode}#{ST}")
+				@output.flush
 			end
 			
 			def read_bootstrap
@@ -67,18 +72,19 @@ module Protocol
 			end
 			
 			# Read application bytes from the HTTY transport.
+			# The HTTP/2 framer always requests exact byte counts (header size, then payload length), so we delegate directly to the underlying input.
 			def read(length = nil)
-				return +"".b if length == 0
-				return @stream.read(length)
+				@input.read(length)
 			end
 			
 			# Write application bytes after bootstrap.
 			# @returns [self]
 			# @raises [IOError] If the local side of the transport is closed.
-			def write(data)
+			def write(data, flush: false)
 				raise IOError, "HTTY stream is closed for writing!" if @local_closed
 				
-				@stream.write(data.to_s.b)
+				@output.write(data.to_s.b)
+				@output.flush if flush
 				
 				return self
 			end
@@ -86,7 +92,7 @@ module Protocol
 			# Flush any buffered output through the underlying stream.
 			# @returns [void]
 			def flush
-				@stream.flush
+				@output.flush
 			end
 			
 			# Close the local write side of this stream abstraction.
@@ -95,7 +101,7 @@ module Protocol
 			def close_write(error = nil)
 				unless @local_closed
 					@local_closed = true
-					@stream.flush
+					@output.flush
 				end
 			end
 			
@@ -110,16 +116,22 @@ module Protocol
 			# Check whether the remote side may still provide more data.
 			# @returns [bool] True if the remote side has not sent or implied a close.
 			def readable?
-				!@stream.closed?
+				!(@input.respond_to?(:closed?) && @input.closed?)
 			end
 			
 			private
 			
+			def read_some(length)
+				@input.read(length)
+			rescue EOFError, Errno::EIO
+				return nil
+			end
+			
 			def read_payload
-				while prefix = @stream.read(1)
+				while prefix = read_some(1)
 					next unless prefix == ESC
 					
-					marker = @stream.read(1)
+					marker = read_some(1)
 					return nil unless marker
 					next unless marker == "P"
 					
@@ -130,11 +142,11 @@ module Protocol
 			end
 			
 			def consume_packet
-				buffer = +""
+				buffer = String.new.b
 				
-				while chunk = @stream.read(1)
+				while chunk = read_some(1)
 					if chunk == ESC
-						terminator = @stream.read(1)
+						terminator = read_some(1)
 						return buffer if terminator == "\\"
 						
 						buffer << chunk

data/lib/protocol/htty/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTY
-		VERSION = "0.2.0"
+		VERSION = "0.4.0"
 	end
 end

data/readme.md

@@ -36,6 +36,16 @@ Please see the [project documentation](https://socketry.github.io/protocol-htty/
 
 Please see the [project releases](https://socketry.github.io/protocol-htty/releases/index) for all releases.
 
+### v0.4.0
+
+  - **Breaking**: Drop the `io-stream` dependency. `Stream.new` and `Stream.open` no longer coerce or wrap their `input` and `output` arguments; raw IO objects are used as-is. Callers that relied on `stream.io` returning an `IO::Stream::Buffered` should wrap the IO themselves before passing it in.
+  - Simplify `Stream#read` to delegate directly to the underlying input, since the HTTP/2 framer always requests exact byte counts (header size, then payload length).
+
+### v0.3.0
+
+  - Change `Protocol::HTTY::Stream` to take explicit input and output endpoints using `Stream.new(input, output)` and `Stream.open(input, output, **options)`.
+  - Read HTTY input without buffering ahead, preserving HTTP/2 frame boundaries by reading only the announced frame payload length.
+
 ### v0.2.0
 
   - Add `Protocol::HTTY::Stream.open(stream, **options)` as the preferred constructor for bootstrapping HTTY over an existing stream.

data/releases.md

@@ -1,5 +1,15 @@
 # Releases
 
+## v0.4.0
+
+  - **Breaking**: Drop the `io-stream` dependency. `Stream.new` and `Stream.open` no longer coerce or wrap their `input` and `output` arguments; raw IO objects are used as-is. Callers that relied on `stream.io` returning an `IO::Stream::Buffered` should wrap the IO themselves before passing it in.
+  - Simplify `Stream#read` to delegate directly to the underlying input, since the HTTP/2 framer always requests exact byte counts (header size, then payload length).
+
+## v0.3.0
+
+  - Change `Protocol::HTTY::Stream` to take explicit input and output endpoints using `Stream.new(input, output)` and `Stream.open(input, output, **options)`.
+  - Read HTTY input without buffering ahead, preserving HTTP/2 frame boundaries by reading only the announced frame payload length.
+
 ## v0.2.0
 
   - Add `Protocol::HTTY::Stream.open(stream, **options)` as the preferred constructor for bootstrapping HTTY over an existing stream.

data/test/protocol/htty/bootstrap.rb

@@ -26,8 +26,7 @@ end
 describe Protocol::HTTY::Stream do
 	let(:input) {StringIO.new}
 	let(:output) {StringIO.new}
-	let(:io) {IO::Stream::Duplex(input, output)}
-	let(:stream) {subject.new(io)}
+	let(:stream) {subject.new(input, output)}
 	
 	it "writes the HTTY raw bootstrap" do
 		stream.write_bootstrap
@@ -45,7 +44,7 @@ describe Protocol::HTTY::Stream do
 	end
 	
 	it "reads a bootstrap split across one-byte reads" do
-		stream = subject.new(OneByteInput.new("hello\eP+Hraw\e\\"))
+		stream = subject.new(OneByteInput.new("hello\eP+Hraw\e\\"), StringIO.new)
 		
 		expect(stream.read_bootstrap).to be == "raw"
 	end
@@ -56,7 +55,7 @@ describe Protocol::HTTY::Stream do
 		
 		stream.read_bootstrap
 		
-		expect(io.read(5)).to be == "world"
+		expect(stream.read(5)).to be == "world"
 	end
 	
 	it "raises on unsupported bootstrap modes" do

data/test/protocol/htty/pty.rb

@@ -20,6 +20,9 @@ class PTYStream
 		@buffer = +"".b
 	end
 	
+	attr :input
+	attr :output
+	
 	def read(length)
 		while @buffer.bytesize < length
 			@buffer << @input.readpartial(4096).b
@@ -104,7 +107,7 @@ describe "HTTY over a real PTY" do
 	it "ignores terminal noise before the bootstrap" do
 		Timeout.timeout(5) do
 			with_fixture("bootstrap") do |stream|
-				framer = Protocol::HTTY::Stream.new(stream)
+				framer = Protocol::HTTY::Stream.new(stream.input, stream.output)
 				
 				expect(framer.read_bootstrap).to be == "raw"
 				expect(stream.read(3)).to be == "RAW"
@@ -115,7 +118,7 @@ describe "HTTY over a real PTY" do
 	it "delivers the HTTP/2 connection preface after raw takeover" do
 		Timeout.timeout(5) do
 			with_fixture("raw_preface") do |stream|
-				framer = Protocol::HTTY::Stream.new(stream)
+				framer = Protocol::HTTY::Stream.new(stream.input, stream.output)
 				
 				expect(framer.read_bootstrap).to be == "raw"
 				
@@ -130,7 +133,8 @@ describe "HTTY over a real PTY" do
 	it "runs an HTTP/2 session until command-side GOAWAY" do
 		Timeout.timeout(5) do
 			with_fixture("http2_server") do |stream|
-				Protocol::HTTY::Stream.new(stream).read_bootstrap
+				stream = Protocol::HTTY::Stream.new(stream.input, stream.output)
+				stream.read_bootstrap
 				
 				framer = Protocol::HTTP2::Framer.new(stream)
 				client = Client.new(framer)
@@ -162,7 +166,8 @@ describe "HTTY over a real PTY" do
 	it "treats command exit after bootstrap without GOAWAY as an abort" do
 		Timeout.timeout(5) do
 			with_fixture("abort_after_bootstrap") do |stream|
-				expect(Protocol::HTTY::Stream.new(stream).read_bootstrap).to be == "raw"
+				stream = Protocol::HTTY::Stream.new(stream.input, stream.output)
+				expect(stream.read_bootstrap).to be == "raw"
 				
 				framer = Protocol::HTTP2::Framer.new(stream)
 				

data/test/protocol/htty/stream.rb

@@ -4,13 +4,12 @@
 # Copyright, 2026, by Samuel Williams.
 
 require "stringio"
-require "tempfile"
 require "protocol/http2/framer"
 require "protocol/htty"
 
 describe Protocol::HTTY::Stream do
 	let(:writer) {StringIO.new}
-	let(:stream) {subject.open(IO::Stream::Duplex(StringIO.new, writer))}
+	let(:stream) {subject.open(StringIO.new, writer)}
 	
 	it "writes raw bytes after bootstrap" do
 		stream.write_bootstrap
@@ -24,7 +23,7 @@ describe Protocol::HTTY::Stream do
 		writer.write("\eP+Hraw\e\\#{Protocol::HTTP2::CONNECTION_PREFACE}")
 		writer.rewind
 
-		reader = subject.open(IO::Stream::Duplex(writer, StringIO.new), bootstrap: :read)
+		reader = subject.open(writer, StringIO.new, bootstrap: :read)
 		
 		expect(reader.read(Protocol::HTTP2::CONNECTION_PREFACE.bytesize)).to be == Protocol::HTTP2::CONNECTION_PREFACE
 		expect(reader.read).to be == ""
@@ -32,7 +31,7 @@ describe Protocol::HTTY::Stream do
 	
 	it "writes the bootstrap when opened in write mode" do
 		writer = StringIO.new
-		stream = subject.open(IO::Stream::Duplex(StringIO.new, writer), bootstrap: :write)
+		stream = subject.open(StringIO.new, writer, bootstrap: :write)
 		
 		expect(writer.string).to be == "\eP+Hraw\e\\"
 		stream.close
@@ -42,14 +41,14 @@ describe Protocol::HTTY::Stream do
 		writer.write("hello")
 		writer.rewind
 		
-		reader = subject.open(IO::Stream::Duplex(writer, StringIO.new))
+		reader = subject.open(writer, StringIO.new)
 		
 		expect(reader.read).to be == "hello"
 		expect(reader.read).to be == ""
 	end
 	
 	it "exposes the underlying output stream" do
-		expect(stream.io).to be(:is_a?, ::IO::Stream::Buffered)
+		expect(stream.io).to be(:equal?, writer)
 	end
 	
 	it "flushes through the underlying stream" do
@@ -93,24 +92,4 @@ describe Protocol::HTTY::Stream do
 			stream.write("hello")
 		end.to raise_exception(IOError)
 	end
-	
-	it "wraps raw IO handles using IO::Stream" do
-		Tempfile.create("protocol-htty") do |file|
-			io_stream = subject.open(file).io
-			
-			expect(io_stream).to be(:is_a?, ::IO::Stream::Buffered)
-			io_stream.close
-		end
-	end
-	
-	it "does not close wrapped raw IO handles when closed" do
-		Tempfile.create("protocol-htty") do |file|
-			wrapped_stream = subject.open(file)
-			
-			wrapped_stream.close
-			
-			expect(file).not.to be(:closed?)
-			file.close
-		end
-	end
 end

data.tar.gz.sig

@@ -1,2 +1,3 @@
-
-�U�:�
�k�آ�$���拡��x.��ٞ���TF�e#v�ev>���!3�~��TCF2m,�{���0�́jp}��ns�����0�lOܢt��姸��84\�:P�4�[�m���p/2~?�":���b
�ҷD�7q��[m�\����N���-#���������T[|�鈟\��ɱQ�G��$��Dtf�v|�1UO
+�g;��M�o��(� Y����Fl��iHs��,E(B�#Ȱ�C���ju�Ύ�o�K-��C�w�CUU����5S��vZET�������#��`����5q�D���!7�­Z;G�֘�Y,#D����3P��r�0�D
���J"В	w
+��f�"����irʅN�y�B�ZҸ�@F]	9?���6_;�є5�"�&���W�D���x�k�Oݭ�g��:(�C��-�B��غ]�luc�Ӟ��xt����
+-3G� ��R^xƹ/��*�ƥ��"���3���o�|��ܗL��(�\ 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-htty
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: io-stream
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.0
 executables: []
 extensions: []
 extra_rdoc_files: []