gruf 2.14.1 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a94efb294635ae84890e1f131927003b8cacb0306947109c96fd002e02c87fee
-  data.tar.gz: 11983bf914472178ed2935d7ee0faf7c60d4fd2204fc6b7b3b0985449c7b5c37
+  metadata.gz: a807b73598db4fb6caf6e0ed79d164342c1f6f0cfa4b0cf03f83f40cb71baabf
+  data.tar.gz: c750eac85c6739048498c5579dabbcf268bc796e998e26c14c7b6e2a96ad3d88
 SHA512:
-  metadata.gz: bf230312d6315af4534e4bb92bbd7405a9850c1ec415895e7cb25f382239f887b8fadf0940207459d237c81c3fe2da0647244c3b1100f73a441c77e118a9bea6
-  data.tar.gz: e505ca2046aa82164be4656aca0b9ad7f696c070abd5c7ea52f8d6afd6e803feaaef095cf96825a2b8dc8b186f4015b8430f68f0c1f9ce472d2764976d596a4f
+  metadata.gz: 0ab26cdfa7b95fc92694dc328ac66b32994f35ddfb5bf9f63fb235256853f77f1b4c382bb01870c1afd5d037a2e915cacc0d5c8c307c30d480b90f5d0b373736
+  data.tar.gz: 06b7a29c4f6bd167178e68d77c4bc68fa704233232b405fa193db8fb4721895391fce58ab70fd06c92ff6a31a4276f20ac8a00a834e0f4c8757ad03f153abeba

data/CHANGELOG.md

@@ -2,6 +2,15 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.15.0
+
+- Autoload Gruf Controllers with zeitwerk, allowing for code reloading in development environments
+- Add `GRUF_CONTROLLERS_PATH` ENV to allow ENV-based runtime configuration of path to gruf controller files
+- Move `ServiceBinder` from instance to static class for performance improvements
+- Use zeitwerk for autoloading
+- Update gem metadata
+- Update `Gruf:Configuration#environment` to use `ENV.fetch`
+
 ### 2.14.1
 
 - Fix issue where the server object hits thread contention in certain race conditions
@@ -13,9 +22,9 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### 2.13.1
 
-- Fix issue with race condition in server starts where servers may fail to bind connections and never reach  
+- Fix issue with race condition in server starts where servers may fail to bind connections and never reach
   serving state (fixes #147)
- 
+
 ### 2.13.0
 
 - Remove server mutex handling in deference to core grpc signal handling
@@ -27,7 +36,7 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### 2.11.0
 
-- Restrict grpc gem to <= 1.41.0 due to regressions in grpc 1.42.x 
+- Restrict grpc gem to <= 1.41.0 due to regressions in grpc 1.42.x
 - Fallback to stdout logger at INFO if no logger is setup
 - Better handling of namespace collisions with Rails
 - Add `GRPC_SERVER_HOST` and `GRPC_SERVER_PORT` for ENV configuration of the server host+port
@@ -67,7 +76,7 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### 2.8.0
 
-- Pass the controller request object into the request logging formatters [#92]  
+- Pass the controller request object into the request logging formatters [#92]
 
 ### 2.7.1
 
@@ -80,12 +89,12 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 ### 2.6.1
 
 - Add frozen_string_literal: true to files, update rubocop to 0.68
-  
+
 ### 2.6.0
 
 - Drop Ruby 2.2 support
-- Abstract gruf controller's send to make it usable in filters 
-- Adjusts configuration reset into a Railtie for Rails systems to ensure proper OOE 
+- Abstract gruf controller's send to make it usable in filters
+- Adjusts configuration reset into a Railtie for Rails systems to ensure proper OOE
 - Bump rubocop to 0.64, address violations, update activesupport/concurrent-ruby dependencies to have a min version
 
 ### 2.5.2

data/gruf.gemspec

@@ -15,8 +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.
 #
-$LOAD_PATH.push File.expand_path('lib', __dir__)
-require 'gruf/version'
+require_relative 'lib/gruf/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'gruf'
@@ -35,7 +34,14 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6', '< 3.2'
 
-  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/bigcommerce/gruf/issues',
+    'changelog_uri' => 'https://github.com/bigcommerce/gruf/CHANGELOG.md',
+    'homepage_uri' => 'https://github.com/bigcommerce/gruf',
+    'rubygems_mfa_required' => 'true',
+    'source_code_uri' => 'https://github.com/bigcommerce/gruf',
+    'wiki_uri' => 'https://github.com/bigcommerce/gruf/wiki'
+  }
 
   spec.add_development_dependency 'bundler-audit', '>= 0.6'
   # rubocop:disable Gemspec/RubyVersionGlobalsUsage
@@ -64,4 +70,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'json', '>= 2.3'
   spec.add_runtime_dependency 'slop', '>= 4.6'
   spec.add_runtime_dependency 'thwait', '>= 0.1'
+  spec.add_runtime_dependency 'zeitwerk', '>= 2'
 end

data/lib/gruf/autoloaders.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2022-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 for accessing Gruf zeitwerk-based autoloaders
+  #
+  module Autoloaders
+    class << self
+      include Enumerable
+
+      ##
+      # Initialize the autoloaders with a given controllers path
+      #
+      # @param [String] controllers_path The path to Gruf Controllers
+      #
+      def load!(controllers_path:)
+        controllers(controllers_path: controllers_path)
+      end
+
+      ##
+      # Enumerate across the managed set of autoloaders
+      #
+      def each
+        yield controllers
+      end
+
+      ##
+      # Reload all files managed by the autoloader
+      #
+      def reload
+        each(&:reload)
+      end
+
+      ##
+      # Lazily instantiate and memoize the Gruf Controllers autoloader in a thread-safe manner
+      #
+      # @return [::Gruf::Controllers::Autoloader]
+      #
+      # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+      def controllers(controllers_path: nil)
+        controllers_mutex do
+          @controllers ||= ::Gruf::Controllers::Autoloader.new(path: controllers_path || ::Gruf.controllers_path)
+        end
+      end
+      # rubocop:enable ThreadSafety/InstanceVariableInClassMethod
+
+      ##
+      # Handle mutations to the controllers autoloader in a thread-safe manner
+      #
+      # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+      def controllers_mutex(&block)
+        @controllers_mutex ||= begin
+          require 'monitor'
+          Monitor.new
+        end
+        @controllers_mutex.synchronize(&block)
+      end
+      # rubocop:enable ThreadSafety/InstanceVariableInClassMethod
+    end
+  end
+end

data/lib/gruf/cli/executor.rb

@@ -23,8 +23,14 @@ module Gruf
     # Handles execution of the gruf binstub, along with command-line arguments
     #
     class Executor
+      class NoServicesBoundError < StandardError; end
+
       ##
       # @param [Hash|ARGV]
+      # @param [::Gruf::Server|NilClass] server
+      # @param [Array<Class>|NilClass] services
+      # @param [Gruf::Hooks::Executor|NilClass] hook_executor
+      # @param [Logger|NilClass] logger
       #
       def initialize(
         args = ARGV,
@@ -35,7 +41,7 @@ module Gruf
       )
         @args = args
         setup! # ensure we set some defaults from CLI here so we can allow configuration
-        @services = services || Gruf.services
+        @services = services.is_a?(Array) ? 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)
@@ -46,6 +52,17 @@ module Gruf
       #
       def run
         exception = nil
+        # wait to load controllers until last possible second to allow late configuration
+        ::Gruf.autoloaders.load!(controllers_path: Gruf.controllers_path)
+        # allow lazy registering globally as late as possible, this allows more flexible binstub injections
+        @services = ::Gruf.services unless @services&.any?
+
+        unless @services.any?
+          raise NoServicesBoundError,
+                'No services bound to this gruf process; please bind a service to a Gruf controller ' \
+                'to start the server successfully'
+        end
+
         begin
           @services.each { |s| @server.add_service(s) }
           @hook_executor.call(:before_server_start, server: @server)

data/lib/gruf/client/error.rb

@@ -37,33 +37,5 @@ module Gruf
         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/errors.rb

@@ -0,0 +1,48 @@
+# 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
+    ##
+    # 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.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 'client/error'
-require_relative 'client/error_factory'
-
 module Gruf
   ##
   # Abstracts out the calling interface for interacting with gRPC clients. Streamlines calling and provides

data/lib/gruf/configuration.rb

@@ -165,7 +165,8 @@ module Gruf
       determine_loggers
       self.ssl_crt_file = "#{root_path}config/ssl/#{environment}.crt"
       self.ssl_key_file = "#{root_path}config/ssl/#{environment}.key"
-      self.controllers_path = root_path.to_s.empty? ? 'app/rpc' : "#{root_path}/app/rpc"
+      cp = ::ENV.fetch('GRUF_CONTROLLERS_PATH', 'app/rpc').to_s
+      self.controllers_path = root_path.to_s.empty? ? cp : "#{root_path}/#{cp}"
       self.backtrace_on_error = ::ENV.fetch('GRPC_BACKTRACE_ON_ERROR', 0).to_i.positive?
       self.rpc_server_options = {
         max_waiting_requests: ::ENV.fetch('GRPC_SERVER_MAX_WAITING_REQUESTS',
@@ -183,6 +184,13 @@ module Gruf
       options
     end
 
+    ##
+    # @return [Boolean]
+    #
+    def development?
+      environment == 'development'
+    end
+
     private
 
     ##
@@ -194,7 +202,7 @@ module Gruf
       if defined?(::Rails)
         ::Rails.env.to_s
       else
-        (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development').to_s
+        ENV.fetch('RACK_ENV') { ENV.fetch('RAILS_ENV', 'development') }.to_s
       end
     end
 

data/lib/gruf/controllers/autoloader.rb

@@ -0,0 +1,74 @@
+# 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 Controllers
+    ##
+    # Handles autoloading of Gruf controllers in the application path. This allows for code reloading on Gruf
+    # controllers.
+    #
+    class Autoloader
+      include ::Gruf::Loggable
+
+      # @!attribute [r] path
+      #   @return [String] The path for this autoloader
+      attr_reader :path
+
+      ##
+      # @param [String] path
+      # @param [Boolean] reloading
+      # @param [String] tag
+      #
+      def initialize(path:, reloading: nil, tag: nil)
+        super()
+        @path = path
+        @loader = ::Zeitwerk::Loader.new
+        @loader.tag = tag || 'gruf-controllers'
+        @setup = false
+        @reloading_enabled = reloading || ::Gruf.development?
+        setup!
+      end
+
+      ##
+      # Reload all files managed by the autoloader, if reloading is enabled
+      #
+      def reload
+        @loader.reload if @reloading_enabled
+      end
+
+      private
+
+      ##
+      # @return [Boolean]
+      #
+      def setup!
+        return true if @setup
+
+        return false unless File.directory?(@path)
+
+        @loader.enable_reloading if @reloading_enabled
+        @loader.ignore("#{@path}/**/*_pb.rb")
+        @loader.push_dir(@path)
+        @loader.setup
+        # always eager load RPC files, so that the service binder can bind the Gruf::Controller instantiation
+        # to the gRPC Service classes
+        @loader.eager_load
+        @setup = true
+      end
+    end
+  end
+end

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
     ##
@@ -67,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
 
       ##
@@ -92,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/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
   ##

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

@@ -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,11 +43,10 @@ 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
 
     ##
@@ -75,7 +74,12 @@ module Gruf
                    end
 
           @port = server.add_http2_port(@hostname, ssl_credentials)
-          @services.each { |s| server.handle(s) }
+          # 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
@@ -89,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
@@ -98,7 +102,7 @@ module Gruf
       @started = false
 
       update_proc_title(:stopped)
-      logger.info { 'Goodbye!' }
+      logger.info { '[gruf] Goodbye!' }
     end
     # :nocov:
 
@@ -111,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
 
     ##
@@ -185,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]

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.14.1'
+  VERSION = '2.15.0'
 end

data/lib/gruf.rb

@@ -20,26 +20,16 @@ require 'active_support/core_ext/module/delegation'
 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.push_dir(__dir__)
+loader.setup
+
 require_relative 'gruf/integrations/rails/railtie' if defined?(::Rails)
 
 ##
@@ -47,4 +37,10 @@ require_relative 'gruf/integrations/rails/railtie' if defined?(::Rails)
 #
 module Gruf
   extend Configuration
+
+  class << self
+    def autoloaders
+      Autoloaders
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 2.14.1
+  version: 2.15.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -304,6 +304,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
 description: gRPC Ruby Framework for building complex gRPC applications at scale
 email:
 - splittingred@gmail.com
@@ -318,11 +332,14 @@ files:
 - bin/gruf
 - gruf.gemspec
 - lib/gruf.rb
+- lib/gruf/autoloaders.rb
 - lib/gruf/cli/executor.rb
 - lib/gruf/client.rb
 - lib/gruf/client/error.rb
 - lib/gruf/client/error_factory.rb
+- lib/gruf/client/errors.rb
 - lib/gruf/configuration.rb
+- lib/gruf/controllers/autoloader.rb
 - lib/gruf/controllers/base.rb
 - lib/gruf/controllers/request.rb
 - lib/gruf/controllers/service_binder.rb
@@ -330,6 +347,7 @@ files:
 - lib/gruf/errors/debug_info.rb
 - lib/gruf/errors/field.rb
 - lib/gruf/errors/helpers.rb
+- lib/gruf/grpc_logger.rb
 - lib/gruf/hooks/base.rb
 - lib/gruf/hooks/executor.rb
 - lib/gruf/hooks/registry.rb
@@ -350,7 +368,7 @@ files:
 - lib/gruf/interceptors/server_interceptor.rb
 - lib/gruf/interceptors/timer.rb
 - lib/gruf/loggable.rb
-- lib/gruf/logging.rb
+- lib/gruf/logger.rb
 - lib/gruf/outbound/request_context.rb
 - lib/gruf/response.rb
 - lib/gruf/serializers/errors/base.rb
@@ -363,7 +381,12 @@ homepage: https://github.com/bigcommerce/gruf
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/bigcommerce/gruf/issues
+  changelog_uri: https://github.com/bigcommerce/gruf/CHANGELOG.md
+  homepage_uri: https://github.com/bigcommerce/gruf
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/bigcommerce/gruf
+  wiki_uri: https://github.com/bigcommerce/gruf/wiki
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -382,7 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.12
 signing_key:
 specification_version: 4
 summary: gRPC Ruby Framework