gruf 2.7.0 → 2.10.0

data/gruf.gemspec

@@ -15,7 +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.
 #
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'gruf/version'
 
 Gem::Specification.new do |spec|
@@ -30,19 +30,37 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/bigcommerce/gruf'
 
   spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf.gemspec']
-  spec.executables   << 'gruf'
+  spec.executables << 'gruf'
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.4'
+  spec.required_ruby_version = '>= 2.6', '< 3.1'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'bundler-audit', '>= 0.6'
+  # rubocop:disable Gemspec/RubyVersionGlobalsUsage
+  spec.add_development_dependency(
+    'factory_bot',
+    (Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5') ? '>= 6.1' : '~> 5.2')
+  )
+  # rubocop:enable Gemspec/RubyVersionGlobalsUsage
+  spec.add_development_dependency 'ffaker', '>= 2.15'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'pry-byebug', '>= 3.9'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.8'
+  spec.add_development_dependency 'rspec_junit_formatter', '>= 0.4'
+  spec.add_development_dependency 'rubocop', '>= 1.0'
+  spec.add_development_dependency 'rubocop-performance', '>= 0.0.1'
+  spec.add_development_dependency 'rubocop-rspec', '>= 2.0'
+  spec.add_development_dependency 'rubocop-thread_safety', '>= 0.3'
+  spec.add_development_dependency 'simplecov', '>= 0.16'
 
-  spec.add_runtime_dependency 'grpc', '~> 1.10'
-  spec.add_runtime_dependency 'grpc-tools', '~> 1.10'
   spec.add_runtime_dependency 'activesupport', '> 4'
-
   spec.add_runtime_dependency 'concurrent-ruby', '> 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'
 end

data/lib/gruf/cli/executor.rb

@@ -38,7 +38,7 @@ module Gruf
         @services = services || Gruf.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)
+        @logger = logger || Gruf.logger || ::Logger.new($stderr)
       end
 
       ##
@@ -67,7 +67,23 @@ module Gruf
       # Setup options for CLI execution and configure Gruf based on inputs
       #
       def setup!
-        opts = Slop.parse(@args) do |o|
+        opts = parse_options
+
+        Gruf.server_binding_url = opts[:host] if opts[:host]
+        if opts.suppress_default_interceptors?
+          Gruf.interceptors.remove(Gruf::Interceptors::ActiveRecord::ConnectionReset)
+          Gruf.interceptors.remove(Gruf::Interceptors::Instrumentation::OutputMetadataTimer)
+        end
+        Gruf.backtrace_on_error = true if opts.backtrace_on_error?
+      end
+
+      ##
+      # Parse all CLI arguments into an options result
+      #
+      # @return [Slop::Result]
+      #
+      def parse_options
+        ::Slop.parse(@args) do |o|
           o.null '-h', '--help', 'Display help message' do
             puts o
             exit(0)
@@ -80,10 +96,6 @@ module Gruf
             exit(0)
           end
         end
-
-        Gruf.server_binding_url = opts[:host] if opts[:host]
-        Gruf.use_default_interceptors = false if opts.suppress_default_interceptors?
-        Gruf.backtrace_on_error = true if opts.backtrace_on_error?
       end
     end
   end

data/lib/gruf/client.rb

@@ -60,9 +60,10 @@ module Gruf
       @opts = options || {}
       @opts[:password] = @opts.fetch(:password, '').to_s
       @opts[:hostname] = @opts.fetch(:hostname, Gruf.default_client_host)
+      @opts[:channel_credentials] = @opts.fetch(:channel_credentials, Gruf.default_channel_credentials)
       @error_factory = Gruf::Client::ErrorFactory.new
-      client_options[:timeout] = client_options[:timeout].to_i if client_options.key?(:timeout)
-      client = "#{service}::Stub".constantize.new(@opts[:hostname], build_ssl_credentials, client_options)
+      client_options[:timeout] = parse_timeout(client_options[:timeout]) if client_options.key?(:timeout)
+      client = "#{service}::Stub".constantize.new(@opts[:hostname], build_ssl_credentials, **client_options)
       super(client)
     end
 
@@ -190,6 +191,8 @@ module Gruf
     #
     # :nocov:
     def build_ssl_credentials
+      return opts[:channel_credentials] if opts[:channel_credentials]
+
       cert = nil
       if opts[:ssl_certificate_file]
         cert = File.read(opts[:ssl_certificate_file]).to_s.strip
@@ -213,5 +216,27 @@ module Gruf
         Gruf::Serializers::Errors::Json
       end
     end
+
+    ##
+    # Handle various timeout values and prevent improper value setting
+    #
+    # @see GRPC::Core::TimeConsts#from_relative_time
+    # @param [mixed] timeout
+    # @return [Float]
+    # @return [GRPC::Core::TimeSpec]
+    #
+    def parse_timeout(timeout)
+      if timeout.nil?
+        GRPC::Core::TimeConsts::ZERO
+      elsif timeout.is_a?(GRPC::Core::TimeSpec)
+        timeout
+      elsif timeout.is_a?(Numeric)
+        timeout
+      elsif timeout.respond_to?(:to_f)
+        timeout.to_f
+      else
+        raise ArgumentError, 'timeout is not a valid value: does not respond to to_f'
+      end
+    end
   end
 end

data/lib/gruf/client/error.rb

@@ -33,6 +33,7 @@ module Gruf
       #
       def initialize(error)
         @error = error
+        super
       end
     end
 
@@ -57,6 +58,7 @@ module Gruf
       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

data/lib/gruf/configuration.rb

@@ -26,6 +26,7 @@ module Gruf
       server_options: {},
       interceptors: nil,
       hooks: nil,
+      default_channel_credentials: nil,
       default_client_host: '',
       use_ssl: false,
       ssl_crt_file: '',
@@ -97,7 +98,7 @@ module Gruf
     #
     def reset
       VALID_CONFIG_KEYS.each do |k, v|
-        send((k.to_s + '='), v)
+        send("#{k}=", v)
       end
       self.interceptors = Gruf::Interceptors::Registry.new
       self.hooks = Gruf::Hooks::Registry.new
@@ -106,7 +107,7 @@ module Gruf
         self.logger = Rails.logger
       else
         require 'logger'
-        self.logger = ::Logger.new(STDOUT)
+        self.logger = ::Logger.new($stdout)
       end
       self.grpc_logger = logger if grpc_logger.nil?
       self.ssl_crt_file = "#{root_path}config/ssl/#{environment}.crt"

data/lib/gruf/controllers/base.rb

@@ -65,7 +65,9 @@ module Gruf
       def self.bind(service)
         service_class = service.name.constantize
         Gruf.services << service_class
+        # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
         @bound_service = service_class
+        # rubocop:enable ThreadSafety/InstanceVariableInClassMethod
         ServiceBinder.new(service_class).bind!(self)
       end
 

data/lib/gruf/controllers/request.rb

@@ -58,7 +58,7 @@ module Gruf
       # @param [Class] service The class of the service being executed against
       # @param [GRPC::RpcDesc] rpc_desc The RPC descriptor of the call
       # @param [GRPC::ActiveCall] active_call The restricted view of the call
-      # @param [Object] message The protobuf message (or messages) of the request
+      # @param [Object|Google::Protobuf::MessageExts] message The protobuf message (or messages) of the request
       #
       def initialize(method_key:, service:, rpc_desc:, active_call:, message:)
         @method_key = method_key
@@ -99,21 +99,23 @@ module Gruf
       # @return [String] The parsed service method name
       #
       def method_name
-        "#{service_key}.#{method_key}"
+        "#{service_key}.#{@method_key}"
       end
 
       ##
       # Return all messages for this request, properly handling different request types
       #
-      # @return Enumerable<Object> All messages for this request
+      # @return [Enumerable<Object>] All messages for this request
       #
       def messages
         if client_streamer?
-          message.call { |msg| yield msg }
+          # rubocop:disable Style/ExplicitBlockArgument
+          @message.call { |msg| yield msg }
+          # rubocop:enable Style/ExplicitBlockArgument
         elsif bidi_streamer?
-          message
+          @message
         else
-          [message]
+          [@message]
         end
       end
     end

data/lib/gruf/controllers/service_binder.rb

@@ -38,7 +38,7 @@ module Gruf
       ##
       # Bind all methods on the service to the passed controller
       #
-      # @param [Gruf::Controllers::Base] controller
+      # @param [Class<Gruf::Controllers::Base>] controller
       #
       def bind!(controller)
         rpc_methods.each { |name, desc| bind_method(controller, name, desc) }

data/lib/gruf/error.rb

@@ -126,7 +126,7 @@ module Gruf
     # @return [Hash] The newly set metadata
     #
     def metadata=(metadata)
-      @metadata = metadata.map { |k, str| [k, str.to_s] }.to_h
+      @metadata = metadata.transform_values(&:to_s)
     end
 
     ##

data/lib/gruf/hooks/executor.rb

@@ -39,7 +39,7 @@ module Gruf
         @hooks.each do |hook|
           next unless hook.respond_to?(name)
 
-          hook.send(name, arguments)
+          hook.send(name, **arguments)
         end
       end
     end

data/lib/gruf/interceptors/client_interceptor.rb

@@ -43,7 +43,7 @@ module Gruf
       # @param [Hash] metadata A hash of outgoing metadata
       # @return [Object] The response message
       #
-      def request_response(request: nil, call: nil, method: nil, metadata: nil)
+      def request_response(request: nil, call: nil, method: nil, metadata: nil, &block)
         rc = Gruf::Outbound::RequestContext.new(
           type: :request_response,
           requests: [request],
@@ -51,9 +51,7 @@ module Gruf
           method: method,
           metadata: metadata
         )
-        call(request_context: rc) do
-          yield
-        end
+        call(request_context: rc, &block)
       end
 
       ##
@@ -65,7 +63,7 @@ module Gruf
       # @param [Hash] metadata A hash of outgoing metadata
       # @return [Object] The response message
       #
-      def client_streamer(requests: nil, call: nil, method: nil, metadata: nil)
+      def client_streamer(requests: nil, call: nil, method: nil, metadata: nil, &block)
         rc = Gruf::Outbound::RequestContext.new(
           type: :client_streamer,
           requests: requests,
@@ -73,9 +71,7 @@ module Gruf
           method: method,
           metadata: metadata
         )
-        call(request_context: rc) do
-          yield
-        end
+        call(request_context: rc, &block)
       end
 
       ##
@@ -87,7 +83,7 @@ module Gruf
       # @param [Hash] metadata A hash of outgoing metadata
       # @return [Object] The response message
       #
-      def server_streamer(request: nil, call: nil, method: nil, metadata: nil)
+      def server_streamer(request: nil, call: nil, method: nil, metadata: nil, &block)
         rc = Gruf::Outbound::RequestContext.new(
           type: :server_streamer,
           requests: [request],
@@ -95,9 +91,7 @@ module Gruf
           method: method,
           metadata: metadata
         )
-        call(request_context: rc) do
-          yield
-        end
+        call(request_context: rc, &block)
       end
 
       ##
@@ -108,7 +102,7 @@ module Gruf
       # @param [Method] method The method being called
       # @param [Hash] metadata A hash of outgoing metadata
       #
-      def bidi_streamer(requests: nil, call: nil, method: nil, metadata: nil)
+      def bidi_streamer(requests: nil, call: nil, method: nil, metadata: nil, &block)
         rc = Gruf::Outbound::RequestContext.new(
           type: :bidi_streamer,
           requests: requests,
@@ -116,9 +110,7 @@ module Gruf
           method: method,
           metadata: metadata
         )
-        call(request_context: rc) do
-          yield
-        end
+        call(request_context: rc, &block)
       end
     end
   end

data/lib/gruf/interceptors/context.rb

@@ -28,14 +28,14 @@ module Gruf
       #
       # @param [Array<Gruf::Interceptors::ServerInterceptor>] interceptors
       #
-      def initialize(interceptors = [])
-        @interceptors = interceptors
+      def initialize(interceptors = nil)
+        @interceptors = interceptors || []
       end
 
       ##
       # Intercept the given request and run interceptors in a FIFO execution order
       #
-      def intercept!
+      def intercept!(&block)
         return yield if @interceptors.none?
 
         i = @interceptors.pop
@@ -45,7 +45,7 @@ module Gruf
 
         i.call do
           if @interceptors.any?
-            intercept! { yield }
+            intercept!(&block)
           else
             yield
           end

data/lib/gruf/interceptors/instrumentation/output_metadata_timer.rb

@@ -27,12 +27,10 @@ module Gruf
         ##
         # Handle the instrumented response. Note: this will only instrument timings of _successful_ responses.
         #
-        def call
+        def call(&block)
           return unless active_call.respond_to?(:output_metadata)
 
-          result = Gruf::Interceptors::Timer.time do
-            yield
-          end
+          result = Gruf::Interceptors::Timer.time(&block)
           output_metadata.update(metadata_key => result.elapsed.to_s)
 
           raise result.message unless result.successful?

data/lib/gruf/interceptors/instrumentation/request_logging/formatters/base.rb

@@ -28,9 +28,11 @@ module Gruf
             # Format the parameters into a loggable string. Must be implemented in every derivative class
             #
             # @param [Hash] _payload The incoming request payload
+            # @param [Gruf::Controllers::Request] request The current controller request
+            # @param [Gruf::Interceptors::Timer::Result] result The timed result of the response
             # @return [String] The formatted string
             #
-            def format(_payload)
+            def format(_payload, request:, result:)
               raise NotImplementedError
             end
           end

data/lib/gruf/interceptors/instrumentation/request_logging/formatters/logstash.rb

@@ -30,9 +30,11 @@ module Gruf
             # Format the request into a JSON-friendly payload
             #
             # @param [Hash] payload The incoming request payload
+            # @param [Gruf::Controllers::Request] request The current controller request
+            # @param [Gruf::Interceptors::Timer::Result] result The timed result of the response
             # @return [String] The JSON representation of the payload
             #
-            def format(payload)
+            def format(payload, request:, result:)
               payload.merge(format: 'json').to_json
             end
           end

data/lib/gruf/interceptors/instrumentation/request_logging/formatters/plain.rb

@@ -28,9 +28,11 @@ module Gruf
             # Format the request by only outputting the message body and params (if set to log params)
             #
             # @param [Hash] payload The incoming request payload
+            # @param [Gruf::Controllers::Request] request The current controller request
+            # @param [Gruf::Interceptors::Timer::Result] result The timed result of the response
             # @return [String] The formatted string
             #
-            def format(payload)
+            def format(payload, request:, result:)
               time = payload.fetch(:duration, 0)
               grpc_status = payload.fetch(:grpc_status, 'GRPC::Ok')
               route_key = payload.fetch(:method, 'unknown')

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

@@ -61,12 +61,10 @@ module Gruf
           #
           # @return [String]
           #
-          def call
-            return yield if options.fetch(:ignore_methods, []).include?(request.method_name)
+          def call(&block)
+            return yield if options.fetch(:ignore_methods, [])&.include?(request.method_name)
 
-            result = Gruf::Interceptors::Timer.time do
-              yield
-            end
+            result = Gruf::Interceptors::Timer.time(&block)
 
             # Fetch log level options and merge with default...
             log_level_map = LOG_LEVEL_MAP.merge(options.fetch(:log_levels, {}))
@@ -100,7 +98,7 @@ module Gruf
             payload[:time] = Time.now.to_s
             payload[:host] = Socket.gethostname
 
-            logger.send(type, formatter.format(payload))
+            logger.send(type, formatter.format(payload, request: request, result: result))
 
             raise result.message unless result.successful?
 
@@ -113,7 +111,7 @@ module Gruf
           # @return [::Gruf::Logger]
           #
           def logger
-            @logger ||= options.fetch(:logger, ::Gruf.logger)
+            @logger ||= (options.fetch(:logger, nil) || Gruf.logger)
           end
 
           ##
@@ -164,26 +162,26 @@ module Gruf
           end
 
           ##
-          # Redact any blacklisted params and return an updated hash
+          # Redact any blocklisted params and return an updated hash
           #
           # @param [Hash] params The hash of parameters to sanitize
           # @return [Hash] The sanitized params in hash form
           #
           def sanitize(params = {})
-            blacklists = options.fetch(:blacklist, []).map(&:to_s)
-            redacted_string = options.fetch(:redacted_string, 'REDACTED')
-            blacklists.each do |blacklist|
-              parts = blacklist.split('.').map(&:to_sym)
+            blocklists = (options.fetch(:blocklist, []) || []).map(&:to_s)
+            redacted_string = options.fetch(:redacted_string, nil) || 'REDACTED'
+            blocklists.each do |blocklist|
+              parts = blocklist.split('.').map(&:to_sym)
               redact!(parts, 0, params, redacted_string)
             end
             params
           end
 
           ##
-          # Helper method to recursively redact based on the black list
+          # Helper method to recursively redact based on the blocklist
           #
-          # @param [Array] parts The blacklist. ex. 'data.schema' -> [:data, :schema]
-          # @param [Integer] idx The current index of the blacklist
+          # @param [Array] parts The blocklist. ex. 'data.schema' -> [:data, :schema]
+          # @param [Integer] idx The current index of the blocklist
           # @param [Hash] params The hash of parameters to sanitize
           # @param [String] redacted_string The custom redact string
           #