OpenNext 项目中 Image Optimization Lambda 的常见问题与解决方案

问题背景

在使用 OpenNext 2.3.6 版本构建 Next.js 应用的 Serverless 部署时，开发者可能会遇到 Image Optimization Lambda 函数无法正常工作的问题。具体表现为 Lambda 运行时抛出"无法找到 threadChild.js 模块"的错误。

问题现象

当部署包含图片优化功能的 Next.js 应用时，Image Optimization Lambda 函数会尝试加载一个名为 threadChild.js 的文件，但该文件实际上并不存在于构建产物中。错误日志显示：

ERROR Uncaught Exception {
    "errorType": "Error",
    "errorMessage": "Cannot find module '/var/task/threadChild.js'",
    "code": "MODULE_NOT_FOUND"
}

根本原因

这个问题主要与 OpenNext 2.3.6 版本中使用的 sharp 图像处理库版本有关。在构建过程中，sharp 库尝试通过 worker 线程来处理图像优化任务，但由于版本兼容性问题，导致无法正确生成或定位所需的 threadChild.js 文件。

解决方案

方案一：降级 sharp 版本

最直接的解决方案是将 sharp 库降级到 0.32.6 版本。可以通过以下步骤实现：

1. 在构建前设置环境变量：

   export SHARP_VERSION="0.32.6"
   

2. 然后执行构建命令：

   yarn open-next build --minify
   

方案二：升级 Next.js 版本

如果项目允许，可以考虑升级 Next.js 到最新版本（如 14.1.1-canary.28 或更高），因为这些版本已经修复了与 sharp 相关的一些兼容性问题。

构建配置建议

对于使用 Serverless Framework 的开发者，建议在 serverless.yml 中配置如下构建步骤：

before:package:createDeploymentArtifacts:
  - yarn open-next build --minify
  - mkdir -p ./.open-next/zips
  - cd .open-next/server-function && zip -r ../zips/server-function.zip .
  - cd .open-next/image-optimization-function && zip -r ../zips/image-optimization-function.zip .
  - cd .open-next/revalidation-function && zip -r ../zips/revalidation-function.zip .
  - cd .open-next/warmer-function && zip -r ../zips/warmer-function.zip .

注意事项

1. 确保构建环境与运行环境的一致性，特别是在 Node.js 版本和依赖管理方面。

2. 如果使用 Docker 或其他容器化方案构建，注意容器内的环境变量设置。

3. 对于生产环境部署，建议先在测试环境中验证解决方案的有效性。

总结

OpenNext 作为将 Next.js 应用部署到 Serverless 环境的优秀工具，在图像优化方面依赖 sharp 库。当遇到 threadChild.js 缺失问题时，通过调整 sharp 版本或升级 Next.js 版本通常可以解决。开发者应根据自身项目需求和环境选择合适的解决方案。