Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
fix(baileys): repair a partial address book, not only an empty one
Yudhi Armyndharis50345dd53bef
diff --git a/src/engine/adapters/baileys-history.spec.ts b/src/engine/adapters/baileys-history.spec.tsindex 68861f468..28b44a741 100644--- a/src/engine/adapters/baileys-history.spec.ts+++ b/src/engine/adapters/baileys-history.spec.ts@@ -115,7 +115,7 @@ describe('hydrateNames', () => {expect(resyncAppState).toHaveBeenCalledWith([...PATCH_NAMES], false);});- it('re-pulls the address-book snapshot on reconnect when the in-memory store is empty', async () => {+ it('re-pulls the address-book snapshot on the first reconnect of a process', async () => {// Baileys skips history + app-state snapshot once accountSyncCounter > 0. The gateway store is// in-memory, so a process restart would otherwise leave GET /contacts empty forever.const set = jest.fn().mockResolvedValue(undefined);@@ -141,7 +141,10 @@ describe('hydrateNames', () => {]);});- it('keeps the incremental resync on reconnect when contacts are already in memory', async () => {+ it('pulls the snapshot even when contacts are already held, since a partial address book cannot be counted', async () => {+ // The initial sync's buffer folds an app-state contacts.upsert into the history record of the+ // same id, and a history name is stripped as a chat title, so saved names go missing while the+ // store still holds plenty of contacts. A count-based gate reads that as "nothing to repair".const set = jest.fn().mockResolvedValue(undefined);const resyncAppState = jest.fn().mockResolvedValue(undefined);const { history: h } = history(@@ -155,8 +158,27 @@ describe('hydrateNames', () => {await h.hydrateNames();- expect(set).not.toHaveBeenCalled();- expect(resyncAppState).toHaveBeenCalledWith([...PATCH_NAMES], false);+ expect(set).toHaveBeenCalledWith({ 'app-state-sync-version': { critical_unblock_low: null } });+ expect(resyncAppState).toHaveBeenCalledWith(['critical_unblock_low'], true);+ });++ it('pulls the snapshot once per process, not on every reconnect', async () => {+ const set = jest.fn().mockResolvedValue(undefined);+ const resyncAppState = jest.fn().mockResolvedValue(undefined);+ const { history: h } = history(+ {+ groupFetchAllParticipating: jest.fn().mockResolvedValue({}),+ resyncAppState,+ authState: { creds: { accountSyncCounter: 3 }, keys: { set } },+ },+ { contactCount: 0 },+ );++ await h.hydrateNames();+ await h.hydrateNames();++ expect(set).toHaveBeenCalledTimes(1);+ expect(resyncAppState.mock.calls.filter(([, initial]) => initial === true)).toHaveLength(1);});it('uses the incremental resync on a first link (accountSyncCounter is still 0)', async () => {diff --git a/src/engine/adapters/baileys-history.ts b/src/engine/adapters/baileys-history.tsindex 39c797bce..8af9ac958 100644--- a/src/engine/adapters/baileys-history.ts+++ b/src/engine/adapters/baileys-history.ts@@ -53,6 +53,15 @@ export function toUnixSeconds(ts: number | { toNumber(): number } | null | undefexport class BaileysHistory {constructor(private readonly host: BaileysHistoryHost) {}+ /**+ * Whether the address-book snapshot has been pulled for this engine instance.+ *+ * One pull per process is what the in-memory contact store needs: it is empty at construction and+ * dies with the process, so every later reconnect on the same instance would re-download the whole+ * contact collection for a store that already holds it.+ */+ private addressbookRestored = false;+/** Post-connect socket handle (hydrateNames runs on connection 'open'). */private sock(): WASocket {return this.host.getSocket();@@ -102,10 +111,20 @@ export class BaileysHistory {** On a reconnect (`accountSyncCounter > 0`) Baileys skips history sync and the address-book snapshot* entirely: WhatsApp assumes the linked device kept its local copy. This gateway's contact store is- * in-memory, so a process restart leaves GET /contacts empty. When that happens we drop the stored- * version of the contact collection (so the next resync asks for a snapshot, not an incremental- * patch) and process its mutations as an initial sync, which is what emits `contacts.upsert` for the- * saved address book. The other collections keep the incremental resync below.+ * in-memory, so a process restart leaves GET /contacts empty. Once per connection we therefore drop+ * the stored version of the contact collection (so the next resync asks for a snapshot, not an+ * incremental patch) and process its mutations as an initial sync, which is what emits+ * `contacts.upsert` for the saved address book. The other collections keep the incremental resync+ * below.+ *+ * Once per connection, not "only when no saved contact is held": during the initial sync the event+ * buffer folds an app-state `contacts.upsert` into a `messaging-history.set` record it is already+ * holding for that id (`absorbed contact upsert in contact set` in Baileys' event-buffer), and the+ * whole initial sync is buffered as one batch, so those saved names arrive only inside the history+ * event, where the handler strips `name` because a history name is a chat title. The address book+ * is then PARTIAL rather than empty, and a count-based gate reads partial as "nothing to do" and+ * never repairs it. The snapshot pull is the only source that cannot be absorbed, so it runs on its+ * own schedule instead of on a count.*/async hydrateNames(): Promise<void> {try {@@ -135,7 +154,8 @@ export class BaileysHistory {return;}const alreadySynced = (this.sock().authState?.creds?.accountSyncCounter ?? 0) > 0;- if (alreadySynced && this.host.contactCount() === 0) {+ if (alreadySynced && !this.addressbookRestored) {+ this.addressbookRestored = true;await this.restoreAddressbookSnapshot();}await this.sock().resyncAppState(collections, false);