Docker部署Node.js应用遇ENOENT错误，添加空package.json是否合理？

问题背景 #

项目文件结构 #

/src
   /config
       status.js
       role.js
       index.js
   /routes
       user.routes.js
       product.routes.js
       index.js
   index.js
Dockerfile
package.json
... other files and folders

关键代码 #

src/config/index.js内容：

module.exports = {
  ...require("./status"),
  ...require("./role"),
};

Dockerfile内容 #

FROM node:19-alpine3.16

WORKDIR /usr/src/app

COPY package*.json ./

RUN npm i

COPY . .

CMD ["node", "src/index.js"]

构建错误日志 #

---> Running in 2f2e6c84845b
npm ERR! code ENOENT
npm ERR! syscall open
npm ERR! path /usr/src/app/src/config/package.json
npm ERR! errno -2
npm ERR! enoent ENOENT: no such file or directory, open '/usr/src/app/src/config/package.json'
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent 

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2022-12-26T09_17_19_235Z-debug-0.log
The command '/bin/sh -c npm i' returned a non-zero code: 254

用户尝试在每个包含index.js的文件夹中添加空内容的package.json后问题解决，但不确定该做法是否合理。

错误原因分析 #

核心问题是Docker构建执行npm i阶段时，npm试图访问尚未被复制到容器中的src/config/package.json，常见触发场景：

• 根目录package.json配置了workspaces字段（如"workspaces": ["src/*"]），npm执行install会扫描子工作区的package.json，但此时src目录还未通过COPY . .复制到容器，导致文件找不到。
• 根package.json的dependencies包含本地路径依赖（如"some-dep": "file:./src/config"），npm安装时会尝试读取该路径文件，但路径不存在。

添加空package.json的合理性分析 #

这种做法能临时解决问题，但并不合理：

• 空文件属于冗余内容，无实际功能，增加项目维护复杂度，后续易引发混淆。
• 若因workspaces导致问题，空package.json会被识别为无效工作区配置，可能引发依赖安装异常等潜在问题。

正确解决方案 #

方案1：适配workspaces的分层构建（推荐） #

如果项目确实使用monorepo工作区，先复制所有子工作区的package.json再执行npm i，既保留构建缓存优势，又满足npm工作区需求：

FROM node:19-alpine3.16

WORKDIR /usr/src/app

# 复制根目录及子工作区的package.json
COPY package*.json ./
COPY src/config/package.json ./src/config/
COPY src/routes/package.json ./src/routes/

RUN npm i

# 复制剩余项目文件
COPY . .

CMD ["node", "src/index.js"]

方案2：移除不必要的配置 #

若项目无需多工作区或本地路径依赖，检查根package.json并移除workspaces字段，同时确保dependencies中无本地路径依赖。此时npm i仅处理根目录依赖，Dockerfile可保持原有逻辑不变。

方案3：全量复制后安装（简单但不推荐） #

若项目依赖规模小、对构建速度要求不高，可先复制所有文件再执行npm i，缺点是代码修改会触发重新安装，构建速度变慢：

FROM node:19-alpine3.16

WORKDIR /usr/src/app

COPY . .

RUN npm i

CMD ["node", "src/index.js"]

内容的提问来源于stack exchange，提问作者Abd Khateeb