Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
fix(cache): expire stalled Redis operations
Yudhi Armyndharis190ea71b6c65
diff --git a/src/common/cache/cache.service.redis.spec.ts b/src/common/cache/cache.service.redis.spec.tsnew file mode 100644index 000000000..feb6d8c0e--- /dev/null+++ b/src/common/cache/cache.service.redis.spec.ts@@ -0,0 +1,131 @@+import { createServer, Socket } from 'node:net';+import { once } from 'node:events';+import { ConfigService } from '@nestjs/config';+import Redis, { RedisOptions } from 'ioredis';+import { CacheService } from './cache.service';+import { LoggerService } from '../services/logger.service';++jest.mock('ioredis');++// A local RESP peer keeps real ioredis command deadlines, queues and reconnection in the test.+describe('CacheService connected response deadlines', () => {+ const RealRedis = jest.requireActual<typeof import('ioredis')>('ioredis').default;+ const RedisMock = Redis as unknown as jest.Mock;+ let service: CacheService;+ let client: Redis;+ let blocked: Set<string>;+ let received: jest.Mock;+ let sockets: Set<Socket>;+ let server: ReturnType<typeof createServer>;+ let operations: Promise<unknown>[];++ beforeEach(async () => {+ operations = [];+ for (const method of ['log', 'warn', 'debug'] as const) {+ jest.spyOn(LoggerService.prototype, method).mockImplementation(() => undefined);+ }+ blocked = new Set();+ received = jest.fn();+ sockets = new Set();+ server = createServer(socket => {+ sockets.add(socket);+ socket.on('close', () => sockets.delete(socket));+ let pending = Buffer.alloc(0);+ socket.on('data', chunk => {+ pending = Buffer.concat([pending, chunk]);+ while (pending.length) {+ const headerEnd = pending.indexOf('\r\n');+ if (headerEnd < 0) return;+ const count = Number(pending.subarray(1, headerEnd).toString());+ let cursor = headerEnd + 2;+ const args: string[] = [];+ for (let i = 0; i < count; i++) {+ const end = pending.indexOf('\r\n', cursor);+ if (end < 0) return;+ const length = Number(pending.subarray(cursor + 1, end).toString());+ if (pending.length < end + 2 + length + 2) return;+ args.push(pending.subarray(end + 2, end + 2 + length).toString());+ cursor = end + 2 + length + 2;+ }+ pending = pending.subarray(cursor);+ const command = args[0].toLowerCase();+ received(command);+ if (!blocked.has(command)) socket.write(command === 'get' ? '$-1\r\n' : '+OK\r\n');+ }+ });+ });+ server.listen(0, '127.0.0.1');+ await once(server, 'listening');+ const address = server.address() as { port: number };+ RedisMock.mockImplementation((options: RedisOptions) => {+ client = new RealRedis({+ ...options,+ host: '127.0.0.1',+ port: address.port,+ username: undefined,+ password: undefined,+ tls: undefined,+ enableReadyCheck: false,+ });+ return client;+ });+ service = new CacheService({ get: () => true } as unknown as ConfigService);+ expect(await service.isAvailable()).toBe(false);+ if (client.status !== 'ready') await once(client, 'ready');+ });++ afterEach(async () => {+ const ended = new Promise<void>(resolve => client.once('end', () => resolve()));+ await service.onModuleDestroy();+ await ended;+ await Promise.allSettled(operations);+ expect(client.status).toBe('end');+ for (const socket of sockets) socket.destroy();+ await new Promise<void>(resolve => server.close(() => resolve()));+ RedisMock.mockReset();+ jest.restoreAllMocks();+ });++ const withinDeadline = async <T>(operation: Promise<T>): Promise<T | 'pending'> => {+ operations.push(operation);+ let timer: NodeJS.Timeout | undefined;+ try {+ return await Promise.race([+ operation,+ new Promise<'pending'>(resolve => {+ timer = setTimeout(() => resolve('pending'), 3000);+ }),+ ]);+ } finally {+ if (timer) clearTimeout(timer);+ }+ };++ it('fails silent connected polls softly, clears their queue and recovers on the same client', async () => {+ expect(await service.isAvailable()).toBe(true);+ blocked.add('ping');+ const recovered = new Promise<void>(resolve => client.once('ready', () => resolve()));+ expect(+ await withinDeadline(Promise.all([service.isAvailable(), service.isAvailable(), service.isAvailable()])),+ ).toEqual([false, false, false]);+ blocked.clear();+ await recovered;+ expect(await service.isAvailable()).toBe(true);+ expect((client as unknown as { commandQueue: { length: number } }).commandQueue.length).toBe(0);+ expect(RedisMock).toHaveBeenCalledTimes(1);+ }, 10000);++ it('bounds silent reads and writes without replaying an expired write after reconnect', async () => {+ blocked.add('get');+ blocked.add('setex');+ const recovered = new Promise<void>(resolve => client.once('ready', () => resolve()));+ expect(+ await withinDeadline(Promise.all([service.getSessionStatus('s1'), service.setSessionStatus('s1', 'ready')])),+ ).toEqual([null, undefined]);+ blocked.clear();+ await recovered;+ expect(await service.isAvailable()).toBe(true);+ expect(received.mock.calls.filter(([command]) => command === 'setex')).toHaveLength(1);+ expect((client as unknown as { commandQueue: { length: number } }).commandQueue.length).toBe(0);+ }, 10000);+});diff --git a/src/common/cache/cache.service.ts b/src/common/cache/cache.service.tsindex dc4e4a71b..bd1ea6316 100644--- a/src/common/cache/cache.service.ts+++ b/src/common/cache/cache.service.ts@@ -29,6 +29,9 @@ const TTL = {SESSIONS_STATS: 15, // 15 sec};+/** Max time to await a cache command or release a socket that stops responding. */+const CACHE_COMMAND_TIMEOUT_MS = 2000;+/** Max time to await a graceful `redis.quit()` on shutdown before force-disconnecting (see onModuleDestroy). */export const CACHE_QUIT_TIMEOUT_MS = 2000;@@ -69,6 +72,10 @@ export class CacheService implements OnModuleDestroy {// Cache is best-effort: a command issued while disconnected fails fast (the caller falls back to// the source of truth) instead of being queued and stalling the request until reconnect.enableOfflineQueue: false,+ commandTimeout: CACHE_COMMAND_TIMEOUT_MS,+ // Release unanswered commands as well as their callers, then let the client reconnect.+ socketTimeout: CACHE_COMMAND_TIMEOUT_MS,+ autoResendUnfulfilledCommands: false,maxRetriesPerRequest: 3,// Reconnect forever with bounded backoff. Returning null (the previous behavior after 3 tries)// makes ioredis abandon reconnection permanently, which is exactly what left the cache dead