faye-redis-ng 1.0.11 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a2266042c42929dc9203cf1160bbfd64d429c87cdb076b3369cd55bbf77032e
-  data.tar.gz: 51509e6fb5fb775bfbdcd4db0dada3dfa26f6bee5f5729d2b3fa165b5b417644
+  metadata.gz: 1b5fc029a910d92539d5500a92a851a1b3db0857a5769e6aa9338b8155126cfd
+  data.tar.gz: cbf1c670cfe442f7511466f278280db0f8543eee8adcddd9dc0e5ba9a0527667
 SHA512:
-  metadata.gz: 79c6d4bee6b55572a772a4977fd5b5a5857746c415bac1f6f0a802ad69b16e137642b90d20ec02ec21abb95f69e5fab9ab830f018c6aaa974ad56b2c3202f269
-  data.tar.gz: 38c29ca6cd4330c5a862951b2810e8e095e4dec2939691bd8379ef714f947ad05a0e875bcf55a53de42d35913357d2f05c38f08b0ce16da12e553e2c7a22f1b1
+  metadata.gz: ae3fb5749855e269fae14583b830bb3d6c55dda8cd90dd28f0bc2fcd4a91c1ca34b89db0a3ac8d7db9343a337653524f84f8b9d7680c089c14e4d42d172ae5f6
+  data.tar.gz: 4355fe52a0d572f61640bc1bef644563f1df61d0e37549e8d35d76a64b58eafb0a255570f973453cda769f5e3a47b01715995fcb111eaa10bcf9a5292077e369

data/CHANGELOG.md

@@ -7,18 +7,63 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.0.11] - 2025-10-31
+## [1.0.13] - 2025-11-01
+
+### Added - Ping-Based Subscription TTL Refresh
+- **Subscription TTLs now refresh on every ping**: Keeps subscriptions alive as long as client is connected
+  - **New behavior**: Each client ping (every ~25s) now refreshes all subscription-related TTLs
+  - **Implementation**:
+    - Added `SubscriptionManager#refresh_client_subscriptions_ttl` method
+    - Modified `Redis#ping` to call subscription TTL refresh
+    - Uses pipelined Redis commands for efficient batch TTL updates
+  - **Impact**:
+    - ✅ Active clients: Subscriptions never expire while connected
+    - ✅ Inactive clients: Subscriptions expire 1 hour after last ping (as expected)
+    - ✅ Long-lived connections: Chat rooms, dashboards work indefinitely
+    - ✅ Prevents silent subscription expiration for active clients
+  - **Before**: Subscriptions expired after 1 hour even for active clients
+  - **After**: Subscriptions only expire 1 hour after client disconnects
+  - **Performance**: Minimal impact - uses single pipelined Redis call per ping
+
+### Design Decision - Message Queue TTL Not Refreshed
+- **Message queue TTL remains fixed at 1 hour**: Does not refresh on ping
+  - **Rationale**:
+    - Active clients: Messages are immediately delivered, queue is usually empty
+    - Empty queues that expire are automatically recreated when needed
+    - Inactive clients: 1-hour TTL provides sufficient buffer for reconnection
+    - Memory efficiency: Prevents permanent empty queue keys for long-lived connections
+  - **Trade-offs**:
+    - ✅ Better memory efficiency: Empty queues expire after 1 hour
+    - ✅ No functional impact: Messages still delivered normally to active clients
+    - ✅ Automatic cleanup: Long-term disconnected clients don't accumulate messages indefinitely
+  - **Behavior**:
+    - Active client: Queue may expire, but recreates automatically on next message
+    - Disconnected < 1 hour: All messages preserved for reconnection
+    - Disconnected > 1 hour: Messages cleared to prevent unbounded growth
 
-### Changed - Optimized Subscription TTL
-- **Reduced subscription_ttl from 24 hours to 5 minutes**: More aggressive cleanup of orphaned subscription data
-  - **Previous**: `subscription_ttl: 86400` (24 hours)
-  - **New**: `subscription_ttl: 300` (5 minutes = 5x client_timeout)
-  - **Rationale**: Client keys expire after 60 seconds, keeping subscription data for 24 hours was excessive
-  - **Impact**: Faster memory reclamation for disconnected clients while maintaining safety net
-  - **Benefits**:
-    - Reduces memory footprint by cleaning up orphaned subscriptions faster
-    - Maintains 5-minute safety window (5 GC cycles) for proper cleanup
-    - Allows short-lived reconnections within 5 minutes to reuse subscription data
+### Notes
+- Ping-based refresh ensures long-lived connections (chat, real-time dashboards) work correctly
+- Message queue strategy balances reliability with memory efficiency
+- The 1-hour TTL provides ample buffer (60 GC cycles) for cleanup after disconnect
+
+## [1.0.12] - 2025-11-01
+
+### Changed - Aligned Subscription TTL with Message TTL
+- **Adjusted subscription_ttl to 1 hour**: Match message_ttl to prevent message loss window
+  - **Previous (v1.0.11)**: `subscription_ttl: 300` (5 minutes)
+  - **New**: `subscription_ttl: 3600` (1 hour, same as message_ttl)
+  - **Rationale**:
+    - Subscription and message TTL must be aligned to prevent message loss window
+    - If subscription expires before messages, new messages won't be enqueued for disconnected clients
+    - Example: If subscription expires at 5 minutes but messages persist for 1 hour, any new messages after 5 minutes won't reach the client even if they reconnect within 1 hour
+  - **Impact**:
+    - Prevents message loss: disconnected clients get all messages within 1-hour window
+    - No TTL gap: subscriptions and messages expire together
+    - Conservative approach for reliable message delivery
+  - **Trade-offs**:
+    - Uses more memory than 5-minute TTL (but still 96% less than original 24 hours)
+    - 1-hour reconnection window is sufficient for most mobile/network interruptions
+    - Maintains 60x safety buffer (60 GC cycles @ 60s interval) for proper cleanup
   - **Affected keys**:
     - `{namespace}:subscriptions:{client_id}` (SET)
     - `{namespace}:channels:{channel}` (SET)
@@ -26,10 +71,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - `{namespace}:patterns` (SET)
   - **Backward compatibility**: Users can still override with custom `subscription_ttl` option
 
+### Added - Ping-Based Subscription TTL Refresh
+- **Subscription TTLs now refresh on every ping**: Keeps subscriptions alive as long as client is connected
+  - **New behavior**: Each client ping (every ~25s) now refreshes all subscription-related TTLs
+  - **Implementation**:
+    - Added `SubscriptionManager#refresh_client_subscriptions_ttl` method
+    - Modified `Redis#ping` to call subscription TTL refresh
+    - Uses pipelined Redis commands for efficient batch TTL updates
+  - **Impact**:
+    - ✅ Active clients: Subscriptions never expire while connected
+    - ✅ Inactive clients: Subscriptions expire 1 hour after last ping (as expected)
+    - ✅ Long-lived connections: Chat rooms, dashboards work indefinitely
+    - ✅ Prevents silent subscription expiration for active clients
+  - **Before**: Subscriptions expired after 1 hour even for active clients
+  - **After**: Subscriptions only expire 1 hour after client disconnects
+  - **Performance**: Minimal impact - uses single pipelined Redis call per ping
+
 ### Notes
-- This change is safe because automatic GC runs every 60 seconds by default
-- The 5-minute TTL provides sufficient buffer (5 GC cycles) for cleanup
+- This change ensures subscriptions don't expire before their associated messages
+- The 1-hour TTL provides ample buffer (60 GC cycles) for cleanup after disconnect
 - TTL-safe implementation (v1.0.10) ensures active subscriptions maintain their original TTL
+- Conservative approach: prioritizes message delivery over aggressive memory optimization
+- Ping-based refresh ensures long-lived connections (chat, real-time dashboards) work correctly
+
+## [1.0.11] - 2025-10-31
+
+### Changed - Reduced Subscription TTL (Reverted in v1.0.12)
+- **Reduced subscription_ttl from 24 hours to 5 minutes**: More aggressive cleanup of orphaned subscription data
+  - **Previous**: `subscription_ttl: 86400` (24 hours)
+  - **New**: `subscription_ttl: 300` (5 minutes = 5x client_timeout)
+  - **Issue discovered**: This created a message loss window - subscriptions expired in 5 minutes but messages persisted for 1 hour
+  - **Resolution**: Reverted in v1.0.12 to align with message_ttl (1 hour)
 
 ## [1.0.10] - 2025-10-30
 

data/README.md

@@ -80,7 +80,7 @@ bayeux = Faye::RackAdapter.new(app, {
   # Data expiration
   client_timeout: 60,         # Client session timeout (seconds)
   message_ttl: 3600,          # Message TTL (seconds)
-  subscription_ttl: 300,      # Subscription keys TTL (seconds, default: 5 minutes)
+  subscription_ttl: 3600,     # Subscription keys TTL (seconds, default: 1 hour)
 
   # Garbage collection
   gc_interval: 60,            # Automatic GC interval (seconds), set to 0 or false to disable

data/lib/faye/redis/subscription_manager.rb

@@ -12,7 +12,7 @@ module Faye
       # Subscribe a client to a channel
       def subscribe(client_id, channel, &callback)
         timestamp = Time.now.to_i
-        subscription_ttl = @options[:subscription_ttl] || 300  # 5 minutes default (5x client_timeout)
+        subscription_ttl = @options[:subscription_ttl] || 3600  # 1 hour default (matches message_ttl)
 
         client_subs_key = client_subscriptions_key(client_id)
         channel_subs_key = channel_subscribers_key(channel)
@@ -118,6 +118,35 @@ module Faye
         EventMachine.next_tick { callback.call(false) } if callback
       end
 
+      # Refresh TTL for all subscription keys related to a client
+      # Called during ping to keep subscriptions alive as long as client is connected
+      def refresh_client_subscriptions_ttl(client_id)
+        subscription_ttl = @options[:subscription_ttl] || 3600
+
+        @connection.with_redis do |redis|
+          # Get all channels this client is subscribed to
+          channels = redis.smembers(client_subscriptions_key(client_id))
+          return if channels.empty?
+
+          # Use pipeline to refresh all TTLs efficiently
+          redis.pipelined do |pipeline|
+            # Refresh client's subscriptions set
+            pipeline.expire(client_subscriptions_key(client_id), subscription_ttl)
+
+            # Refresh each subscription metadata and channel subscriber set
+            channels.each do |channel|
+              pipeline.expire(subscription_key(client_id, channel), subscription_ttl)
+              pipeline.expire(channel_subscribers_key(channel), subscription_ttl)
+            end
+
+            # Refresh patterns set if it exists
+            pipeline.expire(patterns_key, subscription_ttl)
+          end
+        end
+      rescue => e
+        log_error("Failed to refresh subscription TTL for client #{client_id}: #{e.message}")
+      end
+
       # Get all channels a client is subscribed to
       def get_client_subscriptions(client_id, &callback)
         channels = @connection.with_redis do |redis|

data/lib/faye/redis/version.rb

@@ -1,5 +1,5 @@
 module Faye
   class Redis
-    VERSION = '1.0.11'
+    VERSION = '1.0.13'
   end
 end

data/lib/faye/redis.rb

@@ -25,7 +25,7 @@ module Faye
       retry_delay: 1,
       client_timeout: 60,
       message_ttl: 3600,
-      subscription_ttl: 300,  # Subscription keys TTL (5 minutes = 5x client_timeout), provides safety net if GC fails
+      subscription_ttl: 3600,  # Subscription keys TTL (1 hour, matches message_ttl), provides safety net if GC fails
       namespace: 'faye',
       gc_interval: 60,  # Automatic garbage collection interval (seconds), set to 0 or false to disable
       cleanup_batch_size: 50  # Number of items per batch during cleanup (min: 1, max: 1000, prevents blocking)
@@ -88,8 +88,10 @@ module Faye
     end
 
     # Ping a client to keep it alive
+    # Also refreshes subscription TTLs to keep them alive while client is connected
     def ping(client_id)
       @client_registry.ping(client_id)
+      @subscription_manager.refresh_client_subscriptions_ttl(client_id)
     end
 
     # Subscribe a client to a channel

metadata

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