gruf 2.9.1 → 2.15.1

data/lib/gruf/controllers/base.rb

@@ -15,9 +15,6 @@
 # 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 'request'
-require_relative 'service_binder'
-
 module Gruf
   module Controllers
     ##
@@ -26,13 +23,16 @@ module Gruf
     class Base
       include Gruf::Errors::Helpers
 
-      # @var [Gruf::Controller::Request] request
+      # @!attribute [r] request
+      #   @return [Gruf::Controller::Request] The incoming request
       attr_reader :request
-      # @var [Gruf::Error] error
+      # @!attribute [r] error
+      #   @return [Gruf::Error] The current error on the controller
       attr_reader :error
 
       class << self
-        # @var [GRPC::GenericService] bound_service
+        # @!attribute [r] bound_service
+        #   @return [GRPC::GenericService] bound_service The bound gRPC service class
         attr_reader :bound_service
       end
 
@@ -64,11 +64,12 @@ module Gruf
       #
       def self.bind(service)
         service_class = service.name.constantize
-        Gruf.services << service_class
+        ::Gruf.logger.debug "[gruf] Binding #{service_class} to #{name}"
+        ::Gruf.services << service_class
         # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
         @bound_service = service_class
         # rubocop:enable ThreadSafety/InstanceVariableInClassMethod
-        ServiceBinder.new(service_class).bind!(self)
+        ServiceBinder.bind!(service: service_class, controller: self)
       end
 
       ##
@@ -89,6 +90,7 @@ module Gruf
       # @param [block] &block The passed block for executing the method
       #
       def call(method_key, &block)
+        ::Gruf.autoloaders.reload if ::Gruf.development?
         Interceptors::Context.new(@interceptors).intercept! do
           process_action(method_key, &block)
         end

data/lib/gruf/controllers/request.rb

@@ -21,15 +21,20 @@ module Gruf
     # Encapsulates a request for a controller
     #
     class Request
-      # @var [Object] message
+      # @!attribute [r] message
+      #   @return [Object] The protobuf message in the request
       attr_reader :message
-      # @var [GRPC::ActiveCall] active_call
+      # @!attribute [r] active_call
+      #   @return [GRPC::ActiveCall] The active call object used for this request
       attr_reader :active_call
-      # @var [Symbol] method_key
+      # @!attribute [r] method_key
+      #   @return [Symbol] The method name being requested
       attr_reader :method_key
-      # @var [Gruf::Controllers::Request::Type] type
+      # @!attribute [r] type
+      #   @return [Gruf::Controllers::Request::Type] The type of request
       attr_reader :type
-      # @var [Class] service
+      # @!attribute [r] service
+      #   @return [Class] The GRPC service class for this request
       attr_reader :service
 
       delegate :metadata, to: :active_call
@@ -76,7 +81,7 @@ module Gruf
       # @return [String] The mapped service key
       #
       def service_key
-        @service.name.underscore.tr('/', '.').gsub('.service', '')
+        @service.name.to_s.underscore.tr('/', '.').gsub('.service', '')
       end
 
       ##
@@ -106,6 +111,7 @@ module Gruf
       # Return all messages for this request, properly handling different request types
       #
       # @return [Enumerable<Object>] All messages for this request
+      # @return [Object] If a bidi streamed request, will return the message object
       #
       def messages
         if client_streamer?

data/lib/gruf/controllers/service_binder.rb

@@ -26,92 +26,79 @@ module Gruf
       #
       class BoundDesc < SimpleDelegator; end
 
-      ##
-      # Initialize a service binder instance with the given service
-      #
-      # @param [GRPC::GenericService] service The gRPC service stub to bind
-      #
-      def initialize(service)
-        @service = service
-      end
-
-      ##
-      # Bind all methods on the service to the passed controller
-      #
-      # @param [Class<Gruf::Controllers::Base>] controller
-      #
-      def bind!(controller)
-        rpc_methods.each { |name, desc| bind_method(controller, name, desc) }
-      end
-
-      private
-
-      ##
-      # Bind the grpc methods to the service, allowing for server interception and execution control
-      #
-      # @param [Gruf::Controllers::Base] controller
-      # @param [Symbol] method_name
-      # @param [BoundDesc] desc
-      #
-      def bind_method(controller, method_name, desc)
-        method_key = method_name.to_s.underscore.to_sym
-        service_ref = @service
+      class << self
+        ##
+        # Bind all methods on the service to the passed controller
+        #
+        # @param [Class<Gruf::Controllers::Base>] controller
+        #
+        def bind!(service:, controller:)
+          rpc_methods = service.rpc_descs.map { |rd| BoundDesc.new(rd) }
+          rpc_methods.each { |name, desc| bind_method(service, controller, name, desc) }
+        end
 
-        @service.class_eval do
-          if desc.request_response?
-            define_method(method_key) do |message, active_call|
-              c = controller.new(
-                method_key: method_key,
-                service: service_ref,
-                message: message,
-                active_call: active_call,
-                rpc_desc: desc
-              )
-              c.call(method_key)
-            end
-          elsif desc.client_streamer?
-            define_method(method_key) do |active_call|
-              c = controller.new(
-                method_key: method_key,
-                service: service_ref,
-                message: proc { |&block| active_call.each_remote_read(&block) },
-                active_call: active_call,
-                rpc_desc: desc
-              )
-              c.call(method_key)
-            end
-          elsif desc.server_streamer?
-            define_method(method_key) do |message, active_call, &block|
-              c = controller.new(
-                method_key: method_key,
-                service: service_ref,
-                message: message,
-                active_call: active_call,
-                rpc_desc: desc
-              )
-              c.call(method_key, &block)
-            end
-          else # bidi
-            define_method(method_key) do |messages, active_call, &block|
-              c = controller.new(
-                method_key: method_key,
-                service: service_ref,
-                message: messages,
-                active_call: active_call,
-                rpc_desc: desc
-              )
-              c.call(method_key, &block)
+        ##
+        # Bind the grpc methods to the service, allowing for server interception and execution control
+        #
+        # @param [Gruf::Controllers::Base] controller
+        # @param [Symbol] method_name
+        # @param [BoundDesc] desc
+        #
+        def bind_method(service_ref, controller, method_name, desc)
+          method_key = method_name.to_s.underscore.to_sym
+          service_ref.class_eval do
+            if desc.request_response?
+              define_method(method_key) do |message, active_call|
+                controller = controller.name.constantize
+                c = controller.new(
+                  method_key: method_key,
+                  service: service_ref,
+                  message: message,
+                  active_call: active_call,
+                  rpc_desc: desc
+                )
+                c.call(method_key)
+              end
+            elsif desc.client_streamer?
+              define_method(method_key) do |active_call|
+                controller = controller.name.constantize
+                c = controller.new(
+                  method_key: method_key,
+                  service: service_ref,
+                  message: proc { |&block| active_call.each_remote_read(&block) },
+                  active_call: active_call,
+                  rpc_desc: desc
+                )
+                c.call(method_key)
+              end
+            elsif desc.server_streamer?
+              define_method(method_key) do |message, active_call, &block|
+                controller = controller.name.constantize
+                c = controller.new(
+                  method_key: method_key,
+                  service: service_ref,
+                  message: message,
+                  active_call: active_call,
+                  rpc_desc: desc
+                )
+                c.call(method_key, &block)
+              end
+            else # bidi
+              define_method(method_key) do |messages, active_call, &block|
+                controller = controller.name.constantize
+                c = controller.new(
+                  method_key: method_key,
+                  service: service_ref,
+                  message: messages,
+                  active_call: active_call,
+                  rpc_desc: desc
+                )
+                c.call(method_key, &block)
+              end
             end
           end
         end
       end
-
-      ##
-      # @return Array<Gruf::Controllers::ServiceBinder::BoundDesc>
-      #
-      def rpc_methods
-        @service.rpc_descs.map { |rd| BoundDesc.new(rd) }
-      end
     end
   end
 end

data/lib/gruf/error.rb

@@ -15,10 +15,6 @@
 # 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 'errors/field'
-require_relative 'errors/debug_info'
-require_relative 'serializers/errors/base'
-require_relative 'serializers/errors/json'
 
 module Gruf
   ##
@@ -59,20 +55,28 @@ module Gruf
     METADATA_SIZE_EXCEEDED_CODE = 'metadata_size_exceeded'
     METADATA_SIZE_EXCEEDED_MSG = 'Metadata too long, risks exceeding http2 trailing metadata limit.'
 
-    # @return [Symbol] The given internal gRPC code for the error
+    # @!attribute code
+    #   @return [Symbol] The given internal gRPC code for the error
     attr_accessor :code
-    # @return [Symbol] An arbitrary application code that can be used for logical processing of the error by the client
+    # @!attribute app_code
+    #   @return [Symbol] An arbitrary application code that can be used for logical processing of the error
+    #     by the client
     attr_accessor :app_code
-    # @return [String] The error message returned by the server
+    # @!attribute message
+    #   @return [String] The error message returned by the server
     attr_accessor :message
-    # @return [Array] An array of field errors that can be returned by the server
+    # @!attribute field_errors
+    #   @return [Array] An array of field errors that can be returned by the server
     attr_accessor :field_errors
-    # @return [Errors::DebugInfo] A object containing debugging information, such as a stack trace and exception name,
-    # that can be used to debug an given error response. This is sent by the server over the trailing metadata.
+    # @!attribute debug_info
+    #   @return [Errors::DebugInfo] A object containing debugging information, such as a stack trace and exception name,
+    #     that can be used to debug an given error response. This is sent by the server over the trailing metadata.
     attr_accessor :debug_info
-    # @return [GRPC::BadStatus] The gRPC BadStatus error object that was generated
+    # @!attribute [w] grpc_error
+    #   @return [GRPC::BadStatus] The gRPC BadStatus error object that was generated
     attr_writer :grpc_error
-    # @return [Hash] The trailing metadata that was attached to the error
+    # @!attribute [r] metadata
+    #   @return [Hash] The trailing metadata that was attached to the error
     attr_reader :metadata
 
     ##

data/lib/gruf/errors/debug_info.rb

@@ -21,9 +21,11 @@ module Gruf
     # Represents debugging information for an exception that occurred in a gRPC service
     #
     class DebugInfo
-      # @return [String] The detail message of the exception
+      # @!attribute [r] detail
+      #   @return [String] The detail message of the exception
       attr_reader :detail
-      # @return [Array<String>] The stack trace generated by the exception as an array of strings
+      # @!attribute [r] stack_trace
+      #   @return [Array<String>] The stack trace generated by the exception as an array of strings
       attr_reader :stack_trace
 
       ##

data/lib/gruf/errors/field.rb

@@ -21,11 +21,14 @@ module Gruf
     # Represents a field-specific error
     #
     class Field
-      # @return [Symbol] The name of the field as a Symbol
+      # @!attribute [r] field_name
+      #   @return [Symbol] The name of the field as a Symbol
       attr_reader :field_name
-      # @return [Symbol] The application error code for the field, e.g. :job_not_found
+      # @!attribute [r] error_code
+      #   @return [Symbol] The application error code for the field, e.g. :job_not_found
       attr_reader :error_code
-      # @return [String] The error message for the field, e.g. "Job with ID 123 not found"
+      # @!attribute [r] message
+      #   @return [String] The error message for the field, e.g. "Job with ID 123 not found"
       attr_reader :message
 
       ##

data/lib/gruf/{logging.rb → grpc_logger.rb}

@@ -16,20 +16,6 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  ##
-  # Handles internal gruf logging requests
-  #
-  module Logger
-    ##
-    # Return the current Gruf logger
-    #
-    # @return [Logger]
-    #
-    def logger
-      Gruf.logger
-    end
-  end
-
   ##
   # Handles grpc internal logging requests
   #

data/lib/gruf/integrations/rails/railtie.rb

@@ -1,9 +1,39 @@
 # 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
   module Integrations
     module Rails
+      ##
+      # Rails integration for Gruf, that currently only manages code autoloading in a Rails context
+      #
       class Railtie < ::Rails::Railtie
+        initializer 'gruf.initializer' do |app|
+          config.before_configuration do
+            # Remove autoloading of the controllers path from Rails' zeitwerk, so that we ensure Gruf's zeitwerk
+            # properly manages them itself. This allows us to manage code reloading and logging in Gruf specifically
+            app.config.eager_load_paths -= [::Gruf.controllers_path] if app.config.respond_to?(:eager_load_paths)
+            if ::Rails.respond_to?(:autoloaders) # if we're on a late enough version of rails
+              ::Rails.autoloaders.each do |autoloader|
+                autoloader.ignore(Gruf.controllers_path)
+              end
+            end
+          end
+        end
       end
     end
   end

data/lib/gruf/interceptors/base.rb

@@ -21,11 +21,14 @@ module Gruf
     # Base class for interception requests
     #
     class Base
-      # @var [Gruf::Controllers::Request] request
+      # @!attribute [r] request
+      #   @return [Gruf::Controllers::Request] request
       attr_reader :request
-      # @var [Gruf::Error] error
+      # @!attribute [r] error
+      #   @return [Gruf::Error] error
       attr_reader :error
-      # @var [Hash] options
+      # @!attribute [r] options
+      #   @return [Hash] options
       attr_reader :options
 
       ##
@@ -41,13 +44,3 @@ module Gruf
     end
   end
 end
-
-require_relative 'client_interceptor'
-require_relative 'server_interceptor'
-require_relative 'context'
-require_relative 'timer'
-require_relative 'active_record/connection_reset'
-require_relative 'authentication/basic'
-require_relative 'instrumentation/statsd'
-require_relative 'instrumentation/output_metadata_timer'
-require_relative 'instrumentation/request_logging/interceptor'

data/lib/gruf/interceptors/context.rb

@@ -38,7 +38,7 @@ module Gruf
       def intercept!(&block)
         return yield if @interceptors.none?
 
-        i = @interceptors.pop
+        i = @interceptors.shift
         return yield unless i
 
         logger.debug "Intercepting request with interceptor: #{i.class}"

data/lib/gruf/interceptors/instrumentation/request_logging/interceptor.rb

@@ -16,9 +16,6 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 require 'socket'
-require_relative 'formatters/base'
-require_relative 'formatters/logstash'
-require_relative 'formatters/plain'
 
 module Gruf
   module Interceptors

data/lib/gruf/interceptors/timer.rb

@@ -28,8 +28,12 @@ module Gruf
       # @property [Float] elapsed The elapsed time of the request
       #
       class Result
-        attr_reader :message,
-                    :elapsed
+        # @!attribute [r] message
+        #   @return [Object] The returned protobuf message
+        attr_reader :message
+        # @return [r] elapsed
+        #   @return [Float] The time elapsed for this interceptor to execute
+        attr_reader :elapsed
 
         ##
         # @param [Object] message The protobuf message
@@ -53,7 +57,7 @@ module Gruf
         # @return [String] The name of the message class
         #
         def message_class_name
-          @message.class.name
+          @message.class.name.to_s
         end
 
         ##

data/lib/gruf/logger.rb

@@ -0,0 +1,32 @@
+# 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
+  ##
+  # Handles internal gruf logging requests
+  #
+  module Logger
+    ##
+    # Return the current Gruf logger
+    #
+    # @return [Logger]
+    #
+    def logger
+      Gruf.logger
+    end
+  end
+end

data/lib/gruf/outbound/request_context.rb

@@ -21,15 +21,20 @@ module Gruf
     # Encapsulates the context of an outbound client request
     #
     class RequestContext
-      # @var [Symbol]
+      # @!attribute [r] type
+      #   @return [Symbol]
       attr_reader :type
-      # @var [Enumerable] requests
+      # @!attribute [r] requests
+      #   @return [Enumerable] requests
       attr_reader :requests
-      # @var [GRPC::ActiveCall]
+      # @!attribute [r] call
+      #   @return [GRPC::ActiveCall]
       attr_reader :call
-      # @var [Method] method
+      # @!attribute [r] method
+      #   @return [Method] method
       attr_reader :method
-      # @var [Hash] metadata
+      # @!attribute [r] metadata
+      #   @return [Hash] metadata
       attr_reader :metadata
 
       ##
@@ -55,7 +60,7 @@ module Gruf
       # @return [String]
       #
       def method_name
-        @method.to_s.split('/').last
+        @method.to_s.split('/').last.to_s
       end
 
       ##
@@ -64,7 +69,7 @@ module Gruf
       # @return [String]
       #
       def route_key
-        @method[1..-1].underscore.tr('/', '.')
+        @method[1..].to_s.underscore.tr('/', '.')
       end
     end
   end

data/lib/gruf/response.rb

@@ -20,17 +20,23 @@ module Gruf
   # Wraps the active call operation to provide metadata and timing around the request
   #
   class Response
-    # @return [GRPC::ActiveCall::Operation] The operation that was executed for the given request
+    # @!attribute [r] operation
+    #   @return [GRPC::ActiveCall::Operation] The operation that was executed for the given request
     attr_reader :operation
-    # @return [Hash] The metadata that was attached to the operation
+    # @!attribute [r] metadata
+    #   @return [Hash] The metadata that was attached to the operation
     attr_reader :metadata
-    # @return [Hash] The trailing metadata that the service returned
+    # @!attribute [r] trailing_metadata
+    #   @return [Hash] The trailing metadata that the service returned
     attr_reader :trailing_metadata
-    # @return [Time] The set deadline on the call
+    # @!attribute [r] deadline
+    #   @return [Time] The set deadline on the call
     attr_reader :deadline
-    # @return [Boolean] Whether or not the operation was cancelled
+    # @!attribute [r] cancelled
+    #   @return [Boolean] Whether or not the operation was cancelled
     attr_reader :cancelled
-    # @return [Float] The time that the request took to execute
+    # @!attribute [r] execution_time
+    #   @return [Float] The time that the request took to execute
     attr_reader :execution_time
 
     ##

data/lib/gruf/serializers/errors/base.rb

@@ -22,7 +22,8 @@ module Gruf
       # Base class for serialization of errors for transport across the grpc protocol
       #
       class Base
-        # @return [Gruf::Error|String] The error being serialized
+        # @!attribute [r] error
+        #   @return [Gruf::Error|String] The error being serialized
         attr_reader :error
 
         ##