Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
fix(session): keep a nameless revoke off in-flight messages
Yudhi Armyndharis1ab0cd7fda3c
diff --git a/src/modules/session/message-projector.empty-id.spec.ts b/src/modules/session/message-projector.empty-id.spec.tsnew file mode 100644index 000000000..c936c9f0d--- /dev/null+++ b/src/modules/session/message-projector.empty-id.spec.ts@@ -0,0 +1,96 @@+import { DataSource, type Repository } from 'typeorm';+import { EngineRegistry } from '../../engine/engine-registry.service';+import type { IncomingMessage, IWhatsAppEngine } from '../../engine/interfaces/whatsapp-engine.interface';+import type { HookManager } from '../../core/hooks';+import type { EventsGateway } from '../events/events.gateway';+import { Message } from '../message/entities/message.entity';+import type { StatusStoreService } from '../status-store/status-store.service';+import type { WebhookService } from '../webhook/webhook.service';+import { MessageProjector } from './message-projector.service';+import type { SessionLidResolver } from './session-lid-resolver.service';+import type { Session } from './entities/session.entity';+import { deferred } from './inbound-room';++const flush = async (): Promise<void> => {+ for (let n = 0; n < 10; n++) await new Promise(resolve => setImmediate(resolve));+};++// An engine that cannot read a message's id reports the empty sentinel for it. Such an id names no message, so+// a change that carries it must not reach a message that is still being written under the same sentinel.+describe('a change that names no message id', () => {+ let db: DataSource;+ let repository: Repository<Message>;+ let engine: IWhatsAppEngine;+ let projector: MessageProjector;+ let announced: string[];+ let release: () => void;++ beforeEach(async () => {+ db = await new DataSource({+ type: 'better-sqlite3',+ database: ':memory:',+ entities: [Message],+ synchronize: true,+ }).initialize();+ repository = db.getRepository(Message);+ const engines = new EngineRegistry();+ engine = {} as IWhatsAppEngine;+ engines.set('s1', engine);+ announced = [];+ const gate = deferred<void>();+ release = () => gate.resolve();+ projector = new MessageProjector(+ repository,+ { update: jest.fn().mockResolvedValue({ affected: 1 }) } as unknown as Repository<Session>,+ engines,+ { emitMessage: jest.fn(), emitMessageRevoked: jest.fn() } as unknown as EventsGateway,+ {+ dispatch: jest.fn((_session: string, event: string) => {+ announced.push(event);+ return Promise.resolve();+ }),+ } as unknown as WebhookService,+ {+ execute: jest.fn(async (event: string, data: unknown) => {+ if (event === 'message:received' || event === 'message:sent') await gate.promise;+ return { continue: true, data };+ }),+ } as unknown as HookManager,+ {} as StatusStoreService,+ { resolveSenderPhone: jest.fn().mockResolvedValue(null) } as unknown as SessionLidResolver,+ );+ });++ afterEach(async () => {+ await db.destroy();+ });++ it.each([+ ['received', false],+ ['sent', true],+ ])('does not take back an unrelated message %s that is still in its hook chain', async (event, fromMe) => {+ const chatId = '[email protected]';+ const message: IncomingMessage = {+ id: '',+ chatId,+ from: fromMe ? '[email protected]' : chatId,+ to: fromMe ? chatId : '[email protected]',+ fromMe,+ body: 'hello',+ type: 'text',+ timestamp: 1_700_000_000,+ isGroup: false,+ kind: 'individual',+ };+ if (fromMe) projector.handleOwnSendEcho('s1', engine, message);+ else projector.handleInboundMessage('s1', engine, message);+ await flush();+ projector.handleMessageRevoked('s1', engine, { id: '', chatId } as never);+ await flush();+ release();+ await flush();++ expect(await repository.find()).toEqual([expect.objectContaining({ body: 'hello', type: 'text' })]);+ expect(announced).toContain(`message.${event}`);+ });+});diff --git a/src/modules/session/message-projector.service.ts b/src/modules/session/message-projector.service.tsindex 247906790..e256d3b15 100644--- a/src/modules/session/message-projector.service.ts+++ b/src/modules/session/message-projector.service.ts@@ -633,6 +633,9 @@ export class MessageProjector {/** Record a message as not yet written; a re-fire of the same id keeps the changes recorded so far. */private trackInFlight(key: string, message: InboundMessageData): InFlightEntry {+ // A message whose id the engine could not read is registered under no key: the empty id would be shared by+ // every such message, and a revoke or ack that names no message would reach all of them.+ if (!message.id) return { ref: refOf(message) };const inFlight = this.inboundInFlight.get(key) ?? {// The first delivery of an id says whose message it is: a repeat sent from another chat must not// take that over from it, or a change aimed through the repeat would be judged by the wrong rule.