MSW.js 在 Jest 测试环境中遇到的 Response 兼容性问题解析

问题背景

在使用 MSW.js (Mock Service Worker) 进行 API 模拟测试时，开发者可能会遇到 TypeError: response.body.getReader is not a function 的错误。这个问题通常出现在使用 Jest 作为测试框架的环境中，特别是当测试代码尝试模拟 JSON 响应时。

问题本质

这个问题的根源在于 Jest 测试环境与 Node.js 原生模块之间的兼容性问题。具体来说，涉及以下几个方面：

1. Response 对象的实现差异：现代 Node.js 版本（18+）提供了符合 Fetch API 标准的全局 Response 对象，但 Jest 测试环境可能会使用不兼容的 polyfill 或模拟实现。

2. structuredClone 方法的问题：Node.js 18+ 原生支持的 structuredClone 方法在 Jest 的核心-js polyfill 中可能实现不正确，导致 Response 对象的处理出现问题。

3. 流式读取器的缺失：错误信息中提到的 getReader 方法是 ReadableStream 的一部分，在 Jest 环境中可能没有被正确实现。

解决方案

方案一：使用 Node.js 原生模块

最推荐的解决方案是确保测试环境中使用 Node.js 原生的 Fetch API 实现：

const { fetch, Headers, FormData, Request, Response } = require('node:undici');

globalThis.fetch = fetch;
globalThis.Headers = Headers;
globalThis.FormData = FormData;
globalThis.Request = Request;
globalThis.Response = Response;

方案二：添加必要的 polyfill

如果必须使用 Jest 环境，可以尝试添加以下 polyfill：

const { TextDecoder, TextEncoder, ReadableStream } = require('node:util');

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

方案三：降级 undici 版本

在某些情况下，降级 undici 库到 v5 版本可以解决问题，因为该版本不依赖 structuredClone 方法：

npm install undici@5

最佳实践建议

1. 考虑迁移到 Vitest：Vitest 作为新一代测试框架，对现代 JavaScript 特性的支持更好，可以避免这类兼容性问题。

2. 保持依赖更新：确保 MSW.js 和所有相关依赖都是最新版本，因为这些问题通常会在新版本中得到修复。

3. 隔离测试环境：为测试环境单独配置必要的全局变量和 polyfill，避免影响生产代码。

4. 关注 Jest 社区：如果必须使用 Jest，关注其官方仓库中关于 Fetch API 和 structuredClone 相关问题的讨论和修复。

总结

MSW.js 在 Jest 测试环境中遇到的 Response 兼容性问题，本质上是测试工具与现代 JavaScript 特性之间的适配问题。通过理解问题的技术本质，开发者可以选择最适合自己项目的解决方案。长期来看，考虑使用更现代的测试工具或等待 Jest 的更新修复，可能是更可持续的解决方案。

对于使用 NX 等现代前端工具链的项目，特别需要注意测试环境的配置，确保所有必要的 polyfill 和全局变量都已正确设置。这样才能充分发挥 MSW.js 在 API 模拟测试中的强大功能。