gruf 2.16.2 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0508561578b2ebd6490bebfeeee8f4442d4bcec1d1cb877dc0005933564fc33
-  data.tar.gz: b4130a47d10681a4876046aa782640091799d99f433cc5f6ae55f6dce1f60ecf
+  metadata.gz: 3de94291c905860137fbeb2be431f470af5929eddd3df869b602944dbe3253ea
+  data.tar.gz: 282cd45242df875e8c664a9434bb7364592a5062e4d3d4980972d9a314931996
 SHA512:
-  metadata.gz: 1a9e198be4481b4e56c3e57fb7d76be2ce97e6cbe30368fadc990a505d1864c98f1e0d25f02c8209a0dafd89021537b15f6f12a83323ec3c8a7ff114c7c8094b
-  data.tar.gz: 5fc8489af23aa0e387aa84dc4104e7812aa0a767ddb32e6bf83f331442b79073f57c5ef97b2326ff9ec64cebf018d76589ce5f964bf67a69e758dd0780508423
+  metadata.gz: d06b793680ecc5064ec5b4978b83a1a18903f9647b733b3e19ff32979044ab129130019780fafb7f09703f1d7e16ecd5983bf5fa0bd08b1906b4af6597f4c832
+  data.tar.gz: 7e37790c465cbbf80e1d02d1e71fc9a5e8276fb21d6fb894ae19f6eef663910e4df956293dc218b8de91d940d2586e65248f4f6aababd4d661fb4fdad10d37ce

data/CHANGELOG.md

@@ -2,6 +2,17 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.18.0
+
+* Add `GRUF_USE_DEFAULT_INTERCEPTORS` ENV to dynamically enable/disable default interceptors
+* Allow passing of request object directly into `call`
+
+### 2.17.0
+
+* [#179] Add Ruby 3.2 support
+* [#178] Introduce read-write lock for code reloading; cover controller class resolution with code reloading.
+* [#180] Support multiple databases connection reset in `Gruf::Interceptors::ActiveRecord::ConnectionReset`.
+
 ### 2.16.2
 
 * [#175] Fix code reload thread-safety. Calls to `Zeitwerk::Loader#setup` are now made in a thread-safe manner.

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.10.x+. gruf is compatible and tested with Ruby 2.6-3.1.
+gruf currently has active support for gRPC 1.10.x+. gruf is compatible and tested with Ruby 2.7-3.2.
 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) or [dry-rb](https://dry-rb.org/), for instance).
 

data/gruf.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.executables << 'gruf'
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.7', '< 3.2'
+  spec.required_ruby_version = '>= 2.7', '< 3.3'
 
   spec.metadata = {
     'bug_tracker_uri' => 'https://github.com/bigcommerce/gruf/issues',
@@ -43,20 +43,6 @@ Gem::Specification.new do |spec|
     'wiki_uri' => 'https://github.com/bigcommerce/gruf/wiki'
   }
 
-  spec.add_development_dependency 'bundler-audit', '>= 0.6'
-  spec.add_development_dependency 'factory_bot', '>= 6.1'
-  spec.add_development_dependency 'ffaker', '>= 2.15'
-  spec.add_development_dependency 'pry', '~> 0.12'
-  spec.add_development_dependency 'pry-byebug', '>= 3.9'
-  spec.add_development_dependency 'rake', '>= 10.0'
-  spec.add_development_dependency 'rspec', '>= 3.8'
-  spec.add_development_dependency 'rspec_junit_formatter', '>= 0.4'
-  spec.add_development_dependency 'rubocop', '>= 1.0'
-  spec.add_development_dependency 'rubocop-performance', '>= 0.0.1'
-  spec.add_development_dependency 'rubocop-rspec', '>= 2.0'
-  spec.add_development_dependency 'rubocop-thread_safety', '>= 0.3'
-  spec.add_development_dependency 'simplecov', '>= 0.16'
-
   spec.add_runtime_dependency 'activesupport', '> 4'
   spec.add_runtime_dependency 'concurrent-ruby', '> 1'
   spec.add_runtime_dependency 'e2mmap', '>= 0.1'

data/lib/gruf/client.rb

@@ -81,7 +81,11 @@ module Gruf
     #
     def call(request_method, params = {}, metadata = {}, opts = {}, &block)
       request_method = request_method.to_sym
-      req = streaming_request?(request_method) ? params : request_object(request_method, params)
+      req = if params.respond_to?(:to_proto) || streaming_request?(request_method)
+              params
+            else
+              request_object(request_method, params)
+            end
       md = build_metadata(metadata)
       call_sig = call_signature(request_method)
 

data/lib/gruf/configuration.rb

@@ -186,6 +186,8 @@ module Gruf
         connect_md_proc: nil,
         server_args: {}
       }
+      self.use_default_interceptors = ::ENV.fetch('GRUF_USE_DEFAULT_INTERCEPTORS', 1).to_i.positive?
+
       if use_default_interceptors
         interceptors.use(::Gruf::Interceptors::ActiveRecord::ConnectionReset)
         interceptors.use(::Gruf::Interceptors::Instrumentation::OutputMetadataTimer)

data/lib/gruf/controllers/autoloader.rb

@@ -15,6 +15,8 @@
 # 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 'concurrent/atomic/read_write_lock'
+
 module Gruf
   module Controllers
     ##
@@ -47,10 +49,19 @@ module Gruf
       # Reload all files managed by the autoloader, if reloading is enabled
       #
       def reload
-        if @reloading_enabled
-          reload_mutex do
-            @loader.reload
-          end
+        return unless @reloading_enabled
+
+        reload_lock.with_write_lock do
+          @loader.reload
+        end
+      end
+
+      def with_fresh_controller(controller_name)
+        return yield(controller_name.constantize) unless @reloading_enabled
+
+        ::Gruf::Autoloaders.reload
+        reload_lock.with_read_lock do
+          yield(controller_name.constantize)
         end
       end
 
@@ -77,12 +88,8 @@ module Gruf
       ##
       # Handle thread-safe access to the loader
       #
-      def reload_mutex(&block)
-        @reload_mutex ||= begin
-          require 'monitor'
-          Monitor.new
-        end
-        @reload_mutex.synchronize(&block)
+      def reload_lock
+        @reload_lock ||= Concurrent::ReadWriteLock.new
       end
     end
   end

data/lib/gruf/controllers/base.rb

@@ -90,7 +90,6 @@ module Gruf
       # @param [block] &block The passed block for executing the method
       #
       def call(method_key, &block)
-        ::Gruf.autoloaders.reload if ::Gruf.development?
         Interceptors::Context.new(@interceptors).intercept! do
           process_action(method_key, &block)
         end

data/lib/gruf/controllers/service_binder.rb

@@ -46,54 +46,59 @@ module Gruf
         #
         def bind_method(service_ref, controller, method_name, desc)
           method_key = method_name.to_s.underscore.to_sym
+          controller_name = controller.name
           service_ref.class_eval do
             if desc.request_response?
               define_method(method_key) do |message, active_call|
-                controller = controller.name.constantize
-                c = controller.new(
-                  method_key: method_key,
-                  service: service_ref,
-                  message: message,
-                  active_call: active_call,
-                  rpc_desc: desc
-                )
-                c.call(method_key)
+                Gruf::Autoloaders.controllers.with_fresh_controller(controller_name) do |fresh_controller|
+                  c = fresh_controller.new(
+                    method_key: method_key,
+                    service: service_ref,
+                    message: message,
+                    active_call: active_call,
+                    rpc_desc: desc
+                  )
+                  c.call(method_key)
+                end
               end
             elsif desc.client_streamer?
               define_method(method_key) do |active_call|
-                controller = controller.name.constantize
-                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)
+                Gruf::Autoloaders.controllers.with_fresh_controller(controller_name) do |fresh_controller|
+                  c = fresh_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
               end
             elsif desc.server_streamer?
               define_method(method_key) do |message, active_call, &block|
-                controller = controller.name.constantize
-                c = controller.new(
-                  method_key: method_key,
-                  service: service_ref,
-                  message: message,
-                  active_call: active_call,
-                  rpc_desc: desc
-                )
-                c.call(method_key, &block)
+                Gruf::Autoloaders.controllers.with_fresh_controller(controller_name) do |fresh_controller|
+                  c = fresh_controller.new(
+                    method_key: method_key,
+                    service: service_ref,
+                    message: message,
+                    active_call: active_call,
+                    rpc_desc: desc
+                  )
+                  c.call(method_key, &block)
+                end
               end
             else # bidi
               define_method(method_key) do |messages, active_call, &block|
-                controller = controller.name.constantize
-                c = controller.new(
-                  method_key: method_key,
-                  service: service_ref,
-                  message: messages,
-                  active_call: active_call,
-                  rpc_desc: desc
-                )
-                c.call(method_key, &block)
+                Gruf::Autoloaders.controllers.with_fresh_controller(controller_name) do |fresh_controller|
+                  c = fresh_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

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

@@ -27,11 +27,13 @@ module Gruf
         # connection pool, we need to ensure that this is done to properly
         #
         def call
-          ::ActiveRecord::Base.establish_connection if enabled? && !::ActiveRecord::Base.connection.active?
+          if enabled?
+            target_classes.each { |klass| klass.establish_connection unless klass.connection.active? }
+          end
 
           yield
         ensure
-          ::ActiveRecord::Base.clear_active_connections! if enabled?
+          target_classes.each(&:clear_active_connections!) if enabled?
         end
 
         private
@@ -42,6 +44,13 @@ module Gruf
         def enabled?
           defined?(::ActiveRecord::Base)
         end
+
+        ##
+        # @return [Array<Class>] The list of ActiveRecord classes to reset
+        #
+        def target_classes
+          options[:target_classes] || [::ActiveRecord::Base]
+        end
       end
     end
   end

data/lib/gruf/version.rb

@@ -16,5 +16,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.16.2'
+  VERSION = '2.18.0'
 end

metadata

@@ -1,197 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 2.16.2
+  version: 2.18.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler-audit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-- !ruby/object:Gem::Dependency
-  name: ffaker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.15'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-thread_safety
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -399,14 +217,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: gRPC Ruby Framework