protocol-htty 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba295c47e02345ba7101c3958786fc21fd7187294abe6fef0f39a6677baf9be3
-  data.tar.gz: 2fcb179db305375b86b5196ed149c0ef1eed4fb52c7d06447b0a5e68d4dd16a4
+  metadata.gz: 87a3aa4c350c134deb40265ae418e15fbd1158b70a8cf4c21e1748de514ca867
+  data.tar.gz: 506e9101a8df67e75aed817e3227919e06dc00ee5aa8d58d62c6d7139ae8d1ea
 SHA512:
-  metadata.gz: 4132b7c507a0b285f772c91bca4ddbcb315d5faccfeafd28c6907df4553ad5a20190299e9d924c75a946819e656205b603bcae69b6bc61d1e20b08f5e437f60f
-  data.tar.gz: 3149badd26c592217168140c69b654190fdad74d6884b9ef4e729ff9e8a1f4b342f284bec1b1759698d53a15c4c11858e666654d6b7de0cc47e07f44854d45bd
+  metadata.gz: 82d2c3b0fbbd56482711a10da4dad9e0e86177168d1cbc198d126e1d0c347e27dd3123e5d3982f9884e7bc2ee8b8f1be429164f06f16d5c3dde65ff5424750e3
+  data.tar.gz: cb61305b1df49d733cc5b4e0755d2d8962813eafc1e3fb2137122014643b7b7a90bfd44e2490edd428eb32b8bb9a7e31745bfeaa8b8b847ea1ad39d5c2f8aa25

data/lib/protocol/htty/stream.rb

@@ -15,8 +15,10 @@ module Protocol
 			BOOTSTRAP_PREFIX = "+H"
 			RAW_MODE = "raw"
 			
-			def self.open(stream, bootstrap: nil, mode: RAW_MODE)
-				stream = self.new(::IO::Stream(stream))
+			HTTP2_FRAME_HEADER_SIZE = 9
+			
+			def self.open(input, output, bootstrap: nil, mode: RAW_MODE)
+				stream = self.new(input, output)
 				
 				case bootstrap
 				when :write
@@ -32,23 +34,27 @@ 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 = ::IO::Stream(output)
+				@frame_remaining = nil
 				@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
@@ -68,17 +74,36 @@ module Protocol
 			
 			# Read application bytes from the HTTY transport.
 			def read(length = nil)
-				return +"".b if length == 0
-				return @stream.read(length)
+				if length == 0
+					@frame_remaining = nil if @frame_remaining == 0
+					return +"".b
+				end
+				
+				requested_length = length
+				length = [length, @frame_remaining].min if length && @frame_remaining && @frame_remaining > 0
+				buffer = read_exact(length)
+				
+				if buffer && requested_length == HTTP2_FRAME_HEADER_SIZE && !@frame_remaining
+					if buffer.bytesize == HTTP2_FRAME_HEADER_SIZE
+						frame_length = self.class.frame_length(buffer)
+						@frame_remaining = frame_length if frame_length > 0
+					end
+				elsif buffer && @frame_remaining
+					@frame_remaining -= buffer.bytesize
+					@frame_remaining = nil if @frame_remaining <= 0
+				end
+				
+				return buffer
 			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 +111,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 +120,7 @@ module Protocol
 			def close_write(error = nil)
 				unless @local_closed
 					@local_closed = true
-					@stream.flush
+					@output.flush
 				end
 			end
 			
@@ -110,16 +135,47 @@ 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 self.frame_length(buffer)
+				length_high, length_low = buffer.unpack("Cn")
+				return (length_high << 16) | length_low
+			end
+			
+			def read_exact(length)
+				return @input.read if length.nil?
+				
+				buffer = +"".b
+				
+				while buffer.bytesize < length
+					chunk = read_some(length - buffer.bytesize)
+					break unless chunk
+					
+					buffer << chunk.b
+				end
+				
+				return nil if buffer.empty?
+				return buffer
+			end
+			
+			def read_some(length)
+				if @input.respond_to?(:readpartial)
+					@input.readpartial(length)
+				else
+					@input.read(length)
+				end
+			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"
 					
@@ -132,9 +188,9 @@ module Protocol
 			def consume_packet
 				buffer = +""
 				
-				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.3.0"
 	end
 end

data/readme.md

@@ -36,6 +36,11 @@ 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.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,10 @@
 # Releases
 
+## 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

@@ -10,7 +10,7 @@ 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 +24,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 +32,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,7 +42,7 @@ 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 == ""
@@ -86,6 +86,16 @@ describe Protocol::HTTY::Stream do
 		expect(stream).to be(:readable?)
 	end
 	
+	it "reads HTTP/2 frame headers and payloads without reading ahead" do
+		header = [0, 5, 0, 0, 1].pack("CnCCN")
+		input = StringIO.new("#{header}helloextra")
+		reader = subject.open(input, StringIO.new)
+		
+		expect(reader.read(9)).to be == header
+		expect(reader.read(16)).to be == "hello"
+		expect(reader.read(5)).to be == "extra"
+	end
+	
 	it "rejects writes after the local side is closed" do
 		stream.close
 		
@@ -96,7 +106,7 @@ describe Protocol::HTTY::Stream do
 	
 	it "wraps raw IO handles using IO::Stream" do
 		Tempfile.create("protocol-htty") do |file|
-			io_stream = subject.open(file).io
+			io_stream = subject.open(file, file).io
 			
 			expect(io_stream).to be(:is_a?, ::IO::Stream::Buffered)
 			io_stream.close
@@ -105,7 +115,7 @@ describe Protocol::HTTY::Stream do
 	
 	it "does not close wrapped raw IO handles when closed" do
 		Tempfile.create("protocol-htty") do |file|
-			wrapped_stream = subject.open(file)
+			wrapped_stream = subject.open(file, file)
 			
 			wrapped_stream.close
 			

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-htty
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams