From 4687a2a86f1fc55884371f127e7f37ba404c93ab Mon Sep 17 00:00:00 2001 From: Renato Alcara Date: Mon, 27 Apr 2026 00:58:26 -0300 Subject: [PATCH] docs(unified-session): update class docstring (no more circuit breaker) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR #393 review (Copilot): the class-level JSDoc still listed "Circuit breaker protection" as a feature, but the protection was removed in commit b531b46999 in favour of best-effort single-attempt semantics (telemetry is non-critical — failures are swallowed and counted in the hookFailures metric). Updated the bullet point to describe what actually happens now. Note: not addressing the breaking-API change comments (removed enableCircuitBreaker option from UnifiedSessionOptions, removed circuitBreakers/getCircuitBreakerStats/resetCircuitBreakers from makeSocket() return, removed circuit_breaker_* Prometheus metrics) per maintainer policy — this fork has a single consumer (zpro.io), downstream forks absorb on merge. --- src/Utils/unified-session.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/Utils/unified-session.ts b/src/Utils/unified-session.ts index 4244cd69..9b9ba1d4 100644 --- a/src/Utils/unified-session.ts +++ b/src/Utils/unified-session.ts @@ -90,7 +90,9 @@ export type UnifiedSessionTrigger = 'login' | 'pairing' | 'presence' | 'manual' * Manages the unified_session telemetry feature with: * - Server time synchronization * - Rate limiting (prevents spam) - * - Circuit breaker protection + * - Best-effort send semantics (failures are swallowed and counted — + * telemetry is non-critical so a single attempt with the underlying + * sendNode timeout is enough; no retry, no circuit breaker) * - Prometheus metrics integration * - Structured logging *