gruf 2.2.2 → 2.9.1

data/lib/gruf/serializers/errors/json.rb

@@ -1,3 +1,5 @@
+# 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

data/lib/gruf/server.rb

@@ -1,3 +1,5 @@
+# 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
@@ -31,11 +33,11 @@ module Gruf
     ##
     # Initialize the server and load and setup the services
     #
-    # @param [Hash] options
+    # @param [Hash] opts
     #
-    def initialize(options = {})
-      @options = options || {}
-      @interceptors = options.fetch(:interceptor_registry, Gruf.interceptors)
+    def initialize(opts = {})
+      @options = opts || {}
+      @interceptors = opts.fetch(:interceptor_registry, Gruf.interceptors)
       @interceptors = Gruf::Interceptors::Registry.new unless @interceptors.is_a?(Gruf::Interceptors::Registry)
       @services = []
       @started = false
@@ -43,6 +45,8 @@ module Gruf
       @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
 
@@ -52,8 +56,25 @@ module Gruf
     def server
       @server_mu.synchronize do
         @server ||= begin
-          server = GRPC::RpcServer.new(options)
-          @port = server.add_http2_port(options.fetch(:hostname, Gruf.server_binding_url), ssl_credentials)
+          # 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
@@ -68,13 +89,14 @@ module Gruf
       update_proc_title(:starting)
 
       server_thread = Thread.new do
-        logger.info { 'Booting gRPC Server...' }
+        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...' }
@@ -94,11 +116,14 @@ module Gruf
     # :nocov:
 
     ##
+    # Add a gRPC service stub to be served by gruf
+    #
     # @param [Class] klass
     # @raise [ServerAlreadyStartedError] if the server is already started
     #
     def add_service(klass)
       raise ServerAlreadyStartedError if @started
+
       @services << klass unless @services.include?(klass)
     end
 
@@ -111,27 +136,34 @@ module Gruf
     #
     def add_interceptor(klass, opts = {})
       raise ServerAlreadyStartedError if @started
+
       @interceptors.use(klass, opts)
     end
 
     ##
+    # Insert an interceptor before another in the currently registered order of execution
+    #
     # @param [Class] before_class The interceptor that you want to add the new interceptor before
     # @param [Class] interceptor_class The Interceptor to add to the registry
-    # @param [Hash] options A hash of options for the interceptor
+    # @param [Hash] opts A hash of options for the interceptor
     #
-    def insert_interceptor_before(before_class, interceptor_class, options = {})
+    def insert_interceptor_before(before_class, interceptor_class, opts = {})
       raise ServerAlreadyStartedError if @started
-      @interceptors.insert_before(before_class, interceptor_class, options)
+
+      @interceptors.insert_before(before_class, interceptor_class, opts)
     end
 
     ##
+    # Insert an interceptor after another in the currently registered order of execution
+    #
     # @param [Class] after_class The interceptor that you want to add the new interceptor after
     # @param [Class] interceptor_class The Interceptor to add to the registry
-    # @param [Hash] options A hash of options for the interceptor
+    # @param [Hash] opts A hash of options for the interceptor
     #
-    def insert_interceptor_after(after_class, interceptor_class, options = {})
+    def insert_interceptor_after(after_class, interceptor_class, opts = {})
       raise ServerAlreadyStartedError if @started
-      @interceptors.insert_after(after_class, interceptor_class, options)
+
+      @interceptors.insert_after(after_class, interceptor_class, opts)
     end
 
     ##
@@ -146,8 +178,11 @@ module Gruf
     ##
     # Remove an interceptor from the server
     #
+    # @param [Class] klass
+    #
     def remove_interceptor(klass)
       raise ServerAlreadyStartedError if @started
+
       @interceptors.remove(klass)
     end
 
@@ -156,6 +191,7 @@ module Gruf
     #
     def clear_interceptors
       raise ServerAlreadyStartedError if @started
+
       @interceptors.clear
     end
 
@@ -176,8 +212,6 @@ module Gruf
     #
     # :nocov:
     def setup_signal_handlers
-      Thread.abort_on_exception = true
-
       Signal.trap('INT') do
         @stop_server = true
         @stop_server_cv.broadcast
@@ -196,10 +230,12 @@ module Gruf
     # :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
@@ -220,14 +256,12 @@ module Gruf
     #
     # :nocov:
     def ssl_credentials
-      if options.fetch(:use_ssl, Gruf.use_ssl)
-        private_key = File.read(options.fetch(:ssl_key_file, Gruf.ssl_key_file))
-        cert_chain = File.read(options.fetch(:ssl_crt_file, Gruf.ssl_crt_file))
-        certs = [nil, [{ private_key: private_key, cert_chain: cert_chain }], false]
-        GRPC::Core::ServerCredentials.new(*certs)
-      else
-        :this_port_is_insecure
-      end
+      return :this_port_is_insecure unless options.fetch(:use_ssl, Gruf.use_ssl)
+
+      private_key = File.read(options.fetch(:ssl_key_file, Gruf.ssl_key_file))
+      cert_chain = File.read(options.fetch(:ssl_crt_file, Gruf.ssl_crt_file))
+      certs = [nil, [{ private_key: private_key, cert_chain: cert_chain }], false]
+      GRPC::Core::ServerCredentials.new(*certs)
     end
     # :nocov:
 

data/lib/gruf/synchronized_client.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'concurrent'
+
+module Gruf
+  ##
+  # Ensures that we only have one active call to a given endpoint with a given set of params. This can be useful
+  # to mitigate thundering herds.
+  #
+  class SynchronizedClient < Gruf::Client
+    attr_reader :unsynchronized_methods
+
+    ##
+    # Initialize the client and setup the stub
+    #
+    # @param [Module] service The namespace of the client Stub that is desired to load
+    # @param [Hash] options A hash of options for the client
+    # @option options [Array] :unsynchronized_methods A list of methods (as symbols) that
+    #   should be excluded from synchronization
+    # @option options [Integer] :internal_cache_expiry The length of time to keep results
+    #   around for other threads to fetch (in seconds)
+    # @param [Hash] client_options A hash of options to pass to the gRPC client stub
+    #
+    def initialize(service:, options: {}, client_options: {})
+      @unsynchronized_methods = options.delete(:unsynchronized_methods) { [] }
+      @expiry = options.delete(:internal_cache_expiry) { Gruf.synchronized_client_internal_cache_expiry }
+      @locks = Concurrent::Map.new
+      @results = Concurrent::Map.new
+      super
+    end
+
+    ##
+    # Call the client's method with given params. If another call is already active for the same endpoint and the same
+    # params, block until the active call is complete. When unblocked, callers will get a copy of the original result.
+    #
+    # @param [String|Symbol] request_method The method that is being requested on the service
+    # @param [Hash] params (Optional) A hash of parameters that will be inserted into the gRPC request
+    #   message that is required for the given above call
+    # @param [Hash] metadata (Optional) A hash of metadata key/values that are transported with the client request
+    # @param [Hash] opts (Optional) A hash of options to send to the gRPC request_response method
+    # @return [Gruf::Response] The response from the server
+    # @raise [Gruf::Client::Error|GRPC::BadStatus] If an error occurs, an exception will be raised according to the
+    # error type that was returned
+    #
+    def call(request_method, params = {}, metadata = {}, opts = {}, &block)
+      # Allow for bypassing extra behavior for selected methods
+      return super if unsynchronized_methods.include?(request_method.to_sym)
+
+      # Generate a unique key based on the method and params
+      key = "#{request_method}.#{params.hash}"
+
+      # Create a lock for this call if we haven't seen it already, then acquire it
+      lock = @locks.compute_if_absent(key) { Mutex.new }
+      lock.synchronize do
+        # Return value from results cache if it exists. This occurs for callers that were
+        # waiting on the lock while the first caller was making the actual grpc call.
+        response = @results.get(lock)
+        if response
+          Gruf.logger.debug "Returning cached result for #{key}:#{lock.inspect}"
+          next response
+        end
+
+        # Make the grpc call and record response for other callers that are blocked
+        # on the same lock
+        response = super
+        @results.put(lock, response)
+
+        # Schedule a task to come in later and clean out result to prevent memory bloat
+        Concurrent::ScheduledTask.new(@expiry, args: [@results, lock]) { |h, k| h.delete(k) }.execute
+
+        # Remove the lock from the map. The next caller to come through with the
+        # same params will create a new lock and start the process over again.
+        # Anyone who was waiting on this call will be using a local reference
+        # to the same lock as us, and will fetch the result from the cache.
+        @locks.delete(key)
+
+        # Return response
+        response
+      end
+    end
+  end
+end

data/lib/gruf/timer.rb

@@ -1,3 +1,5 @@
+# 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
@@ -27,11 +29,12 @@ module Gruf
     #   result.time # => 1.10123
     #   result.result # => 'my_thing_is_done'
     #
+    # @property [Object] result The result of the block that was called
+    # @property [Float] time The time, in ms, of the block execution
+    #
     class Result
-      # @return [Object] result The result of the block that was called
-      attr_reader :result
-      # @return [Float] time The time, in ms, of the block execution
-      attr_reader :time
+      attr_reader :result,
+                  :time
 
       ##
       # Initialize the result object
@@ -50,7 +53,7 @@ module Gruf
       # @return [Boolean] Whether or not this result was a success
       #
       def success?
-        !result.is_a?(GRPC::BadStatus)
+        !result.is_a?(GRPC::BadStatus) && !result.is_a?(StandardError) && !result.is_a?(GRPC::Core::CallError)
       end
     end
 
@@ -65,7 +68,7 @@ module Gruf
       start_time = Time.now
       begin
         result = yield
-      rescue GRPC::BadStatus => e
+      rescue GRPC::BadStatus, StandardError, GRPC::Core::CallError => e
         result = e
       end
       end_time = Time.now

data/lib/gruf/version.rb

@@ -1,3 +1,5 @@
+# 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
@@ -14,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.2.2'.freeze
+  VERSION = '2.9.1'
 end

data/lib/gruf.rb

@@ -1,3 +1,5 @@
+# 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
@@ -23,14 +25,22 @@ 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)
 
 ##
 # Initializes configuration of gruf core module