gruf 2.13.1 → 2.17.0

data/lib/gruf/controllers/health_controller.rb

@@ -0,0 +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.
+#
+require 'grpc/health/v1/health_services_pb'
+
+module Gruf
+  module Controllers
+    ##
+    # Dynamic standard grpc health check controller. Can be used as-is, or can use ::Gruf.health_check_hook to
+    # provide custom responses.
+    #
+    class HealthController < Gruf::Controllers::Base
+      bind ::Grpc::Health::V1::Health::Service
+
+      def check
+        health_proc = ::Gruf.health_check_hook
+        return health_proc.call(request, error) if !health_proc.nil? && health_proc.respond_to?(:call)
+
+        ::Grpc::Health::V1::HealthCheckResponse.new(
+          status: ::Grpc::Health::V1::HealthCheckResponse::ServingStatus::SERVING
+        )
+      end
+    end
+  end
+end

data/lib/gruf/controllers/request.rb

@@ -36,6 +36,11 @@ module Gruf
       # @!attribute [r] service
       #   @return [Class] The GRPC service class for this request
       attr_reader :service
+      # @!attribute [r] context
+      #   @return [::ActiveSupport::HashWithIndifferentAccess] An arbitrary hash of key/value entries that are
+      #     accessible for interceptors, that can be used to shared information between interceptors and pass down into
+      #     the controller.
+      attr_reader :context
 
       delegate :metadata, to: :active_call
       delegate :messages, :client_streamer?, :server_streamer?, :bidi_streamer?, :request_response?, to: :type
@@ -72,6 +77,7 @@ module Gruf
         @message = message
         @rpc_desc = rpc_desc
         @type = Type.new(rpc_desc)
+        @context = ::ActiveSupport::HashWithIndifferentAccess.new
       end
 
       ##

data/lib/gruf/controllers/service_binder.rb

@@ -26,92 +26,84 @@ 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
+          controller_name = controller.name
+          service_ref.class_eval do
+            if desc.request_response?
+              define_method(method_key) do |message, active_call|
+                Gruf::Autoloaders.controllers.with_fresh_controller(controller_name) do |fresh_controller|
+                  c = fresh_controller.new(
+                    method_key: method_key,
+                    service: service_ref,
+                    message: message,
+                    active_call: active_call,
+                    rpc_desc: desc
+                  )
+                  c.call(method_key)
+                end
+              end
+            elsif desc.client_streamer?
+              define_method(method_key) do |active_call|
+                Gruf::Autoloaders.controllers.with_fresh_controller(controller_name) do |fresh_controller|
+                  c = fresh_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
+              end
+            elsif desc.server_streamer?
+              define_method(method_key) do |message, active_call, &block|
+                Gruf::Autoloaders.controllers.with_fresh_controller(controller_name) do |fresh_controller|
+                  c = fresh_controller.new(
+                    method_key: method_key,
+                    service: service_ref,
+                    message: message,
+                    active_call: active_call,
+                    rpc_desc: desc
+                  )
+                  c.call(method_key, &block)
+                end
+              end
+            else # bidi
+              define_method(method_key) do |messages, active_call, &block|
+                Gruf::Autoloaders.controllers.with_fresh_controller(controller_name) do |fresh_controller|
+                  c = fresh_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
       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
   ##

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/active_record/connection_reset.rb

@@ -27,11 +27,13 @@ module Gruf
         # connection pool, we need to ensure that this is done to properly
         #
         def call
-          ::ActiveRecord::Base.establish_connection if enabled? && !::ActiveRecord::Base.connection.active?
+          if enabled?
+            target_classes.each { |klass| klass.establish_connection unless klass.connection.active? }
+          end
 
           yield
         ensure
-          ::ActiveRecord::Base.clear_active_connections! if enabled?
+          target_classes.each(&:clear_active_connections!) if enabled?
         end
 
         private
@@ -42,6 +44,13 @@ module Gruf
         def enabled?
           defined?(::ActiveRecord::Base)
         end
+
+        ##
+        # @return [Array<Class>] The list of ActiveRecord classes to reset
+        #
+        def target_classes
+          options[:target_classes] || [::ActiveRecord::Base]
+        end
       end
     end
   end

data/lib/gruf/interceptors/base.rb

@@ -44,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/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/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/server.rb

@@ -43,39 +43,45 @@ module Gruf
       @options = opts || {}
       @interceptors = opts.fetch(:interceptor_registry, Gruf.interceptors)
       @interceptors = Gruf::Interceptors::Registry.new unless @interceptors.is_a?(Gruf::Interceptors::Registry)
-      @services = []
+      @services = nil
       @started = false
       @hostname = opts.fetch(:hostname, Gruf.server_binding_url)
       @event_listener_proc = opts.fetch(:event_listener_proc, Gruf.event_listener_proc)
-      setup
     end
 
     ##
     # @return [GRPC::RpcServer] The GRPC server running
     #
     def server
-      @server ||= begin
-        # For backward compatibility, we allow these options to be passed directly
-        # in the Gruf::Server options, or via Gruf.rpc_server_options.
-        server_options = {
-          pool_size: options.fetch(:pool_size, Gruf.rpc_server_options[:pool_size]),
-          max_waiting_requests: options.fetch(:max_waiting_requests, Gruf.rpc_server_options[:max_waiting_requests]),
-          poll_period: options.fetch(:poll_period, Gruf.rpc_server_options[:poll_period]),
-          pool_keep_alive: options.fetch(:pool_keep_alive, Gruf.rpc_server_options[:pool_keep_alive]),
-          connect_md_proc: options.fetch(:connect_md_proc, Gruf.rpc_server_options[:connect_md_proc]),
-          server_args: options.fetch(:server_args, Gruf.rpc_server_options[:server_args])
-        }
-
-        server = if @event_listener_proc
-                   server_options[:event_listener_proc] = @event_listener_proc
-                   Gruf::InstrumentableGrpcServer.new(**server_options)
-                 else
-                   GRPC::RpcServer.new(**server_options)
-                 end
-
-        @port = server.add_http2_port(@hostname, ssl_credentials)
-        @services.each { |s| server.handle(s) }
-        server
+      server_mutex do
+        @server ||= begin
+          # For backward compatibility, we allow these options to be passed directly
+          # in the Gruf::Server options, or via Gruf.rpc_server_options.
+          server_options = {
+            pool_size: options.fetch(:pool_size, Gruf.rpc_server_options[:pool_size]),
+            max_waiting_requests: options.fetch(:max_waiting_requests, Gruf.rpc_server_options[:max_waiting_requests]),
+            poll_period: options.fetch(:poll_period, Gruf.rpc_server_options[:poll_period]),
+            pool_keep_alive: options.fetch(:pool_keep_alive, Gruf.rpc_server_options[:pool_keep_alive]),
+            connect_md_proc: options.fetch(:connect_md_proc, Gruf.rpc_server_options[:connect_md_proc]),
+            server_args: options.fetch(:server_args, Gruf.rpc_server_options[:server_args])
+          }
+
+          server = if @event_listener_proc
+                     server_options[:event_listener_proc] = @event_listener_proc
+                     Gruf::InstrumentableGrpcServer.new(**server_options)
+                   else
+                     GRPC::RpcServer.new(**server_options)
+                   end
+
+          @port = server.add_http2_port(@hostname, ssl_credentials)
+          # do not reference `services` any earlier than this method, as it allows autoloading to take effect
+          # and load services into `Gruf.services` as late as possible, which gives us flexibility with different
+          # execution paths (such as vanilla ruby, grape, multiple Rails versions, etc). The autoloaders are
+          # initially loaded in `Gruf::Cli::Executor` _directly_ before the gRPC services are loaded into the gRPC
+          # server, to allow for loading services as late as possible in the execution chain.
+          services.each { |s| server.handle(s) }
+          server
+        end
       end
     end
 
@@ -87,7 +93,7 @@ module Gruf
       update_proc_title(:starting)
 
       server_thread = Thread.new do
-        logger.info { "Starting gruf server at #{@hostname}..." }
+        logger.info { "[gruf] Starting gruf server at #{@hostname}..." }
         server.run_till_terminated_or_interrupted(KILL_SIGNALS)
       end
       @started = true
@@ -96,7 +102,7 @@ module Gruf
       @started = false
 
       update_proc_title(:stopped)
-      logger.info { 'Goodbye!' }
+      logger.info { '[gruf] Goodbye!' }
     end
     # :nocov:
 
@@ -109,7 +115,7 @@ module Gruf
     def add_service(klass)
       raise ServerAlreadyStartedError if @started
 
-      @services << klass unless @services.include?(klass)
+      @services << klass unless services.include?(klass)
     end
 
     ##
@@ -183,31 +189,11 @@ module Gruf
     private
 
     ##
-    # Setup server
-    #
-    # :nocov:
-    def setup
-      load_controllers
-    end
-    # :nocov:
-
-    ##
-    # Auto-load all gRPC handlers
+    # @return [Array<Class>]
     #
-    # :nocov:
-    def load_controllers
-      return unless File.directory?(controllers_path)
-
-      path = File.realpath(controllers_path)
-      $LOAD_PATH.unshift(path)
-      Dir["#{path}/**/*.rb"].each do |f|
-        next if f.include?('_pb') # exclude if people include proto generated files in app/rpc
-
-        logger.info "- Loading gRPC service file: #{f}"
-        load File.realpath(f)
-      end
+    def services
+      @services ||= (::Gruf.services || (options.fetch(:services, nil) || []))
     end
-    # :nocov:
 
     ##
     # @param [String]
@@ -242,5 +228,17 @@ module Gruf
       Process.setproctitle("gruf #{Gruf::VERSION} -- #{state}")
     end
     # :nocov:
+    #
+
+    ##
+    # Handle thread-safe access to the server
+    #
+    def server_mutex(&block)
+      @server_mutex ||= begin
+        require 'monitor'
+        Monitor.new
+      end
+      @server_mutex.synchronize(&block)
+    end
   end
 end

data/lib/gruf/version.rb

@@ -16,5 +16,5 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  VERSION = '2.13.1'
+  VERSION = '2.17.0'
 end

data/lib/gruf.rb

@@ -17,29 +17,21 @@
 #
 require 'grpc'
 require 'active_support/core_ext/module/delegation'
+require 'active_support/hash_with_indifferent_access'
 require 'active_support/concern'
 require 'active_support/inflector'
 require 'base64'
-require_relative 'gruf/version'
-require_relative 'gruf/logging'
-require_relative 'gruf/loggable'
-require_relative 'gruf/configuration'
-require_relative 'gruf/errors/helpers'
-require_relative 'gruf/cli/executor'
-require_relative 'gruf/controllers/base'
-require_relative 'gruf/outbound/request_context'
-require_relative 'gruf/interceptors/registry'
-require_relative 'gruf/interceptors/base'
-require_relative 'gruf/hooks/registry'
-require_relative 'gruf/hooks/executor'
-require_relative 'gruf/hooks/base'
-require_relative 'gruf/timer'
-require_relative 'gruf/response'
-require_relative 'gruf/error'
-require_relative 'gruf/client'
-require_relative 'gruf/synchronized_client'
-require_relative 'gruf/instrumentable_grpc_server'
-require_relative 'gruf/server'
+
+# use Zeitwerk to lazily autoload all the files in the lib directory
+require 'zeitwerk'
+loader = ::Zeitwerk::Loader.new
+loader.tag = File.basename(__FILE__, '.rb')
+loader.inflector = ::Zeitwerk::GemInflector.new(__FILE__)
+loader.ignore("#{__dir__}/gruf/integrations/rails/railtie.rb")
+loader.ignore("#{__dir__}/gruf/controllers/health_controller.rb")
+loader.push_dir(__dir__)
+loader.setup
+
 require_relative 'gruf/integrations/rails/railtie' if defined?(::Rails)
 
 ##
@@ -47,4 +39,10 @@ require_relative 'gruf/integrations/rails/railtie' if defined?(::Rails)
 #
 module Gruf
   extend Configuration
+
+  class << self
+    def autoloaders
+      Autoloaders
+    end
+  end
 end