gruf 2.10.0 → 2.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b132efe87ccf85ffcf897a67f5c268b8696e60e5f2b280c93c52f08fea1aa122
-  data.tar.gz: 6a1d99886e075daac23eadeabd5e347c92d4fdc7659f7dd639d7e79e38c6b6f8
+  metadata.gz: 0fdf24359533f0c174160c022698b4c3dff0358700a340f470abf68149619380
+  data.tar.gz: f5a07f92989697f5ca2625f21ab150dad8b0e9c848ace26833e11541bf83f2e8
 SHA512:
-  metadata.gz: b5140ea90e6bc018cef228f7bece3096cd389bec36cc4b80f5e1a9b2ebefbab7afe494146c9f4843418f06ffe27d404885d470477c732986befe94b69191297d
-  data.tar.gz: fb3baf2ad10bf606b57c37f45d419e11c41bb34ce56c9801d3367cb471cfe22f097b42bbfa60aa77cbb3eda338c947eee48f909b2866df1bf660953772ac2b64
+  metadata.gz: 1108582d41b071f520d393e9c4946fe90fe88c93cc26dbbb7c6980b580c586d27ddb69fee0b5ff7a89e2accd4aabd25f39635f0b04833a41eb369ce0b98bf6c0
+  data.tar.gz: 8082bb3b4f30ed4d45d7928fc7c34aaa2b13204d3adca682d9fab51641a72dac3692227edfe789062b2ef1b3e0b78b8cdb495e97c9cfe952bf59a9ee0370f408

data/CHANGELOG.md

@@ -2,11 +2,44 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.13.1
+
+- 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
+- Relax grpc pin as upstream regression is fixed
+
+### 2.12.0
+
+- Fixed interceptor order to be FIFO as documented, instead of FILO (fixes #139)
+
+### 2.11.0
+
+- 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
+- Add `GRPC_BACKTRACE_ON_ERROR` as available ENV configuration
+- Add default ENV-based configuration of the GRPC server pool
+  - `GRPC_SERVER_POOL_SIZE` - sets the size of the GRPC server pool
+  - `GRPC_SERVER_POOL_KEEP_ALIVE` - keep alive time for threads spawned by the server pool
+  - `GRPC_SERVER_POLL_PERIOD` - period in seconds to poll for workers in the gRPC server pool
+- Improve Yardoc support across the library
+- Added attribute-based documentation for Gruf configuration options
+- Add mfa required for gemspec metadata
+
 ### 2.10.0
 
 - Drop support for Ruby 2.4/2.5 to align with Ruby EOL schedule, supporting 2.6+ only
 - Allow for float/TimeSpec timeout values on clients
 
+### 2.9.1
+
+- Allow for float/TimeSpec timeout values on clients (backport from 2.10.0)
+
 ### 2.9.0
 
 - Change to racially neutral terminology across library

data/README.md

@@ -1,8 +1,8 @@
 # gruf - gRPC Ruby Framework
 
-[![CircleCI](https://circleci.com/gh/bigcommerce/gruf/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf.svg)](https://badge.fury.io/rb/gruf) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf.svg?branch=main)](https://inch-ci.org/github/bigcommerce/gruf?branch=main)
+[![CircleCI](https://circleci.com/gh/bigcommerce/gruf/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf.svg)](https://badge.fury.io/rb/gruf) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf.svg?branch=main)](https://inch-ci.org/github/bigcommerce/gruf?branch=main) [![Maintainability](https://api.codeclimate.com/v1/badges/4a8e9269f99100aeb7cb/maintainability)](https://codeclimate.com/github/bigcommerce/gruf/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/4a8e9269f99100aeb7cb/test_coverage)](https://codeclimate.com/github/bigcommerce/gruf/test_coverage)
 
-gruf is a Ruby framework that wraps the [gRPC Ruby library](https://github.com/grpc/grpc/tree/main/src/ruby) to
+gruf is a Ruby framework that wraps the [gRPC Ruby library](https://github.com/grpc/grpc/tree/master/src/ruby) to
 provide a more streamlined integration into Ruby and Ruby on Rails applications.
 
 It provides an abstracted server and client for gRPC services, along with other tools to help get gRPC services in Ruby
@@ -17,7 +17,7 @@ up fast and efficiently at scale. Some of its features include:
   still preserving gRPC BadStatus codes
 * Server and client execution timings in responses
 
-gruf currently has active support for gRPC 1.10.x+. gruf is compatible and tested with Ruby 2.2-2.7.
+gruf currently has active support for gRPC 1.10.x+. gruf is compatible and tested with Ruby 2.2-3.0.
 gruf is also not [Rails](https://github.com/rails/rails)-specific, and can be used in any Ruby framework
 (such as [Grape](https://github.com/ruby-grape/grape) or [dry-rb](https://dry-rb.org/), for instance).
 

data/gruf.gemspec

@@ -35,7 +35,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6', '< 3.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
   spec.add_development_dependency 'bundler-audit', '>= 0.6'
   # rubocop:disable Gemspec/RubyVersionGlobalsUsage
   spec.add_development_dependency(
@@ -57,10 +58,10 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'activesupport', '> 4'
   spec.add_runtime_dependency 'concurrent-ruby', '> 1'
-  spec.add_runtime_dependency 'e2mmap', '~> 0.1'
+  spec.add_runtime_dependency 'e2mmap', '>= 0.1'
   spec.add_runtime_dependency 'grpc', '~> 1.10'
   spec.add_runtime_dependency 'grpc-tools', '~> 1.10'
   spec.add_runtime_dependency 'json', '>= 2.3'
-  spec.add_runtime_dependency 'slop', '~> 4.6'
-  spec.add_runtime_dependency 'thwait', '~> 0.1'
+  spec.add_runtime_dependency 'slop', '>= 4.6'
+  spec.add_runtime_dependency 'thwait', '>= 0.1'
 end

data/lib/gruf/client/error.rb

@@ -23,7 +23,8 @@ module Gruf
     # GRPC::BadStatus error
     #
     class Error < StandardError
-      # @return [Object] error The deserialized error
+      # @!attribute [r] error
+      #   @return [Object] error The deserialized error
       attr_reader :error
 
       ##

data/lib/gruf/client.rb

@@ -38,11 +38,14 @@ module Gruf
   class Client < SimpleDelegator
     include Gruf::Loggable
 
-    # @return [Class] The base, friendly name of the service being requested
+    # @!attribute [r] base_klass
+    #   @return [Class] The base, friendly name of the service being requested
     attr_reader :base_klass
-    # @return [Class] The class name of the gRPC service being requested
+    # @!attribute [r] service_klass
+    #   @return [Class] The class name of the gRPC service being requested
     attr_reader :service_klass
-    # @return [Hash] A hash of options for the client
+    # @!attribute [r] opts
+    #   @return [Hash] A hash of options for the client
     attr_reader :opts
 
     ##
@@ -230,7 +233,7 @@ module Gruf
         GRPC::Core::TimeConsts::ZERO
       elsif timeout.is_a?(GRPC::Core::TimeSpec)
         timeout
-      elsif timeout.is_a?(Numeric)
+      elsif timeout.is_a?(Numeric) # rubocop:disable Lint/DuplicateBranch
         timeout
       elsif timeout.respond_to?(:to_f)
         timeout.to_f

data/lib/gruf/configuration.rb

@@ -20,6 +20,63 @@ module Gruf
   # Represents configuration settings for the system
   #
   module Configuration
+    # @!attribute root_path
+    #   @return [String] The root path for your application
+    # @!attribute server_binding_url
+    #   @return [String] The full hostname:port that the gRPC server should bind to
+    # @!attribute server_options
+    #   @return [Hash] A hash of options to pass to the server instance
+    # @!attribute interceptors
+    #   @return [::Gruf::Interceptors::Registry] A registry of Gruf server interceptors
+    # @!attribute hooks
+    #   @return [::Gruf::Hooks::Registry] A registry of Gruf hooks for the server
+    # @!attribute default_channel_credentials
+    #   @return [NilClass]
+    #   @return [Symbol]
+    #   @return [Hash]
+    # @!attribute default_client_host
+    #   @return [String] The default host for all new Gruf::Client objects to use as their target host
+    # @!attribute use_ssl
+    #   @return [Boolean] If true, will setup the server to use TLS
+    # @!attribute ssl_crt_file
+    #   @return [String] If use_ssl is true, the relative path from the root_path to the CRT file for the server
+    # @!attribute ssl_key_file
+    #   @return [String] If use_ssl is true, the relative path from the root_path to the key file for the server
+    # @!attribute controllers_path
+    #   @return [String] The relative path from root_path to locate Gruf Controllers in
+    # @!attribute services
+    #   @return [Array<Class>] An array of services to serve with this Gruf server
+    # @!attribute logger
+    #   @return [Logger] The logger class for Gruf-based logging
+    # @!attribute grpc_logger
+    #   @return [Logger] The logger to use with GRPC's core logger (which logs plaintext). It is recommended to set
+    #      this to an STDOUT logger and use a logging pipeline that can translate plaintext logs given GRPC's
+    #      unformatted logging.
+    # @!attribute error_metadata_key
+    #   @return [Symbol] The metadata key to use for error messages sent back in trailing metadata.
+    # @!attribute error_serializer
+    #   @return [NilClass|::Gruf::Serializers::Errors::Base] The error serializer to use for error messages sent
+    #      back in trailing metadata. Defaults to the base JSON serializer.
+    # @!attribute append_server_errors_to_trailing_metadata
+    #   @return [Boolean] If true, will append all server error information into the trailing metadata in the response
+    #      from the server
+    # @!attribute use_default_interceptors
+    #   @return [Boolean] If true, will use the default ActiveRecord and Timer interceptors for servers
+    # @!attribute backtrace_on_error
+    #   @return [Boolean] If true, will return the backtrace on any errors in servers in the trailing metadata
+    # @!attribute backtrace_limit
+    #   @return [Integer] The limit of lines to use in backtraces returned
+    # @!attribute use_exception_message
+    #   @return [String] If true, will pass the actual exception message from the error in a server
+    # @!attribute internal_error_message
+    #   @return [String] If use_exception_message is false, this message will be used instead as a replacement
+    # @!attribute event_listener_proc
+    #   @return [NilClass]
+    #   @return [Proc] If set, this will be used during GRPC events (such as pool exhaustions)
+    # @!attribute synchronized_client_internal_cache_expiry
+    #   @return [Integer] Internal cache expiry period (in seconds) for the SynchronizedClient
+    # @!attribute rpc_server_options
+    #   @return [Hash] A hash of RPC options for GRPC server configuration
     VALID_CONFIG_KEYS = {
       root_path: '',
       server_binding_url: '0.0.0.0:9001',
@@ -61,8 +118,8 @@ module Gruf
     # Whenever this is extended into a class, setup the defaults
     #
     def self.extended(base)
-      if defined?(Rails)
-        Gruf::Integrations::Rails::Railtie.config.before_initialize { base.reset }
+      if defined?(::Rails)
+        ::Gruf::Integrations::Rails::Railtie.config.before_initialize { base.reset }
       else
         base.reset
       end
@@ -100,22 +157,28 @@ module Gruf
       VALID_CONFIG_KEYS.each do |k, v|
         send("#{k}=", v)
       end
-      self.interceptors = Gruf::Interceptors::Registry.new
-      self.hooks = Gruf::Hooks::Registry.new
-      self.root_path = Rails.root.to_s.chomp('/') if defined?(Rails)
-      if defined?(Rails) && Rails.logger
-        self.logger = Rails.logger
-      else
-        require 'logger'
-        self.logger = ::Logger.new($stdout)
-      end
-      self.grpc_logger = logger if grpc_logger.nil?
+      self.server_binding_url = "#{::ENV.fetch('GRPC_SERVER_HOST',
+                                               '0.0.0.0')}:#{::ENV.fetch('GRPC_SERVER_PORT', 9_001)}"
+      self.interceptors = ::Gruf::Interceptors::Registry.new
+      self.hooks = ::Gruf::Hooks::Registry.new
+      self.root_path = ::Rails.root.to_s.chomp('/') if defined?(::Rails)
+      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"
+      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',
+                                          GRPC::RpcServer::DEFAULT_MAX_WAITING_REQUESTS).to_i,
+        pool_size: ::ENV.fetch('GRPC_SERVER_POOL_SIZE', GRPC::RpcServer::DEFAULT_POOL_SIZE).to_i,
+        pool_keep_alive: ::ENV.fetch('GRPC_SERVER_POOL_KEEP_ALIVE', GRPC::Pool::DEFAULT_KEEP_ALIVE),
+        poll_period: ::ENV.fetch('GRPC_SERVER_POLL_PERIOD', GRPC::RpcServer::DEFAULT_POLL_PERIOD),
+        connect_md_proc: nil,
+        server_args: {}
+      }
       if use_default_interceptors
-        interceptors.use(Gruf::Interceptors::ActiveRecord::ConnectionReset)
-        interceptors.use(Gruf::Interceptors::Instrumentation::OutputMetadataTimer)
+        interceptors.use(::Gruf::Interceptors::ActiveRecord::ConnectionReset)
+        interceptors.use(::Gruf::Interceptors::Instrumentation::OutputMetadataTimer)
       end
       options
     end
@@ -128,11 +191,30 @@ module Gruf
     # @return [String] The current Ruby environment
     #
     def environment
-      if defined?(Rails)
-        Rails.env.to_s
+      if defined?(::Rails)
+        ::Rails.env.to_s
       else
         (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development').to_s
       end
     end
+
+    ##
+    # Dynamically determine the appropriate logger
+    #
+    def determine_loggers
+      if defined?(::Rails) && ::Rails.logger
+        self.logger = ::Rails.logger
+      else
+        require 'logger'
+        self.logger = ::Logger.new($stdout)
+        log_level = ::ENV.fetch('LOG_LEVEL', 'info').to_s.upcase
+        begin
+          logger.level = ::Logger::Severity.const_get(log_level)
+        rescue NameError => _e
+          logger.level = ::Logger::Severity::INFO
+        end
+      end
+      self.grpc_logger = logger if grpc_logger.nil?
+    end
   end
 end

data/lib/gruf/controllers/base.rb

@@ -26,13 +26,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
 

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/error.rb

@@ -59,20 +59,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/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
 
       ##

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/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/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..].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
 
         ##

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
 
     ##
@@ -41,10 +45,6 @@ module Gruf
       @interceptors = Gruf::Interceptors::Registry.new unless @interceptors.is_a?(Gruf::Interceptors::Registry)
       @services = []
       @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
@@ -54,30 +54,28 @@ module Gruf
     # @return [GRPC::RpcServer] The GRPC server running
     #
     def server
-      @server_mu.synchronize 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)
-          @services.each { |s| server.handle(s) }
-          server
-        end
+      @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
       end
     end
 
@@ -90,23 +88,10 @@ module Gruf
 
       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
+        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
 
@@ -202,28 +187,10 @@ module Gruf
     #
     # :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
     #

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.10.0'
+  VERSION = '2.13.1'
 end

data/lib/gruf.rb

@@ -40,7 +40,7 @@ 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)
+require_relative 'gruf/integrations/rails/railtie' if defined?(::Rails)
 
 ##
 # Initializes configuration of gruf core module

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.13.1
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2022-02-17 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,28 +280,28 @@ 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'
 description: gRPC Ruby Framework for building complex gRPC applications at scale
@@ -376,7 +362,8 @@ files:
 homepage: https://github.com/bigcommerce/gruf
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -395,7 +382,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.3.4
 signing_key:
 specification_version: 4
 summary: gRPC Ruby Framework