Happy-DOM 在 Bun 环境下关闭浏览器实例时出现 TypeError 问题分析

问题背景

Happy-DOM 是一个流行的 JavaScript DOM 实现库，它提供了一个虚拟的浏览器环境，可以在 Node.js 环境中运行。近期有开发者报告，在使用 Bun 运行时调用 Browser 实例的 close 方法时会抛出 TypeError 错误，而同样的代码在 Node.js 环境下却能正常运行。

问题现象

当开发者在 Bun 环境下执行以下代码时：

import { Browser } from "happy-dom";

const browser = new Browser();
browser.newPage();
await browser.close();

会收到如下错误信息：

TypeError: frame.window[PropertySymbol.destroy] is not a function.

通过调试发现，frame.window 对象上缺少了 PropertySymbol.destroy 符号属性，而这个属性在 Node.js 环境下是正常存在的。

技术分析

根本原因

经过深入调查，发现问题源于 Bun 的 VM 上下文实现存在一个 Bug。Happy-DOM 在创建 BrowserWindow 实例时会使用 VM 上下文来隔离窗口与全局上下文。具体来说：

1. Happy-DOM 在初始化过程中会调用 VM.createContext(this) 来设置 VM 上下文
2. 在 Bun 环境下，这个操作会导致 this 的上下文被错误地改变
3. 结果就是后续访问 this 上的方法和属性（包括符号属性）会失败

影响范围

这个问题主要影响以下场景：

• 直接使用 Browser API 创建和管理浏览器实例
• 在 Bun 环境下运行相关代码
• 尝试关闭浏览器或页面实例时

解决方案

官方修复

Bun 团队在 v1.1.41 版本中修复了 VM 上下文相关的 Bug。升级到该版本或更高版本后，Happy-DOM 的 close 方法可以正常工作。

临时解决方案

在 Bun 修复该问题之前，开发者可以考虑以下替代方案：

1. 使用 GlobalRegistrator.register() 方法注册全局窗口，这会创建 GlobalWindow 实例而不是 BrowserWindow 实例
2. 避免在 Bun 环境下使用需要 VM 上下文的 Happy-DOM 功能
3. 暂时切换到 Node.js 环境进行开发和测试

技术细节

Happy-DOM 的窗口实现差异

Happy-DOM 有两种窗口实现方式：

1. GlobalWindow：不使用 VM 上下文，通过 GlobalRegistrator.register() 创建
2. BrowserWindow：使用 VM 上下文进行隔离，是 Browser API 默认创建的窗口类型

VM 上下文的重要性

VM 上下文在 Happy-DOM 中扮演着关键角色：

• 提供窗口间的隔离环境
• 防止全局污染
• 模拟真实浏览器中 iframe 和多窗口的行为

最佳实践

对于需要在不同 JavaScript 运行时使用 Happy-DOM 的开发者，建议：

1. 明确测试目标运行环境的兼容性
2. 保持运行时环境（Bun/Node.js）更新到最新稳定版
3. 对于关键功能，考虑在不同环境下进行兼容性测试
4. 关注 Happy-DOM 和运行时的更新日志，及时获取兼容性改进信息

总结

这次问题揭示了 JavaScript 运行时实现差异可能导致的兼容性问题。随着 Bun 等新兴运行时的普及，开发者需要更加注意跨运行时兼容性。Happy-DOM 作为重要的 DOM 实现库，其与不同运行时的交互行为值得持续关注。