gruf 2.2.2 → 2.9.1

data/gruf.gemspec

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -14,7 +15,7 @@
 # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'gruf/version'
 
 Gem::Specification.new do |spec|
@@ -25,18 +26,41 @@ Gem::Specification.new do |spec|
   spec.licenses      = ['MIT']
 
   spec.summary       = 'gRPC Ruby Framework'
-  spec.description   = spec.summary
+  spec.description   = 'gRPC Ruby Framework for building complex gRPC applications at scale'
   spec.homepage      = 'https://github.com/bigcommerce/gruf'
 
   spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf.gemspec']
-  spec.executables   << 'gruf'
+  spec.executables << 'gruf'
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.4', '< 3.1'
+
   spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'bundler-audit', '>= 0.6'
+  # rubocop:disable Gemspec/RubyVersionGlobalsUsage
+  spec.add_development_dependency(
+    'factory_bot',
+    (Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5') ? '>= 6.1' : '~> 5.2')
+  )
+  # rubocop:enable Gemspec/RubyVersionGlobalsUsage
+  spec.add_development_dependency 'ffaker', '>= 2.15'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'pry-byebug', '>= 3.9'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.8'
+  spec.add_development_dependency 'rspec_junit_formatter', '>= 0.4'
+  spec.add_development_dependency 'rubocop', '>= 1.0'
+  spec.add_development_dependency 'rubocop-performance', '>= 0.0.1'
+  spec.add_development_dependency 'rubocop-rspec', '>= 2.0'
+  spec.add_development_dependency 'rubocop-thread_safety', '>= 0.3'
+  spec.add_development_dependency 'simplecov', '>= 0.16'
 
+  spec.add_runtime_dependency 'activesupport', '> 4'
+  spec.add_runtime_dependency 'concurrent-ruby', '> 1'
+  spec.add_runtime_dependency 'e2mmap', '~> 0.1'
   spec.add_runtime_dependency 'grpc', '~> 1.10'
   spec.add_runtime_dependency 'grpc-tools', '~> 1.10'
-  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'json', '>= 2.3'
+  spec.add_runtime_dependency 'slop', '~> 4.6'
+  spec.add_runtime_dependency 'thwait', '~> 0.1'
 end

data/lib/gruf/cli/executor.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'slop'
+
+module Gruf
+  module Cli
+    ##
+    # Handles execution of the gruf binstub, along with command-line arguments
+    #
+    class Executor
+      ##
+      # @param [Hash|ARGV]
+      #
+      def initialize(
+        args = ARGV,
+        server: nil,
+        services: nil,
+        hook_executor: nil,
+        logger: nil
+      )
+        @args = args
+        setup! # ensure we set some defaults from CLI here so we can allow configuration
+        @services = services || Gruf.services
+        @hook_executor = hook_executor || Gruf::Hooks::Executor.new(hooks: Gruf.hooks&.prepare)
+        @server = server || Gruf::Server.new(Gruf.server_options)
+        @logger = logger || Gruf.logger || ::Logger.new($stderr)
+      end
+
+      ##
+      # Run the server
+      #
+      def run
+        exception = nil
+        begin
+          @services.each { |s| @server.add_service(s) }
+          @hook_executor.call(:before_server_start, server: @server)
+          @server.start!
+        rescue StandardError => e
+          exception = e
+          # Catch the exception here so that we always ensure the post hook runs
+          # This allows systems wanting to provide external server instrumentation
+          # the ability to properly handle server failures
+          @logger.fatal("FATAL ERROR: #{e.message} #{e.backtrace.join("\n")}")
+        end
+        @hook_executor.call(:after_server_stop, server: @server)
+        raise exception if exception
+      end
+
+      private
+
+      ##
+      # Setup options for CLI execution and configure Gruf based on inputs
+      #
+      def setup!
+        opts = parse_options
+
+        Gruf.server_binding_url = opts[:host] if opts[:host]
+        if opts.suppress_default_interceptors?
+          Gruf.interceptors.remove(Gruf::Interceptors::ActiveRecord::ConnectionReset)
+          Gruf.interceptors.remove(Gruf::Interceptors::Instrumentation::OutputMetadataTimer)
+        end
+        Gruf.backtrace_on_error = true if opts.backtrace_on_error?
+      end
+
+      ##
+      # Parse all CLI arguments into an options result
+      #
+      # @return [Slop::Result]
+      #
+      def parse_options
+        ::Slop.parse(@args) do |o|
+          o.null '-h', '--help', 'Display help message' do
+            puts o
+            exit(0)
+          end
+          o.string '--host', 'Specify the binding url for the gRPC service'
+          o.bool '--suppress-default-interceptors', 'Do not use the default interceptors'
+          o.bool '--backtrace-on-error', 'Push backtraces on exceptions to the error serializer'
+          o.null '-v', '--version', 'print gruf version' do
+            puts Gruf::VERSION
+            exit(0)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gruf/client/error.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Gruf
+  class Client < SimpleDelegator
+    ##
+    # Represents an error that was returned from the server's trailing metadata. Used as a custom exception object
+    # that is instead raised in the case of the service returning serialized error data, as opposed to the normal
+    # GRPC::BadStatus error
+    #
+    class Error < StandardError
+      # @return [Object] error The deserialized error
+      attr_reader :error
+
+      ##
+      # Initialize the client error
+      #
+      # @param [Object] error The deserialized error
+      #
+      def initialize(error)
+        @error = error
+        super
+      end
+    end
+
+    ##
+    # See https://github.com/grpc/grpc-go/blob/master/codes/codes.go for a detailed summary of each error type
+    #
+    module Errors
+      class Base < Gruf::Client::Error; end
+      class Error < Base; end
+      class Validation < Base; end
+
+      class Ok < Base; end
+
+      class InvalidArgument < Validation; end
+      class NotFound < Validation; end
+      class AlreadyExists < Validation; end
+      class OutOfRange < Validation; end
+
+      class Cancelled < Error; end
+      class DataLoss < Error; end
+      class DeadlineExceeded < Error; end
+      class FailedPrecondition < Error; end
+      class Internal < Error; end
+      class PermissionDenied < Error; end
+      class ResourceExhausted < Error; end
+      class Unauthenticated < Error; end
+      class Unavailable < Error; end
+      class Unimplemented < Error; end
+      class Unknown < Error; end
+    end
+  end
+end

data/lib/gruf/client/error_factory.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Gruf
+  class Client < SimpleDelegator
+    ##
+    # Translates exceptions into Gruf::Client::Errors
+    #
+    class ErrorFactory
+      ##
+      # @param [Class] default_class
+      # @param [Class] deserializer_class
+      # @param [String|Symbol] metadata_key
+      #
+      def initialize(
+        default_class: nil,
+        deserializer_class: nil,
+        metadata_key: nil
+      )
+        @default_class = default_class || Gruf::Client::Errors::Internal
+        @metadata_key = (metadata_key || Gruf.error_metadata_key).to_s
+        @deserializer_class = deserializer_class || default_serializer
+      end
+
+      ##
+      # Determine the proper error class to raise given the incoming exception. This will attempt to coalesce the
+      # exception object into the appropriate Gruf::Client::Errors subclass, or fallback to the default class if none
+      # is found (or it is a StandardError or higher-level error). It will leave alone Signals instead of attempting to
+      # coalesce them.
+      #
+      # @param [Exception] exception
+      # @return [Gruf::Client::Errors::Base|SignalException]
+      #
+      def from_exception(exception)
+        # passthrough on Signals, we don't want to mess with these
+        return exception if exception.is_a?(SignalException)
+
+        exception_class = determine_class(exception)
+        if exception.is_a?(GRPC::BadStatus)
+          # if it's a GRPC::BadStatus code, let's check for any trailing error metadata and decode it
+          exception_class.new(deserialize(exception))
+        else
+          # otherwise, let's just capture the error and build the wrapper class
+          exception_class.new(exception)
+        end
+      end
+
+      private
+
+      ##
+      # Deserialize any trailing metadata error payload from the exception
+      #
+      # @param [Gruf::Client::Errors::Base]
+      # @return [String]
+      #
+      def deserialize(exception)
+        if exception.respond_to?(:metadata)
+          key = exception.metadata.key?(@metadata_key.to_s) ? @metadata_key.to_s : @metadata_key.to_sym
+          return @deserializer_class.new(exception.metadata[key]).deserialize if exception.metadata.key?(key)
+        end
+
+        exception
+      end
+
+      ##
+      # @param [Exception] exception
+      # @return [Gruf::Client::Errors::Base]
+      #
+      def determine_class(exception)
+        error_class = Gruf::Client::Errors.const_get(exception.class.name.demodulize)
+
+        # Ruby module inheritance will have StandardError, ScriptError, etc still get to this point
+        # So we need to explicitly check for ancestry here
+        return @default_class unless error_class.ancestors.include?(Gruf::Client::Errors::Base)
+
+        error_class
+      rescue NameError => _e
+        @default_class
+      end
+
+      ##
+      # @return [Gruf::Serializers::Errors::Base]
+      #
+      def default_serializer
+        return Gruf::Serializers::Errors::Json unless Gruf.error_serializer
+
+        Gruf.error_serializer.is_a?(Class) ? Gruf.error_serializer : Gruf.error_serializer.to_s.constantize
+      end
+    end
+  end
+end

data/lib/gruf/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -13,6 +15,9 @@
 # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
+require_relative 'client/error'
+require_relative 'client/error_factory'
+
 module Gruf
   ##
   # Abstracts out the calling interface for interacting with gRPC clients. Streamlines calling and provides
@@ -33,25 +38,6 @@ module Gruf
   class Client < SimpleDelegator
     include Gruf::Loggable
 
-    ##
-    # Represents an error that was returned from the server's trailing metadata. Used as a custom exception object
-    # that is instead raised in the case of the service returning serialized error data, as opposed to the normal
-    # GRPC::BadStatus error
-    #
-    class Error < StandardError
-      # @return [Object] error The deserialized error
-      attr_reader :error
-
-      ##
-      # Initialize the client error
-      #
-      # @param [Object] error The deserialized error
-      #
-      def initialize(error)
-        @error = error
-      end
-    end
-
     # @return [Class] The base, friendly name of the service being requested
     attr_reader :base_klass
     # @return [Class] The class name of the gRPC service being requested
@@ -72,9 +58,12 @@ module Gruf
       @base_klass = service
       @service_klass = "#{base_klass}::Service".constantize
       @opts = options || {}
-      @opts[:password] = options.fetch(:password, '').to_s
-      @opts[:hostname] = options.fetch(:hostname, Gruf.default_client_host)
-      client = "#{service}::Stub".constantize.new(@opts[:hostname], build_ssl_credentials, client_options)
+      @opts[:password] = @opts.fetch(:password, '').to_s
+      @opts[:hostname] = @opts.fetch(:hostname, Gruf.default_client_host)
+      @opts[:channel_credentials] = @opts.fetch(:channel_credentials, Gruf.default_channel_credentials)
+      @error_factory = Gruf::Client::ErrorFactory.new
+      client_options[:timeout] = parse_timeout(client_options[:timeout]) if client_options.key?(:timeout)
+      client = "#{service}::Stub".constantize.new(@opts[:hostname], build_ssl_credentials, **client_options)
       super(client)
     end
 
@@ -82,8 +71,8 @@ module Gruf
     # Call the client's method with given params
     #
     # @param [String|Symbol] request_method The method that is being requested on the service
-    # @param [Hash] params (Optional) A hash of parameters that will be inserted into the gRPC request message that is required
-    # for the given above call
+    # @param [Hash] params (Optional) A hash of parameters that will be inserted into the gRPC request message that is
+    # required for the given above call
     # @param [Hash] metadata (Optional) A hash of metadata key/values that are transported with the client request
     # @param [Hash] opts (Optional) A hash of options to send to the gRPC request_response method
     # @return [Gruf::Response] The response from the server
@@ -96,18 +85,15 @@ module Gruf
       md = build_metadata(metadata)
       call_sig = call_signature(request_method)
 
-      raise NotImplementedError, "The method #{request_method} has not been implemented in this service." unless call_sig
+      unless call_sig
+        raise NotImplementedError, "The method #{request_method} has not been implemented in this service."
+      end
+
+      resp, operation = execute(call_sig, req, md, opts, &block)
 
-      resp = execute(call_sig, req, md, opts, &block)
+      raise @error_factory.from_exception(resp.result) unless resp.success?
 
-      Gruf::Response.new(resp.result, resp.time)
-    rescue GRPC::BadStatus => e
-      emk = Gruf.error_metadata_key.to_s
-      raise Gruf::Client::Error, error_deserializer_class.new(e.metadata[emk]).deserialize if e.respond_to?(:metadata) && e.metadata.key?(emk)
-      raise # passthrough
-    rescue StandardError => e
-      Gruf.logger.error e.message
-      raise
+      Gruf::Response.new(operation: operation, message: resp.result, execution_time: resp.time)
     end
 
     ##
@@ -137,13 +123,17 @@ module Gruf
     # @param [Object] req (Optional) The protobuf request message to send
     # @param [Hash] metadata (Optional) A hash of metadata key/values that are transported with the client request
     # @param [Hash] opts (Optional) A hash of options to send to the gRPC request_response method
+    # @return [Array<Gruf::Timer::Result, GRPC::ActiveCall::Operation>]
     #
     def execute(call_sig, req, metadata, opts = {}, &block)
-      Timer.time do
+      operation = nil
+      result = Gruf::Timer.time do
         opts[:return_op] = true
         opts[:metadata] = metadata
-        send(call_sig, req, opts, &block)
+        operation = send(call_sig, req, opts, &block)
+        operation.execute
       end
+      [result, operation]
     end
 
     ##
@@ -165,7 +155,7 @@ module Gruf
     #
     def request_object(request_method, params = {})
       desc = rpc_desc(request_method)
-      desc && desc.input ? desc.input.new(params) : nil
+      desc&.input ? desc.input.new(params) : nil
     end
 
     ##
@@ -175,7 +165,7 @@ module Gruf
     #
     def call_signature(request_method)
       desc = rpc_desc(request_method)
-      desc && desc.name ? desc.name.to_s.underscore.to_sym : nil
+      desc&.name ? desc.name.to_s.underscore.to_sym : nil
     end
 
     ##
@@ -201,6 +191,8 @@ module Gruf
     #
     # :nocov:
     def build_ssl_credentials
+      return opts[:channel_credentials] if opts[:channel_credentials]
+
       cert = nil
       if opts[:ssl_certificate_file]
         cert = File.read(opts[:ssl_certificate_file]).to_s.strip
@@ -224,5 +216,27 @@ module Gruf
         Gruf::Serializers::Errors::Json
       end
     end
+
+    ##
+    # Handle various timeout values and prevent improper value setting
+    #
+    # @see GRPC::Core::TimeConsts#from_relative_time
+    # @param [mixed] timeout
+    # @return [Float]
+    # @return [GRPC::Core::TimeSpec]
+    #
+    def parse_timeout(timeout)
+      if timeout.nil?
+        GRPC::Core::TimeConsts::ZERO
+      elsif timeout.is_a?(GRPC::Core::TimeSpec)
+        timeout
+      elsif timeout.is_a?(Numeric)
+        timeout
+      elsif timeout.respond_to?(:to_f)
+        timeout.to_f
+      else
+        raise ArgumentError, 'timeout is not a valid value: does not respond to to_f'
+      end
+    end
   end
 end

data/lib/gruf/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -23,6 +25,8 @@ module Gruf
       server_binding_url: '0.0.0.0:9001',
       server_options: {},
       interceptors: nil,
+      hooks: nil,
+      default_channel_credentials: nil,
       default_client_host: '',
       use_ssl: false,
       ssl_crt_file: '',
@@ -36,17 +40,32 @@ module Gruf
       append_server_errors_to_trailing_metadata: true,
       use_default_interceptors: true,
       backtrace_on_error: false,
+      backtrace_limit: 10,
       use_exception_message: true,
-      internal_error_message: 'Internal Server Error'
+      internal_error_message: 'Internal Server Error',
+      event_listener_proc: nil,
+      synchronized_client_internal_cache_expiry: 60,
+      rpc_server_options: {
+        pool_size: GRPC::RpcServer::DEFAULT_POOL_SIZE,
+        max_waiting_requests: GRPC::RpcServer::DEFAULT_MAX_WAITING_REQUESTS,
+        poll_period: GRPC::RpcServer::DEFAULT_POLL_PERIOD,
+        pool_keep_alive: GRPC::Pool::DEFAULT_KEEP_ALIVE,
+        connect_md_proc: nil,
+        server_args: {}
+      }.freeze
     }.freeze
 
-    attr_accessor *VALID_CONFIG_KEYS.keys
+    attr_accessor(* VALID_CONFIG_KEYS.keys)
 
     ##
     # Whenever this is extended into a class, setup the defaults
     #
     def self.extended(base)
-      base.reset
+      if defined?(Rails)
+        Gruf::Integrations::Rails::Railtie.config.before_initialize { base.reset }
+      else
+        base.reset
+      end
     end
 
     ##
@@ -79,15 +98,16 @@ module Gruf
     #
     def reset
       VALID_CONFIG_KEYS.each do |k, v|
-        send((k.to_s + '='), v)
+        send("#{k}=", v)
       end
       self.interceptors = Gruf::Interceptors::Registry.new
+      self.hooks = Gruf::Hooks::Registry.new
       self.root_path = Rails.root.to_s.chomp('/') if defined?(Rails)
       if defined?(Rails) && Rails.logger
         self.logger = Rails.logger
       else
         require 'logger'
-        self.logger = ::Logger.new(STDOUT)
+        self.logger = ::Logger.new($stdout)
       end
       self.grpc_logger = logger if grpc_logger.nil?
       self.ssl_crt_file = "#{root_path}config/ssl/#{environment}.crt"

data/lib/gruf/controllers/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -29,14 +31,19 @@ module Gruf
       # @var [Gruf::Error] error
       attr_reader :error
 
+      class << self
+        # @var [GRPC::GenericService] bound_service
+        attr_reader :bound_service
+      end
+
       ##
       # Initialize the controller within the given request context
       #
-      # @param [Symbol] method_key
-      # @param [GRPC::GenericService] service
-      # @param [GRPC::RpcDesc] rpc_desc
-      # @param [GRPC::ActiveCall] active_call
-      # @param [Google::Protobuf::MessageExts] message
+      # @param [Symbol] method_key The gRPC method that this controller relates to
+      # @param [GRPC::GenericService] service The gRPC service stub for this controller
+      # @param [GRPC::RpcDesc] rpc_desc The RPC descriptor for this service method
+      # @param [GRPC::ActiveCall] active_call The gRPC ActiveCall object
+      # @param [Google::Protobuf::MessageExts] message The incoming protobuf request message
       #
       def initialize(method_key:, service:, rpc_desc:, active_call:, message:)
         @request = Request.new(
@@ -53,25 +60,41 @@ module Gruf
       ##
       # Bind the controller to the given service and add it to the service registry
       #
-      # @param [GRPC::GenericService] service
+      # @param [GRPC::GenericService] service The name of the service to bind this controller to
       #
       def self.bind(service)
-        Gruf.services << service.name.constantize
-        ServiceBinder.new(service).bind!(self)
+        service_class = service.name.constantize
+        Gruf.services << service_class
+        # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+        @bound_service = service_class
+        # rubocop:enable ThreadSafety/InstanceVariableInClassMethod
+        ServiceBinder.new(service_class).bind!(self)
+      end
+
+      ##
+      # Call a method on this controller.
+      # Override this in a subclass to modify the behavior around processing a method
+      #
+      # @param [Symbol] method_key The name of the gRPC service method being called as a Symbol
+      # @param [block] &block The passed block for executing the method
+      #
+      def process_action(method_key, &block)
+        send(method_key, &block)
       end
 
       ##
       # Call a method on this controller
       #
-      # @param [Symbol] method_key
+      # @param [Symbol] method_key The name of the gRPC service method being called as a Symbol
+      # @param [block] &block The passed block for executing the method
       #
       def call(method_key, &block)
         Interceptors::Context.new(@interceptors).intercept! do
-          send(method_key, &block)
+          process_action(method_key, &block)
         end
       rescue GRPC::BadStatus
-        raise # passthrough
-      rescue StandardError => e
+        raise # passthrough, to be caught by Gruf::Interceptors::Timer
+      rescue GRPC::Core::CallError, StandardError => e # CallError is not a StandardError
         set_debug_info(e.message, e.backtrace) if Gruf.backtrace_on_error
         error_message = Gruf.use_exception_message ? e.message : Gruf.internal_error_message
         fail!(:internal, :unknown, error_message)