protocol-grpc 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a889e5eb3f6b74e8609a27a4667b62611ab8dc0515d24d9ecf70c4fee7e25b11
-  data.tar.gz: 56b5bc9e9d8a767db66ead55bcc97404e8092ef6a75a008d4bd893624391b808
+  metadata.gz: ef695986f77971ac09708cb8bc1cbb694fd402c1c6f2fcc9070b26309a95fbcb
+  data.tar.gz: 2ba1216276a20618b2e93034981f15522f5b6dae44a615d51796b08dc67f2dbe
 SHA512:
-  metadata.gz: 6aab2ee9f75421070a6348c39da680c7cd320e31021b9492f48d48832ab4caf580ffa77113a792e336cd87158890d22ed12d9e4650079954b33c99c7da85e422
-  data.tar.gz: 67c0e25c06ed8f5c8ad431233506f6133655d64a6e546d9767c74049d85b0fa6b54e37384e15e6458c429f0431779fad96c8b01e30821acd8f7952a260ccf3de
+  metadata.gz: a5c9661129270d4ccd3d47b84ae6d3e2058f1c7499fb9302f69a85d08dbe67ea305d72f23d2ab36f62ab728a40982b5ae7f9b1c2aaa29e09378206912b5afec7
+  data.tar.gz: bb0825134335b844320744dda1130e3fd9426c5eb4b8894a17cdb408c0d67b978c3a2bcb05c9a5164faa00d0ebf0903097c9533e0695aac8963068265eb3eb90

data/context/getting-started.md

@@ -130,4 +130,3 @@ call.deadline.exceeded?  # => false
 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 => e
-					trailers_only_error(e.status_code, e.message)
-				rescue => e
-					trailers_only_error(Status::INTERNAL, e.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/body/readable_body.rb

@@ -15,6 +15,11 @@ module Protocol
 			# This is the standard readable body for gRPC - all gRPC responses use message framing.
 			# Wraps the underlying HTTP body and transforms raw chunks into decoded gRPC messages.
 			class ReadableBody < Protocol::HTTP::Body::Wrapper
+				# Wrap the body of a message.
+				#
+				# @parameter message [Request | Response] The message to wrap.
+				# @parameter options [Hash] The options to pass to the initializer.
+				# @returns [ReadableBody | Nil] The wrapped body or `nil` if the message has no body.
 				def self.wrap(message, **options)
 					if body = message.body
 						message.body = self.new(body, **options)

data/lib/protocol/grpc/interface.rb

@@ -11,8 +11,8 @@ module Protocol
 		# Can be used by both client stubs and server implementations.
 		class Interface
 			# RPC method definition
-			RPC = Struct.new(:request_class, :response_class, :streaming, :method, keyword_init: true) do
-				def initialize(request_class:, response_class:, streaming: :unary, method: nil)
+			RPC = Struct.new(:name, :request_class, :response_class, :streaming, :method, keyword_init: true) do
+				def initialize(name:, request_class:, response_class:, streaming: :unary, method: nil)
 					super
 				end
 				
@@ -40,6 +40,8 @@ module Protocol
 			# @parameter streaming [Symbol] Streaming type (:unary, :server_streaming, :client_streaming, :bidirectional)
 			# @parameter method [Symbol | Nil] Optional explicit Ruby method name (snake_case). If not provided, automatically converts PascalCase to snake_case.
 			def self.rpc(name, **options)
+				options[:name] = name
+				
 				# Ensure snake_case method name is always available
 				options[:method] ||= pascal_case_to_snake_case(name.to_s).to_sym
 				

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,17 @@ 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,7 +7,7 @@
 module Protocol
 	# @namespace
 	module GRPC
-		VERSION = "0.3.0"
+		VERSION = "0.5.0"
 	end
 end
 

data/readme.md

@@ -28,6 +28,10 @@ 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.4.0
+
+  - Add `RPC#name`.
+
 ### v0.3.0
 
   - **Breaking**: `Protocol::GRPC::Call` now takes a `response` object parameter instead of separate `response_headers`.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.4.0
+
+  - Add `RPC#name`.
+
 ## v0.3.0
 
   - **Breaking**: `Protocol::GRPC::Call` now takes a `response` object parameter instead of separate `response_headers`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-grpc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -86,14 +86,14 @@ dependencies:
     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: []