Docker `npm install` 与 TypeScript 中的 GitHub 私有 repo 依赖项

Question

我们有一个 Node TypeScript 项目，我们正在尝试对其进行 Dockerize。 该项目依赖于另一个 GitHub 私有存储库，该存储库通过 package.json 中的“git@github.com:{private-repo-name}”语法引用。 依赖项目也是一个TS项目。 在任何本地开发 PC 操作系统（例如 macOS、Ubuntu LTS 等）的克隆位置和 shell 中运行npm install （或npm ci等）时，主项目安装和构建良好。 然而，当尝试 Dockerize 主项目时，我们看到npm build脚本错误显然没有意义。 依赖项目有一个“准备”脚本，它在为依赖项目调用的npm install之后npm install ，在它的 repo 被检出后。 “准备”脚本是npm run build ，“构建”脚本是tsc -p . && npm run validate tsc -p . && npm run validate 。

所以事情看起来像这样：

主项目的 package.json：

{
    "name": "main-project",
    "private": true,
    "scripts": {
        ...
    },
    "dependencies": {
        ...
        "typescript": "^4.3.4",
        "private-repo": "git@github.com:my-private-repo.git#a-branch",
    },
    "devDependencies": {
        "@types/example": "^1.0.0",
        ...
    }
}

依赖项目package.json：

{
    "name": "dependency-project",
    "main": "dist/index.js",
    "types": "dist/index.d.ts",
    "scripts": {
        "build": "tsc -p . && npm run validate",
        "prepare": "npm run build",
        "validate": "node dist/validate.js"
    },
    "private": true,
    "dependencies": {
        ...
    },
    "devDependencies": {
        "@types/example": "1.0.0",
        ...
    }
}

总体目标是分层构建 Docker 映像，但我们在第一步（主项目的npm install ）无错误地完成时遇到了困难。

主项目的 Dockerfile 如下所示：

FROM node:16-alpine
ARG SSH_KEY
RUN apk add git openssh-client
COPY package.json package-lock.json ./
RUN mkdir -p -m 0600 ~/.ssh && ssh-keyscan github.com >> ~/.ssh/known_hosts
RUN ssh-agent sh -c 'echo $SSH_KEY | base64 -d | ssh-add - ; npm ci'

这种将私钥传递到层构建中的方法工作正常（尽管它是我们能够开始工作的各种方法中的唯一一种，包括 Docker Buildkit）。 回购被检出并且安装显然成功，然后“准备”脚本（因此npm build和tsc -p ）运行。

当我们运行docker build --build-arg SSH_KEY=$key . 一切正常，直到出现以下错误：

#9 27.31 npm ERR! > my-private-repo@0.0.3 prepare
#9 27.31 npm ERR! > npm run build
#9 27.31 npm ERR!
#9 27.31 npm ERR!
#9 27.31 npm ERR! > my-private-repo@0.0.3 build
#9 27.31 npm ERR! > tsc -p . && npm run validate
#9 27.31 npm ERR!
#9 27.31 npm ERR! error TS2688: Cannot find type definition file for 'cacheable-request'.
#9 27.31 npm ERR!   The file is in the program because:
#9 27.31 npm ERR!     Entry point for implicit type library 'cacheable-request'
#9 27.31 npm ERR! error TS2688: Cannot find type definition file for 'chai'.
#9 27.31 npm ERR!   The file is in the program because:
#9 27.31 npm ERR!     Entry point for implicit type library 'chai'
#9 27.31 npm ERR! error TS2688: Cannot find type definition file for 'cors'.
#9 27.31 npm ERR!   The file is in the program because:
#9 27.31 npm ERR!     Entry point for implicit type library 'cors'
#9 27.31 npm ERR! error TS2688: Cannot find type definition file for 'faker'.
#9 27.31 npm ERR!   The file is in the program because:
#9 27.31 npm ERR!     Entry point for implicit type library 'faker'
#9 27.31 npm ERR! error TS2688: Cannot find type definition file for 'lodash'.
#9 27.31 npm ERR!   The file is in the program because:
#9 27.31 npm ERR!     Entry point for implicit type library 'lodash'
#9 27.31 npm ERR! error TS2688: Cannot find type definition file for 'mocha'.
#9 27.31 npm ERR!   The file is in the program because:
#9 27.31 npm ERR!     Entry point for implicit type library 'mocha'
#9 27.31 npm ERR! error TS2688: Cannot find type definition file for 'responselike'.
#9 27.31 npm ERR!   The file is in the program because:
#9 27.31 npm ERR!     Entry point for implicit type library 'responselike'

令人困惑的是，那些“错误 TS2688”消息所指的包都不是依赖项（私有仓库）项目的依赖项（它们在主项目的 package-lock.json 中。我们不知道如何解释） .

我们尝试的主要故障排除步骤包括：

• 在本地开发 PC 操作系统上使用相同的 Node 和 npm 版本，并运行主项目的npm install [工作正常]。
• 在这篇文章之后，尝试在它抱怨的每个包中查找index.d.ts文件（但这些包甚至不在依赖项目中）： https : //github.com/microsoft/TypeScript/问题/27956
• 试图理解并检查这篇文章，但无济于事： 修复 TS2688：在 node_modules 中找不到类型定义文件

似乎在相关的Docker层中调用的shell的用户上下文中一定有什么东西导致TS使用了错误的package.json（即错误的依赖项），因为我们在Dockerfile中所做的非常简单，它适用于除 Docker 层之外的任何地方。

Answer 1

[更新/回答我自己的问题] 我无法完全解释这种行为，因为它没有任何意义。 相反，我尝试使用 ubuntu:20.04 而不是 node:16-alpine 图像。 我不得不添加 node 和一堆依赖项，但完成后我能够很好地npm ci ，没有那个打字稿投诉，或任何其他投诉。

这是 Dockerfile 以防万一可以帮助任何人（注意这只是基础/构建层）：

FROM ubuntu:20.04

RUN apt-get update \
  # had to install tzdata this first to get the noninteractive to work
  && DEBIAN_FRONTEND="noninteractive" apt-get install -y --no-install-recommends tzdata \
  && apt-get install -y curl gnupg build-essential libcurl4-openssl-dev openssh-client git\
  && curl -fsSL https://deb.nodesource.com/setup_16.x | bash - \
  #&& apt-get remove -y --purge cmdtest \
  && apt-get update \
  && apt-get install -y nodejs \
  && rm -rf /var/lib/apt/lists/* \
  && rm -rf /var/lib/apt/lists.d/* \
  && apt-get autoremove \
  && apt-get clean \
  && apt-get autoclean

RUN adduser --disabled-password --gecos "" --uid 1000 node

RUN chown -R node:node /home/node

USER node

# had to set mode to 0700 otherwise couldn't open .ssh director to write known_hosts file
RUN mkdir -p -m 0700 ~/.ssh && ssh-keyscan github.com >> ~/.ssh/known_hosts
RUN mkdir -p ~/app/node_modules && chown -R node:node /home/node/app

WORKDIR ~/app

COPY package.json package-lock.json ./

# had to allow uid=1000 access for this to work
RUN --mount=type=ssh,uid=1000 npm ci

COPY --chown=node:node . .

RUN npm run build

希望对其他人有所帮助，因为我花了大约一周的“空闲”时间才达到这一点！