如何用Jest测试Chrome扩展后台未导出的消息监听处理函数？

我想用Jest对Chrome扩展的后台脚本做单元测试。测试initialiseBackground函数很简单，但消息处理函数handleNewMessage没导出，而且我不想导出它，希望把它作为单元测试的一部分。我的测试思路是：

1. 调用initialiseBackground()添加监听器；
2. 通过某种方式发送消息触发该监听器。

我的后台脚本：

export function initialiseBackground() {
    chrome.runtime.onMessage.addListener(handleNewMessage);
}
initialiseBackground()


function handleNewMessage(message, sender, onSuccess) {
    switch (message.action) {
        case ACTIONS.ONE:
            one(onSuccess);
            return true;
        case ACTIONS.TWO:
            two(message);
            return;
        case ACTIONS.THREE:
            three(message, sender);
            return;
        default:
            console.warn('Action not found:', message.action);
    }
}

目前我已通过Jest配置文件中的Mock文件完成了如下Mock：

global.chrome = {
    runtime: {
        sendMessage: jest.fn(), //trigger listener
        onMessage: {
            addListener: jest.fn(), //set listener
        },
    },
    storage: {
        local: {
            set: jest.fn(),
            get: jest.fn(),
        },
    },
};

请问我的需求是否可实现？或是有更优的处理方案？

你的需求完全可以实现，而且思路是对的，下面是具体的实现方式和优化建议：

1. 捕获未导出的handleNewMessage函数 #

当前你Mock的chrome.runtime.onMessage.addListener是一个jest.fn()，当调用initialiseBackground()时，这个mock函数会接收到handleNewMessage作为参数。我们可以直接从mock的调用记录里提取这个函数，之后就能直接调用它来测试逻辑，不需要导出。

示例测试代码：

import { initialiseBackground } from './background';

describe('Background Script', () => {
  beforeEach(() => {
    // 重置所有mock的调用记录
    jest.clearAllMocks();
    // 重新初始化背景脚本
    initialiseBackground();
  });

  it('should handle ACTIONS.ONE correctly', () => {
    // 从addListener的调用记录中提取handleNewMessage函数
    const handleNewMessage = chrome.runtime.onMessage.addListener.mock.calls[0][0];
    // 模拟onSuccess回调
    const mockOnSuccess = jest.fn();
    
    // 触发消息处理逻辑
    const result = handleNewMessage({ action: 'ONE' }, {}, mockOnSuccess);
    
    // 验证one函数是否被正确调用
    expect(one).toHaveBeenCalledWith(mockOnSuccess);
    // 验证函数返回值符合预期
    expect(result).toBe(true);
  });

  it('should log warning for unknown action', () => {
    const handleNewMessage = chrome.runtime.onMessage.addListener.mock.calls[0][0];
    // Mock console.warn
    console.warn = jest.fn();
    
    handleNewMessage({ action: 'UNKNOWN' }, {}, jest.fn());
    
    expect(console.warn).toHaveBeenCalledWith('Action not found:', 'UNKNOWN');
  });
});

2. 优化Mock细节 #

• 你当前的chrome.runtime.sendMessage mock其实用不上，因为我们是直接调用捕获到的handleNewMessage，不需要通过sendMessage触发，可以移除或者保留但不用管它。
• 要确保ACTIONS、one、two、three这些依赖也被正确Mock，避免测试依赖真实实现。比如在测试文件顶部添加：

// Mock常量ACTIONS
global.ACTIONS = {
  ONE: 'ONE',
  TWO: 'TWO',
  THREE: 'THREE'
};

// Mock后台脚本内的依赖函数
jest.mock('./background', () => ({
  ...jest.requireActual('./background'),
  one: jest.fn(),
  two: jest.fn(),
  three: jest.fn()
}));

3. 替代方案（可选） #

如果觉得捕获函数的方式不够直观，也可以考虑两种替代方案：

• 模块内导出：将handleNewMessage改为export function handleNewMessage，生产代码里不对外暴露这个函数（比如不在入口文件的导出列表里），但测试时可以直接导入它进行测试，这种方式不会影响生产代码的公共API。
• 拆分逻辑：把消息处理的核心逻辑拆分成独立的模块（比如messageHandlers.js），单独测试这个模块的逻辑，再测试initialiseBackground是否正确注册了监听器。

总结 #

你的初始思路完全可行，通过捕获mock的addListener参数来获取未导出的handleNewMessage是最直接的方式，不需要修改生产代码的结构。如果想让测试代码更清晰，也可以考虑模块内导出或者拆分逻辑的方案。

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