gruf 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f730b985ec9be1cdbe0ad8333a6b4e0bdf63e91c
-  data.tar.gz: 4279e2c4c19621269c876984b050cd2b1b5556ad
+  metadata.gz: 0c2a05e3aed4e246d1e0de691d1b9ee25fe33efd
+  data.tar.gz: a829923c5dd79579525e2034e6b3dabc995f1b20
 SHA512:
-  metadata.gz: eed32a217e3e649c51944b0b12cc4b3ae7ae7b8a37acbbd3bf6963aa54acdb78d17a2136527541423936474b914347dc40b5fb181ba7cbd643a5b6eda1e8e6ad
-  data.tar.gz: 59fa0142e79caad40ebbc00b14a9f18fa6b3d00bfe74ae66259a621e9f0eeee4e622dc9d928fcb85594c7468a2977d2993439d8fe57c2f617dfbd8b5569a0f29
+  metadata.gz: ada2953033d6ca5850c35f5f63a59e86489d1c55bd909e72c73d155c7348f32bffc3168531bcc00f548c06f3f75ea480616b5a20370fb3f3708c12d3f5cb5b9e
+  data.tar.gz: 317a912622dc017fc6568bb66aeace92a620175f2cb6e99047f320777b4b9b7f805ef1ce39039650d6b0074a105b0da460c354b5a22f33a6c9eb2cf97bb13e02

data/CHANGELOG.md

@@ -2,6 +2,14 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.1.0
+
+- Add ability to list, clear, insert before, insert after, and remove to a server's interceptor
+registry
+- Ensure interceptors and services cannot be adjusted on the server after it starts to 
+prevent threading issues
+- [#36], [#37] Adds `response_class`, `request_class`, and `service` accessors to controller request
+
 ### 2.0.3
 
 - Fix regression [#35] where gruf was not able to be loaded outside of a Rails application

data/README.md

@@ -17,7 +17,7 @@ up fast and efficiently at scale. Some of its features include:
   still preserving gRPC BadStatus codes
 * Server and client execution timings in responses
 
-gruf currently has active support for gRPC 1.4.x-1.6.x. gruf is compatible and tested with Ruby 2.2, 
+gruf currently has active support for gRPC 1.4.x-1.8.x. gruf is compatible and tested with Ruby 2.2,
 2.3, and 2.4. gruf is also not [Rails](https://github.com/rails/rails)-specific, and can be used in any 
 Ruby framework (such as [Grape](https://github.com/ruby-grape/grape), for instance).
 
@@ -239,6 +239,10 @@ Gruf.configure do |c|
 end
 ```
 
+By default, the ActiveRecord Connection Reset interceptor and Output Metadata Timing interceptor
+are loaded into gruf unless explicitly told not to via the `use_default_interceptors` configuration
+parameter.
+
 ## Instrumentation
 
 gruf comes out of the box with a couple of instrumentation interceptors packed in: 
@@ -323,6 +327,7 @@ view and clone that shows how to integrate Gruf into an existing Rails applicati
 ### Gruf 3.0
 
 * Utilize the new core Ruby interceptors in gRPC 1.7
+* Support client interceptors
 * Change configuration to an injectable object to ensure thread safety on chained server/client interactions
 * Move all references to `Gruf.` configuration into injectable parameters
 * Redo server configuration to be fully injectable

data/lib/gruf/controllers/request.rb

@@ -27,6 +27,8 @@ module Gruf
       attr_reader :method_key
       # @var [Gruf::Controllers::Request::Type] type
       attr_reader :type
+      # @var [Class] service
+      attr_reader :service
 
       delegate :metadata, to: :active_call
       delegate :messages, :client_streamer?, :server_streamer?, :bidi_streamer?, :request_response?, to: :type
@@ -54,6 +56,7 @@ module Gruf
         @service = service
         @active_call = active_call
         @message = message
+        @rpc_desc = rpc_desc
         @type = Type.new(rpc_desc)
       end
 
@@ -67,6 +70,20 @@ module Gruf
         @service.name.underscore.tr('/', '.').gsub('.service', '')
       end
 
+      ##
+      # @return [Class]
+      #
+      def response_class
+        @rpc_desc.output
+      end
+
+      ##
+      # @return [Class]
+      #
+      def request_class
+        @rpc_desc.input
+      end
+
       ##
       # Parse the method signature into a service.method name format
       #

data/lib/gruf/interceptors/registry.rb

@@ -28,7 +28,7 @@ module Gruf
       ##
       # Add an interceptor to the registry
       #
-      # @param [Gruf::Interceptors::Base] interceptor_class The class of the interceptor to add
+      # @param [Class] interceptor_class The class of the interceptor to add
       # @param [Hash] options A hash of options to pass into the interceptor during initialization
       #
       def use(interceptor_class, options = {})
@@ -40,12 +40,25 @@ module Gruf
         end
       end
 
+      ##
+      # Remove an interceptor from the registry
+      #
+      # @param [Class] interceptor_class The interceptor class to remove
+      # @raise [InterceptorNotFoundError] if the interceptor is not found
+      #
+      def remove(interceptor_class)
+        pos = @registry.find_index { |opts| opts.fetch(:klass, '') == interceptor_class }
+        raise InterceptorNotFoundError if pos.nil?
+        @registry.delete_at(pos)
+      end
+
       ##
       # Insert an interceptor before another specified interceptor
       #
-      # @param [Gruf::Interceptors::Base] before_class The interceptor to insert before
-      # @param [Gruf::Interceptors::Base] interceptor_class The class of the interceptor to add
+      # @param [Class] before_class The interceptor to insert before
+      # @param [Class] interceptor_class The class of the interceptor to add
       # @param [Hash] options A hash of options to pass into the interceptor during initialization
+      # @raise [InterceptorNotFoundError] if the before interceptor is not found
       #
       def insert_before(before_class, interceptor_class, options = {})
         interceptors_mutex do
@@ -62,9 +75,10 @@ module Gruf
       ##
       # Insert an interceptor after another specified interceptor
       #
-      # @param [Gruf::Interceptors::Base] after_class The interceptor to insert after
-      # @param [Gruf::Interceptors::Base] interceptor_class The class of the interceptor to add
+      # @param [Class] after_class The interceptor to insert after
+      # @param [Class] interceptor_class The class of the interceptor to add
       # @param [Hash] options A hash of options to pass into the interceptor during initialization
+      # @raise [InterceptorNotFoundError] if the after interceptor is not found
       #
       def insert_after(after_class, interceptor_class, options = {})
         interceptors_mutex do
@@ -78,6 +92,17 @@ module Gruf
         end
       end
 
+      ##
+      # Return a list of the interceptor classes in the registry in their execution order
+      #
+      # @return [Array<Class>]
+      #
+      def list
+        interceptors_mutex do
+          @registry.map { |h| h[:klass] }
+        end
+      end
+
       ##
       # Load and return all interceptors for the given request
       #

data/lib/gruf/server.rb

@@ -19,6 +19,8 @@ module Gruf
   # based on configuration values.
   #
   class Server
+    class ServerAlreadyStartedError < StandardError; end
+
     include Gruf::Loggable
 
     # @return [Integer] The port the server is bound to
@@ -36,6 +38,7 @@ module Gruf
       @interceptors = options.fetch(:interceptor_registry, Gruf.interceptors)
       @interceptors = Gruf::Interceptors::Registry.new unless @interceptors.is_a?(Gruf::Interceptors::Registry)
       @services = []
+      @started = false
       setup!
     end
 
@@ -58,9 +61,11 @@ module Gruf
     # rubocop:disable Lint/ShadowedException
     def start!
       logger.info { 'Booting gRPC Server...' }
+      @started = true
       server.run_till_terminated
     rescue Interrupt, SignalException, SystemExit
       logger.info { 'Shutting down gRPC server...' }
+      @started = false
       server.stop
     end
     # :nocov:
@@ -68,21 +73,70 @@ module 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 [Gruf::Interceptors::Base]
-    # @param [Hash]
+    # @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
 
+    ##
+    # @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] options A hash of options for the interceptor
+    #
+    def insert_interceptor_before(before_class, interceptor_class, options = {})
+      raise ServerAlreadyStartedError if @started
+      @interceptors.insert_before(before_class, interceptor_class, options)
+    end
+
+    ##
+    # @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] options A hash of options for the interceptor
+    #
+    def insert_interceptor_after(after_class, interceptor_class, options = {})
+      raise ServerAlreadyStartedError if @started
+      @interceptors.insert_after(after_class, interceptor_class, options)
+    end
+
+    ##
+    # Return the current list of added interceptor classes
+    #
+    # @return [Array<Class>]
+    #
+    def list_interceptors
+      @interceptors.list
+    end
+
+    ##
+    # Remove an interceptor from the server
+    #
+    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
 
     ##

data/lib/gruf/version.rb

@@ -14,5 +14,5 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  VERSION = '2.0.3'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-07 00:00:00.000000000 Z
+date: 2017-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: gRPC Ruby Framework