MSW 升级至 2.6.0 后遇到的 BroadcastChannel 未定义问题解析

问题背景

在使用 MSW（Mock Service Worker）进行前端测试时，从 2.5.2 版本升级到 2.6.0 版本后，开发者可能会遇到 ReferenceError: BroadcastChannel is not defined 的错误。这个问题主要出现在使用 Jest 和 JSDOM 环境进行测试的场景中。

问题原因分析

MSW 2.6.0 版本开始使用了 BroadcastChannel API 来实现某些功能，而 JSDOM 测试环境默认不提供这个 API 的实现。BroadcastChannel 是一个允许不同浏览器上下文（如窗口、iframe、worker 等）之间进行通信的 Web API。

类似的问题还包括：

• TransformStream is not defined
• TextEncoder is not defined
• TextDecoder is not defined

这些都属于现代 Web API，在 Node.js 测试环境中默认不可用。

解决方案

1. 使用 jest-fixed-jsdom 包

专门为解决这类问题而创建的 jest-fixed-jsdom 包提供了这些缺失 API 的补丁实现。安装后会自动为测试环境添加必要的全局变量。

2. 自定义测试环境

对于不想引入额外依赖的项目，可以创建自定义测试环境：

import { JestEnvironmentConfig, EnvironmentContext } from '@jest/environment';
import Environment from 'jest-environment-jsdom';

export default class CustomTestEnvironment extends Environment {
    constructor(config: JestEnvironmentConfig, context: EnvironmentContext) {
        super(config, context);
       
        this.global.BroadcastChannel = BroadcastChannel;
        this.global.TransformStream = TransformStream;
        this.global.TextEncoder = TextEncoder;
        this.global.TextDecoder = TextDecoder;
    }
}

然后在 jest 配置中指定使用这个环境：

module.exports = {
    testEnvironment: '<path-to-your-custom-environment>'
}

3. 直接添加 polyfill

通过 Jest 的 setupFiles 配置直接注入必要的全局变量：

// jest.polyfills.js
const { TextDecoder, TextEncoder } = require("util");
const { BroadcastChannel } = require("worker_threads");

Object.defineProperties(globalThis, {
    TextDecoder: { value: TextDecoder },
    TextEncoder: { value: TextEncoder },
    BroadcastChannel: { value: BroadcastChannel },
});

然后在 jest.config.js 中：

module.exports = {
    setupFiles: ["<rootDir>/jest.polyfills.js"]
}

更深层次的建议

JSDOM 作为测试环境存在一些固有缺陷，对于现代 Web 开发来说可能不是最佳选择。开发者可以考虑：

1. 迁移到更现代的测试环境如 happy-dom
2. 评估是否真的需要完整的 DOM 环境，某些场景下可以使用更轻量级的测试方案
3. 对于 Node.js 18+ 环境，许多现代 Web API 已经可以通过内置模块获得

总结

MSW 2.6.0 引入的新功能依赖了一些现代 Web API，这要求测试环境提供相应的实现。通过合理的 polyfill 策略可以解决这些问题，但从长远来看，考虑升级测试基础设施可能是更好的选择。开发者应根据项目实际情况选择最适合的解决方案。