Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
fix(group): refund the reachout budget on a WhatsApp rate limit
Yudhi Armyndharis4a64748f9fc0
diff --git a/src/modules/group/group.service.spec.ts b/src/modules/group/group.service.spec.tsindex 6a8a7d934..98ea71874 100644--- a/src/modules/group/group.service.spec.ts+++ b/src/modules/group/group.service.spec.ts@@ -5,6 +5,7 @@ import { IWhatsAppEngine } from '../../engine/interfaces/whatsapp-engine.interfaimport { EngineNotSupportedError } from '../../common/errors/engine-not-supported.error';import { EngineRefusedError } from '../../common/errors/engine-refused.error';import { EngineTransportError } from '../../common/errors/engine-transport.error';+import { EngineThrottledError } from '../../common/errors/engine-throttled.error';import { SendPacingService } from '../message/send-pacing.service';/** Pacing is off by default; its own spec covers the governor, so here it must simply not refuse. */@@ -159,6 +160,24 @@ describe('GroupService', () => {expect(pacing.refundGroupReachouts).toHaveBeenCalledWith('s1', reservation);});+ // WhatsApp turned a throttled request away before it ran, so the batch contacted nobody.+ it.each([+ ['createGroup', (svc: GroupService) => svc.createGroup('s1', 'G', ['[email protected]'])],+ ['addParticipants', (svc: GroupService) => svc.addParticipants('s1', 'g1', ['[email protected]'])],+ ])('refunds the reservation when WhatsApp rate-limits %s', async (_label, call) => {+ const error = new EngineThrottledError('rate-limited (code 429)');+ const reservation = { coldCount: 1, dayStartMs: 1 };+ const { svc, pacing } = makeServiceWithPacing(+ { createGroup: jest.fn().mockRejectedValue(error), addParticipants: jest.fn().mockRejectedValue(error) },+ {+ assertReachoutAllowed: jest.fn().mockResolvedValue(reservation),+ refundGroupReachouts: jest.fn(),+ },+ );+ await expect(call(svc)).rejects.toBe(error);+ expect(pacing.refundGroupReachouts).toHaveBeenCalledWith('s1', reservation);+ });+it.each([['a timed-out add (WhatsApp may still apply it)', new EngineTransportError('did not answer in time')],['a raw socket error', new Error('Connection Closed')],diff --git a/src/modules/group/group.service.ts b/src/modules/group/group.service.tsindex b12b55d4e..e83d0abab 100644--- a/src/modules/group/group.service.ts+++ b/src/modules/group/group.service.ts@@ -9,16 +9,21 @@ import { paginate, ListOptions } from '../../common/utils/paginate';import { SendPacingService } from '../message/send-pacing.service';import { createLogger } from '../../common/services/logger.service';import { EngineNotSupportedError } from '../../common/errors/engine-not-supported.error';+import { EngineThrottledError } from '../../common/errors/engine-throttled.error';/*** Whether a failed paced write provably contacted nobody, so its reserved budget can go back: a- * client or refusal status (400 bad input, 403 refused, 404 no such group, 409 not ready) or a 501- * for an operation the engine lacks. Anything else (a 503 deadline that abandoned an IQ still in+ * client or refusal status (400 bad input, 403 refused, 404 no such group, 409 not ready), a 501+ * for an operation the engine lacks, or a 503 WhatsApp rate limit (EngineThrottledError), which+ * WhatsApp turned away before it ran. Anything else (a 503 deadline that abandoned an IQ still in* flight, a dropped socket, a dead page) leaves the outcome unknown, and WhatsApp may already have* added the participants, so the batch stays charged.*/function contactedNobody(error: unknown): boolean {- return error instanceof HttpException && (error.getStatus() < 500 || error instanceof EngineNotSupportedError);+ return (+ error instanceof HttpException &&+ (error.getStatus() < 500 || error instanceof EngineNotSupportedError || error instanceof EngineThrottledError)+ );}/**