gruf 1.0.0

data/lib/gruf/hooks/registry.rb

@@ -0,0 +1,104 @@
+# coding: utf-8
+# 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_relative 'base'
+require_relative 'active_record/connection_reset'
+
+module Gruf
+  module Hooks
+    ##
+    # Registry of all hooks added
+    #
+    class Registry
+      class HookDescendantError < StandardError; end
+
+      class << self
+        ##
+        # Add an authentication strategy, either through a class or a block
+        #
+        # @param [String] name
+        # @param [Gruf::Hooks::Base|NilClass] hook
+        # @return [Class]
+        #
+        def add(name, hook = nil, &block)
+          base = Gruf::Hooks::Base
+          hook ||= Class.new(base)
+          hook.class_eval(&block) if block_given?
+
+          # all hooks require either the before, after, or around method
+          raise NoMethodError unless hook.method_defined?(:before) || hook.method_defined?(:after) || hook.method_defined?(:around) || hook.method_defined?(:outer_around)
+
+          raise HookDescendantError, "Hooks must descend from #{base}" unless hook.ancestors.include?(base)
+
+          _registry[name.to_sym] = hook
+        end
+
+        ##
+        # Return a strategy type registry via a hash accessor syntax
+        #
+        def [](name)
+          _registry[name.to_sym]
+        end
+
+        ##
+        # Iterate over each hook in the registry
+        #
+        def each
+          _registry.each do |name, s|
+            yield name, s
+          end
+        end
+
+        ##
+        # @return [Hash<Class>]
+        #
+        def to_h
+          _registry
+        end
+
+        ##
+        # @return [Boolean]
+        #
+        def any?
+          count > 0
+        end
+
+        ##
+        # @return [Integer]
+        #
+        def count
+          to_h.keys.count
+        end
+
+        ##
+        # @return [Hash]
+        #
+        def clear
+          @_registry = {}
+        end
+
+        private
+
+        ##
+        # @return [Hash<Class>]
+        #
+        def _registry
+          @_registry ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/gruf/instrumentation/base.rb

@@ -0,0 +1,59 @@
+# coding: utf-8
+# 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 Instrumentation
+    ##
+    # Base class for a hook. Define before, around, or after methods to utilize functionality.
+    #
+    class Base
+      include Gruf::Loggable
+
+      attr_reader :options, :service, :response, :request, :execution_time, :call_signature, :active_call
+
+      def initialize(service, request, response, execution_time, call_signature, active_call, options = {})
+        @service = service
+        @request = request
+        @response = response
+        @execution_time = execution_time
+        @call_signature = call_signature.to_s.gsub('_without_intercept', '').to_sym
+        @active_call = active_call
+        @options = options
+        setup
+      end
+
+      ##
+      # Useful for setting up an instrumentation module post instantiation
+      #
+      def setup
+        # noop
+      end
+
+      ##
+      # @return [Boolean]
+      #
+      def success?
+        !response.is_a?(GRPC::BadStatus)
+      end
+
+      ##
+      #
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/gruf/instrumentation/output_metadata_timer.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+# 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 Instrumentation
+    ##
+    # Appends the timer metadata to the active call output metadata
+    #
+    class OutputMetadataTimer < Gruf::Instrumentation::Base
+      ##
+      # Handle the instrumented response. Note: this will only instrument timings of _successful_ responses.
+      #
+      def call
+        active_call.output_metadata.update(metadata_key => execution_time.to_s)
+      end
+
+      private
+
+      ##
+      # @return [Symbol]
+      #
+      def metadata_key
+        options.fetch(:output_metadata_timer, {}).fetch(:metadata_key, :timer).to_sym
+      end
+    end
+  end
+end

data/lib/gruf/instrumentation/registry.rb

@@ -0,0 +1,95 @@
+# coding: utf-8
+# 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_relative 'base'
+require_relative 'statsd'
+require_relative 'output_metadata_timer'
+
+module Gruf
+  module Instrumentation
+    ##
+    # Registry of all hooks added
+    #
+    class Registry
+      class HookDescendantError < StandardError; end
+
+      class << self
+        ##
+        # Add an authentication strategy, either through a class or a block
+        #
+        # @param [String] name
+        # @param [Gruf::Hooks::Base|NilClass] hook
+        # @return [Class]
+        #
+        def add(name, hook = nil, &block)
+          base = Gruf::Instrumentation::Base
+          hook ||= Class.new(base)
+          hook.class_eval(&block) if block_given?
+
+          raise HookDescendantError, "Hooks must descend from #{base}" unless hook.ancestors.include?(base)
+
+          _registry[name.to_sym] = hook
+        end
+
+        ##
+        # Return a strategy type registry via a hash accessor syntax
+        #
+        def [](name)
+          _registry[name.to_sym]
+        end
+
+        ##
+        # Iterate over each hook in the registry
+        #
+        def each
+          _registry.each do |name, s|
+            yield name, s
+          end
+        end
+
+        ##
+        # @return [Hash<Class>]
+        #
+        def to_h
+          _registry
+        end
+
+        ##
+        # @return [Boolean]
+        #
+        def any?
+          to_h.keys.count > 0
+        end
+
+        ##
+        # @return [Hash]
+        #
+        def clear
+          @_registry = {}
+        end
+
+        private
+
+        ##
+        # @return [Hash<Class>]
+        #
+        def _registry
+          @_registry ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/gruf/instrumentation/statsd.rb

@@ -0,0 +1,74 @@
+# coding: utf-8
+# 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 Instrumentation
+    ##
+    # Adds increment and timing stats to gRPC routes, pushing data to StatsD
+    #
+    class Statsd < Gruf::Instrumentation::Base
+      ##
+      # Push data to StatsD, only doing so if a client is set
+      #
+      def call
+        if client
+          client.increment(route_key)
+          client.timing(route_key, execution_time)
+        else
+          Gruf.logger.error 'Statsd module loaded, but no client configured!'
+        end
+      end
+
+      private
+
+      ##
+      # @return [String]
+      #
+      def route_key
+        "#{key_prefix}#{service_key}.#{call_signature}"
+      end
+
+      ##
+      # @return [String]
+      #
+      def service_key
+        service.class.name.underscore.tr('/', '.')
+      end
+
+      ##
+      # @return [String]
+      #
+      def key_prefix
+        prefix = options.fetch(:prefix, '').to_s
+        prefix.empty? ? '' : "#{prefix}."
+      end
+
+      ##
+      # @return [::Statsd]
+      #
+      def client
+        @client ||= options.fetch(:client, nil)
+      end
+
+      ##
+      # @return [Hash]
+      #
+      def options
+        @options.fetch(:statsd, {})
+      end
+    end
+  end
+end

data/lib/gruf/loggable.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+# 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 Loggable
+    ##
+    # @return [Logger]
+    #
+    def logger
+      Gruf.logger
+    end
+  end
+end

data/lib/gruf/logging.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+# 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 Logger
+    def logger
+      Gruf.logger
+    end
+  end
+
+  module GrpcLogger
+    def logger
+      Gruf.grpc_logger
+    end
+  end
+end
+
+module GRPC
+  extend Gruf::GrpcLogger
+end

data/lib/gruf/response.rb

@@ -0,0 +1,55 @@
+# coding: utf-8
+# 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
+  ##
+  # Wraps the active call operation to provide metadata and timing around the request
+  #
+  class Response
+    attr_reader :operation, :metadata, :trailing_metadata, :deadline, :cancelled, :execution_time
+
+    ##
+    # @param [GRPC::ActiveCall::Operation] op
+    # @param [Float] execution_time
+    #
+    def initialize(op, execution_time = nil)
+      @operation = op
+      @message = op.execute
+      @metadata = op.metadata
+      @trailing_metadata = op.trailing_metadata
+      @deadline = op.deadline
+      @cancelled = op.cancelled?
+      @execution_time = execution_time || 0.0
+    end
+
+    ##
+    # Return the message returned by the request
+    #
+    def message
+      @message ||= op.execute
+    end
+
+    ##
+    # Return execution time of the call internally on the server in ms
+    #
+    # @return [Integer]
+    #
+    def internal_execution_time
+      key = Gruf.instrumentation_options.fetch(:output_metadata_timer, {}).fetch(:metadata_key, 'timer')
+      trailing_metadata[key].to_f
+    end
+  end
+end