tonic-rails 0.1.0 → 0.2.0

data/lib/tonic/rails/base.rb

@@ -111,6 +111,21 @@ module Tonic
       # @return [Hash{String=>String}]
       attr_reader :grpc_metadata
 
+      # Response headers (initial metadata) for this call.  For streaming
+      # responses, set them before the first message; for unary RPCs,
+      # anywhere in the handler.  `-bin` names take binary values.
+      # @return [Hash]
+      def response_metadata
+        @response_metadata ||= {}
+      end
+
+      # Trailing metadata, sent with the final status, whether the call
+      # succeeds or fails.
+      # @return [Hash]
+      def trailing_metadata
+        @trailing_metadata ||= {}
+      end
+
       # Milliseconds left before the client's deadline, or nil if the
       # client did not set one.
       # @return [Integer, nil]
@@ -143,39 +158,52 @@ module Tonic
         raise RpcError.new("method #{rpc_name} not implemented", code: :unimplemented) unless respond_to?(spec[:handler])
 
         @grpc_metadata = metadata
+        @grpc_sender = sender
+        @grpc_headers_sent = false
         @grpc_deadline_at = timeout_ms && (Process.clock_gettime(Process::CLOCK_MONOTONIC) + (timeout_ms / 1000.0))
 
-        request = if spec[:request_stream]
-          Enumerator.new do |y|
-            while (message = read_request(reader, spec))
-              y << message
-            end
-          end
-        else
-          read_request(reader, spec) || raise(RpcError.new("missing request message", code: :invalid_argument))
-        end
-
-        result = public_send(spec[:handler], request)
-
-        if spec[:response_stream]
-          unless result.respond_to?(:each)
-            raise TypeError, "streaming handler #{self.class}##{spec[:handler]} must return an Enumerable, got #{result.class}"
-          end
-
-          result.each { |item| push_response(sender, encode_response(item, spec)) }
-          nil
-        else
-          encode_response(result, spec)
-        end
+        result = public_send(spec[:handler], build_request(reader, spec))
+        respond(result, spec, sender)
       rescue RpcError
         raise
       rescue StandardError => e
         Tonic::Rails.log_exception(e, "#{self.class}##{rpc_name}")
         raise RpcError.new("internal error", code: :internal)
+      ensure
+        attach_trailing_metadata
       end
 
       private
 
+      def build_request(reader, spec)
+        unless spec[:request_stream]
+          return read_request(reader, spec) || raise(RpcError.new("missing request message", code: :invalid_argument))
+        end
+
+        Enumerator.new do |y|
+          while (message = read_request(reader, spec))
+            y << message
+          end
+        end
+      end
+
+      # Unary: the encoded response.  Streaming: nil, after pushing each
+      # message through the sender.
+      def respond(result, spec, sender)
+        unless spec[:response_stream]
+          encoded = encode_response(result, spec)
+          send_response_headers
+          return encoded
+        end
+
+        unless result.respond_to?(:each)
+          raise TypeError, "streaming handler #{self.class}##{spec[:handler]} must return an Enumerable, got #{result.class}"
+        end
+
+        result.each { |item| push_response(sender, encode_response(item, spec)) }
+        nil
+      end
+
       def read_request(reader, spec)
         bytes = reader.next
         if bytes.nil?
@@ -205,11 +233,30 @@ module Tonic
       end
 
       def push_response(sender, bytes)
+        send_response_headers
         sender.push(bytes)
       rescue IOError
         # The client went away; nothing left to deliver to.
         raise RpcError.new("client cancelled the stream", code: :cancelled)
       end
+
+      def send_response_headers
+        return if @grpc_headers_sent
+
+        @grpc_headers_sent = true
+        return if @response_metadata.nil? || @response_metadata.empty? || @grpc_sender.nil?
+
+        @grpc_sender.send_headers(Metadata.encode(@response_metadata))
+      end
+
+      # Runs in `ensure`, so it must never raise over the call's outcome.
+      def attach_trailing_metadata
+        return if @trailing_metadata.nil? || @trailing_metadata.empty? || @grpc_sender.nil?
+
+        @grpc_sender.add_trailers(Metadata.encode(@trailing_metadata))
+      rescue StandardError => e
+        Tonic::Rails.log_exception(e, "#{self.class} trailing metadata")
+      end
     end
   end
 end

data/lib/tonic/rails/configuration.rb

@@ -47,7 +47,8 @@ module Tonic
       # Concurrent HTTP/2 streams per connection.  0 = unlimited.  Default 32.
       attr_accessor :concurrency_limit_per_connection
 
-      # Log every request, not just errors, to stderr.  Default false.
+      # Log one line per RPC (path, status, duration) through `logger`.
+      # Unexpected exceptions are always logged.  Default false.
       attr_accessor :log_requests
 
       # Callables wrapping every RPC, outermost first:

data/lib/tonic/rails/instrumentation.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/notifications"
+
+module Tonic
+  module Rails
+    # Every RPC is wrapped in an ActiveSupport::Notifications event, so APM
+    # agents, OpenTelemetry and your own subscribers can observe it:
+    #
+    #   ActiveSupport::Notifications.subscribe("process_rpc.tonic_rails") do |event|
+    #     event.payload[:path]      # "/demo.v1.ItemService/GetItem"
+    #     event.payload[:service]   # "demo.v1.ItemService"
+    #     event.payload[:rpc]       # "GetItem"
+    #     event.payload[:metadata]  # request metadata Hash
+    #     event.payload[:code]      # gRPC status code, 0 = OK
+    #     event.payload[:status]    # :ok, :not_found, :internal, ...
+    #     event.duration            # milliseconds
+    #   end
+    #
+    # When a call fails, :exception_object holds the RpcError. If a handler
+    # raised something unexpected, that RpcError's #cause is the original
+    # exception.
+    module Instrumentation
+      EVENT = "process_rpc.tonic_rails"
+
+      module_function
+
+      # @api private
+      def instrument(path, metadata)
+        # Without subscribers, skip building the payload: this runs on
+        # every RPC.
+        return yield unless ActiveSupport::Notifications.notifier.listening?(EVENT)
+
+        service, rpc = path.delete_prefix("/").split("/", 2)
+        payload = { path: path, service: service, rpc: rpc, metadata: metadata, code: nil, status: nil }
+        ActiveSupport::Notifications.instrument(EVENT, payload) do
+          result = yield
+          payload[:code] = 0
+          payload[:status] = :ok
+          result
+        rescue RpcError => e
+          payload[:code] = e.code
+          payload[:status] = e.code_name
+          raise
+        rescue StandardError
+          payload[:code] = RpcError::CODES[:internal]
+          payload[:status] = :internal
+          raise
+        end
+      end
+
+      # Logs one line per RPC through the configured logger, e.g.
+      #   gRPC /demo.v1.ItemService/GetItem OK in 1.4ms
+      #   gRPC /demo.v1.ItemService/GetItem NOT_FOUND in 0.9ms: item 7 not found
+      # Enabled by `config.log_requests = true`.
+      class RequestLogger
+        def initialize(logger)
+          @logger = logger
+        end
+
+        def call(event)
+          payload = event.payload
+          status = (payload[:status] || :unknown).to_s.upcase
+          line = format("gRPC %<path>s %<status>s in %<ms>.1fms", path: payload[:path], status: status, ms: event.duration)
+          error = payload[:exception_object]
+          line = "#{line}: #{error.message}" if error && payload[:code] != 0
+          @logger.info(line)
+        end
+
+        # @return [Object] the subscription, for #unsubscribe
+        def subscribe
+          ActiveSupport::Notifications.subscribe(EVENT, self)
+        end
+      end
+    end
+  end
+end

data/lib/tonic/rails/metadata.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Tonic
+  module Rails
+    # Converts handler-supplied gRPC metadata into header pairs.
+    #
+    # Names are lower-cased and must be valid gRPC metadata names; names
+    # ending in "-bin" carry binary values, which are base64-encoded as the
+    # gRPC spec requires.  Other values must be printable ASCII.
+    module Metadata
+      NAME = /\A[0-9a-z_.-]+\z/
+      PRINTABLE = /\A[\x20-\x7e]*\z/
+      RESERVED = %w[content-type te user-agent content-length connection transfer-encoding].freeze
+
+      module_function
+
+      # @param metadata [Hash{String,Symbol=>String,Array<String>}]
+      # @return [Hash{String=>String}]
+      # @raise [ArgumentError] for invalid or reserved names and values
+      def encode(metadata)
+        metadata.each_with_object({}) do |(name, value), out|
+          name = name.to_s.downcase
+          validate_name!(name)
+          out[name] = encode_value(name, value)
+        end
+      end
+
+      def validate_name!(name)
+        raise ArgumentError, "invalid gRPC metadata name #{name.inspect}" unless NAME.match?(name)
+        return unless RESERVED.include?(name) || (name.start_with?("grpc-") && name != "grpc-status-details-bin")
+
+        raise ArgumentError, "gRPC metadata name #{name.inspect} is reserved"
+      end
+
+      def encode_value(name, value)
+        values = Array(value).map(&:to_s)
+        if name.end_with?("-bin")
+          values.map { |v| [v].pack("m0") }.join(",")
+        else
+          values.each do |v|
+            next if PRINTABLE.match?(v)
+
+            raise ArgumentError, "gRPC metadata #{name} must be printable ASCII; use a -bin name for binary"
+          end
+          values.join(",")
+        end
+      end
+    end
+  end
+end

data/lib/tonic/rails/railtie.rb

@@ -28,8 +28,8 @@ module Tonic
       config.after_initialize do
         configuration = Tonic::Rails.configuration
         # Only inside an actual web server process — not consoles, rake
-        # tasks, or test runs.  Forking servers (Puma cluster mode) must
-        # instead start the server per worker, e.g. in `on_worker_boot`.
+        # tasks, or test runs.  With Puma, prefer `plugin :tonic_rails`
+        # (lib/puma/plugin/tonic_rails.rb), which also covers cluster mode.
         if configuration.auto_start && defined?(::Rails::Server)
           server = Tonic::Rails.server
           thread = Thread.new do

data/lib/tonic/rails/rpc_error.rb

@@ -2,13 +2,23 @@
 
 module Tonic
   module Rails
-    # Raise from a handler to end the RPC with a gRPC status.
+    # Raise from a handler (or interceptor) to end the RPC with a gRPC status.
     #
-    #   raise Tonic::Rails::RpcError.new("product not found", code: :not_found)
+    #   raise Tonic::Rails::RpcError.new("item not found", code: :not_found)
     #
-    # The message is sent to the client, so keep internal details out of
-    # it.  Any other exception becomes INTERNAL with a generic message
-    # and is logged server-side.
+    # Optionally attach trailing metadata and rich error details (protobuf
+    # messages such as google.rpc.BadRequest, sent in the standard
+    # grpc-status-details-bin trailer as a google.rpc.Status):
+    #
+    #   raise Tonic::Rails::RpcError.new(
+    #     "invalid item", code: :invalid_argument,
+    #     metadata: { "x-request-id" => request_id },
+    #     details: [Google::Rpc::BadRequest.new(field_violations: [...])],
+    #   )
+    #
+    # The message, metadata and details go to the client, so keep internal
+    # details out of them.  Any other exception becomes INTERNAL with a
+    # generic message and is logged server-side.
     class RpcError < Error
       CODES = {
         ok: 0,
@@ -35,13 +45,70 @@ module Tonic
       # @return [Integer] numeric gRPC status code
       attr_reader :code
 
+      # @return [Hash] trailing metadata sent with the status
+      attr_reader :metadata
+
+      # @return [Array<Google::Protobuf::AbstractMessage>] rich error details
+      attr_reader :details
+
       # @param message [String] status message sent to the client
       # @param code [Symbol, Integer] gRPC status code (see CODES)
-      def initialize(message = nil, code: :unknown)
+      # @param metadata [Hash] trailing metadata (see Tonic::Rails::Metadata)
+      # @param details [Array<Google::Protobuf::AbstractMessage>] messages
+      #   packed into google.rpc.Status.details
+      def initialize(message = nil, code: :unknown, metadata: {}, details: [])
         @code = self.class.normalize_code(code)
+        @metadata = metadata
+        @details = Array(details)
         super(message || code_name.to_s)
       end
 
+      # @api private
+      # @return [Hash{String=>String}] trailers to send with this status
+      def trailers
+        trailers = Metadata.encode(metadata)
+        trailers["grpc-status-details-bin"] = [status_proto].pack("m0") unless details.empty?
+        trailers
+      end
+
+      # The encoded google.rpc.Status (code = 1, message = 2, details = 3 as
+      # google.protobuf.Any), built directly so googleapis protos aren't a
+      # dependency.
+      def status_proto
+        require "google/protobuf/well_known_types"
+        buf = (+"").b
+        buf << field_key(1, 0) << varint(code)
+        buf << length_delimited(2, message.b)
+        details.each do |detail|
+          any = detail.is_a?(Google::Protobuf::Any) ? detail : Google::Protobuf::Any.pack(detail)
+          buf << length_delimited(3, Google::Protobuf::Any.encode(any))
+        end
+        buf
+      end
+
+      private
+
+      def field_key(field, wire_type)
+        varint((field << 3) | wire_type)
+      end
+
+      def length_delimited(field, bytes)
+        field_key(field, 2) + varint(bytes.bytesize) + bytes
+      end
+
+      def varint(value)
+        bytes = []
+        loop do
+          byte = value & 0x7f
+          value >>= 7
+          bytes << (value.zero? ? byte : byte | 0x80)
+          break if value.zero?
+        end
+        bytes.pack("C*")
+      end
+
+      public
+
       # @return [Symbol] e.g. :not_found
       def code_name
         CODE_NAMES.fetch(@code)

data/lib/tonic/rails/server.rb

@@ -20,8 +20,7 @@ module Tonic
         @router = Router.new
         @native = nil
         @state = :stopped
-        @stop_reader = nil
-        @stop_writer = nil
+        @stop_signal = nil
         @stop_requested = false
         @lock = Mutex.new
       end
@@ -51,12 +50,17 @@ module Tonic
           @configuration.validate!
           Tonic::Rails.native_extension!
           Tonic::Rails._set_shutting_down(false)
-          @stop_reader, @stop_writer = IO.pipe
+          # A Queue rather than a self-pipe: pushing to it is safe from trap
+          # handlers, and unlike pipes it can be waited on with a timeout
+          # on every platform (Windows select() only handles sockets).
+          @stop_signal = Thread::Queue.new
           stop if @stop_requested # requested while we were starting up
           @native = build_native_server
           @native.start_server
+          log_pump = spawn_log_pump
           @state = :running
 
+          request_log = subscribe_request_logger
           previous_handlers = install_signal_handlers ? trap_signals : {}
           workers = Array.new(@configuration.dispatch_threads) { |i| spawn_worker(i) }
           log_startup
@@ -65,11 +69,12 @@ module Tonic
           wait_for_stop(workers)
           shutdown(workers)
         ensure
+          ActiveSupport::Notifications.unsubscribe(request_log) if request_log
           previous_handlers&.each { |signal, handler| Signal.trap(signal, handler || "DEFAULT") }
           @native&.stop_server
+          stop_log_pump(log_pump)
           @native = nil
-          [@stop_reader, @stop_writer].each { |io| io.close if io && !io.closed? }
-          @stop_reader = @stop_writer = nil
+          @stop_signal = nil
           Tonic::Rails._set_shutting_down(false)
           @state = :stopped
         end
@@ -79,9 +84,7 @@ module Tonic
       # other threads; returns immediately.
       def stop
         @stop_requested = true
-        @stop_writer&.write_nonblock(".", exception: false)
-      rescue IOError
-        # Already stopped.
+        @stop_signal&.push(:stop)
       end
 
       def running?
@@ -113,7 +116,6 @@ module Tonic
         native.set_worker_threads(config.worker_threads || 0)
         native.set_keepalive(config.keepalive_interval.to_f, config.keepalive_timeout.to_f)
         native.set_dispatch_queue_size(config.dispatch_queue_size)
-        native.set_log_requests(config.log_requests ? true : false)
         native.set_compression(config.compression ? true : false)
         native.set_reflection(config.reflection ? true : false)
         native.set_reflection_descriptors(Reflection.file_descriptors(@router.service_names)) if config.reflection
@@ -133,8 +135,9 @@ module Tonic
         end
 
         guarded = lambda do |path, metadata, transport|
-          call.call(path, metadata, transport)
-        rescue RpcError
+          Instrumentation.instrument(path, metadata) { call.call(path, metadata, transport) }
+        rescue RpcError => e
+          attach_error_trailers(transport, e)
           raise
         rescue StandardError => e
           Tonic::Rails.log_exception(e, path)
@@ -144,6 +147,15 @@ module Tonic
         wrap_with_rails_executor(guarded)
       end
 
+      # An RpcError's own metadata and rich details travel as trailers.
+      def attach_error_trailers(transport, error)
+        return if error.metadata.empty? && error.details.empty?
+
+        transport[:sender]&.add_trailers(error.trailers)
+      rescue StandardError => e
+        Tonic::Rails.log_exception(e, "RpcError trailers")
+      end
+
       # Each RPC runs inside the Rails executor (or reloader, when code
       # reloading is on): ActiveRecord connections are returned, query
       # caches and CurrentAttributes are reset — the same isolation Rack
@@ -156,6 +168,41 @@ module Tonic
         ->(path, metadata, transport) { wrapper.wrap { callback.call(path, metadata, transport) } }
       end
 
+      def subscribe_request_logger
+        return unless @configuration.log_requests && @configuration.logger
+
+        Instrumentation::RequestLogger.new(@configuration.logger).subscribe
+      end
+
+      # Transport events from the Rust side (rejected calls, expired
+      # deadlines, refused connections, faults) can't call Ruby directly;
+      # this thread drains them into the configured logger.
+      def spawn_log_pump
+        native = @native
+        logger = @configuration.logger
+        @log_pump_running = true
+        Thread.new do
+          Thread.current.name = "tonic-rails-log"
+          write_transport_logs(logger, native.next_log_events(0.25)) while @log_pump_running
+          write_transport_logs(logger, native.next_log_events(0)) # whatever shutdown produced
+        rescue StandardError => e
+          warn("tonic-rails: log thread stopped: #{e.class}: #{e.message}")
+        end
+      end
+
+      def stop_log_pump(thread)
+        return unless thread
+
+        @log_pump_running = false
+        thread.join(2)
+      end
+
+      def write_transport_logs(logger, events)
+        return unless logger
+
+        events.each { |level, message| logger.public_send(level, "tonic-rails: #{message}") }
+      end
+
       def spawn_worker(index)
         native = @native
         Thread.new do
@@ -174,7 +221,7 @@ module Tonic
 
       def wait_for_stop(workers)
         loop do
-          break if @stop_reader.wait_readable(1)
+          break if @stop_signal.pop(timeout: 1)
 
           dead = workers.reject(&:alive?)
           unless dead.empty?

data/lib/tonic/rails/testing.rb

@@ -28,19 +28,35 @@ module Tonic
         attr_reader :error
       end
 
-      # Response side of a call: collects encoded messages.
+      # Response side of a call: collects encoded messages and metadata.
       class Sender
-        attr_reader :messages
+        attr_reader :messages, :headers, :trailers
 
         def initialize
           @messages = []
+          @headers = {}
+          @trailers = {}
         end
 
         def push(bytes)
           @messages << bytes
         end
+
+        def send_headers(headers)
+          raise "response headers must be sent before any response message" unless @messages.empty?
+
+          @headers.merge!(headers)
+        end
+
+        def add_trailers(trailers)
+          @trailers.merge!(trailers)
+        end
       end
 
+      # What a call produced: the response (or responses, for streaming),
+      # plus the response headers and trailers as they'd go on the wire.
+      Result = Struct.new(:response, :headers, :trailers)
+
       module_function
 
       # @param service_class [Class] handler class
@@ -53,6 +69,18 @@ module Tonic
       #   an Array of responses for server- and bidi-streaming RPCs
       # @raise [RpcError] when the handler ends the call with a status
       def call(service_class, rpc_name, request, metadata: {}, timeout_ms: nil)
+        invoke(service_class, rpc_name, request, metadata: metadata, timeout_ms: timeout_ms).response
+      end
+
+      # Like #call, but returns a Result with the response metadata too:
+      #
+      #   result = Tonic::Rails::Testing.invoke(ItemService, :GetItem, { id: 1 })
+      #   result.response.name           # => "Widget"
+      #   result.headers["x-cache"]      # => "hit"
+      #   result.trailers["x-cost-ms"]   # => "3"
+      #
+      # @return [Result]
+      def invoke(service_class, rpc_name, request, metadata: {}, timeout_ms: nil)
         spec = service_class.grpc_rpcs.fetch(rpc_name.to_s) do
           raise ArgumentError, "#{service_class} has no RPC #{rpc_name}"
         end
@@ -69,11 +97,12 @@ module Tonic
           timeout_ms: timeout_ms,
         )
 
-        if spec[:response_stream]
+        response = if spec[:response_stream]
           sender.messages.map { |bytes| spec[:response].decode(bytes) }
         else
           spec[:response].decode(result)
         end
+        Result.new(response, sender.headers, sender.trailers)
       end
 
       def encode(klass, message)

data/lib/tonic/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Tonic
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/tonic-rails.rb

@@ -10,9 +10,11 @@ module Tonic
 end
 
 require "tonic/rails/version"
+require "tonic/rails/metadata"
 require "tonic/rails/rpc_error"
 require "tonic/rails/configuration"
 require "tonic/rails/router"
+require "tonic/rails/instrumentation"
 require "tonic/rails/base"
 require "tonic/rails/reflection"
 require "tonic/rails/server"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tonic-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Tanous
@@ -77,11 +77,15 @@ files:
 - ext/tonic_rails_native/src/framing.rs
 - ext/tonic_rails_native/src/gvl.rs
 - ext/tonic_rails_native/src/lib.rs
+- ext/tonic_rails_native/src/log.rs
 - ext/tonic_rails_native/src/net.rs
 - ext/tonic_rails_native/src/server.rs
+- lib/puma/plugin/tonic_rails.rb
 - lib/tonic-rails.rb
 - lib/tonic/rails/base.rb
 - lib/tonic/rails/configuration.rb
+- lib/tonic/rails/instrumentation.rb
+- lib/tonic/rails/metadata.rb
 - lib/tonic/rails/railtie.rb
 - lib/tonic/rails/reflection.rb
 - lib/tonic/rails/router.rb