Jest未自动取消moment mock致tz调用报错，求排查方案

我之前也碰到过Jest里moment.tz()报错的情况，结合你的描述，这个问题的核心原因主要有这几个：

• Jest自动mock在搞鬼：如果你的Jest配置里开了automock: true，或者有全局mock规则，Jest会自动生成一个空的moment mock对象——这个mock根本没有tz方法，因为tz是moment-timezone插件额外提供的扩展，自动mock不会帮你把这部分加上，所以调用moment().tz()就会报错。
• 模块扩展被截断：如果你的业务代码是先导入moment，再导入moment-timezone来扩展它，但Jest的自动mock提前把moment替换成了空对象，导致moment-timezone没法给它加上tz方法。
• 缓存优先级问题：哪怕你试过jest.unmock()或者require.requireActual()，要是Jest已经缓存了之前的mock版本，真实的moment和moment-timezone也没法正确加载生效。

针对你的需求的解决方案 #

你想要只在指定测试文件手动mock moment，其他场景用真实的moment+tz，那可以按这几步来：

1. 先搞定全局自动mock的问题 #

打开你的Jest配置文件（比如jest.config.js），检查有没有automock: true：

• 如果有，要么直接改成false全局关闭自动mock；
• 或者添加例外规则，让moment和moment-timezone不被自动mock：

// jest.config.js
module.exports = {
  // ...其他配置项
  automock: false,
  unmockedModulePathPatterns: ['moment', 'moment-timezone']
};

2. 在需要手动mock的测试文件里，正确mock moment（包含tz方法） #

如果你需要在特定测试里mock moment的行为，同时保留tz方法的正常逻辑，可以这么写：

// 目标测试文件.test.js
jest.mock('moment', () => {
  // 先加载真实的moment和moment-timezone
  const realMoment = require.requireActual('moment');
  require.requireActual('moment-timezone');

  // 这里可以自定义mock逻辑，比如固定当前时间
  const mockMoment = (date) => realMoment(date).tz('Asia/Shanghai');
  
  // 把moment的静态方法都复制到mock对象上
  Object.assign(mockMoment, realMoment);
  
  return mockMoment;
});

要是你不需要真实的tz实现，只是想mock tz的返回值，也可以手动给mock对象加上tz方法：

jest.mock('moment', () => {
  const mockMomentInstance = {
    tz: jest.fn(() => mockMomentInstance), // 支持链式调用
    format: jest.fn(() => '2024-05-20')
  };
  const mockMoment = jest.fn(() => mockMomentInstance);
  
  // 别忘了mock静态的moment.tz()方法
  mockMoment.tz = jest.fn(() => mockMomentInstance);
  
  return mockMoment;
});

3. 清除Jest的模块缓存 #

如果之前的测试已经缓存了mock版本的moment，可能导致新的配置不生效，你可以：

• 运行测试时加上--clearCache参数：jest --clearCache；
• 或者在测试文件开头手动清除缓存：

delete require.cache[require.resolve('moment')];
delete require.cache[require.resolve('moment-timezone')];

4. 确认业务代码的导入方式 #

确保你的业务代码正确导入了moment-timezone，两种常见的正确方式：

// 方式1：直接导入moment-timezone（推荐）
import moment from 'moment-timezone';

// 方式2：先导入moment，再导入moment-timezone进行扩展
import moment from 'moment';
import 'moment-timezone';

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