wasm-bindgen 中 web_sys 字符串枚举类型生成问题的技术解析

背景介绍

wasm-bindgen 是一个用于连接 Rust 和 JavaScript 的工具链，它允许 Rust 代码与 JavaScript 代码进行互操作。web_sys 是 wasm-bindgen 生态系统中的一个重要 crate，它提供了对 Web API 的 Rust 绑定。

在最新版本的 wasm-bindgen 0.2.94 和 web_sys 0.3.71 中，开发者发现了一个关于字符串枚举类型(TypeScript 定义)生成的问题：即使没有在项目接口中显式使用某些 web_sys 的字符串枚举类型，生成的 TypeScript 定义文件中也会包含这些类型的定义。

问题现象

当开发者使用 wasm-pack 构建项目时，生成的 TypeScript 定义文件(.d.ts)中会包含大量来自 web_sys 的字符串枚举类型定义，例如：

/**
 *The `MediaSourceReadyState` enum.
 *
 **This API requires the following crate features to be activated: `MediaSourceReadyState`*
 */
export type MediaSourceReadyState = "closed" | "open" | "ended";

这些类型定义在之前的版本(wasm_bindgen 0.2.93)中并不会出现，即使开发者并没有在项目接口中使用这些类型。

技术分析

web_sys 的类型系统设计

web_sys 的主要目的是为 JavaScript Web API 提供 Rust 绑定。由于这些 API 是从 JavaScript 导入到 Rust 的，因此在 JavaScript/TypeScript 端不需要导出这些类型，所以通常不会在 .d.ts 文件中包含这些类型。

然而，字符串枚举是一个特殊情况。web_sys 中的字符串枚举定义方式与用户代码中导出字符串枚举的方式完全相同：

#[wasm_bindgen]
pub enum MediaSourceReadyState {
    Closed = "closed",
    Open = "open",
    Ended = "ended",
}

这种定义方式与用户导出 C 风格枚举和结构体的行为一致，因此从技术上讲，将字符串枚举包含在生成的 .d.ts 文件中是符合预期的行为。

类型导出的四种情况

从技术角度看，web_sys 字符串枚举的使用可以分为四种情况：

1. 外部类型内部使用：web_sys 定义的枚举仅在项目内部使用
2. 外部类型公开使用：web_sys 定义的枚举作为项目公共接口的一部分
3. 自定义类型内部使用：用户定义的枚举仅在项目内部使用
4. 自定义类型公开使用：用户定义的枚举作为项目公共接口的一部分

其中，情况1和4的行为是明确的：

• 情况1不应导出类型定义
• 情况4应该导出类型定义

但情况2和3的行为则不太明确：

• 情况2中，虽然类型需要定义，但不确定是否应该导出
• 情况3中，虽然枚举被显式定义为 pub，但不确定是否应该因为它仅内部使用而不导出

私有字符串枚举的特殊情况

用户代码中还存在私有字符串枚举的特殊情况。当前的行为是：

• 私有字符串枚举被公开使用时：定义类型但不导出
• 私有字符串枚举仅内部使用时：不定义类型

解决方案讨论

针对这个问题，开发团队讨论了多种解决方案：

1. 临时解决方案：为 web_sys 枚举添加 skip_typescript 属性

   • 优点：快速解决问题，同时保持 #2153 的修复
   • 缺点：不适用于用户自定义的 web_sys 补充绑定

2. 彻底解决方案：只导出被引用的类型

   • 更精确地控制类型导出
   • 需要更多开发工作

3. 回退方案：完全回退到之前的行为

   • 立即解决问题
   • 放弃 #2153 的相关改进

经过讨论，团队决定先采用回退方案，暂时解决当前问题，同时继续研究更完善的解决方案。

对开发者的影响

对于使用 wasm-bindgen 和 web_sys 的开发者，这个问题会导致：

1. 生成的 TypeScript 定义文件变得臃肿，包含大量未使用的类型定义
2. 可能影响 TypeScript 的类型检查和自动补全体验
3. 在构建过程中增加不必要的处理时间

建议开发者：

• 暂时回退到 wasm_bindgen 0.2.93 版本
• 关注后续更新，等待更完善的解决方案
• 如果必须使用新版本，可以手动清理不需要的类型定义

未来展望

wasm-bindgen 团队将继续研究更智能的类型导出机制，目标是：

• 精确控制哪些类型需要导出
• 保持与现有行为的兼容性
• 提供更灵活的类型导出配置选项

这个问题的解决将进一步提升 wasm-bindgen 在 TypeScript 生态系统中的集成体验，使生成的类型定义更加精确和高效。