如何在Jest测试中模拟PubNub addListener绑定的事件？

问题说明 #

使用PubNub的业务包需要用Jest实现全量测试覆盖，但当前无法覆盖pubnub.addListener注册的status和message事件处理逻辑。相关核心代码如下：

// add listener
const listener = {
    // 需要覆盖的逻辑（status和message）
    status: (statusEvent) => {
        if (statusEvent.category === "PNConnectedCategory") {
            console.log("Connected");
        }
    },
    message: (messageEvent) => {
        // 消息处理逻辑
    }
};

this.pubnub.addListener(listener);
this.pubnub.subscribe({ channels: [this.channel] });

现有测试框架如下：

describe("publishPubNub test suites", () => {  
    const sideEffect = function (options) {
        pubnubService.publishPubNub(options);
        return true;
    } 

    it("successfull", () => {
        //TODO: mock event here
        const isCompleted =  sideEffect(publishPubNubOptions)
        expect(isCompleted).toBeTruthy();
    });
})

实现步骤与代码示例 #

1. Mock PubNub模块/实例 #

通过Jest的mock功能替换PubNub，追踪addListener和subscribe的调用：

// 全局mock PubNub模块
jest.mock('pubnub', () => {
  const mockAddListener = jest.fn();
  const mockSubscribe = jest.fn();
  // 如果用到publish方法也一并mock
  const mockPublish = jest.fn();
  return jest.fn().mockImplementation(() => ({
    addListener: mockAddListener,
    subscribe: mockSubscribe,
    publish: mockPublish
  }));
});

2. 捕获注册的Listener并手动触发事件 #

在测试用例中，先初始化服务，从mock的addListener调用记录中取出注册的listener，再手动调用事件方法覆盖逻辑：

describe("publishPubNub test suites", () => {
  let pubnubService;
  let mockPubNubInstance;

  beforeEach(() => {
    jest.clearAllMocks();
    // 实例化你的PubNub服务类
    pubnubService = new PubnubService();
    // 获取mock的PubNub实例
    mockPubNubInstance = require('pubnub').mock.instances[0];
    // 调用服务中初始化listener和subscribe的方法（比如init）
    pubnubService.init();
  });

  // 测试status事件的PNConnectedCategory分支
  it("triggers log when PNConnectedCategory status is received", () => {
    // 取出注册的listener
    const registeredListener = mockPubNubInstance.addListener.mock.calls[0][0];
    
    // 监听console.log，验证逻辑执行
    const logSpy = jest.spyOn(console, 'log').mockImplementation();
    // 手动触发status事件
    registeredListener.status({ category: "PNConnectedCategory" });
    
    expect(logSpy).toHaveBeenCalledWith("Connected");
    // 恢复console.log
    logSpy.mockRestore();
  });

  // 测试message事件处理逻辑
  it("processes message event correctly", () => {
    const registeredListener = mockPubNubInstance.addListener.mock.calls[0][0];
    // 构造模拟的message事件对象
    const mockMsgEvent = {
      message: "test payload",
      channel: pubnubService.channel
    };

    // 手动触发message事件
    registeredListener.message(mockMsgEvent);

    // 根据你的消息处理逻辑添加断言，比如验证内部状态更新或方法调用
    // expect(pubnubService.processedMessages).toContain(mockMsgEvent.message);
  });

  it("successfully publishes to PubNub", () => {
    const publishOptions = { channel: "test", message: "hello" };
    const isCompleted = pubnubService.publishPubNub(publishOptions);
    
    expect(isCompleted).toBeTruthy();
    // 验证publish方法是否被正确调用
    expect(mockPubNubInstance.publish).toHaveBeenCalledWith(publishOptions);
  });
});

关键注意事项 #

• 如果服务通过依赖注入传入PubNub实例，无需mock整个模块，直接传入手动创建的mock实例即可。
• 每个测试用例前调用jest.clearAllMocks()清除mock记录，避免测试间的状态污染。
• subscribe方法仅需mock，不需要实际执行，因为我们的目标是覆盖listener内的逻辑，而非验证PubNub的订阅流程。

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