Automerge项目中Vite构建时重复WASM文件问题解析

在基于Vite构建工具开发Automerge项目时，开发者可能会遇到一个奇怪的现象：构建后的dist/assets目录中会出现两个几乎相同的automerge_wasm_bg-.wasm文件。这种现象虽然不会影响实际功能，但会增加构建产物体积并造成开发者困惑。

问题根源

该问题的根源在于Vite构建工具的特殊处理机制与wasm-bindgen生成代码的交互方式。具体来说：

1. wasm-bindgen在生成Web目标代码时，会自动创建一个使用import.meta.url来定位WASM文件的初始化方法
2. Automerge项目中的low_level.ts文件会无条件引入web/automerge_wasm.js模块
3. Vite构建时会扫描所有类似new URL("./<path>", import.meta.url)的代码模式，并尝试将引用的资源包含到构建结果中

由于Automerge的初始化方法实际上并不依赖这种自动定位机制（它要求显式提供WASM文件），这种扫描行为就导致了不必要的WASM文件被包含到构建结果中。

解决方案比较

目前有两种可行的解决方案：

1. Vite插件方案

通过自定义Vite插件，在构建过程中修改wasm-bindgen生成的代码，将URL构造函数调用替换为无害的占位符。这种方案的优点是：

• 不需要修改Automerge的构建脚本
• 只在Vite配置层面解决问题
• 对其他构建工具没有影响

缺点是：

• 需要维护额外的Vite配置
• 对代码的修改较为侵入式

2. 构建时代码修改方案

在Automerge的构建脚本(build.mjs)中，直接修改wasm-bindgen生成的JavaScript文件，添加Vite的特殊注释/* @vite-ignore */来阻止资源扫描。这种方案的优点是：

• 一次性解决问题，不需要每个项目都配置
• 修改范围明确，只影响Vite构建
• 构建结果更干净

缺点是：

• 需要修改Automerge的构建流程
• 对wasm-bindgen生成的代码进行后处理可能不够优雅

技术实现细节

在第二种方案中，关键的技术实现是在构建脚本中添加对wasm-bindgen输出文件的处理：

// 在runWasmBindgen函数中添加
const jsFiles = fs.readdirSync(outputPath).filter(file => file.endsWith(".js"))

for (const jsFile of jsFiles) {
  const filePath = path.join(outputPath, jsFile)
  let content = fs.readFileSync(filePath, "utf8")
  
  content = content.replace(
    /new URL\('automerge_wasm_bg\.wasm', import\.meta\.url\)/g,
    "new /* @vite-ignore */ URL('automerge_wasm_bg.wasm', import.meta.url)"
  )
  
  fs.writeFileSync(filePath, content)
}

这种修改利用了Vite的一个特性：当检测到/* @vite-ignore */注释时，会跳过对该URL的资源扫描和处理。

最佳实践建议

对于Automerge项目维护者来说，推荐采用第二种方案，即在构建阶段就解决问题。这种方案具有更好的用户体验，因为：

1. 最终用户不需要任何额外配置
2. 构建结果更加干净合理
3. 不影响其他构建工具的使用
4. 符合"开箱即用"的原则

对于临时解决方案，或者在不方便修改Automerge构建脚本的情况下，可以使用第一种Vite插件方案作为过渡。

总结

构建工具与现代WebAssembly的交互常常会产生一些意料之外的行为。Automerge项目中遇到的重复WASM文件问题，本质上是因为不同工具链对资源加载方式的不同假设导致的。通过理解问题根源并选择合适的解决方案，可以确保构建结果既干净又高效。