解决Floating-UI与Vitest/Webpack的React 17兼容性问题

在使用Floating-UI库时，开发者可能会遇到与测试工具Vitest或打包工具Webpack的兼容性问题，特别是在React 17环境下。本文将深入分析问题原因并提供解决方案。

问题现象

当项目中使用以下技术栈组合时：

• React 17.0.2
• TypeScript 5.1.3
• Vite 4.4.9
• Vitest 0.34.6

在将Floating-UI从0.26.25升级到0.27.5版本后，测试运行会失败并报错："Cannot find module 'react/jsx-runtime'"，尽管应用在浏览器中运行正常。

根本原因

这个问题源于React 17和现代打包工具的模块解析机制差异。Floating-UI的打包输出使用了现代React（18/19）的模块引用方式，而React 17的模块系统略有不同。

具体来说，问题出在：

1. Floating-UI的.mjs分发文件引用了react/jsx-runtime
2. 在Node环境下运行时，需要明确指定.js扩展名
3. 但直接添加.js扩展名会破坏React 18/19的兼容性

解决方案

对于Vitest用户

在Vitest配置中添加以下设置：

test: {
  deps: {
    inline: [/@floating-ui/],
  },
}

这个配置告诉Vitest将Floating-UI相关依赖内联处理，避免模块解析问题。

对于Webpack 5用户

如果是使用Webpack 5的项目，可以通过添加解析别名来解决：

resolve: {
  alias: {
    "react/jsx-dev-runtime": "react/jsx-dev-runtime.js",
    "react/jsx-runtime": "react/jsx-runtime.js"
  }
}

这个别名配置确保Webpack能正确找到React 17的JSX运行时模块。

注意事项

1. 虽然升级Vite/Vitest到最新版本可能解决此问题，但在大型项目中可能不现实
2. React 18/19用户通常不会遇到此问题，这是React 17特有的兼容性问题
3. 如果项目允许升级React版本，升级到React 18+是更彻底的解决方案

总结

Floating-UI作为流行的UI定位库，在与React 17和现代构建工具配合使用时可能会遇到模块解析问题。通过调整构建工具的配置，可以很好地解决这些兼容性问题，而无需强制升级项目的主要依赖版本。理解这些兼容性问题的根源有助于开发者更好地维护和升级他们的前端项目。