Uppy Companion 模块在 ESM 导入时的正确使用方式

Uppy 是一个流行的文件上传库，而 Companion 是其服务器端组件。最近有开发者反馈在升级到 4.10.0 及以上版本时遇到了 Cannot read properties of undefined (reading 'app') 的错误。本文将深入分析这个问题并提供解决方案。

问题背景

当开发者尝试从 @uppy/companion 导入并使用 companion.app() 方法时，在某些情况下会遇到以下错误：

TypeError: Cannot read properties of undefined (reading 'app')

这个问题主要出现在使用 ES 模块(ESM)导入方式时，特别是在 TypeScript 或现代 JavaScript 项目中。

根本原因

问题的根源在于模块导入方式的不同。在 CommonJS (CJS) 环境中，直接使用 require 导入可以正常工作：

const companion = require('@uppy/companion')

但在 ESM 环境中，直接使用 import 导入会导致 companion.app 不可用：

import companion from '@uppy/companion'  // 这种方式可能有问题

这是因为 Companion 模块的导出方式在 ESM 和 CJS 环境下有所不同。

解决方案

方案一：使用命名空间导入

最可靠的解决方案是使用命名空间导入方式：

import * as companion from '@uppy/companion'

const appResult = companion.app(companionOptions)
const companionApp = appResult.app
app.use('/', companionApp)
companion.socket(app.listen(3020))

这种方式无论在 TypeScript 还是 JavaScript 中都能正常工作。

方案二：直接解构导入

如果你确定使用的是支持的环境，也可以直接解构导入：

import { app as companionApp, socket } from '@uppy/companion'

app.use('/', companionApp(companionOptions))
socket(app.listen(3020))

方案三：混合导入方式

在某些情况下，可以结合默认导入和命名导入：

import companion, { socket } from '@uppy/companion'

const { app } = companion.app(companionOptions)
app.use('/', app)
socket(app.listen(3020))

配置注意事项

无论使用哪种导入方式，配置 Companion 时都需要注意以下几点：

1. 必须配置 secret：这是安全必需的
2. 生产环境需要 uploadUrls：否则会拒绝启动
3. 文件路径需要存在：确保 filePath 指向的目录可写
4. 服务器配置要匹配：server.path 必须与 Express 路由匹配

最佳实践建议

1. 在 TypeScript 项目中，优先使用命名空间导入方式
2. 对于新项目，建议直接使用 ESM 模块规范
3. 升级时注意检查导入语句是否需要调整
4. 生产环境务必配置所有安全相关选项

总结

Uppy Companion 是一个功能强大的文件上传服务端组件，正确理解其在不同模块系统下的导入方式对于项目成功集成至关重要。通过本文介绍的方法，开发者可以避免常见的导入错误，确保项目顺利运行。

对于从旧版本升级的项目，特别需要注意模块导入方式可能发生的变化。遵循这些实践建议，可以大大减少集成过程中遇到的问题。