如何用Jest监视测试作用域外Redis客户端的on方法？

由于被测代码中的redisClient属于模块级局部变量，测试代码无法直接访问，因此需要通过Mock Redis客户端的创建过程来间接监视on方法的调用，以下是具体实现方案：

核心思路 #

被测代码采用链式调用redis.createClient().on(...)，我们可以让redis.createClient返回一个带有模拟on方法的对象，通过这个模拟对象追踪on的调用情况，同时模拟错误触发场景。

具体实现 #

场景1：测试客户端触发error事件时的日志逻辑 #

这是被测代码中on('error')监听的真实场景（客户端创建成功后，运行时触发错误）：

// 测试代码
beforeEach(() => {
  jest.resetModules(); // 清除模块缓存，确保每次测试重新加载被测代码
  jest.clearAllMocks(); // 重置所有mock的调用记录
});

it('should log error when redis client emits error event', () => {
  // 1. 创建模拟客户端，包含可监视的on方法
  const mockClient = {
    on: jest.fn((event, handler) => {
      // 模拟error事件触发，直接调用传入的错误处理函数
      if (event === 'error') {
        handler(new Error('test error'));
      }
      return mockClient; // 支持链式调用
    })
  };

  // 2. Mock redis.createClient，返回模拟客户端
  jest.mock('redis', () => ({
    createClient: jest.fn(() => mockClient)
  }));

  // 3. 加载被测代码（模块级代码会立即执行）
  require('../path-to-your-sut-file'); // 替换为被测文件的实际路径

  // 4. 验证on方法是否被正确调用
  expect(mockClient.on).toHaveBeenCalledWith('error', expect.any(Function));
  
  // 可选：验证日志函数是否被调用
  expect(logging.error).toHaveBeenCalledWith(expect.stringContaining('Redis Client Error'));
});

场景2：测试createClient调用失败的情况 #

如果你的测试目标是验证createClient本身抛出错误时的处理逻辑（注意：这种场景下on方法不会被调用，因为链式调用会中断）：

it('should handle error when creating redis client fails', () => {
  const testError = new Error('test error');

  // Mock createClient直接抛出错误
  jest.mock('redis', () => ({
    createClient: jest.fn(() => {
      throw testError;
    })
  }));

  // 验证加载被测代码时是否抛出错误
  expect(() => require('../path-to-your-sut-file')).toThrow(testError);
});

关键说明 #

1. 模块缓存处理：由于被测代码中的redisClient是模块级变量，导入时会立即执行，因此每次测试前需要用jest.resetModules()清除模块缓存，确保mock生效。
2. Mock链式调用：模拟客户端的on方法需要返回自身，以匹配被测代码的链式调用写法。
3. 场景区分：不要混淆“客户端创建失败”和“客户端运行时触发错误”两种场景，前者不会触发on('error')监听，后者才是被测代码中on方法的作用场景。

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