protocol-grpc 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 301c1d74991d960be7af4b50850ffa24aab9e4c2c7aedc97759518027aacfe18
-  data.tar.gz: ac2fe4b32aa211ef8dbf4329a8677ae09deced47ab21816c0b6fb361d346dcd2
+  metadata.gz: 121472581aa9d3d84bc5b1542bbe6d49274180ae0129d151a2b8f6aca9377026
+  data.tar.gz: 820130b179cf141d525cc483900a14edbc68705c6f318e469c258c1e6cb0735d
 SHA512:
-  metadata.gz: 2467aaa36d36c6d011ee4913984defc1974d008bf25081777863d83b4c3c7c7825556ae571a99cc74858a7eece0c99cf253953230bbb7220244082a2c32bd95f
-  data.tar.gz: 222fe2052157790f288d72f6f6feff1ad42d507ab188e2bce23cbf0f2e9fa63d7eb0966f774935e5ae0ad3e5a497170f8b126f9dfa4d10ccf53b7f385d7b8437
+  metadata.gz: 8576fe2b1c9f6f0b88e2472c34bd5720e48e33c43da18845360e52c10017410ea1b730d206a71c47ad8e8b5e7b9e132e9e795524e8baea89f67156bb660e0bfc
+  data.tar.gz: cc61e8bc843aa2e27ad8a6c9d9e63788be37729a53060b19a486b572e6761aa35fb066edf1493b63ff4b71bb1f5058af6014a7c8deb3c9f92d6c76a272925e9a

data/context/getting-started.md

@@ -129,3 +129,4 @@ call.deadline.exceeded?  # => false
 # Access peer information
 call.peer  # => Protocol::HTTP::Address
 ```
+

data/design.md

@@ -293,58 +293,22 @@ module Protocol
 				message ? URI.decode_www_form_component(message) : nil
 			end
 			
-			# Build headers with gRPC status and message
-			# @parameter status [Integer] gRPC status code
-			# @parameter message [String, nil] Optional status message
-			# @parameter policy [Hash] Header policy to use
-			# @returns [Protocol::HTTP::Headers]
-			def self.build_status_headers(status: Status::OK, message: nil, policy: HEADER_POLICY)
-				headers = Protocol::HTTP::Headers.new([], nil, policy: policy)
-				headers["grpc-status"] = status.to_s
-				headers["grpc-message"] = URI.encode_www_form_component(message) if message
-				headers
-			end
-			
-			# Mark that trailers will follow (call after sending initial headers)
-			# @parameter headers [Protocol::HTTP::Headers]
-			# @returns [Protocol::HTTP::Headers]
-			def self.prepare_trailers!(headers)
-				headers.trailer!
-				headers
-			end
+		# Add gRPC status, message, and optional backtrace to headers.
+		# Whether these become headers or trailers is controlled by the protocol layer.
+		# @parameter headers [Protocol::HTTP::Headers]
+		# @parameter status [Integer] gRPC status code
+		# @parameter message [String | Nil] Optional status message
+		# @parameter error [Exception | Nil] Optional error object (used to extract backtrace)
+		def self.add_status!(headers, status: Status::OK, message: nil, error: nil)
+			headers["grpc-status"] = Header::Status.new(status)
+			headers["grpc-message"] = Header::Message.new(Header::Message.encode(message)) if message
 			
-			# Add status as trailers to existing headers
-			# @parameter headers [Protocol::HTTP::Headers]
-			# @parameter status [Integer] gRPC status code
-			# @parameter message [String, nil] Optional status message
-			def self.add_status_trailer!(headers, status: Status::OK, message: nil)
-				headers.trailer! unless headers.trailer?
-				headers["grpc-status"] = status.to_s
-				headers["grpc-message"] = URI.encode_www_form_component(message) if message
-			end
-			
-			# Add status as initial headers (for trailers-only responses)
-			# @parameter headers [Protocol::HTTP::Headers]
-			# @parameter status [Integer] gRPC status code
-			# @parameter message [String, nil] Optional status message
-			def self.add_status_header!(headers, status: Status::OK, message: nil)
-				headers["grpc-status"] = status.to_s
-				headers["grpc-message"] = URI.encode_www_form_component(message) if message
-			end
-			
-			# Build a trailers-only error response (no body, status in headers)
-			# @parameter status [Integer] gRPC status code
-			# @parameter message [String, nil] Optional status message
-			# @parameter policy [Hash] Header policy to use
-			# @returns [Protocol::HTTP::Response]
-			def self.build_trailers_only_response(status:, message: nil, policy: HEADER_POLICY)
-				headers = Protocol::HTTP::Headers.new([], nil, policy: policy)
-				headers["content-type"] = "application/grpc+proto"
-				add_status_header!(headers, status: status, message: message)
-				
-				Protocol::HTTP::Response[200, headers, nil]
+			# Add backtrace from error if available
+			if error && error.backtrace && !error.backtrace.empty?
+				headers["backtrace"] = error.backtrace
 			end
 		end
+		end
 	end
 end
 ```
@@ -754,7 +718,7 @@ module Protocol
 				# Find handler
 				handler = @services[service_name]
 				unless handler
-					return trailers_only_error(Status::UNIMPLEMENTED, "Service not found: #{service_name}")
+					return make_response(Status::UNIMPLEMENTED, "Service not found: #{service_name}")
 				end
 				
 				# Determine handler method and message classes
@@ -773,17 +737,17 @@ module Protocol
 				end
 				
 				unless handler.respond_to?(handler_method)
-					return trailers_only_error(Status::UNIMPLEMENTED, "Method not found: #{method_name}")
+					return make_response(Status::UNIMPLEMENTED, "Method not found: #{method_name}")
 				end
 				
 				# Handle the RPC
-				begin
-					handle_rpc(request, handler, handler_method, request_class, response_class)
-				rescue Error => error
-					trailers_only_error(e.status_code, error.message)
-				rescue => error
-					trailers_only_error(Status::INTERNAL, error.message)
-				end
+			begin
+				handle_rpc(request, handler, handler_method, request_class, response_class)
+			rescue Error => error
+				make_response(error.status_code, error.message, error: error)
+			rescue => error
+				make_response(Status::INTERNAL, error.message, error: error)
+			end
 			end
 			
 			protected
@@ -811,20 +775,22 @@ module Protocol
 				handler.send(method, input, output, call)
 				output.close_write unless output.closed?
 				
-								# Mark trailers and add status
-				response_headers.trailer!
-				Metadata.add_status_trailer!(response_headers, status: Status::OK)
-				
-				Protocol::HTTP::Response[200, response_headers, output]
-			end
+							# Mark trailers and add status
+			response_headers.trailer!
+			Metadata.add_status!(response_headers, status: Status::OK)
 			
-			def trailers_only_error(status_code, message)
-				Metadata.build_trailers_only_response(
-					status: status_code,
-					message: message,
-					policy: HEADER_POLICY
-				)
-			end
+			Protocol::HTTP::Response[200, response_headers, output]
+		end
+		
+		protected
+		
+		def make_response(status_code, message, error: nil)
+			headers = Protocol::HTTP::Headers.new([], nil, policy: HEADER_POLICY)
+			headers["content-type"] = "application/grpc+proto"
+			Metadata.add_status!(headers, status: status_code, message: message, error: error)
+			
+			Protocol::HTTP::Response[200, headers, nil]
+		end
 		end
 	end
 end
@@ -953,7 +919,7 @@ def handle_grpc_request(http_request)
 		# Add status as trailer - these will be sent after the response body
 		# Note: The user just adds them to headers; the @tail marker ensures
 		# they're recognized as trailers internally
-	Protocol::GRPC::Metadata.add_status_trailer!(headers, status: Protocol::GRPC::Status::OK)
+	Protocol::GRPC::Metadata.add_status!(headers, status: Protocol::GRPC::Status::OK)
 	
 	Protocol::HTTP::Response[200, headers, output]
 end

data/lib/protocol/grpc/metadata.rb

@@ -75,57 +75,23 @@ module Protocol
 				end
 			end
 			
-			# Build headers with gRPC status and message
-			# @parameter status [Integer] gRPC status code
-			# @parameter message [String | Nil] Optional status message
-			# @parameter policy [Hash] Header policy to use
-			# @returns [Protocol::HTTP::Headers]
-			def self.build_status_headers(status: Status::OK, message: nil, policy: HEADER_POLICY)
-				headers = Protocol::HTTP::Headers.new([], nil, policy: policy)
-				headers["grpc-status"] = Header::Status.new(status)
-				headers["grpc-message"] = Header::Message.new(Header::Message.encode(message)) if message
-				headers
-			end
-			
-			# Mark that trailers will follow (call after sending initial headers)
-			# @parameter headers [Protocol::HTTP::Headers]
-			# @returns [Protocol::HTTP::Headers]
-			def self.prepare_trailers!(headers)
-				headers.trailer!
-				headers
-			end
-			
-			# Add status as trailers to existing headers
-			# @parameter headers [Protocol::HTTP::Headers]
-			# @parameter status [Integer] gRPC status code
-			# @parameter message [String | Nil] Optional status message
-			def self.add_status_trailer!(headers, status: Status::OK, message: nil)
-				headers.trailer! unless headers.trailer?
-				headers["grpc-status"] = Header::Status.new(status)
-				headers["grpc-message"] = Header::Message.new(Header::Message.encode(message)) if message
-			end
-			
-			# Add status as initial headers (for trailers-only responses)
+			# Add gRPC status, message, and optional backtrace to headers.
+			# Whether these become headers or trailers is controlled by the protocol layer.
 			# @parameter headers [Protocol::HTTP::Headers]
 			# @parameter status [Integer] gRPC status code
 			# @parameter message [String | Nil] Optional status message
-			def self.add_status_header!(headers, status: Status::OK, message: nil)
+			# @parameter error [Exception | Nil] Optional error object (used to extract backtrace)
+			def self.add_status!(headers, status: Status::OK, message: nil, error: nil)
 				headers["grpc-status"] = Header::Status.new(status)
 				headers["grpc-message"] = Header::Message.new(Header::Message.encode(message)) if message
-			end
-			
-			# Build a trailers-only error response (no body, status in headers)
-			# @parameter status [Integer] gRPC status code
-			# @parameter message [String | Nil] Optional status message
-			# @parameter policy [Hash] Header policy to use
-			# @returns [Protocol::HTTP::Response]
-			def self.build_trailers_only_response(status:, message: nil, policy: HEADER_POLICY)
-				headers = Protocol::HTTP::Headers.new([], nil, policy: policy)
-				headers["content-type"] = "application/grpc+proto"
-				add_status_header!(headers, status: status, message: message)
 				
-				Protocol::HTTP::Response[200, headers, nil]
+				# Add backtrace from error if available
+				if error && error.backtrace && !error.backtrace.empty?
+					# Assign backtrace array directly - Split header will handle it
+					headers["backtrace"] = error.backtrace
+				end
 			end
+			
 		end
 	end
 end

data/lib/protocol/grpc/middleware.rb

@@ -30,9 +30,9 @@ module Protocol
 				begin
 					dispatch(request)
 				rescue Error => error
-					trailers_only_error(error.status_code, error.message)
+					make_response(error.status_code, error.message, error: error)
 				rescue StandardError => error
-					trailers_only_error(Status::INTERNAL, error.message)
+					make_response(Status::INTERNAL, error.message, error: error)
 				end
 			end
 			
@@ -45,7 +45,7 @@ module Protocol
 				raise NotImplementedError, "Subclasses must implement #dispatch"
 			end
 			
-			protected
+		protected
 			
 			# Check if the request is a gRPC request.
 			# @parameter request [Protocol::HTTP::Request]
@@ -55,16 +55,18 @@ module Protocol
 				content_type&.start_with?("application/grpc")
 			end
 			
-			# Build a trailers-only error response.
+			# Make a gRPC error response with status and optional message.
 			# @parameter status_code [Integer] gRPC status code
 			# @parameter message [String] Error message
+			# @parameter error [Exception] Optional error object (used to extract backtrace)
 			# @returns [Protocol::HTTP::Response]
-			def trailers_only_error(status_code, message)
-				Metadata.build_trailers_only_response(
-					status: status_code,
-					message: message,
-					policy: HEADER_POLICY
-				)
+			def make_response(status_code, message, error: nil)
+				headers = Protocol::HTTP::Headers.new([], nil, policy: HEADER_POLICY)
+				headers["content-type"] = "application/grpc+proto"
+				
+				Metadata.add_status!(headers, status: status_code, message: message, error: error)
+				
+				Protocol::HTTP::Response[200, headers, nil]
 			end
 		end
 	end

data/lib/protocol/grpc/version.rb

@@ -7,6 +7,7 @@
 module Protocol
 	# @namespace
 	module GRPC
-		VERSION = "0.4.0"
+		VERSION = "0.5.1"
 	end
 end
+

data/readme.md

@@ -28,6 +28,12 @@ Please see the [project documentation](https://socketry.github.io/protocol-grpc/
 
 Please see the [project releases](https://socketry.github.io/protocol-grpc/releases/index) for all releases.
 
+### v0.5.0
+
+  - Server-side errors now automatically include backtraces in response headers when an error object is provided. Backtraces are transmitted as arrays via Split headers and can be extracted by clients.
+  - Consolidated `add_status_trailer!`, `add_status_header!`, `build_status_headers`, `prepare_trailers!`, and `build_trailers_only_response` into a single `add_status!` method. Whether status becomes headers or trailers is now controlled by the protocol layer.
+  - Renamed `trailers_only_error` to `make_response` and inlined response creation logic. The method now accepts an `error:` parameter for automatic backtrace extraction.
+
 ### v0.4.0
 
   - Add `RPC#name`.

data/releases.md

@@ -1,5 +1,11 @@
 # Releases
 
+## v0.5.0
+
+  - Server-side errors now automatically include backtraces in response headers when an error object is provided. Backtraces are transmitted as arrays via Split headers and can be extracted by clients.
+  - Consolidated `add_status_trailer!`, `add_status_header!`, `build_status_headers`, `prepare_trailers!`, and `build_trailers_only_response` into a single `add_status!` method. Whether status becomes headers or trailers is now controlled by the protocol layer.
+  - Renamed `trailers_only_error` to `make_response` and inlined response creation logic. The method now accepts an `error:` parameter for automatic backtrace extraction.
+
 ## v0.4.0
 
   - Add `RPC#name`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-grpc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -70,30 +70,30 @@ dependencies:
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: protocol-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.56'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0.56'
 executables: []
 extensions: []
 extra_rdoc_files: []