gruf 1.0.0

data/lib/gruf/configuration.rb

@@ -0,0 +1,124 @@
+# 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
+  ##
+  # Represents configuration settings for the system
+  #
+  module Configuration
+    VALID_CONFIG_KEYS = {
+      root_path: '',
+      server_binding_url: '0.0.0.0:9001',
+      authentication_options: {},
+      instrumentation_options: {},
+      hook_options: {},
+      default_client_host: '',
+      use_ssl: false,
+      ssl_crt_file: '',
+      ssl_key_file: '',
+      servers_path: '',
+      services: [],
+      logger: nil,
+      grpc_logger: nil,
+      error_metadata_key: :'error-internal-bin',
+      error_serializer: nil,
+      authorization_metadata_key: 'authorization',
+      append_server_errors_to_trailing_metadata: true,
+      use_default_hooks: true,
+      backtrace_on_error: false
+    }.freeze
+
+    attr_accessor *VALID_CONFIG_KEYS.keys
+
+    ##
+    # Whenever this is extended into a class, setup the defaults
+    #
+    def self.extended(base)
+      base.reset
+    end
+
+    ##
+    # Yield self for ruby-style initialization
+    #
+    # @yields [Gruf::Configuration]
+    # @return [Gruf::Configuration]
+    #
+    def configure
+      yield self
+    end
+
+    ##
+    # Return the current configuration options as a Hash
+    #
+    # @return [Hash]
+    #
+    def options
+      opts = {}
+      VALID_CONFIG_KEYS.each do |k, _v|
+        opts.merge!(k => send(k))
+      end
+      opts
+    end
+
+    ##
+    # Set the default configuration onto the extended class
+    #
+    # @return [Hash] options The reset options hash
+    #
+    def reset
+      VALID_CONFIG_KEYS.each do |k, v|
+        send((k.to_s + '=').to_sym, v)
+      end
+      if defined?(Rails) && Rails.logger
+        self.root_path = Rails.root
+        self.logger = Rails.logger
+      else
+        require 'logger'
+        self.logger = ::Logger.new(STDOUT)
+      end
+      self.grpc_logger = logger if grpc_logger.nil?
+      self.ssl_crt_file = "#{root_path}/config/ssl/#{environment}.crt"
+      self.ssl_key_file = "#{root_path}/config/ssl/#{environment}.key"
+      self.servers_path = "#{root_path}/app/rpc"
+      self.authentication_options = {
+        credentials: [{
+          username: 'grpc',
+          password: 'magic'
+        }]
+      }
+      if use_default_hooks
+        Gruf::Hooks::Registry.add(:ar_connection_reset, Gruf::Hooks::ActiveRecord::ConnectionReset)
+        Gruf::Instrumentation::Registry.add(:output_metadata_timer, Gruf::Instrumentation::OutputMetadataTimer)
+      end
+      options
+    end
+
+    private
+
+    ##
+    # Automatically determine environment
+    #
+    # @return [String]
+    #
+    def environment
+      if defined?(Rails)
+        Rails.env.to_s
+      else
+        (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development').to_s
+      end
+    end
+  end
+end

data/lib/gruf/error.rb

@@ -0,0 +1,162 @@
+# 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 'errors/field'
+require_relative 'errors/debug_info'
+require_relative 'serializers/errors/base'
+require_relative 'serializers/errors/json'
+
+module Gruf
+  ##
+  # Represents a error that can be transformed into a gRPC error and have metadata attached to the trailing headers.
+  # This layer acts as an middle layer that can have metadata injection, tracing support, and other functionality
+  # not present in the gRPC core.
+  #
+  class Error
+    include Gruf::Loggable
+
+    TYPES = {
+      ok: GRPC::Ok,
+      cancelled: GRPC::Cancelled,
+      unknown: GRPC::Unknown,
+      invalid_argument: GRPC::InvalidArgument,
+      bad_request: GRPC::InvalidArgument,
+      deadline_exceeded: GRPC::DeadlineExceeded,
+      not_found: GRPC::NotFound,
+      already_exists: GRPC::AlreadyExists,
+      unauthorized: GRPC::PermissionDenied,
+      permission_denied: GRPC::PermissionDenied,
+      unauthenticated: GRPC::Unauthenticated,
+      resource_exhausted: GRPC::ResourceExhausted,
+      failed_precondition: GRPC::FailedPrecondition,
+      aborted: GRPC::Aborted,
+      out_of_range: GRPC::OutOfRange,
+      unimplemented: GRPC::Unimplemented,
+      internal: GRPC::Internal,
+      unavailable: GRPC::Unavailable,
+      data_loss: GRPC::DataLoss
+    }.freeze
+
+    attr_accessor :code, :app_code, :message, :field_errors, :debug_info, :grpc_error
+    attr_reader :metadata
+
+    ##
+    # Initialize the error, setting default values
+    #
+    def initialize(args = {})
+      args.each do |k, v|
+        send("#{k.to_sym}=", v) if respond_to?(k.to_sym)
+      end
+      @field_errors = []
+    end
+
+    ##
+    # Add a field error to this error package
+    #
+    # @param [Symbol] field_name
+    # @param [Symbol] error_code
+    # @param [String] message
+    #
+    def add_field_error(field_name, error_code, message = '')
+      @field_errors << Errors::Field.new(field_name, error_code, message)
+    end
+
+    ##
+    # @param [String] detail
+    # @param [Array<String>] stack_trace
+    #
+    def set_debug_info(detail, stack_trace = [])
+      @debug_info = Errors::DebugInfo.new(detail, stack_trace)
+    end
+
+    ##
+    # Ensure all metadata values are strings
+    #
+    def metadata=(md)
+      @metadata = md.map { |k, str| [k, str.to_s] }.to_h
+    end
+
+    ##
+    # Serialize the error for transport
+    #
+    # @return [String]
+    #
+    def serialize
+      serializer = serializer_class.new(self)
+      serializer.serialize.to_s
+    end
+
+    ##
+    # @param [GRPC::ActiveCall]
+    # @return [Error]
+    #
+    def attach_to_call(active_call)
+      metadata[Gruf.error_metadata_key.to_sym] = serialize if Gruf.append_server_errors_to_trailing_metadata
+      if !metadata.empty? && active_call && active_call.respond_to?(:output_metadata)
+        active_call.output_metadata.update(metadata)
+      end
+      self
+    end
+
+    ##
+    # @param [GRPC::ActiveCall]
+    # @return [GRPC::BadStatus]
+    #
+    def fail!(active_call)
+      raise attach_to_call(active_call).grpc_error
+    end
+
+    ##
+    # @return [Hash]
+    #
+    def to_h
+      {
+        code: code,
+        app_code: app_code,
+        message: message,
+        field_errors: field_errors.map(&:to_h),
+        debug_info: debug_info.to_h
+      }
+    end
+
+    ##
+    # @return [GRPC::BadStatus]
+    #
+    def grpc_error
+      @grpc_error = grpc_class.new(message, **@metadata)
+    end
+
+    private
+
+    ##
+    # @return [Gruf::Serializers::Errors::Base]
+    #
+    def serializer_class
+      if Gruf.error_serializer
+        Gruf.error_serializer.is_a?(Class) ? Gruf.error_serializer : Gruf.error_serializer.to_s.constantize
+      else
+        Gruf::Serializers::Errors::Json
+      end
+    end
+
+    ##
+    # @return [Class]
+    #
+    def grpc_class
+      TYPES[code]
+    end
+  end
+end

data/lib/gruf/errors/debug_info.rb

@@ -0,0 +1,45 @@
+# 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 Errors
+    ##
+    # Represents debugging information
+    #
+    class DebugInfo
+      attr_reader :detail, :stack_trace
+
+      ##
+      # @param [String] detail
+      # @param [Array<String>] stack_trace
+      #
+      def initialize(detail, stack_trace = [])
+        @detail = detail
+        @stack_trace = stack_trace.is_a?(String) ? stack_trace.split("\n") : stack_trace
+      end
+
+      ##
+      # @return [Hash]
+      #
+      def to_h
+        {
+          detail: detail,
+          stack_trace: stack_trace
+        }
+      end
+    end
+  end
+end

data/lib/gruf/errors/field.rb

@@ -0,0 +1,48 @@
+# 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 Errors
+    ##
+    # Represents a field-specific error
+    #
+    class Field
+      attr_reader :field_name, :error_code, :message
+
+      ##
+      # @param [Symbol] field_name
+      # @param [Symbol] error_code
+      # @param [String] message
+      #
+      def initialize(field_name, error_code, message = '')
+        @field_name = field_name
+        @error_code = error_code
+        @message = message
+      end
+
+      ##
+      # @return [Hash]
+      #
+      def to_h
+        {
+          field_name: field_name,
+          error_code: error_code,
+          message: message
+        }
+      end
+    end
+  end
+end

data/lib/gruf/hooks/active_record/connection_reset.rb

@@ -0,0 +1,36 @@
+# 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 Hooks
+    module ActiveRecord
+      ##
+      # Resets the ActiveRecord connection to maintain accurate connected state in the thread pool
+      #
+      class ConnectionReset < Gruf::Hooks::Base
+        def after(_success, _response, _call_signature, _req, _call)
+          ::ActiveRecord::Base.clear_active_connections! if enabled?
+        end
+
+        private
+
+        def enabled?
+          defined?(::ActiveRecord::Base)
+        end
+      end
+    end
+  end
+end

data/lib/gruf/hooks/base.rb

@@ -0,0 +1,44 @@
+# 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 Hooks
+    ##
+    # Base class for a hook. Define before, around, or after methods to utilize functionality.
+    #
+    class Base
+      include Gruf::Loggable
+
+      attr_reader :options, :service
+
+      ##
+      # @param [Gruf::Service] service
+      # @param [Hash] options
+      #
+      def initialize(service, options = {})
+        @service = service
+        @options = options
+        setup
+      end
+
+      ##
+      # Method that can be used to setup the hook prior to running it
+      def setup
+        # noop
+      end
+    end
+  end
+end