gruf 1.2.7 → 2.0.0

data/lib/gruf/controllers/base.rb

@@ -0,0 +1,82 @@
+# 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 'request'
+require_relative 'service_binder'
+
+module Gruf
+  module Controllers
+    ##
+    # Base controller object for Gruf gRPC requests
+    #
+    class Base
+      include Gruf::Errors::Helpers
+
+      # @var [Gruf::Controller::Request] request
+      attr_reader :request
+      # @var [Gruf::Error] error
+      attr_reader :error
+
+      ##
+      # Initialize the controller within the given request context
+      #
+      # @param [Symbol] method_key
+      # @param [GRPC::GenericService] service
+      # @param [GRPC::RpcDesc] rpc_desc
+      # @param [GRPC::ActiveCall] active_call
+      # @param [Google::Protobuf::MessageExts] message
+      #
+      def initialize(method_key:, service:, rpc_desc:, active_call:, message:)
+        @request = Request.new(
+          method_key: method_key,
+          service: service,
+          rpc_desc: rpc_desc,
+          active_call: active_call,
+          message: message
+        )
+        @error = Gruf::Error.new
+        @interceptors = Gruf.interceptors.prepare(@request, @error)
+      end
+
+      ##
+      # Bind the controller to the given service and add it to the service registry
+      #
+      # @param [GRPC::GenericService] service
+      #
+      def self.bind(service)
+        Gruf.services << service.name.constantize
+        ServiceBinder.new(service).bind!(self)
+      end
+
+      ##
+      # Call a method on this controller
+      #
+      # @param [Symbol] method_key
+      #
+      def call(method_key, &block)
+        Interceptors::Context.new(@interceptors).intercept! do
+          send(method_key, &block)
+        end
+      rescue GRPC::BadStatus
+        raise # passthrough
+      rescue => e
+        set_debug_info(e.message, e.backtrace) if Gruf.backtrace_on_error
+        error_message = Gruf.use_exception_message ? e.message : Gruf.internal_error_message
+        fail!(:internal, :unknown, error_message)
+      end
+    end
+  end
+end

data/lib/gruf/controllers/request.rb

@@ -0,0 +1,96 @@
+# 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 Controllers
+    ##
+    # Encapsulates a request for a controller
+    #
+    class Request
+      # @var [Object] message
+      attr_reader :message
+      # @var [GRPC::ActiveCall] active_call
+      attr_reader :active_call
+      # @var [Symbol] method_key
+      attr_reader :method_key
+      # @var [Gruf::Controllers::Request::Type] type
+      attr_reader :type
+
+      delegate :metadata, to: :active_call
+      delegate :messages, :client_streamer?, :server_streamer?, :bidi_streamer?, :request_response?, to: :type
+
+      class Type
+        delegate :client_streamer?, :server_streamer?, :bidi_streamer?, :request_response?, to: :@rpc_desc
+
+        ##
+        # @param [GRPC::RpcDesc] rpc_desc
+        #
+        def initialize(rpc_desc)
+          @rpc_desc = rpc_desc
+        end
+      end
+
+      ##
+      # @param [Symbol] method_key The method symbol of the RPC method being executed
+      # @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
+      #
+      def initialize(method_key:, service:, rpc_desc:, active_call:, message:)
+        @method_key = method_key
+        @service = service
+        @active_call = active_call
+        @message = message
+        @type = Type.new(rpc_desc)
+      end
+
+      ##
+      # Returns the service name as a translated name separated by periods. Strips
+      # the superfluous "Service" suffix from the name
+      #
+      # @return [String]
+      #
+      def service_key
+        @service.name.underscore.tr('/', '.').gsub('.service', '')
+      end
+
+      ##
+      # Parse the method signature into a service.method name format
+      #
+      # @return [String] The parsed service method name
+      #
+      def method_name
+        "#{service_key}.#{method_key}"
+      end
+
+      ##
+      # Return all messages for this request, properly handling different request types
+      #
+      # @return Enumerable<Object>
+      #
+      def messages
+        if client_streamer?
+          message.call { |msg| yield msg }
+        elsif bidi_streamer?
+          message
+        else
+          [message]
+        end
+      end
+    end
+  end
+end

data/lib/gruf/controllers/service_binder.rb

@@ -0,0 +1,86 @@
+# 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 Controllers
+    ##
+    # Binds gRPC services to a gruf controller
+    #
+    class ServiceBinder
+      ##
+      # Represents a bound RPC descriptor for future-proofing internal helpers
+      #
+      class BoundDesc < SimpleDelegator; end
+
+      ##
+      # @param [GRPC::GenericService] service
+      #
+      def initialize(service)
+        @service = service
+      end
+
+      ##
+      # @param [Gruf::Controllers::Base]
+      #
+      def bind!(controller)
+        rpc_methods.each { |name, desc| bind_method(controller, name, desc) }
+      end
+
+      private
+
+      ##
+      # @param [Gruf::Controllers::Base] controller
+      # @param [Symbol] method_name
+      # @param [BoundDesc] desc
+      #
+      def bind_method(controller, method_name, desc)
+        method_key = method_name.to_s.underscore.to_sym
+        service_ref = @service
+
+        @service.class_eval do
+          if desc.request_response?
+            define_method(method_key) do |message, active_call|
+              c = controller.new(method_key: method_key, service: service_ref, message: message, active_call: active_call, rpc_desc: desc)
+              c.call(method_key)
+            end
+          elsif desc.client_streamer?
+            define_method(method_key) do |active_call|
+              c = controller.new(method_key: method_key, service: service_ref, message: proc { |&block| active_call.each_remote_read(&block) }, active_call: active_call, rpc_desc: desc)
+              c.call(method_key)
+            end
+          elsif desc.server_streamer?
+            define_method(method_key) do |message, active_call, &block|
+              c = controller.new(method_key: method_key, service: service_ref, message: message, active_call: active_call, rpc_desc: desc)
+              c.call(method_key, &block)
+            end
+          else # bidi
+            define_method(method_key) do |messages, active_call, &block|
+              c = controller.new(method_key: method_key, service: service_ref, message: messages, active_call: active_call, rpc_desc: desc)
+              c.call(method_key, &block)
+            end
+          end
+        end
+      end
+
+      ##
+      # @return Array<Gruf::Controllers::ServiceBinder::BoundDesc>
+      #
+      def rpc_methods
+        @service.rpc_descs.map { |rd| BoundDesc.new(rd) }
+      end
+    end
+  end
+end

data/lib/gruf/error.rb

@@ -90,6 +90,15 @@ module Gruf
       @field_errors << Errors::Field.new(field_name, error_code, message)
     end
 
+    ##
+    # Return true if there are any present field errors
+    #
+    # @return [Boolean] True if the service has any field errors
+    #
+    def has_field_errors?
+      @field_errors.any?
+    end
+
     ##
     # Set the debugging information for the error message
     #

data/lib/gruf/errors/helpers.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 Errors
+    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 → interceptors}/active_record/connection_reset.rb

@@ -15,25 +15,19 @@
 # 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 Interceptors
     module ActiveRecord
       ##
       # Resets the ActiveRecord connection to maintain accurate connected state in the thread pool
       #
-      class ConnectionReset < Gruf::Hooks::Base
+      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
         #
-        # @param [Boolean] _success Whether or not the call was successful
-        # @param [Object] _response The protobuf response object
-        # @param [Symbol] _call_signature The gRPC method on the service that was called
-        # @param [Object] _request The protobuf request object
-        # @param [GRPC::ActiveCall] _call the gRPC core active call object, which represents marshalled data for
-        # the call itself
-        #
-        def after(_success, _response, _call_signature, _request, _call)
+        def call
           ::ActiveRecord::Base.clear_active_connections! if enabled?
+          yield
         end
 
         private

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

@@ -0,0 +1,80 @@
+# 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 'base64'
+
+module Gruf
+  module Interceptors
+    module Authentication
+      ##
+      # Handles basic authentication for gRPC requests
+      #
+      class Basic < Gruf::Interceptors::ServerInterceptor
+
+        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 = request.active_call.respond_to?(:metadata) ? request.active_call.metadata['authorization'].to_s : ''
+          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

data/lib/gruf/interceptors/base.rb

@@ -0,0 +1,51 @@
+# 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 Interceptors
+    ##
+    # Base class for interception requests
+    #
+    class Base
+      # @var [Gruf::Controllers::Request] request
+      attr_reader :request
+      # @var [Gruf::Error] error
+      attr_reader :error
+      # @var [Hash] options
+      attr_reader :options
+
+      ##
+      # @param [Gruf::Controllers::Request] request
+      # @param [Gruf::Error] error
+      # @param [Hash] options
+      #
+      def initialize(request, error, options = {})
+        @request = request
+        @error = error
+        @options = options || {}
+      end
+    end
+  end
+end
+
+require_relative 'server_interceptor'
+require_relative 'context'
+require_relative 'timer'
+require_relative 'active_record/connection_reset'
+require_relative 'authentication/basic'
+require_relative 'instrumentation/statsd'
+require_relative 'instrumentation/output_metadata_timer'
+require_relative 'instrumentation/request_logging/interceptor'