Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(baileys): re-read chat state a session start may have changed

Yudhi Armyndharis7e7c0ac0c4d6
diff --git a/src/engine/adapters/baileys-chat-state-store.service.spec.ts b/src/engine/adapters/baileys-chat-state-store.service.spec.ts
index fda1e4294..861dcf4ef 100644
--- a/src/engine/adapters/baileys-chat-state-store.service.spec.ts
+++ b/src/engine/adapters/baileys-chat-state-store.service.spec.ts
@@ -157,6 +157,21 @@ describe('ChatStateStoreService', () => {
expect(svc.get('s', 'c')).toEqual({ muteEndTime: null, archived: true, pinned: false });
});
+ it('forgetAbsent makes one session read through again for chats it found no row for', async () => {
+ const repo = makeRepo();
+ const svc = svcWith(repo);
+ svc.get('s', 'c');
+ svc.get('t', 'c');
+ await tick(); // both are now known to have no row
+ await repo.upsert({ sessionId: 's', chatId: 'c', archived: true } as ChatState); // written by another node
+ svc.forgetAbsent('s');
+ svc.get('s', 'c');
+ svc.get('t', 'c');
+ await tick();
+ expect(svc.get('s', 'c')).toEqual(expect.objectContaining({ archived: true }));
+ expect(repo.findOne).toHaveBeenCalledTimes(3); // 't' is still skipped
+ });
+
it('swallows a repo error on reload and remember (table may not exist yet)', async () => {
const repo = {
find: jest.fn(() => Promise.reject(new Error('no such table'))),
diff --git a/src/engine/adapters/baileys-chat-state-store.service.ts b/src/engine/adapters/baileys-chat-state-store.service.ts
index f7e32a6a4..409107073 100644
--- a/src/engine/adapters/baileys-chat-state-store.service.ts
+++ b/src/engine/adapters/baileys-chat-state-store.service.ts
@@ -22,6 +22,8 @@ export interface ChatStateStore {
reload(): Promise<void>;
/** Forget every chat state of one session (an unlink: the next account to link it starts clean). */
clearSession(sessionId: string): Promise<void>;
+ /** Re-read a session's chats known to have no row (a start: another node may have written them since). */
+ forgetAbsent(sessionId: string): void;
}
const DEFAULT_STATE: ChatStateValue = { muteEndTime: null, archived: false, pinned: false };
@@ -154,6 +156,13 @@ export class ChatStateStoreService implements ChatStateStore, OnModuleInit {
}
}
+ forgetAbsent(sessionId: string): void {
+ const prefix = `${sessionId}${SEP}`;
+ for (const k of [...this.absent]) {
+ if (k.startsWith(prefix)) this.absent.delete(k);
+ }
+ }
+
/** Warm a cache miss from the table. This lookup still returns undefined (the read cannot await); the next hits. */
private warmFromTable(k: string, sessionId: string, chatId: string): void {
if (this.pendingLookups.has(k)) return;
diff --git a/src/engine/adapters/baileys-lifecycle.ts b/src/engine/adapters/baileys-lifecycle.ts
index f7b78cb41..0f21914d7 100644
--- a/src/engine/adapters/baileys-lifecycle.ts
+++ b/src/engine/adapters/baileys-lifecycle.ts
@@ -235,6 +235,7 @@ export class BaileysLifecycle {
if (this.intentionalClose) {
return;
}
+ this.host.config.chatStateStore?.forgetAbsent(this.host.config.sessionId);
// An install that skipped a Baileys patch fails later with errors that name no cause: an
// app-state resync that never terminates, a newsletter create that cannot parse its reply.
diff --git a/src/engine/adapters/baileys-session-store.spec.ts b/src/engine/adapters/baileys-session-store.spec.ts
index b1d5981f4..d0b1781bc 100644
--- a/src/engine/adapters/baileys-session-store.spec.ts
+++ b/src/engine/adapters/baileys-session-store.spec.ts
@@ -23,6 +23,7 @@ class FakeChatStateStore implements ChatStateStore {
clearSession(): Promise<void> {
return Promise.resolve();
}
+ forgetAbsent(): void {}
}
describe('BaileysSessionStore', () => {
diff --git a/src/engine/adapters/baileys.adapter.spec.ts b/src/engine/adapters/baileys.adapter.spec.ts
index a21a2fcd8..2568c3421 100644
--- a/src/engine/adapters/baileys.adapter.spec.ts
+++ b/src/engine/adapters/baileys.adapter.spec.ts
@@ -4333,12 +4333,13 @@ describe('BaileysAdapter store-backed ops', () => {
expect(fakeStore.clearSession).toHaveBeenCalledWith('db-uuid-1');
});
- describe('persisted chat states on an unlink', () => {
+ describe('persisted chat states', () => {
const chatStateStore = {
get: jest.fn(),
remember: jest.fn().mockResolvedValue(undefined),
reload: jest.fn().mockResolvedValue(undefined),
clearSession: jest.fn(),
+ forgetAbsent: jest.fn(),
};
const linked = async (onDisconnected = jest.fn()): Promise<BaileysAdapter> => {
// A failing clear must not change how either unlink ends.
@@ -4355,6 +4356,12 @@ describe('BaileysAdapter store-backed ops', () => {
return adapter;
};
+ // Another node may have written rows while it held the session (takeover).
+ it('re-reads them on start for chats found without a row before', async () => {
+ await linked();
+ expect(chatStateStore.forgetAbsent).toHaveBeenCalledWith('sess-1');
+ });
+
it('clears them on logout', async () => {
const adapter = await linked();
await expect(adapter.logout()).resolves.toBeUndefined();