faye-redis-ng 1.0.12 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 398f99e890ab9d57e91c5f42f93898488c2b1f475f0831d6079e06314a1d4923
-  data.tar.gz: 7191ecc674147302d1ccce44a612ede961d53709059bd21eb69b28cefe527385
+  metadata.gz: 1b5fc029a910d92539d5500a92a851a1b3db0857a5769e6aa9338b8155126cfd
+  data.tar.gz: cbf1c670cfe442f7511466f278280db0f8543eee8adcddd9dc0e5ba9a0527667
 SHA512:
-  metadata.gz: 3fe20898a79896711f0e003aaf9e6e44baa6b455130260bd6d24ce03424460c140d51a55da29fba63920490e6e04691318e244a48d608ac0f9c6ceeca443f4d7
-  data.tar.gz: f3317d04d6423963b17dd05d6e24b5f37b9a416da06780c92f118a94e4e42b3116e444cdb0fa18e89e4ef173d524325bd1e2cc0c54bf7235e4733162df740262
+  metadata.gz: ae3fb5749855e269fae14583b830bb3d6c55dda8cd90dd28f0bc2fcd4a91c1ca34b89db0a3ac8d7db9343a337653524f84f8b9d7680c089c14e4d42d172ae5f6
+  data.tar.gz: 4355fe52a0d572f61640bc1bef644563f1df61d0e37549e8d35d76a64b58eafb0a255570f973453cda769f5e3a47b01715995fcb111eaa10bcf9a5292077e369

data/CHANGELOG.md

@@ -7,6 +7,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
+### 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
@@ -32,11 +71,28 @@ 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 ensures subscriptions don't expire before their associated messages
-- The 1-hour TTL provides ample buffer (60 GC cycles) for cleanup
+- 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
 

data/lib/faye/redis/subscription_manager.rb

@@ -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.12'
+    VERSION = '1.0.13'
   end
 end

data/lib/faye/redis.rb

@@ -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.12
+  version: 1.0.13
 platform: ruby
 authors:
 - Zac