istox_gruf 2.7.1

data/lib/gruf/errors/helpers.rb

@@ -0,0 +1,44 @@
+# 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 Errors
+    ##
+    # Helper module for standardizing error interaction
+    #
+    module Helpers
+      delegate :add_field_error, :set_debug_info, :has_field_errors?, to: :error
+
+      ##
+      # Will issue a GRPC BadStatus exception, with a code based on the code passed.
+      #
+      # @param [Symbol] error_code The network error code that maps to gRPC status codes
+      # @param [Symbol] app_code The application-specific code for the error
+      # @param [String] message (Optional) A detail message about the error
+      # @param [Hash] metadata (Optional) Any metadata to inject into the trailing metadata for the response
+      #
+      def fail!(error_code, app_code = nil, message = '', metadata = {})
+        e = error
+        e.code = error_code.to_sym
+        e.app_code = app_code ? app_code.to_sym : e.code
+        e.message = message.to_s
+        e.metadata = metadata
+        e.fail!(request.active_call)
+      end
+    end
+  end
+end

data/lib/gruf/hooks/base.rb

@@ -0,0 +1,34 @@
+# 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 Hooks
+    ##
+    # Base class for a hook that allows execution at various points of Gruf server processes
+    #
+    class Base
+      include Gruf::Loggable
+
+      ##
+      # @param [Hash] options
+      #
+      def initialize(options: nil)
+        @options = options || {}
+      end
+    end
+  end
+end

data/lib/gruf/hooks/executor.rb

@@ -0,0 +1,47 @@
+# 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 Hooks
+    ##
+    # Base class for a hook that allows execution at various points of gRPC server processes
+    #
+    class Executor
+      include Gruf::Loggable
+
+      def initialize(hooks: nil)
+        @hooks = hooks || Gruf.hooks&.prepare || []
+      end
+
+      ##
+      # Execute a hook point for each registered hook in the registry
+      #
+      # @param [Symbol] name
+      # @param [Hash] arguments
+      #
+      def call(name, arguments = {})
+        name = name.to_sym
+
+        @hooks.each do |hook|
+          next unless hook.respond_to?(name)
+
+          hook.send(name, arguments)
+        end
+      end
+    end
+  end
+end

data/lib/gruf/hooks/registry.rb

@@ -0,0 +1,159 @@
+# 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 Hooks
+    ##
+    # Handles registration of hooks
+    #
+    class Registry
+      class HookNotFoundError < StandardError; end
+
+      def initialize
+        @registry = []
+      end
+
+      ##
+      # Add a hook to the registry
+      #
+      # @param [Class] hook_class The class of the hook to add
+      # @param [Hash] options A hash of options to pass into the hook during initialization
+      #
+      def use(hook_class, options = {})
+        hooks_mutex do
+          @registry << {
+            klass: hook_class,
+            options: options
+          }
+        end
+      end
+
+      ##
+      # Remove a hook from the registry
+      #
+      # @param [Class] hook_class The hook class to remove
+      # @raise [HookNotFoundError] if the hook is not found
+      #
+      def remove(hook_class)
+        pos = @registry.find_index { |opts| opts.fetch(:klass, '') == hook_class }
+        raise HookNotFoundError if pos.nil?
+
+        @registry.delete_at(pos)
+      end
+
+      ##
+      # Insert a hook before another specified hook
+      #
+      # @param [Class] before_class The hook to insert before
+      # @param [Class] hook_class The class of the hook to add
+      # @param [Hash] options A hash of options to pass into the hook during initialization
+      # @raise [HookNotFoundError] if the before hook is not found
+      #
+      def insert_before(before_class, hook_class, options = {})
+        hooks_mutex do
+          pos = @registry.find_index { |opts| opts.fetch(:klass, '') == before_class }
+          raise HookNotFoundError if pos.nil?
+
+          @registry.insert(
+            pos,
+            klass: hook_class,
+            options: options
+          )
+        end
+      end
+
+      ##
+      # Insert a hook after another specified hook
+      #
+      # @param [Class] after_class The hook to insert after
+      # @param [Class] hook_class The class of the hook to add
+      # @param [Hash] options A hash of options to pass into the hook during initialization
+      # @raise [HookNotFoundError] if the after hook is not found
+      #
+      def insert_after(after_class, hook_class, options = {})
+        hooks_mutex do
+          pos = @registry.find_index { |opts| opts.fetch(:klass, '') == after_class }
+          raise HookNotFoundError if pos.nil?
+
+          @registry.insert(
+            (pos + 1),
+            klass: hook_class,
+            options: options
+          )
+        end
+      end
+
+      ##
+      # Return a list of the hook classes in the registry in their execution order
+      #
+      # @return [Array<Class>]
+      #
+      def list
+        hooks_mutex do
+          @registry.map { |h| h[:klass] }
+        end
+      end
+
+      ##
+      # Lazily load and return all hooks for the given request
+      #
+      # @return [Array<Gruf::Hooks::Base>]
+      #
+      def prepare
+        is = []
+        hooks_mutex do
+          @registry.each do |o|
+            is << o[:klass].new(options: o[:options])
+          end
+        end
+        is
+      end
+
+      ##
+      # Clear the registry
+      #
+      def clear
+        hooks_mutex do
+          @registry = []
+        end
+      end
+
+      ##
+      # @return [Integer] The number of hooks currently loaded
+      #
+      def count
+        hooks_mutex do
+          @registry ||= []
+          @registry.count
+        end
+      end
+
+      private
+
+      ##
+      # Handle mutations to the hook registry in a thread-safe manner
+      #
+      def hooks_mutex(&block)
+        @hooks_mutex ||= begin
+          require 'monitor'
+          Monitor.new
+        end
+        @hooks_mutex.synchronize(&block)
+      end
+    end
+  end
+end

data/lib/gruf/instrumentable_grpc_server.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Gruf
+  ##
+  # A subclass of GRPC::RpcServer that can be used for enhanced monitoring
+  # of thread pool. Note that since we are reaching into the internals of
+  # GRPC::RpcServer, we need to watch the evolution of that class.
+  #
+  class InstrumentableGrpcServer < GRPC::RpcServer
+    ##
+    # Add an event_listener_proc that, if supplied, will be called
+    # when interesting events happen in the server.
+    #
+    def initialize(pool_size: DEFAULT_POOL_SIZE,
+                   max_waiting_requests: DEFAULT_MAX_WAITING_REQUESTS,
+                   poll_period: DEFAULT_POLL_PERIOD,
+                   pool_keep_alive: Pool::DEFAULT_KEEP_ALIVE,
+                   connect_md_proc: nil,
+                   server_args: {},
+                   interceptors: [],
+                   event_listener_proc: nil)
+      # Call the base class initializer
+      super(
+        pool_size: pool_size,
+        max_waiting_requests: max_waiting_requests,
+        poll_period: poll_period,
+        pool_keep_alive: pool_keep_alive,
+        connect_md_proc: connect_md_proc,
+        server_args: server_args,
+        interceptors: interceptors
+      )
+
+      # Save event listener for later
+      @event_listener_proc = event_listener_proc
+    end
+
+    ##
+    # Notify the event listener of something interesting
+    #
+    def notify(event)
+      return if @event_listener_proc.nil? || !@event_listener_proc.respond_to?(:call)
+
+      @event_listener_proc.call(event)
+    end
+
+    ##
+    # Hook into the thread pool availability check for monitoring
+    #
+    def available?(an_rpc)
+      super.tap do |obj|
+        notify(:thread_pool_exhausted) unless obj
+      end
+    end
+
+    ##
+    # Hook into the method implementation check for monitoring
+    #
+    def implemented?(an_rpc)
+      super.tap do |obj|
+        notify(:unimplemented) unless obj
+      end
+    end
+  end
+end

data/lib/gruf/integrations/rails/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Gruf
+  module Integrations
+    module Rails
+      class Railtie < ::Rails::Railtie
+      end
+    end
+  end
+end

data/lib/gruf/interceptors/active_record/connection_reset.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
+  module Interceptors
+    module ActiveRecord
+      ##
+      # Resets the ActiveRecord connection to maintain accurate connected state in the thread pool
+      #
+      class ConnectionReset < ::Gruf::Interceptors::ServerInterceptor
+        ##
+        # Reset any ActiveRecord connections after a gRPC service is called. Because of the way gRPC manages its
+        # connection pool, we need to ensure that this is done to properly
+        #
+        def call
+          ::ActiveRecord::Base.establish_connection if enabled? && !::ActiveRecord::Base.connection.active?
+
+          yield
+        ensure
+          ::ActiveRecord::Base.clear_active_connections! if enabled?
+        end
+
+        private
+
+        ##
+        # @return [Boolean] If AR is loaded, we can enable this hook safely
+        #
+        def enabled?
+          defined?(::ActiveRecord::Base)
+        end
+      end
+    end
+  end
+end

data/lib/gruf/interceptors/authentication/basic.rb

@@ -0,0 +1,87 @@
+# 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 'base64'
+
+module Gruf
+  module Interceptors
+    module Authentication
+      ##
+      # Handles basic authentication for gRPC requests
+      #
+      class Basic < Gruf::Interceptors::ServerInterceptor
+        ##
+        # Validate authentication
+        #
+        def call
+          fail!(:unauthenticated, :unauthenticated) unless bypass? || valid?
+          yield
+        end
+
+        private
+
+        ##
+        # @return [Boolean] If this method is in the excluded list, bypass
+        #
+        def bypass?
+          options.fetch(:excluded_methods, []).include?(request.method_name)
+        end
+
+        ##
+        # @return [Boolean] True if the basic authentication was valid
+        #
+        def valid?
+          server_credentials.any? do |cred|
+            username = cred.fetch(:username, '').to_s
+            password = cred.fetch(:password, '').to_s
+            if username.empty?
+              request_password == password
+            else
+              request_credentials == "#{username}:#{password}"
+            end
+          end
+        end
+
+        ##
+        # @return [Array<Hash>] An array of valid server credentials for this service
+        #
+        def server_credentials
+          options.fetch(:credentials, [])
+        end
+
+        ##
+        # @return [String] The decoded request credentials
+        #
+        def request_credentials
+          credentials = if request.active_call.respond_to?(:metadata)
+                          request.active_call.metadata['authorization'].to_s
+                        else
+                          ''
+                        end
+          Base64.decode64(credentials.to_s.gsub('Basic ', '').strip)
+        end
+
+        ##
+        # @return [String] The decoded request password
+        #
+        def request_password
+          @request_password ||= request_credentials.split(':').last
+        end
+      end
+    end
+  end
+end