Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(events): say a dropped connection's events can arrive out of order
Yudhi Armyndharis932463d47de7
diff --git a/docs/13-horizontal-scaling.md b/docs/13-horizontal-scaling.mdindex a15e65004..7f38d4af3 100644--- a/docs/13-horizontal-scaling.md+++ b/docs/13-horizontal-scaling.md@@ -153,7 +153,8 @@> **The fan-out to other replicas is best effort and keeps no replay queue.** A Redis that pauses for less> than 10 s (a snapshot fork, a slow fsync) answers afterwards, and every event raised meanwhile reaches> the other replicas late. A longer silence, a restart, a failover or an outage drops the connection a node-> publishes on, and what was written to it may be lost with it. The events that node raises while it is+> publishes on, and what was written to it may be lost with it, or may still reach the other replicas late+> and after newer events, which their clients then apply out of order. The events that node raises while it is> disconnected, plus its reconnect backoff of up to 5 s once Redis is back, are dropped for the clients> connected to the other replicas: they are not delivered late and not twice. Clients connected to the node> that raised an event are served directly, and webhooks do not use this path, so neither is affected. Memorydiff --git a/src/modules/events/redis-io.adapter.ts b/src/modules/events/redis-io.adapter.tsindex 0259629e3..6bac830e1 100644--- a/src/modules/events/redis-io.adapter.ts+++ b/src/modules/events/redis-io.adapter.ts@@ -100,13 +100,14 @@ export function rejectRootNamespace(server: Server): void {* Delivery while Redis is away or slow: the fan-out to the other replicas is best effort and keeps no replay* queue. A Redis that pauses for less than WS_REDIS_SOCKET_TIMEOUT_MS answers afterwards, and every event raised* meanwhile reaches them late. Silence for that long destroys the publisher's socket, and so does a restart, a- * failover or an outage: what was written to the dropped connection may be lost with it. The events this node- * raises while it is disconnected, plus its reconnect backoff of up to 5 s once Redis is back (wsRedisOptions),- * are dropped for the other replicas, never delivered late and never twice. A Redis that keeps answering, but- * slower than events are raised, never looks silent: it is bounded by WS_REDIS_MAX_UNANSWERED, above which- * frames are dropped for the other replicas until it catches up. Clients on this node are served by the local- * broadcast and webhooks do not use this path, so neither is affected. What the publisher holds is bounded by one- * socket deadline of traffic for a silent Redis and by that cap for a slow one.+ * failover or an outage: what was written to the dropped connection may be lost with it, or may still reach the+ * other replicas late and after newer events. The events this node raises while it is disconnected, plus its+ * reconnect backoff of up to 5 s once Redis is back (wsRedisOptions), are dropped for the other replicas, never+ * delivered late and never twice. A Redis that keeps answering, but slower than events are raised, never looks+ * silent: it is bounded by WS_REDIS_MAX_UNANSWERED, above which frames are dropped for the other replicas until+ * it catches up. Clients on this node are served by the local broadcast and webhooks do not use this path, so+ * neither is affected. What the publisher holds is bounded by one socket deadline of traffic for a silent Redis+ * and by that cap for a slow one.*/export class RedisIoAdapter extends IoAdapter {private pubClient?: Redis;