istox_gruf 2.7.1

data/lib/gruf/outbound/request_context.rb

@@ -0,0 +1,71 @@
+# 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 Outbound
+    ##
+    # Encapsulates the context of an outbound client request
+    #
+    class RequestContext
+      # @var [Symbol]
+      attr_reader :type
+      # @var [Enumerable] requests
+      attr_reader :requests
+      # @var [GRPC::ActiveCall]
+      attr_reader :call
+      # @var [Method] method
+      attr_reader :method
+      # @var [Hash] metadata
+      attr_reader :metadata
+
+      ##
+      # Initialize the new request context
+      #
+      # @param [Symbol] type The type of request
+      # @param [Enumerable] requests An enumerable of requests being sent
+      # @param [GRPC::ActiveCall] call The GRPC ActiveCall object
+      # @param [Method] method The method being called
+      # @param [Hash] metadata A hash of outgoing metadata
+      #
+      def initialize(type:, requests:, call:, method:, metadata:)
+        @type = type
+        @requests = requests
+        @call = call
+        @method = method
+        @metadata = metadata
+      end
+
+      ##
+      # Return the name of the method being called, e.g. GetThing
+      #
+      # @return [String]
+      #
+      def method_name
+        @method.to_s.split('/').last
+      end
+
+      ##
+      # Return the proper routing key for the request
+      #
+      # @return [String]
+      #
+      def route_key
+        @method[1..-1].underscore.tr('/', '.')
+      end
+    end
+  end
+end

data/lib/gruf/response.rb

@@ -0,0 +1,71 @@
+# 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
+  ##
+  # Wraps the active call operation to provide metadata and timing around the request
+  #
+  class Response
+    # @return [GRPC::ActiveCall::Operation] The operation that was executed for the given request
+    attr_reader :operation
+    # @return [Hash] The metadata that was attached to the operation
+    attr_reader :metadata
+    # @return [Hash] The trailing metadata that the service returned
+    attr_reader :trailing_metadata
+    # @return [Time] The set deadline on the call
+    attr_reader :deadline
+    # @return [Boolean] Whether or not the operation was cancelled
+    attr_reader :cancelled
+    # @return [Float] The time that the request took to execute
+    attr_reader :execution_time
+
+    ##
+    # Initialize a response object with the given gRPC operation
+    #
+    # @param [GRPC::ActiveCall::Operation] operation The given operation for the current call
+    # @param [StdClass] message
+    # @param [Float] execution_time The amount of time that the response took to occur
+    #
+    def initialize(operation:, message:, execution_time: nil)
+      @operation = operation
+      @message = message
+      @metadata = operation.metadata
+      @trailing_metadata = operation.trailing_metadata
+      @deadline = operation.deadline
+      @cancelled = operation.cancelled?
+      @execution_time = execution_time || 0.0
+    end
+
+    ##
+    # Return the message returned by the request
+    #
+    # @return [Object] The protobuf response message
+    #
+    def message
+      @message ||= @operation.execute
+    end
+
+    ##
+    # Return execution time of the call internally on the server in ms
+    #
+    # @return [Float] The execution time of the response
+    #
+    def internal_execution_time
+      trailing_metadata['timer'].to_f
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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 Serializers
+    module Errors
+      ##
+      # Base class for serialization of errors for transport across the grpc protocol
+      #
+      class Base
+        # @return [Gruf::Error|String] The error being serialized
+        attr_reader :error
+
+        ##
+        # @param [Gruf::Error|String] err The error to serialize
+        #
+        def initialize(err)
+          @error = err
+        end
+
+        ##
+        # Must be implemented in a derived class. This method should serialize the error into a transportable String
+        # that can be pushed into GRPC metadata across the wire.
+        #
+        # @return [String] The serialized error
+        #
+        def serialize
+          raise NotImplementedError
+        end
+
+        ##
+        # Must be implemented in a derived class. This method should deserialize the error object that is transported
+        # over the gRPC trailing metadata payload.
+        #
+        # @return [Object|Hash] The deserialized error object
+        #
+        def deserialize
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# 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 'json'
+
+module Gruf
+  module Serializers
+    module Errors
+      ##
+      # Serializes the error via JSON for transport
+      #
+      class Json < Base
+        ##
+        # @return [String] The serialized JSON string
+        #
+        def serialize
+          @error.to_h.to_json
+        end
+
+        ##
+        # @return [Hash] A hash deserialized from the inputted JSON
+        #
+        def deserialize
+          JSON.parse(@error)
+        end
+      end
+    end
+  end
+end

data/lib/gruf/server.rb

@@ -0,0 +1,294 @@
+# 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
+  ##
+  # Represents a gRPC server. Automatically loads and augments gRPC handlers and services
+  # based on configuration values.
+  #
+  class Server
+    class ServerAlreadyStartedError < StandardError; end
+
+    include Gruf::Loggable
+
+    # @return [Integer] The port the server is bound to
+    attr_reader :port
+    # @return [Hash] Hash of options passed into the server
+    attr_reader :options
+
+    ##
+    # Initialize the server and load and setup the services
+    #
+    # @param [Hash] opts
+    #
+    def initialize(opts = {})
+      init(opts)
+    end
+
+    def init(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
+      @stop_server = false
+      @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
+
+    ##
+    # @return [GRPC::RpcServer] The GRPC server running
+    #
+    def server
+      @server_mu.synchronize do
+        @server ||= begin
+          # 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
+      end
+    end
+
+    ##
+    # Start the gRPC server
+    #
+    # :nocov:
+    def start!
+      update_proc_title(:starting)
+
+      server_thread = Thread.new do
+        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, 2) }
+        end
+        logger.info { 'Shutting down...' }
+        server.stop
+      end
+
+      server.wait_till_running
+      @started = true
+      update_proc_title(:serving)
+      stop_server_thread.join
+      server_thread.join
+      @started = false
+
+      update_proc_title(:stopped)
+      logger.info { 'Goodbye!' }
+    end
+
+    def init_restart
+      logger.info { 'Restarting gruf...' }
+      @restart = true
+      @stop_server = true
+    end
+
+    def required_restart
+      @restart
+    end
+
+    # :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
+
+    ##
+    # Add an interceptor to the server
+    #
+    # @param [Class] klass The Interceptor to add to the registry
+    # @param [Hash] opts A hash of options for the interceptor
+    # @raise [ServerAlreadyStartedError] if the server is already started
+    #
+    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] opts A hash of options for the interceptor
+    #
+    def insert_interceptor_before(before_class, interceptor_class, opts = {})
+      raise ServerAlreadyStartedError if @started
+
+      @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] opts A hash of options for the interceptor
+    #
+    def insert_interceptor_after(after_class, interceptor_class, opts = {})
+      raise ServerAlreadyStartedError if @started
+
+      @interceptors.insert_after(after_class, interceptor_class, opts)
+    end
+
+    ##
+    # Return the current list of added interceptor classes
+    #
+    # @return [Array<Class>]
+    #
+    def list_interceptors
+      @interceptors.list
+    end
+
+    ##
+    # Remove an interceptor from the server
+    #
+    # @param [Class] klass
+    #
+    def remove_interceptor(klass)
+      raise ServerAlreadyStartedError if @started
+
+      @interceptors.remove(klass)
+    end
+
+    ##
+    # Clear the interceptor registry of interceptors
+    #
+    def clear_interceptors
+      raise ServerAlreadyStartedError if @started
+
+      @interceptors.clear
+    end
+
+    private
+
+    ##
+    # Setup server
+    #
+    # :nocov:
+    def setup
+      setup_signal_handlers
+      load_controllers
+    end
+    # :nocov:
+
+    ##
+    # Register signal handlers
+    #
+    # :nocov:
+    def setup_signal_handlers
+      Signal.trap('INT') do
+        @stop_server = true
+        @stop_server_cv.broadcast
+      end
+
+      Signal.trap('TERM') do
+        @stop_server = true
+        @stop_server_cv.broadcast
+      end
+    end
+    # :nocov:
+
+    ##
+    # Auto-load all gRPC handlers
+    #
+    # :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
+    end
+    # :nocov:
+
+    ##
+    # @param [String]
+    #
+    def controllers_path
+      options.fetch(:controllers_path, Gruf.controllers_path)
+    end
+
+    ##
+    # Load the SSL/TLS credentials for this server
+    #
+    # @return [GRPC::Core::ServerCredentials|Symbol]
+    #
+    # :nocov:
+    def ssl_credentials
+      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:
+
+    ##
+    # Updates proc name/title
+    #
+    # @param [Symbol] state
+    #
+    # :nocov:
+    def update_proc_title(state)
+      Process.setproctitle("gruf #{Gruf::VERSION} -- #{state}")
+    end
+    # :nocov:
+  end
+end