如何使用Jest测试Node.js服务端事件？

测试Node.js中继承EventEmitter的类的事件发射，核心是监听目标事件，验证事件是否触发以及携带的数据是否正确。下面是两种常用实现方式：

方式一：用Jest mock函数监听事件 #

给目标事件绑定Jest mock函数，调用触发方法后，断言mock函数的调用情况。

const { EventEmitter } = require('events');

class MyClass extends EventEmitter {
  aMethod(data) {
    this.emit("myEvent", data);
  }
}

it('should emit the event with correct data', () => {
  const myInstance = new MyClass();
  const mockHandler = jest.fn();

  // 绑定事件监听
  myInstance.on('myEvent', mockHandler);

  // 调用触发事件的方法
  const testData = { id: 1, content: 'test' };
  myInstance.aMethod(testData);

  // 断言事件触发情况
  expect(mockHandler).toHaveBeenCalledTimes(1);
  expect(mockHandler).toHaveBeenCalledWith(testData);
});

方式二：Promise配合监听（适配异步场景） #

如果事件是异步触发的，用Promise包裹监听逻辑，等待事件触发后再做断言。

const { EventEmitter } = require('events');

class MyClass extends EventEmitter {
  async aMethod(data) {
    // 模拟异步操作
    await new Promise(resolve => setTimeout(resolve, 100));
    this.emit("myEvent", data);
  }
}

it('should emit the event asynchronously', async () => {
  const myInstance = new MyClass();
  const testData = { name: 'asyncTest' };

  // 用Promise等待事件触发
  const eventPromise = new Promise(resolve => {
    myInstance.on('myEvent', (data) => resolve(data));
  });

  // 调用异步方法
  await myInstance.aMethod(testData);

  // 断言事件数据
  const emittedData = await eventPromise;
  expect(emittedData).toEqual(testData);
});

额外注意 #

如果在多个测试用例中复用实例，建议在afterEach中清理监听，避免用例间相互影响：

afterEach(() => {
  myInstance.removeAllListeners('myEvent');
});

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