0

0

Vitest 中 spyOn 必须在测试作用域内声明:原因与配置冲突详解

碧海醫心

碧海醫心

发布时间:2026-01-24 14:39:01

|

190人浏览过

|

来源于php中文网

原创

Vitest 中 spyOn 必须在测试作用域内声明:原因与配置冲突详解

vitest 的 `vi.spyon()` 无法在 `describe` 外部(如模块顶层)正常工作,主因是 `mockreset`、`restoremocks`、`clearmocks` 和 `threads: false` 等配置会干扰 spy 的生命周期管理,导致其在测试执行前被意外重置或失效。

在 Jest 中,jest.spyOn() 允许在测试文件顶层声明 spy,因为 Jest 默认对 mock/spy 实施“自动清理 + 作用域隔离”策略,且其 mock 系统与测试生命周期深度耦合。但 Vitest 的行为更严格——所有 spies 和 mocks 应被视为测试状态的一部分,必须在 it 或 beforeEach 等测试生命周期钩子中创建,否则极易受全局 mock 重置机制影响。

你遇到的问题本质是配置与 spy 使用方式的冲突:

  • mockReset: true:在每个测试前调用 vi.resetModules() 并重置所有 mock/spy 状态;
  • restoreMocks: true:恢复所有被 vi.mock() 替换的模块为原始实现(影响 spyOn 所依赖的原始对象引用);
  • clearMocks: true:清空所有 mock/spy 的调用记录(包括未被 vi.restoreAllMocks() 显式恢复的 spy);
  • threads: false:虽不直接导致失败,但在单线程模式下,模块缓存和 mock 状态共享更敏感,加剧了跨测试污染风险。

当 notificationSpy = vi.spyOn(...) 在 describe 外定义时,它在文件加载阶段即被创建;而 mockReset/clearMocks 会在每个 it 开始前触发,无差别清除该 spy 的调用历史甚至破坏其代理关系,最终导致 expect(notificationSpy).toHaveBeenCalledOnce(...) 断言失败(spy 调用计数为 0)。

✅ 正确做法(推荐):

一键职达
一键职达

AI全自动批量代投简历软件,自动浏览招聘网站从海量职位中用AI匹配职位并完成投递的全自动操作,真正实现'一键职达'的便捷体验。

下载
describe('PostboxList', () => {
  it('the notification is visible when fetching status is HasError', async () => {
    // ✅ 在测试内部创建 spy → 确保其生命周期与当前测试完全绑定
    const notificationSpy = vi.spyOn(NotificationActions, 'addNotification');

    const store = mockStore({
      postbox: {
        documents: { data: [], fetchingStatus: DataFetchingStatus.HasError },
        messages: { data: [], fetchingStatus: DataFetchingStatus.HasError },
      },
    });

    render(, { store });

    expect(notificationSpy).toHaveBeenCalledOnce({
      title: 'POSTBOX.ERROR.TITLE',
      text: 'POSTBOX.ERROR.TEXT',
    });
  });
});

⚠️ 若需复用 spy(如多个测试共用),请使用 beforeEach + afterEach 显式管理:

describe('PostboxList', () => {
  let notificationSpy: SpyInstance;

  beforeEach(() => {
    notificationSpy = vi.spyOn(NotificationActions, 'addNotification');
  });

  afterEach(() => {
    vi.restoreAllMocks(); // 显式恢复,避免泄漏
  });

  it('...', () => {
    // 使用 notificationSpy
  });

  it('...', () => {
    // 使用 notificationSpy
  });
});

? 配置优化建议(在 vite.config.ts 中):

test: {
  // ...其他配置保持不变
  mockReset: false,     // ❌ 移除:避免自动重置顶层 spy
  restoreMocks: false,  // ❌ 移除:由 beforeEach/afterEach 显式控制
  clearMocks: false,    // ❌ 移除:同上,避免误清调用记录
  threads: true,        // ✅ 恢复默认(推荐),提升隔离性
}

? 总结:Vitest 的设计哲学是“mock/spy 即测试局部状态”。将 vi.spyOn() 移至 it 或 beforeEach 内部,配合关闭激进的自动重置配置,即可彻底解决该问题。这不仅修复当前 bug,也使测试更健壮、可预测,并符合 Vitest 最佳实践。

相关专题

更多
线程和进程的区别
线程和进程的区别

线程和进程的区别:线程是进程的一部分,用于实现并发和并行操作,而线程共享进程的资源,通信更方便快捷,切换开销较小。本专题为大家提供线程和进程区别相关的各种文章、以及下载和课程。

482

2023.08.10

C++ 高级模板编程与元编程
C++ 高级模板编程与元编程

本专题深入讲解 C++ 中的高级模板编程与元编程技术,涵盖模板特化、SFINAE、模板递归、类型萃取、编译时常量与计算、C++17 的折叠表达式与变长模板参数等。通过多个实际示例,帮助开发者掌握 如何利用 C++ 模板机制编写高效、可扩展的通用代码,并提升代码的灵活性与性能。

10

2026.01.23

php远程文件教程合集
php远程文件教程合集

本专题整合了php远程文件相关教程,阅读专题下面的文章了解更多详细内容。

28

2026.01.22

PHP后端开发相关内容汇总
PHP后端开发相关内容汇总

本专题整合了PHP后端开发相关内容,阅读专题下面的文章了解更多详细内容。

21

2026.01.22

php会话教程合集
php会话教程合集

本专题整合了php会话教程相关合集,阅读专题下面的文章了解更多详细内容。

20

2026.01.22

宝塔PHP8.4相关教程汇总
宝塔PHP8.4相关教程汇总

本专题整合了宝塔PHP8.4相关教程,阅读专题下面的文章了解更多详细内容。

11

2026.01.22

PHP特殊符号教程合集
PHP特殊符号教程合集

本专题整合了PHP特殊符号相关处理方法,阅读专题下面的文章了解更多详细内容。

11

2026.01.22

PHP探针相关教程合集
PHP探针相关教程合集

本专题整合了PHP探针相关教程,阅读专题下面的文章了解更多详细内容。

8

2026.01.22

菜鸟裹裹入口以及教程汇总
菜鸟裹裹入口以及教程汇总

本专题整合了菜鸟裹裹入口地址及教程分享,阅读专题下面的文章了解更多详细内容。

52

2026.01.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二期_大前端线上班
第二期_大前端线上班

共345课时 | 45.5万人学习

Django 教程
Django 教程

共28课时 | 3.4万人学习

Pandas 教程
Pandas 教程

共15课时 | 1.0万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号