gruf 2.9.1 → 2.15.1

data/lib/gruf/server.rb

@@ -23,11 +23,15 @@ module Gruf
   class Server
     class ServerAlreadyStartedError < StandardError; end
 
+    KILL_SIGNALS = %w[INT TERM QUIT].freeze
+
     include Gruf::Loggable
 
-    # @return [Integer] The port the server is bound to
+    # @!attribute [r] port
+    #   @return [Integer] The port the server is bound to
     attr_reader :port
-    # @return [Hash] Hash of options passed into the server
+    # @!attribute [r] options
+    #   @return [Hash] Hash of options passed into the server
     attr_reader :options
 
     ##
@@ -39,22 +43,17 @@ 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
-      @stop_server = false
-      @stop_server_cv = ConditionVariable.new
-      @stop_server_mu = Monitor.new
-      @server_mu = Monitor.new
       @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_mu.synchronize do
+      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.
@@ -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,29 +93,16 @@ module Gruf
       update_proc_title(:starting)
 
       server_thread = Thread.new do
-        logger.info { "Starting gruf server at #{@hostname}..." }
-        server.run
-      end
-
-      stop_server_thread = Thread.new do
-        loop do
-          break if @stop_server
-
-          @stop_server_mu.synchronize { @stop_server_cv.wait(@stop_server_mu, 10) }
-        end
-        logger.info { 'Shutting down...' }
-        server.stop
+        logger.info { "[gruf] Starting gruf server at #{@hostname}..." }
+        server.run_till_terminated_or_interrupted(KILL_SIGNALS)
       end
-
-      server.wait_till_running
       @started = true
       update_proc_title(:serving)
-      stop_server_thread.join
       server_thread.join
       @started = false
 
       update_proc_title(:stopped)
-      logger.info { 'Goodbye!' }
+      logger.info { '[gruf] Goodbye!' }
     end
     # :nocov:
 
@@ -124,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
 
     ##
@@ -198,49 +189,11 @@ module Gruf
     private
 
     ##
-    # Setup server
-    #
-    # :nocov:
-    def setup
-      setup_signal_handlers
-      load_controllers
-    end
-    # :nocov:
-
-    ##
-    # Register signal handlers
-    #
-    # :nocov:
-    def setup_signal_handlers
-      Signal.trap('INT') do
-        @stop_server = true
-        @stop_server_cv.broadcast
-      end
-
-      Signal.trap('TERM') do
-        @stop_server = true
-        @stop_server_cv.broadcast
-      end
-    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]
@@ -275,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/synchronized_client.rb

@@ -23,6 +23,8 @@ module Gruf
   # to mitigate thundering herds.
   #
   class SynchronizedClient < Gruf::Client
+    # @!attribute [r] unsynchronized_methods
+    #   @return [Array]
     attr_reader :unsynchronized_methods
 
     ##

data/lib/gruf/timer.rb

@@ -33,8 +33,12 @@ module Gruf
     # @property [Float] time The time, in ms, of the block execution
     #
     class Result
-      attr_reader :result,
-                  :time
+      # @!attribute [r] result
+      #   @return [mixed]
+      attr_reader :result
+      # @!attribute [r] time
+      #   @return [Float]
+      attr_reader :time
 
       ##
       # Initialize the result object

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.9.1'
+  VERSION = '2.15.1'
 end

data/lib/gruf.rb

@@ -20,31 +20,27 @@ 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'
-require_relative 'gruf/integrations/rails/railtie' if defined?(Rails)
+
+# 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)
 
 ##
 # Initializes configuration of gruf core module
 #
 module Gruf
   extend Configuration
+
+  class << self
+    def autoloaders
+      Autoloaders
+    end
+  end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 2.9.1
+  version: 2.15.1
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -238,14 +224,14 @@ dependencies:
   name: e2mmap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
@@ -294,30 +280,44 @@ dependencies:
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.6'
 - !ruby/object:Gem::Dependency
   name: thwait
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !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
@@ -332,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
@@ -344,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
@@ -364,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
@@ -376,7 +380,13 @@ files:
 homepage: https://github.com/bigcommerce/gruf
 licenses:
 - MIT
-metadata: {}
+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:
@@ -385,17 +395,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.3.12
 signing_key:
 specification_version: 4
 summary: gRPC Ruby Framework