tonic-rails 0.1.0-x86_64-linux-gnu → 0.3.0-x86_64-linux-gnu

data/lib/tonic/rails/peer.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Tonic
+  module Rails
+    # The client on the other end of an RPC, available in handlers as
+    # `peer`:
+    #
+    #   peer.address       # => "10.0.4.17:51234"
+    #   peer.ip            # => "10.0.4.17"
+    #   peer.certificate   # => OpenSSL::X509::Certificate, with mutual TLS
+    #   peer.certificate&.subject.to_s  # => "/CN=billing-service"
+    class Peer
+      # @return [String, nil] "ip:port" ("[ipv6]:port" for IPv6)
+      attr_reader :address
+
+      # @param address [String, nil]
+      # @param certificates [Array<String>] DER-encoded chain, leaf first
+      def initialize(address = nil, certificates = [])
+        @address = address
+        @certificate_ders = certificates
+      end
+
+      # @return [String, nil]
+      def ip
+        return unless address
+
+        host = address.rpartition(":").first
+        host.delete_prefix("[").delete_suffix("]")
+      end
+
+      # @return [Integer, nil]
+      def port
+        address && Integer(address.rpartition(":").last, exception: false)
+      end
+
+      # The client certificate presented over mutual TLS, or nil.
+      # @return [OpenSSL::X509::Certificate, nil]
+      def certificate
+        certificate_chain.first
+      end
+
+      # @return [Array<OpenSSL::X509::Certificate>] leaf first
+      def certificate_chain
+        @certificate_chain ||= begin
+          require "openssl"
+          @certificate_ders.map { |der| OpenSSL::X509::Certificate.new(der) }
+        end
+      end
+
+      # True when the client authenticated with a certificate.
+      def authenticated?
+        !@certificate_ders.empty?
+      end
+
+      def inspect
+        "#<#{self.class.name} #{address || 'unknown'}#{' (certificate)' if authenticated?}>"
+      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/router.rb

@@ -38,6 +38,7 @@ module Tonic
           reader: call[:reader],
           sender: call[:sender],
           timeout_ms: call[:timeout_ms],
+          peer: Peer.new(call[:peer_address], call[:peer_certificates] || []),
         )
       end
 

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,9 +20,9 @@ module Tonic
         @router = Router.new
         @native = nil
         @state = :stopped
-        @stop_reader = nil
-        @stop_writer = nil
+        @stop_signal = nil
         @stop_requested = false
+        @health = Health.new(configuration, @router)
         @lock = Mutex.new
       end
 
@@ -51,25 +51,34 @@ 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
+          @health.attach(@native)
           @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
           yield self if block_given?
 
           wait_for_stop(workers)
+          @health.detach
           shutdown(workers)
         ensure
+          ActiveSupport::Notifications.unsubscribe(request_log) if request_log
           previous_handlers&.each { |signal, handler| Signal.trap(signal, handler || "DEFAULT") }
+          @health.detach
           @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,15 +88,32 @@ 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?
         @state == :running
       end
 
+      # Mark the whole server, or the given services (fully-qualified
+      # names), SERVING in grpc.health.v1.  Takes effect immediately when
+      # running, otherwise when the server starts.
+      #
+      # With `config.health_check`, a service reports SERVING only while the
+      # check passes *and* it's marked serving here.
+      def serving!(*services)
+        @health.mark(services, true)
+        self
+      end
+
+      # Mark the whole server, or the given services, NOT_SERVING (e.g. for
+      # maintenance), so load balancers and readiness probes route around
+      # this instance.  Calls are still served.
+      def not_serving!(*services)
+        @health.mark(services, false)
+        self
+      end
+
       # @return [Hash{Symbol=>Integer}] request and connection counters
       def stats
         native = @native
@@ -113,7 +139,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 +158,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 +170,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 +191,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 +244,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/tasks/tonic-rails.rake

@@ -27,7 +27,19 @@ namespace :tonic_rails do
     ruby_out = ENV.fetch("RUBY_OUT", "lib/grpc")
     protos = Dir.glob(File.join(proto_dir, "**", "*.proto"))
     abort "No .proto files found in #{proto_dir}/" if protos.empty?
-    abort "protoc not found on PATH. Install the Protocol Buffers compiler." unless system("protoc", "--version", out: File::NULL)
+    version = begin
+      IO.popen(%w[protoc --version], err: File::NULL, &:read)[/\d+(\.\d+)+/]
+    rescue SystemCallError
+      nil
+    end
+    abort "protoc not found on PATH. Install the Protocol Buffers compiler (22.0 or newer)." unless version
+    # protoc before 22 emits the Ruby DSL that google-protobuf 4 removed
+    # (`undefined method 'build' for DescriptorPool` at load time).
+    major = version.split(".").then { |parts| parts.first == "3" ? parts[1].to_i : parts.first.to_i }
+    if major < 22
+      abort "protoc #{version} is too old for google-protobuf 4: install protoc 22.0 or newer " \
+            "(distribution packages are often older; see https://github.com/protocolbuffers/protobuf/releases)."
+    end
 
     FileUtils.mkdir_p(ruby_out)
     sh "protoc", "--ruby_out=#{ruby_out}", "-I#{proto_dir}", *protos

data/lib/tonic/rails/testing/errors.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Tonic
+  module Rails
+    module Testing
+      # Shared helpers for the RSpec matcher and Minitest assertions.
+      # @api private
+      module Errors
+        module_function
+
+        # Exceptions that carry a gRPC status: tonic-rails' own, and the
+        # official grpc gem client's, when it's loaded.
+        def classes
+          [Tonic::Rails::RpcError, (GRPC::BadStatus if defined?(GRPC::BadStatus))].compact
+        end
+
+        def status?(error)
+          classes.any? { |klass| error.is_a?(klass) }
+        end
+
+        # @return [Integer]
+        def code(error)
+          error.code
+        end
+
+        # @return [String] the status message the client sees.  The grpc
+        # gem keeps it in #details (its #message adds the code).
+        def message(error)
+          text = defined?(GRPC::BadStatus) && error.is_a?(GRPC::BadStatus) ? error.details.to_s : error.message
+          text.dup.force_encoding(Encoding::UTF_8)
+        end
+
+        def code_name(code)
+          Tonic::Rails::RpcError::CODE_NAMES.fetch(code, code)
+        end
+
+        def message_matches?(expected, actual)
+          expected.is_a?(Regexp) ? expected.match?(actual) : expected.to_s == actual
+        end
+
+        def describe(error)
+          "#{code_name(code(error)).to_s.upcase} (#{message(error).inspect})"
+        end
+      end
+    end
+  end
+end

data/lib/tonic/rails/testing/minitest.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "tonic/rails/testing"
+require "tonic/rails/testing/errors"
+
+module Tonic
+  module Rails
+    module Testing
+      # Minitest assertions for gRPC statuses:
+      #
+      #   class ItemServiceTest < ActiveSupport::TestCase
+      #     include Tonic::Rails::Testing::Assertions
+      #
+      #     test "missing items" do
+      #       error = assert_grpc_error(:not_found) { Tonic::Rails::Testing.call(ItemService, :GetItem, { id: 0 }) }
+      #       assert_match(/0/, error.message)
+      #     end
+      #   end
+      module Assertions
+        # Asserts the block raises a gRPC status (Tonic::Rails::RpcError or
+        # GRPC::BadStatus) with the given code and, optionally, message
+        # (String or Regexp).  Returns the error.
+        def assert_grpc_error(code = nil, message = nil, &)
+          errors = Testing::Errors
+          error = assert_raises(*errors.classes, &)
+          if code
+            expected = Tonic::Rails::RpcError.normalize_code(code)
+            assert_equal(
+              errors.code_name(expected), errors.code_name(errors.code(error)),
+              "Expected gRPC status #{errors.code_name(expected).to_s.upcase}, got #{errors.describe(error)}"
+            )
+          end
+          if message
+            assert(
+              errors.message_matches?(message, errors.message(error)),
+              "Expected gRPC message #{message.inspect}, got #{errors.message(error).inspect}",
+            )
+          end
+          error
+        end
+      end
+    end
+  end
+end

data/lib/tonic/rails/testing/rspec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rspec/expectations"
+require "tonic/rails/testing"
+require "tonic/rails/testing/errors"
+
+# Matches a block that ends with a gRPC status, raised as a
+# Tonic::Rails::RpcError (Testing.call) or a GRPC::BadStatus (the official
+# client):
+#
+#   expect { Tonic::Rails::Testing.call(ItemService, :GetItem, { id: 0 }) }
+#     .to raise_grpc_error(:not_found)
+#   expect { stub.get_item(request) }.to raise_grpc_error(:invalid_argument).with_message(/name/)
+#   expect { ... }.to raise_grpc_error   # any non-OK status
+RSpec::Matchers.define :raise_grpc_error do |expected_code = nil|
+  errors = Tonic::Rails::Testing::Errors
+
+  supports_block_expectations
+
+  chain(:with_message) { |message| @expected_message = message }
+
+  match do |block|
+    @expected = expected_code && Tonic::Rails::RpcError.normalize_code(expected_code)
+    begin
+      block.call
+      @error = nil
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      raise unless errors.status?(e)
+
+      @error = e
+    end
+    return false unless @error
+
+    (@expected.nil? || errors.code(@error) == @expected) &&
+      (!defined?(@expected_message) || errors.message_matches?(@expected_message, errors.message(@error)))
+  end
+
+  description do
+    text = +"raise a gRPC error"
+    text << " #{errors.code_name(@expected).to_s.upcase}" if @expected
+    text << " with message #{@expected_message.inspect}" if defined?(@expected_message)
+    text
+  end
+
+  failure_message do
+    actual = @error ? "got #{errors.describe(@error)}" : "nothing was raised"
+    "expected block to #{description}, but #{actual}"
+  end
+
+  failure_message_when_negated do
+    "expected block not to #{description}, but got #{errors.describe(@error)}"
+  end
+end

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
@@ -49,10 +65,23 @@ module Tonic
       #   request; an Array of them for client- and bidi-streaming RPCs
       # @param metadata [Hash{String=>String}]
       # @param timeout_ms [Integer, nil] simulated client deadline
+      # @param peer [Tonic::Rails::Peer, nil] simulated client (address, certificates)
       # @return [Google::Protobuf::AbstractMessage, Array] the response, or
       #   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)
+      def call(service_class, rpc_name, request, metadata: {}, timeout_ms: nil, peer: nil)
+        invoke(service_class, rpc_name, request, metadata: metadata, timeout_ms: timeout_ms, peer: peer).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, peer: nil)
         spec = service_class.grpc_rpcs.fetch(rpc_name.to_s) do
           raise ArgumentError, "#{service_class} has no RPC #{rpc_name}"
         end
@@ -67,13 +96,15 @@ module Tonic
           reader: reader,
           sender: sender,
           timeout_ms: timeout_ms,
+          peer: peer,
         )
 
-        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.3.0"
   end
 end

data/lib/tonic-rails.rb

@@ -10,10 +10,14 @@ module Tonic
 end
 
 require "tonic/rails/version"
+require "tonic/rails/metadata"
+require "tonic/rails/peer"
 require "tonic/rails/rpc_error"
 require "tonic/rails/configuration"
 require "tonic/rails/router"
+require "tonic/rails/instrumentation"
 require "tonic/rails/base"
+require "tonic/rails/health"
 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.3.0
 platform: x86_64-linux-gnu
 authors:
 - Matt Tanous
@@ -54,12 +54,24 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- lib/generators/tonic_rails/install/install_generator.rb
+- lib/generators/tonic_rails/install/templates/tonic_rails.rb.tt
+- lib/generators/tonic_rails/service/service_generator.rb
+- lib/generators/tonic_rails/service/templates/handler.rb.tt
+- lib/generators/tonic_rails/service/templates/service.proto.tt
+- lib/generators/tonic_rails/service/templates/service_spec.rb.tt
+- lib/generators/tonic_rails/service/templates/service_test.rb.tt
+- lib/puma/plugin/tonic_rails.rb
 - lib/tonic-rails.rb
 - lib/tonic/rails/3.3/tonic_rails_native.so
 - lib/tonic/rails/3.4/tonic_rails_native.so
 - lib/tonic/rails/4.0/tonic_rails_native.so
 - lib/tonic/rails/base.rb
 - lib/tonic/rails/configuration.rb
+- lib/tonic/rails/health.rb
+- lib/tonic/rails/instrumentation.rb
+- lib/tonic/rails/metadata.rb
+- lib/tonic/rails/peer.rb
 - lib/tonic/rails/railtie.rb
 - lib/tonic/rails/reflection.rb
 - lib/tonic/rails/router.rb
@@ -67,6 +79,9 @@ files:
 - lib/tonic/rails/server.rb
 - lib/tonic/rails/tasks/tonic-rails.rake
 - lib/tonic/rails/testing.rb
+- lib/tonic/rails/testing/errors.rb
+- lib/tonic/rails/testing/minitest.rb
+- lib/tonic/rails/testing/rspec.rb
 - lib/tonic/rails/version.rb
 homepage: https://github.com/CodingAnarchy/tonic-rails
 licenses: