Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

4.7 KB
Raw Blame
import type { PluginContext } from '../../../core/plugins';

jest.mock('../../adapters/baileys.adapter', () => ({
  BaileysAdapter: jest.fn().mockImplementation((config: unknown) => ({ config })),
}));

import { BaileysPlugin } from './index';
import { BaileysAdapter } from '../../adapters/baileys.adapter';
import type { LidMappingStore } from '../../identity/lid-mapping-store.service';
import type { ChatStateStore } from '../../adapters/baileys-chat-state-store.service';

describe('BaileysPlugin.createEngine (opaque config)', () => {
  beforeEach(() => jest.clearAllMocks());

  it('reads authDir from context.config.baileys and passes neutral per-call fields', () => {
    const plugin = new BaileysPlugin();
    void plugin.onLoad({
      config: { baileys: { authDir: '/data/baileys' } },
      logger: { log: jest.fn() },
    } as unknown as PluginContext);

    plugin.createEngine({ sessionId: 'sess-1', dbSessionId: 'db-1', proxyUrl: 'http://p' });

    expect(BaileysAdapter).toHaveBeenCalledWith(
      expect.objectContaining({
        sessionId: 'sess-1',
        dbSessionId: 'db-1',
        authDir: '/data/baileys',
        proxyUrl: 'http://p',
      }),
    );
  });

  it('falls back to the default authDir when context has no baileys config', () => {
    const plugin = new BaileysPlugin();
    plugin.createEngine({ sessionId: 'sess-2' });
    expect(BaileysAdapter).toHaveBeenCalledWith(
      expect.objectContaining({ sessionId: 'sess-2', authDir: './data/baileys' }),
    );
  });

  it('advertises the supported feature set', () => {
    expect(new BaileysPlugin().getFeatures()).toEqual([
      'text-messages',
      'typing-indicator',
      'media-messages',
      'location-messages',
      'contact-messages',
      'message-replies',
      'message-forwarding',
      'message-reactions',
      'message-deletion',
      'group-management',
      'read-receipts',
      'channels',
      'status-updates',
      'catalog',
    ]);
  });

  it('reports the baileys library name', () => {
    expect(new BaileysPlugin().getEngineLibrary().name).toBe('@whiskeysockets/baileys');
  });

  it('passes the message store to the adapter', () => {
    const store = {
      put: jest.fn(),
      getMessage: jest.fn(),
      getMessages: jest.fn(),
      update: jest.fn(),
      remove: jest.fn(),
      clearSession: jest.fn(),
    };
    const plugin = new BaileysPlugin(store);
    plugin.createEngine({ sessionId: 'sess-1' });
    expect(BaileysAdapter).toHaveBeenCalledWith(expect.objectContaining({ sessionId: 'sess-1', messageStore: store }));
  });

  // Both stores are optional in the adapter, so a dropped hop would silently stop persisting learned
  // lid pairs and chat state across restarts instead of failing anything.
  it('passes the lid-mapping and chat-state stores to the adapter', () => {
    const lidMappingStore = {} as LidMappingStore;
    const chatStateStore = {} as ChatStateStore;
    new BaileysPlugin(undefined, undefined, lidMappingStore, chatStateStore).createEngine({ sessionId: 'sess-1' });
    expect(BaileysAdapter).toHaveBeenCalledWith(expect.objectContaining({ lidMappingStore, chatStateStore }));
  });

  it('Uses the constructor-supplied engine config when onLoad never ran (enable-failure path)', () => {
    const plugin = new BaileysPlugin(undefined, { baileys: { authDir: '/op/baileys' } });
    plugin.createEngine({ sessionId: 'sess-3' });
    expect(BaileysAdapter).toHaveBeenCalledWith(
      expect.objectContaining({ sessionId: 'sess-3', authDir: '/op/baileys' }),
    );
  });

  it('Prefers context.config over the constructor blob on the healthy enable path', () => {
    const plugin = new BaileysPlugin(undefined, { baileys: { authDir: '/ctor/baileys' } });
    void plugin.onLoad({
      config: { baileys: { authDir: '/context/baileys' } },
      logger: { log: jest.fn() },
    } as unknown as PluginContext);
    plugin.createEngine({ sessionId: 'sess-4' });
    expect(BaileysAdapter).toHaveBeenCalledWith(
      expect.objectContaining({ sessionId: 'sess-4', authDir: '/context/baileys' }),
    );
  });

  // The factory hardens and purges credential dirs under its own base, so the engine must write there
  // even when a persisted plugin-config override names another directory.
  it('Prefers the per-call authDir over a context.config override', () => {
    const plugin = new BaileysPlugin();
    void plugin.onLoad({
      config: { baileys: { authDir: '/override/baileys' } },
      logger: { log: jest.fn() },
    } as unknown as PluginContext);
    plugin.createEngine({ sessionId: 'sess-5', authDir: '/factory/baileys' });
    expect(BaileysAdapter).toHaveBeenCalledWith(
      expect.objectContaining({ sessionId: 'sess-5', authDir: '/factory/baileys' }),
    );
  });
});