如何用Jest模拟Discord实例方法及类监听器内的逻辑？

核心问题在于Discord.js的Client是事件驱动的异步对象，直接测试会依赖真实Discord API，必须通过Mock模拟隔离依赖，手动触发事件并验证内部逻辑。

步骤1：Mock Discord.js模块 #

用Jest完全替换Discord.js的真实实现，避免调用真实API。

步骤2：模拟Client实例的关键方法与属性 #

需要模拟Client实例的on（记录事件监听器）、login（返回异步成功结果）、guilds.cache.get（返回模拟公会数据），确保服务类的逻辑能在测试环境中运行。

步骤3：手动触发事件并验证逻辑 #

从on方法的调用记录中取出事件回调，手动执行来触发ready等事件，进而验证内部的异步逻辑。

示例代码 #

服务类实现（参考）discordService.js

const { Client } = require('discord.js');
const env = require('./env');

class DiscordService {
  constructor() {
    this.client = new Client({ intents: ['Guilds'] });
    this.initEvents();
  }

  initEvents() {
    this.client.on('ready', async () => {
      const guild = await this.client.guilds.cache.get(env.DISCORD_SERVER_ID);
      if (guild) this.guild = guild;
    });
  }

  async start() {
    await this.client.login(env.DISCORD_BOT_TOKEN);
  }
}

module.exports = DiscordService;

测试代码discordService.test.js

const DiscordService = require('./discordService');
const { Client } = require('discord.js');
const env = require('./env');

// 全局Mock Discord.js模块
jest.mock('discord.js');

// 模拟公会对象
const mockGuild = { id: env.DISCORD_SERVER_ID, name: '测试公会' };

describe('DiscordService', () => {
  let service;
  let mockClient;
  let mockOn;
  let mockLogin;

  beforeEach(() => {
    // 重置所有Mock状态
    Client.mockClear();
    
    // 构建Client实例的Mock方法
    mockOn = jest.fn();
    mockLogin = jest.fn().mockResolvedValue(true);
    const mockCache = { get: jest.fn().mockReturnValue(mockGuild) };
    
    // 组装完整的Client Mock实例
    mockClient = {
      on: mockOn,
      login: mockLogin,
      guilds: { cache: mockCache }
    };
    
    // 让Client构造函数返回Mock实例
    Client.mockImplementation(() => mockClient);
    
    // 初始化服务
    service = new DiscordService();
  });

  test('初始化时正确创建Client实例', () => {
    expect(Client).toHaveBeenCalledWith({ intents: ['Guilds'] });
  });

  test('调用start时触发client.login', async () => {
    await service.start();
    expect(mockLogin).toHaveBeenCalledWith(env.DISCORD_BOT_TOKEN);
  });

  test('注册ready事件监听器', () => {
    expect(mockOn).toHaveBeenCalledWith('ready', expect.any(Function));
  });

  test('ready事件触发时正确获取并存储公会', async () => {
    // 从on的调用记录中提取ready事件的回调函数
    const readyCallback = mockOn.mock.calls.find(call => call[0] === 'ready')[1];
    
    // 手动触发ready事件（异步要加await）
    await readyCallback();
    
    // 验证公会获取逻辑
    expect(mockClient.guilds.cache.get).toHaveBeenCalledWith(env.DISCORD_SERVER_ID);
    expect(service.guild).toEqual(mockGuild);
  });
});

关键说明 #

1. Mock隔离：通过jest.mock('discord.js')完全隔离真实Discord API，测试不依赖网络或外部服务
2. 事件触发：事件监听器通过on方法注册，测试时取出回调手动执行，模拟Discord客户端的事件触发
3. 异步处理：ready事件中的异步逻辑要加await，确保测试等待逻辑完成后再断言
4. 扩展模拟：如果服务用到其他Discord API（如channels、members），只需在mockClient中添加对应模拟属性即可

内容的提问来源于stack exchange，提问作者IdontEvenEven