Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

4.6 KB
Raw Blame
import { WwebjsContacts } from './wwebjs-contacts';
import { BaileysContacts } from './baileys-contacts';
import { createLogger } from '../../common/services/logger.service';
import { type WwebjsEngineHost } from './wwebjs-host';
import type { Client } from 'whatsapp-web.js';
import type { WASocket } from '@whiskeysockets/baileys';

/**
 * The blocklist READ β€” the missing half of the exposed block/unblock writes. The neutral shape is
 * a bare array of ids: whatsapp-web.js resolves full Contact models but Baileys' blocklist query
 * answers only jids, and inventing the other fields on one engine would make the two engines claim
 * different things about the same account.
 */

const logger = createLogger('blocked-contacts.spec');

describe('WwebjsContacts.getBlockedContacts', () => {
  function makeContacts(): { contacts: WwebjsContacts; client: { getBlockedContacts: jest.Mock } } {
    const client = { getBlockedContacts: jest.fn() };
    const host = {
      ensureReady: jest.fn(),
      getClient: () => client as unknown as Client,
      logger,
      reportIfPageTransportError: jest.fn(),
    } as unknown as WwebjsEngineHost;
    return { contacts: new WwebjsContacts(host), client };
  }

  it('maps the blocked Contact models to their neutral ids', async () => {
    const { contacts, client } = makeContacts();
    client.getBlockedContacts.mockResolvedValue([
      { id: { _serialized: '[email protected]' } },
      { id: { _serialized: '[email protected]' } },
    ]);

    await expect(contacts.getBlockedContacts()).resolves.toEqual(['[email protected]', '[email protected]']);
  });

  it('drops an entry whose id is unreadable rather than reporting "undefined"', async () => {
    const { contacts, client } = makeContacts();
    client.getBlockedContacts.mockResolvedValue([{ id: {} }, { id: { _serialized: '[email protected]' } }]);

    await expect(contacts.getBlockedContacts()).resolves.toEqual(['[email protected]']);
  });

  it('lists an id once when the blocklist holds a contact under both its LID and its phone', async () => {
    const { contacts, client } = makeContacts();
    // whatsapp-web.js answers a LID entry under the contact's phone id (a plain string), so the two
    // entries read as the same id.
    client.getBlockedContacts.mockResolvedValue([
      { id: '[email protected]' },
      { id: { _serialized: '[email protected]' } },
      { id: { _serialized: '[email protected]' } },
    ]);

    await expect(contacts.getBlockedContacts()).resolves.toEqual(['[email protected]', '[email protected]']);
  });

  it('resolves [] for an empty blocklist', async () => {
    const { contacts, client } = makeContacts();
    client.getBlockedContacts.mockResolvedValue([]);

    await expect(contacts.getBlockedContacts()).resolves.toEqual([]);
  });
});

describe('BaileysContacts.getBlockedContacts', () => {
  function makeContacts(toNeutralJid = (jid: string): string => jid.replace('@s.whatsapp.net', '@c.us')): {
    contacts: BaileysContacts;
    sock: { fetchBlocklist: jest.Mock };
  } {
    const sock = { fetchBlocklist: jest.fn() };
    const host = {
      ensureReady: jest.fn(),
      getSocket: () => sock as unknown as WASocket,
      logger,
      toNeutralJid,
    };
    return { contacts: new BaileysContacts(host as never), sock };
  }

  it('neutralises the blocklist jids', async () => {
    const { contacts, sock } = makeContacts();
    sock.fetchBlocklist.mockResolvedValue(['[email protected]', '[email protected]']);

    await expect(contacts.getBlockedContacts()).resolves.toEqual(['[email protected]', '[email protected]']);
  });

  it('drops undefined jid attrs (a wire item without a jid carries nothing addressable)', async () => {
    const { contacts, sock } = makeContacts();
    sock.fetchBlocklist.mockResolvedValue([undefined, '[email protected]']);

    await expect(contacts.getBlockedContacts()).resolves.toEqual(['[email protected]']);
  });

  it('lists an id once when the blocklist holds a contact under both its LID and its phone', async () => {
    // The session knows the pair, so both wire jids fold to the contact's phone id.
    const { contacts, sock } = makeContacts(jid =>
      jid === '111222333@lid' ? '[email protected]' : jid.replace('@s.whatsapp.net', '@c.us'),
    );
    sock.fetchBlocklist.mockResolvedValue(['111222333@lid', '[email protected]', '[email protected]']);

    await expect(contacts.getBlockedContacts()).resolves.toEqual(['[email protected]', '[email protected]']);
  });

  it('resolves [] for an empty blocklist', async () => {
    const { contacts, sock } = makeContacts();
    sock.fetchBlocklist.mockResolvedValue([]);

    await expect(contacts.getBlockedContacts()).resolves.toEqual([]);
  });
});