Happy DOM 中事件监听器未重置问题的技术解析

问题背景

在使用 Happy DOM 进行前端测试时，开发者可能会遇到一个典型问题：在连续运行多个测试用例时，注册在 window、document 或 body 上的事件监听器没有被正确清除。这个问题尤其在使用 jQuery 等传统库时更为明显，因为这些库通常会在全局对象上注册事件处理器。

问题现象

当测试代码在 body 元素上注册点击事件监听器后，后续测试运行时这些监听器会累积存在。例如：

1. 第一次测试运行时，点击事件触发一次，处理逻辑执行一次
2. 第二次测试运行时，同样的点击事件会触发两次处理逻辑
3. 随着测试运行次数增加，事件处理逻辑会被重复执行多次

根本原因

这个问题实际上与测试运行器的配置有关，而非 Happy DOM 本身的问题。当使用 Vitest 作为测试运行器并启用了 singleThread 模式时，测试隔离机制会被禁用。

在单线程模式下，Vitest 不会为每个测试用例创建新的上下文环境，导致全局状态（包括 DOM 事件监听器）在测试用例之间持续存在。这是 Vitest 的预期行为，而非 Happy DOM 的缺陷。

解决方案

方案一：禁用单线程模式

最简单的解决方案是移除 poolOptions.threads.singleThread 配置，让 Vitest 使用默认的多线程模式。在这种模式下，每个测试用例都会获得干净的上下文环境。

// vitest.config.js
export default defineConfig({
  test: {
    // 移除或注释掉以下配置
    // poolOptions: {
    //   threads: {
    //     singleThread: true
    //   }
    // }
  }
})

方案二：手动清理事件监听器

如果必须使用单线程模式，可以在每个测试用例的 afterEach 钩子中手动清理事件监听器：

afterEach(() => {
  // 移除body上的所有点击事件监听器
  document.body.replaceWith(document.body.cloneNode(true));
  
  // 或者使用jQuery的方式
  $('body').off('click');
});

方案三：重构测试策略

对于测试 jQuery 代码，可以考虑以下优化策略：

1. 将事件绑定逻辑封装到可初始化的模块中
2. 在测试前初始化模块，测试后销毁模块
3. 使用模拟的 DOM 环境而不是全局的 document

最佳实践建议

1. 避免全局状态：尽量将事件监听器限制在特定元素而非全局对象上
2. 使用测试隔离：充分利用测试框架的隔离机制
3. 考虑现代化重构：虽然需要先写测试，但长远来看，将 jQuery 代码逐步重构为现代 JavaScript 会更易于维护
4. 合理使用模拟：对于复杂的遗留代码，可以考虑使用 jest.mock 或 vi.mock 来模拟部分功能

总结

Happy DOM 本身能够正确模拟浏览器环境，但测试隔离问题通常源于测试运行器的配置。理解测试框架的运行机制和隔离策略对于编写可靠的测试至关重要。在测试遗留代码时，适当的封装和清理策略可以帮助我们构建更健壮的测试套件。