faye-redis-ng 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02a75e3e557cd2916224537b1d688333c2661e1006a836ca92afde12f59c04bb
-  data.tar.gz: 33a2a61187282c3801de1ac648f4d55fa0ad2a46d5ef1c1f964f1e5db5df7ed7
+  metadata.gz: f87f5800dede3c5720fc5ab77944c3322f735cd808c1b02edd218fc6d97bca8b
+  data.tar.gz: 13d579f33d6620ab7ecdc3567b45dd7c4a58264ed0115b25ddc39454662b2e0c
 SHA512:
-  metadata.gz: 79f1cdaeb24197a454fbcf9ffa2a2a0678ebe2e09c0ab82a694e9e6b643fba4a43fa14d836c1cb3eeca91c9f4091d63faec489d60c7237e8652b42679c8a811f
-  data.tar.gz: d96e691b5bb66c86c64852474b4bbb9cb1797420adfed71210f64c27f0e695b5489dec71c18d6636daa3ecdcea6e6a1580f90cba850f140e1c7ebc5734d615b8
+  metadata.gz: fbd69bad2590d4e55b141941952c95e316c3d8dd2a1e37f4ebbe3129ffe00b48957e8ba86c02732ef67aad97200c47b27dc6c663c5c41640cbaa0dd6787e8514
+  data.tar.gz: 8c08572629040c40e130f03c0881e864f02a1dbfb89b5db9c0509c255d4cf986a9f38bf5267c4834216dcae0ca26ef6c115742b42c4f61095c9e4cb14264824a

data/CHANGELOG.md

@@ -7,6 +7,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.6] - 2025-10-30
+
+### Added
+- **Automatic Garbage Collection**: Implemented automatic GC timer that runs periodically to clean up expired clients and orphaned data
+  - New `gc_interval` configuration option (default: 60 seconds)
+  - Automatically starts when EventMachine is running
+  - Can be disabled by setting `gc_interval` to 0 or false
+  - Lazy initialization ensures timer starts even if engine is created before EventMachine starts
+  - Timer is properly stopped on disconnect to prevent resource leaks
+
+### Changed
+- **Improved User Experience**: No longer requires manual setup of periodic cleanup
+  - Memory leak prevention is now automatic by default
+  - Matches behavior of original faye-redis-ruby project
+  - Users can still manually call `cleanup_expired` if needed
+  - Custom GC schedules possible by disabling automatic GC
+
+### Technical Details
+The automatic GC timer:
+- Runs `cleanup_expired` every 60 seconds by default
+- Only starts when EventMachine reactor is running
+- Supports lazy initialization for engines created outside EM context
+- Properly handles cleanup on disconnect
+- Can be customized or disabled via `gc_interval` option
+
 ## [1.0.5] - 2025-10-30
 
 ### Fixed
@@ -126,7 +151,8 @@ For 100 subscribers receiving one message:
 ### Security
 - Client and message IDs now use `SecureRandom.uuid` instead of predictable time-based generation
 
-[Unreleased]: https://github.com/7a6163/faye-redis-ng/compare/v1.0.5...HEAD
+[Unreleased]: https://github.com/7a6163/faye-redis-ng/compare/v1.0.6...HEAD
+[1.0.6]: https://github.com/7a6163/faye-redis-ng/compare/v1.0.5...v1.0.6
 [1.0.5]: https://github.com/7a6163/faye-redis-ng/compare/v1.0.4...v1.0.5
 [1.0.4]: https://github.com/7a6163/faye-redis-ng/compare/v1.0.3...v1.0.4
 [1.0.3]: https://github.com/7a6163/faye-redis-ng/compare/v1.0.2...v1.0.3

data/README.md

@@ -81,6 +81,9 @@ bayeux = Faye::RackAdapter.new(app, {
   client_timeout: 60,         # Client session timeout (seconds)
   message_ttl: 3600,          # Message TTL (seconds)
 
+  # Garbage collection
+  gc_interval: 60,            # Automatic GC interval (seconds), set to 0 or false to disable
+
   # Logging
   log_level: :info,           # Log level (:silent, :info, :debug)
 
@@ -236,11 +239,45 @@ The CI/CD pipeline will automatically:
 
 ## Memory Management
 
-### Cleaning Up Expired Clients
+### Automatic Garbage Collection
+
+**New in v1.0.6**: faye-redis-ng now includes automatic garbage collection that runs every 60 seconds by default. This automatically cleans up expired clients and orphaned subscription keys, preventing memory leaks without any manual intervention.
+
+```ruby
+bayeux = Faye::RackAdapter.new(app, {
+  mount: '/faye',
+  timeout: 25,
+  engine: {
+    type: Faye::Redis,
+    host: 'localhost',
+    port: 6379,
+    gc_interval: 60  # Run GC every 60 seconds (default)
+  }
+})
+```
+
+To customize the GC interval or disable it:
 
-To prevent memory leaks from orphaned subscription keys, you should periodically clean up expired clients:
+```ruby
+engine: {
+  type: Faye::Redis,
+  host: 'localhost',
+  port: 6379,
+  gc_interval: 300  # Run GC every 5 minutes
+}
 
-#### Manual Cleanup
+# Or disable automatic GC
+engine: {
+  type: Faye::Redis,
+  host: 'localhost',
+  port: 6379,
+  gc_interval: 0  # Disabled - you'll need to call cleanup_expired manually
+}
+```
+
+### Manual Cleanup
+
+If you've disabled automatic GC, you can manually clean up expired clients:
 
 ```ruby
 # Get the engine instance
@@ -252,9 +289,9 @@ engine.cleanup_expired do |expired_count|
 end
 ```
 
-#### Automatic Periodic Cleanup (Recommended)
+#### Custom GC Schedule (Optional)
 
-Add this to your Faye server setup:
+If you need more control, you can disable automatic GC and implement your own schedule:
 
 ```ruby
 require 'eventmachine'
@@ -268,11 +305,12 @@ bayeux = Faye::RackAdapter.new(app, {
     type: Faye::Redis,
     host: 'localhost',
     port: 6379,
-    namespace: 'my-app'
+    namespace: 'my-app',
+    gc_interval: 0  # Disable automatic GC
   }
 })
 
-# Schedule automatic cleanup every 5 minutes
+# Custom cleanup schedule - every 5 minutes
 EM.add_periodic_timer(300) do
   bayeux.get_engine.cleanup_expired do |count|
     puts "[#{Time.now}] Cleaned up #{count} expired clients" if count > 0
@@ -330,12 +368,15 @@ The `cleanup_expired` method removes:
 
 ### Memory Leak Prevention
 
-Without periodic cleanup, abnormal client disconnections (crashes, network failures, etc.) can cause orphaned keys to accumulate:
+**v1.0.6+**: Automatic garbage collection is now enabled by default, preventing memory leaks from orphaned keys without any configuration needed.
+
+Without GC, abnormal client disconnections (crashes, network failures, etc.) can cause orphaned keys to accumulate:
 
-- **Before fix**: 10,000 orphaned clients × 5 channels = 50,000+ keys = 100-500 MB leaked
-- **After fix**: All orphaned keys are cleaned up automatically
+- **Before v1.0.5**: 10,000 orphaned clients × 5 channels = 50,000+ keys = 100-500 MB leaked
+- **v1.0.5**: Manual cleanup required via `cleanup_expired` method
+- **v1.0.6+**: Automatic GC runs every 60 seconds by default - no manual intervention needed
 
-**Recommendation**: Schedule cleanup every 5-10 minutes in production environments.
+The automatic GC ensures memory usage remains stable even with frequent client disconnections.
 
 ## Troubleshooting
 

data/lib/faye/redis/version.rb

@@ -1,5 +1,5 @@
 module Faye
   class Redis
-    VERSION = '1.0.5'
+    VERSION = '1.0.6'
   end
 end

data/lib/faye/redis.rb

@@ -25,7 +25,8 @@ module Faye
       retry_delay: 1,
       client_timeout: 60,
       message_ttl: 3600,
-      namespace: 'faye'
+      namespace: 'faye',
+      gc_interval: 60  # Automatic garbage collection interval (seconds), set to 0 or false to disable
     }.freeze
 
     attr_reader :server, :options, :connection, :client_registry,
@@ -50,10 +51,16 @@ module Faye
 
       # Set up message routing
       setup_message_routing
+
+      # Start automatic garbage collection timer
+      start_gc_timer
     end
 
     # Create a new client
     def create_client(&callback)
+      # Ensure GC timer is started (lazy initialization)
+      ensure_gc_timer_started
+
       client_id = generate_client_id
       @client_registry.create(client_id) do |success|
         if success
@@ -136,6 +143,9 @@ module Faye
 
     # Disconnect the engine
     def disconnect
+      # Stop GC timer if running
+      stop_gc_timer
+
       @pubsub_coordinator.disconnect
       @connection.disconnect
     end
@@ -254,5 +264,42 @@ module Faye
     def log_error(message)
       @logger.error(message)
     end
+
+    # Start automatic garbage collection timer
+    def start_gc_timer
+      gc_interval = @options[:gc_interval]
+
+      # Skip if GC is disabled (0, false, or nil)
+      return if !gc_interval || gc_interval == 0
+
+      # Only start timer if EventMachine is running
+      return unless EventMachine.reactor_running?
+
+      @logger.info("Starting automatic GC timer with interval: #{gc_interval} seconds")
+
+      @gc_timer = EventMachine.add_periodic_timer(gc_interval) do
+        @logger.debug("Running automatic garbage collection")
+        cleanup_expired do |count|
+          @logger.debug("GC completed: #{count} expired clients cleaned") if count > 0
+        end
+      end
+    end
+
+    # Ensure GC timer is started (called lazily on first operation)
+    def ensure_gc_timer_started
+      return if @gc_timer  # Already started
+      return if !@options[:gc_interval] || @options[:gc_interval] == 0  # Disabled
+
+      start_gc_timer
+    end
+
+    # Stop automatic garbage collection timer
+    def stop_gc_timer
+      if @gc_timer
+        EventMachine.cancel_timer(@gc_timer)
+        @gc_timer = nil
+        @logger.info("Stopped automatic GC timer")
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faye-redis-ng
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Zac