gruf-queue 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93e75c950c181dceecb26c7bb037014232fb190602c85800702c6b8bf29329c7
-  data.tar.gz: a81edb2a6d96d1c514c850b20ed0422eeed701e296497149df0e57597cc1875e
+  metadata.gz: 16b3387c40ed0f1175b3b6ee1127a15825788f17ae1ccd829385462d58c49913
+  data.tar.gz: d6694faf0538b2f6085a318433389ccf073c2f93876e78f1fb770bc061f6273d
 SHA512:
-  metadata.gz: 6d6f81af6800c4f8aca41a5400609e147b011b24ae9c6864b3caede6492889e7b9b8e9912274828f9bb35f57793b93355a50b918527d9383b3a719ad7346e509
-  data.tar.gz: e4efc9c13fe4c3867f65312175f65896e6dcd1f65c52ecbec99727ccb2a62e3c4f527ba7afc941ff3ec53faa9c212175b28bf286f753eee6190e47119eb41cc4
+  metadata.gz: b69971940855b247545a1488522d7b0abb9833c9d2eea4b4f8399e664fe9910f3a044a07e967e4cb3f8da91188b758d6ebdf5fd3097b477a51cf707d3275e13e
+  data.tar.gz: bc4d7414d8fdb9223721928facbb5b17db77bd753904a1419af72729ebaae22dcbcaf60244a53fca058ece126d9b1c16a284a3eb1ad0b7fbb92a1352a85d7591

data/CHANGELOG.md

@@ -5,6 +5,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.3]
+
+### Changed
+- **BREAKING**: Removed ServerFactory - use `QueuedRpcServer.new()` directly instead
+- **BREAKING**: Removed Configuration wrapper - use Gruf's native configuration
+- **BREAKING**: Removed custom ConnectionReset interceptor - use gruf's built-in `Gruf::Interceptors::ActiveRecord::ConnectionReset`
+- Simplified plugin.rb from 104 to 60 lines by removing complex validation logic
+- Merged pool.rb into pool_enhancements.rb for better organization
+
+### Removed
+- `Gruf::Queue::ServerFactory` - unnecessary abstraction layer
+- `Gruf::Queue::Configuration` - wrapper around Gruf's native config
+- `Gruf::Queue::Interceptors::ConnectionReset` - replaced with gruf's built-in
+- `Gruf::Queue::Pool` class - functionality moved to PoolEnhancements module
+- Obsolete test files and redundant test cases
+
+### Improved
+- **730 lines of code removed** - dramatically simplified codebase
+- More direct and intuitive API without unnecessary abstractions
+- Better integration with gruf's native features
+- Cleaner test suite with eliminated logging noise
+- Improved maintainability and reduced complexity
+
+### Fixed
+- Suppressed Gruf logger output during tests for cleaner test runs
+- Updated all documentation and examples to reflect simplified API
+
 ## [0.1.2]
 
 ### Changed

data/README.md

@@ -84,7 +84,7 @@ Gruf.configure do |config|
   config.rpc_server = Gruf::Queue::QueuedRpcServer
   
   config.interceptors.use(
-    Gruf::Queue::Interceptors::ConnectionReset,
+    Gruf::Interceptors::ActiveRecord::ConnectionReset,
     enabled: true,
     target_classes: [ActiveRecord::Base]
   )
@@ -108,19 +108,15 @@ Gruf.configure do |config|
 end
 ```
 
-### Using Server Factory
+### Custom Server Configuration
 
-For advanced server creation:
+For custom server instances with specific options:
 
 ```ruby
-# Create custom server instances
-server = Gruf::Queue::ServerFactory.create_server(
+# Create custom server instances directly
+server = Gruf::Queue::QueuedRpcServer.new(
   pool_size: 15,
-  max_waiting_requests: 30,
-  server: Gruf::Queue::QueuedRpcServer,
-  interceptors: [
-    Gruf::Queue::Interceptors::ConnectionReset
-  ]
+  max_waiting_requests: 30
 )
 
 Gruf::Server.new(
@@ -139,7 +135,7 @@ The `ConnectionReset` interceptor automatically manages database connections:
 # Customizable with additional target classes:
 Gruf.configure do |config|
   config.interceptors.use(
-    Gruf::Queue::Interceptors::ConnectionReset,
+    Gruf::Interceptors::ActiveRecord::ConnectionReset,
     enabled: true,
     target_classes: [ActiveRecord::Base, CustomConnectionClass]
   )
@@ -162,7 +158,7 @@ Advanced thread pool implementation:
 - Structured logging with thread identification
 - Comprehensive error isolation and recovery
 
-#### `Gruf::Queue::Interceptors::ConnectionReset`
+#### `Gruf::Interceptors::ActiveRecord::ConnectionReset`
 Smart database connection management:
 - Automatically resets ActiveRecord connections after each request
 - Validates connection handlers before attempting reset

data/lib/gruf/queue/plugin.rb

@@ -6,32 +6,18 @@ module Gruf
   module Queue
     # Plugin management for gruf-queue integration.
     #
-    # Provides idempotent installation and configuration of queue-specific settings
-    # including RPC server setup and interceptor registration.
-    #
-    # @example Install plugin
-    #   Gruf::Queue::Plugin.install!  # => true
-    #
-    # @example Check installation status
-    #   Gruf::Queue::Plugin.installed?  # => true
+    # Provides simple installation and configuration of queue-specific settings.
     class Plugin
       class << self
         def install!
           return false if @installed
 
-          begin
-            Configuration.configure unless Configuration.configured?
-            enhance_grpc_pool
-            Gruf.configure do |config|
-              configure_rpc_server(config)
-              configure_interceptors(config)
-            end
-
-            @installed = true
-            true
-          rescue StandardError
-            false
-          end
+          enhance_grpc_pool
+          configure_gruf
+          @installed = true
+          true
+        rescue StandardError
+          false
         end
 
         def installed?
@@ -40,63 +26,38 @@ module Gruf
 
         def reset!
           @installed = false
-          Configuration.reset! if Configuration.respond_to?(:reset!)
         end
 
         private
 
-        def configure_rpc_server(config)
-          config.rpc_server = QueuedRpcServer
-        end
-
-        def configure_interceptors(config)
-          return unless defined?(ActiveRecord)
-
-          validate_active_record_availability
-          ensure_interceptors_registry_available(config)
-
-          config.interceptors.use(
-            Interceptors::ConnectionReset,
-            enabled: true,
-            target_classes: [ActiveRecord::Base],
-          )
-        end
-
-        def validate_active_record_availability
-          return if ActiveRecord::Base.respond_to?(:connection_handler)
-
-          raise StandardError, 'ActiveRecord::Base does not support connection_handler'
-        end
-
-        def ensure_interceptors_registry_available(config)
-          return if config.respond_to?(:interceptors) && !config.interceptors.nil?
-
-          begin
-            require 'gruf/interceptors/registry'
-          rescue LoadError => e
-            raise StandardError, "Failed to load Gruf interceptors registry: #{e.message}"
-          end
-
-          if config.respond_to?(:interceptors=)
-            config.interceptors = ::Gruf::Interceptors::Registry.new
-          elsif config.respond_to?(:define_singleton_method)
-            registry = ::Gruf::Interceptors::Registry.new
-            config.define_singleton_method(:interceptors) { registry }
-            config.define_singleton_method(:interceptors=) { |val| registry = val }
-          else
-            raise StandardError, 'Cannot initialize interceptors registry: configuration object lacks required methods'
-          end
-
-          return if config.respond_to?(:interceptors) && config.interceptors.respond_to?(:use)
-
-          raise StandardError, 'Interceptors registry initialization failed: missing use method'
-        end
-
         def enhance_grpc_pool
           return if ::GRPC::Pool.included_modules.include?(Gruf::Queue::PoolEnhancements)
 
           ::GRPC::Pool.prepend(Gruf::Queue::PoolEnhancements)
         end
+
+        def configure_gruf
+          Gruf.configure do |config|
+            # Set default server options compatible with QueuedRpcServer
+            config.rpc_server_options = {
+              pool_size: QueuedRpcServer::DEFAULT_POOL_SIZE,
+              max_waiting_requests: QueuedRpcServer::DEFAULT_MAX_WAITING_REQUESTS,
+              poll_period: QueuedRpcServer::DEFAULT_POLL_PERIOD,
+              pool_keep_alive: PoolEnhancements::DEFAULT_KEEP_ALIVE,
+            }
+
+            if defined?(ActiveRecord)
+              require 'gruf/interceptors/active_record/connection_reset'
+              # Configure interceptors at the global level
+              if Gruf.respond_to?(:interceptors)
+                Gruf.interceptors.use(
+                  Gruf::Interceptors::ActiveRecord::ConnectionReset,
+                  target_classes: [ActiveRecord::Base],
+                )
+              end
+            end
+          end
+        end
       end
     end
   end

data/lib/gruf/queue/pool_enhancements.rb

@@ -10,6 +10,9 @@ module Gruf
     # @example Usage
     #   GRPC::Pool.prepend(Gruf::Queue::PoolEnhancements)
     module PoolEnhancements
+      # Default keep-alive time for worker threads (in seconds)
+      DEFAULT_KEEP_ALIVE = 600
+
       def jobs_waiting
         @jobs&.size || 0
       end

data/lib/gruf/queue/queued_rpc_server.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'pool'
+require_relative 'pool_enhancements'
 
 module Gruf
   module Queue
@@ -32,7 +32,7 @@ module Gruf
 
       def initialize(pool_size: DEFAULT_POOL_SIZE,
                      max_waiting_requests: DEFAULT_MAX_WAITING_REQUESTS,
-                     pool_keep_alive: Pool::DEFAULT_KEEP_ALIVE,
+                     pool_keep_alive: PoolEnhancements::DEFAULT_KEEP_ALIVE,
                      poll_period: DEFAULT_POLL_PERIOD,
                      **args)
         super

data/lib/gruf/queue/version.rb

@@ -2,6 +2,6 @@
 
 module Gruf
   module Queue
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

data/lib/gruf-queue.rb

@@ -2,11 +2,8 @@
 
 require 'gruf'
 require 'gruf/queue/version'
-require 'gruf/queue/pool'
+require 'gruf/queue/pool_enhancements'
 require 'gruf/queue/queued_rpc_server'
-require 'gruf/queue/configuration'
-require 'gruf/queue/server_factory'
-require 'gruf/queue/interceptors/connection_reset'
 require 'gruf/queue/plugin'
 
 # Auto-install plugin when required unless explicitly disabled

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gruf-queue
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ether Moon
@@ -135,13 +135,9 @@ files:
 - README.md
 - gruf-queue.gemspec
 - lib/gruf-queue.rb
-- lib/gruf/queue/configuration.rb
-- lib/gruf/queue/interceptors/connection_reset.rb
 - lib/gruf/queue/plugin.rb
-- lib/gruf/queue/pool.rb
 - lib/gruf/queue/pool_enhancements.rb
 - lib/gruf/queue/queued_rpc_server.rb
-- lib/gruf/queue/server_factory.rb
 - lib/gruf/queue/version.rb
 homepage: https://github.com/ether-moon/gruf-queue
 licenses:

data/lib/gruf/queue/configuration.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module Gruf
-  module Queue
-    # Configuration management for gruf-queue integration.
-    #
-    # Enhances Gruf configuration with queue-specific settings and provides
-    # idempotent configuration setup with proper error handling.
-    #
-    # @example Configure Gruf
-    #   Gruf::Queue::Configuration.configure
-    module Configuration
-      module_function
-
-      def configure
-        return if configured?
-
-        begin
-          Gruf.configure do |config|
-            enhance_gruf_configuration(config)
-          end
-
-          @configured = true
-        rescue StandardError => e
-          if defined?(Gruf) && Gruf.respond_to?(:logger)
-            Gruf.logger.error("Failed to enhance Gruf configuration: #{e.message}")
-          end
-          raise
-        end
-      end
-
-      def configured?
-        !!@configured
-      end
-
-      def reset!
-        raise 'reset! can only be called in test environments' unless test_environment?
-
-        @configured = false
-
-        return unless defined?(Gruf) && Gruf.respond_to?(:configuration)
-
-        config = Gruf.configuration
-        config.rpc_server = nil if config.respond_to?(:rpc_server=)
-      end
-
-      def enhance_gruf_configuration(config)
-        config.define_singleton_method(:rpc_server) { @rpc_server }
-        config.define_singleton_method(:rpc_server=) { |val| @rpc_server = val }
-        config.rpc_server = nil unless config.respond_to?(:rpc_server)
-
-        return if Gruf.respond_to?(:configuration)
-
-        Gruf.define_singleton_method(:configuration) { config }
-      end
-
-      def test_environment?
-        ENV['RACK_ENV'] == 'test' ||
-          ENV['RAILS_ENV'] == 'test' ||
-          defined?(RSpec)
-      end
-    end
-  end
-end

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

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-module Gruf
-  module Queue
-    module Interceptors
-      # ActiveRecord connection reset interceptor for threaded gRPC environments.
-      #
-      # Automatically resets database connections after each request to prevent
-      # connection leaks and stale connections in multi-threaded environments.
-      #
-      # @example Basic usage with Gruf
-      #   config.interceptors.use(
-      #     Gruf::Queue::Interceptors::ConnectionReset,
-      #     target_classes: [ActiveRecord::Base]
-      #   )
-      class ConnectionReset < ::Gruf::Interceptors::ServerInterceptor
-        def initialize(request, call, method, options = {})
-          @request = request
-          @call = call
-          @method = method
-          @options = options || {}
-          @options[:enabled] = true unless @options.key?(:enabled)
-        end
-
-        def call
-          yield
-        ensure
-          begin
-            reset_connections if enabled?
-          rescue StandardError
-            # Ignore connection reset errors silently
-          end
-        end
-
-        private
-
-        attr_reader :options
-
-        def enabled?
-          return false if options[:enabled] == false
-          return false if target_classes.empty?
-
-          true
-        end
-
-        def reset_connections
-          validated_classes = validate_target_classes
-          return if validated_classes.empty?
-
-          validated_classes.each do |klass|
-            reset_connection_for_class(klass)
-          end
-        end
-
-        def target_classes
-          return Array(@target_classes).compact if instance_variable_defined?(:@target_classes)
-
-          default_classes = defined?(::ActiveRecord::Base) ? [::ActiveRecord::Base] : []
-          classes = options.fetch(:target_classes, default_classes)
-          Array(classes).compact
-        end
-
-        def validate_target_classes
-          target_classes.select do |klass|
-            valid_class?(klass)
-          end
-        end
-
-        def valid_class?(klass)
-          return false unless klass.is_a?(Class)
-          return false unless klass.respond_to?(:connection_handler)
-
-          true
-        end
-
-        def reset_connection_for_class(klass)
-          handler = klass.connection_handler
-          handler.clear_active_connections!(:all) if handler.respond_to?(:clear_active_connections!)
-          handler.clear_reloadable_connections! if handler.respond_to?(:clear_reloadable_connections!)
-          true
-        rescue StandardError
-          false
-        end
-      end
-    end
-  end
-end

data/lib/gruf/queue/pool.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module Gruf
-  module Queue
-    # Enhanced thread pool with structured logging and improved error handling.
-    #
-    # Extends GRPC::Pool to provide better job scheduling, thread safety,
-    # and comprehensive error isolation for gRPC server request handling.
-    #
-    # @example Basic usage
-    #   pool = Gruf::Queue::Pool.new(10, keep_alive: 300)
-    #   pool.schedule { puts "Hello from worker thread" }
-    #   pool.start
-    class Pool < ::GRPC::Pool
-      # Default keep-alive time for worker threads (in seconds)
-      DEFAULT_KEEP_ALIVE = 600
-
-      def initialize(size, keep_alive: DEFAULT_KEEP_ALIVE)
-        super
-      end
-
-      def jobs_waiting
-        @jobs&.size || 0
-      end
-
-      def schedule(*args, &blk)
-        return false if blk.nil?
-
-        @stop_mutex.synchronize do
-          return false if @stopped
-
-          @jobs << [blk, args]
-          true
-        end
-      rescue StandardError
-        false
-      end
-
-      def start
-        @stop_mutex.synchronize do
-          raise 'Pool already stopped' if @stopped
-        end
-
-        target_size = @size.to_i
-
-        until @workers.size == target_size
-          next_thread = create_worker_thread
-          @workers << next_thread if next_thread
-        end
-      end
-
-      protected
-
-      def create_worker_thread
-        Thread.new do
-          catch(:exit) do
-            _loop_execute_jobs
-          end
-          remove_current_thread
-        end
-      rescue StandardError
-        nil
-      end
-
-      def _loop_execute_jobs
-        Thread.current.name = "gruf-queue-worker-#{Thread.current.object_id}"
-
-        loop do
-          begin
-            blk, args = @jobs.pop
-            execute_job_safely(blk, args)
-          rescue ThreadError, SystemStackError, IOError
-            # Ignore system-level errors to prevent worker thread death
-          end
-
-          @stop_mutex.synchronize do
-            return if @stopped
-          end
-        end
-      end
-
-      def execute_job_safely(blk, args)
-        blk.call(*args)
-      rescue SystemStackError, IOError, GRPC::Core::CallError, GRPC::BadStatus, Timeout::Error
-        # Ignore system/network/gRPC errors to prevent worker thread death
-      end
-    end
-  end
-end

data/lib/gruf/queue/server_factory.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-module Gruf
-  module Queue
-    # Factory for creating configured gRPC servers with queue-specific options.
-    #
-    # Provides centralized server creation with intelligent defaults, option validation,
-    # and fallback handling for different server types.
-    #
-    # @example Create basic server
-    #   server = Gruf::Queue::ServerFactory.create_server(pool_size: 20)
-    #
-    # @example Create with custom server class
-    #   server = Gruf::Queue::ServerFactory.create_server(
-    #     server: MyCustomServer,
-    #     pool_size: 15
-    #   )
-    module ServerFactory
-      module_function
-
-      # Create a new gRPC server instance with the provided options.
-      #
-      # @param opts [Hash] Configuration options for the server
-      # @option opts [Class] :server Custom server class to use
-      # @option opts [Integer] :pool_size Thread pool size
-      # @option opts [Proc] :event_listener_proc Event listener procedure
-      # @return [GRPC::RpcServer] Configured server instance
-      def create_server(opts = {})
-        # Default to QueuedRpcServer if no server specified
-        rpc_server = opts.fetch(:server, nil)
-        rpc_server ||= (defined?(Gruf) && Gruf.respond_to?(:rpc_server) && Gruf.rpc_server) || QueuedRpcServer
-
-        # Validate server class
-        validate_server_class!(rpc_server) if opts.key?(:server)
-
-        default_options = get_default_options
-
-        server_options = {
-          pool_size: opts.fetch(:pool_size, default_options[:pool_size]),
-          max_waiting_requests: opts.fetch(:max_waiting_requests, default_options[:max_waiting_requests]),
-          poll_period: opts.fetch(:poll_period, default_options[:poll_period]),
-          pool_keep_alive: opts.fetch(:pool_keep_alive, default_options[:pool_keep_alive]),
-          connect_md_proc: opts.fetch(:connect_md_proc, nil),
-          server_args: opts.fetch(:server_args, default_options[:server_args]),
-        }
-
-        # Handle interceptors via Gruf configuration if available
-        interceptors = opts.fetch(:interceptors, [])
-        if interceptors.any? && defined?(Gruf) && Gruf.respond_to?(:configuration)
-          interceptors.each do |interceptor|
-            Gruf.configuration.interceptors.use(interceptor, enabled: true)
-          end
-        elsif interceptors.any?
-          server_options[:interceptors] = interceptors
-        end
-
-        begin
-          rpc_server.new(**server_options)
-        rescue ArgumentError => e
-          raise unless e.message.include?('unknown keywords')
-
-          # Filter out unsupported options for basic GRPC::RpcServer
-          filtered_options = server_options.except(:pool_size, :max_waiting_requests, :poll_period, :pool_keep_alive)
-          rpc_server.new(**filtered_options)
-        end
-      end
-
-      # Validate server class inherits from GRPC::RpcServer.
-      #
-      # @param server_class [Class] Server class to validate
-      # @raise [ArgumentError] if not a valid GRPC server class
-      # @return [void]
-      def validate_server_class!(server_class)
-        return if server_class.is_a?(Class) && server_class <= ::GRPC::RpcServer
-
-        raise ArgumentError, "Server must be a subclass of GRPC::RpcServer, got #{server_class}"
-      end
-      module_function :validate_server_class!
-
-      # Get default server options with Gruf integration fallback.
-      #
-      # @return [Hash] Default configuration options
-      def get_default_options
-        if defined?(Gruf) && Gruf.respond_to?(:rpc_server_options)
-          Gruf.rpc_server_options
-        else
-          {
-            pool_size: QueuedRpcServer::DEFAULT_POOL_SIZE,
-            max_waiting_requests: QueuedRpcServer::DEFAULT_MAX_WAITING_REQUESTS,
-            poll_period: QueuedRpcServer::DEFAULT_POLL_PERIOD,
-            pool_keep_alive: Pool::DEFAULT_KEEP_ALIVE,
-            server_args: {},
-          }
-        end
-      end
-      module_function :get_default_options
-    end
-  end
-end