改进 CI 构建时间

2020年2月18日，由 Ethan Dennis (@erdennis13) 和 João Moreno (@joaomoreno) 撰写

Visual Studio Code 是一个庞大的项目，有许多活动部件和活跃的参与者列表。我们已经展示过我们如何积极使用 Azure Pipelines 来维护我们的构建和持续集成基础设施，以保持良好的工程实践。在这篇博文中，我们将讨论我们如何使用 Azure Pipelines Artifact Caching Tasks 来显著减少我们的 CI 构建时间。

我们在早前的一篇博文中描述了如何将 CI 构建时间减少了 33%。这是通过使用自定义构建任务实现的，这些任务会缓存 VS Code 使用的 node 模块，而不是在构建时解析包。虽然我们对这次性能提升感到满意，但我们想看看我们自己构建的缓存任务还能推动多远。

上次我们讨论 CI 工程时，我们的目标平台涵盖了 Windows、macOS 和 Linux。如今，VS Code 的目标平台更加多样化，例如为其远程服务器组件支持 Arm64 和 Alpine Linux。总共有八个不同的目标平台都共享通用的构建步骤。本文概述了我们如何利用缓存任务来减少 CI 的重复工作，并进一步改善我们的构建时间。

改进空间

那么，所有构建作业中究竟有哪些共同步骤呢？每个构建目标都有一个遵循类似步骤集的作业。在很高的层面上，每个作业都必须：

1. 还原依赖
2. 检查 TypeScript 和 JavaScript 代码
3. 将 TypeScript 编译为 JavaScript
4. 运行单元测试套件
5. 运行集成测试套件
6. 打包 VS Code

我们的缓存任务是加速**还原依赖**步骤的显而易见的选择。例如，既然 package-lock.json 文件很少更改，为什么还要运行一个耗时的 npm install 步骤，而不是缓存上一次运行的结果呢？由于我们之前已经讨论过缓存包，这篇博文的有趣之处在于我们如何将缓存应用到其他步骤。

由于代码检查和编译是平台无关的，这些步骤可以很容易地由单个构建代理运行，并与其他依赖平台的代理共享其结果，而不是让所有代理重复执行这项工作。我们创建了一个 Linux 构建代理，其唯一职责就是：还原包、检查代码和编译源代码。我们所要做的就是与其他代理共享结果。

缓存一切

为了在构建代理之间共享缓存结果，我们需要平台无关的缓存，而这最初并不被缓存任务所支持。因此，一个可选的 platformIndependent 参数被添加到了 Azure Pipelines Artifact Caching Tasks 中。

以下是 VS Code 使用 platformIndependent 参数的方式：

- task: 1ESLighthouseEng.PipelineArtifactCaching.RestoreCacheV1.RestoreCache@1
  inputs:
    keyfile: keyfile
    targetfolder: target
    vstsFeed: $(ArtifactFeed)
    platformIndependent: true

在缓存 node 模块时，使用 package-lock.json 文件作为缓存键是合乎逻辑的。当这个文件改变时，我们必须使缓存失效。当缓存编译输出时，整个代码库都必须作为缓存键。为了简化问题，我们决定使用 HEAD 提交作为缓存键，因为一个新的提交将不可避免地创建一个新的缓存条目。这对于我们的目的来说很好用，因为单次构建，尽管跨构建代理运行，总是在单个提交上运行。

另一个缺失的功能是能够在每个构建作业中创建多个缓存。我们现在发现自己要处理两个缓存（node 模块、编译），却没有办法单独处理每个缓存。缓存任务会输出一个名为 CacheRestored 的环境变量，可以用来乐观地跳过构建任务。这个环境变量在与单个缓存交互的构建中工作得很好，但在有多个缓存时就不那么好了——让我们不知道 CacheRestored 指的是哪个缓存。因此，又一个可选的 alias 参数被添加到了 Azure Pipelines Artifact Caching Tasks 中。

以下是我们使用 alias 参数的方式：

- task: 1ESLighthouseEng.PipelineArtifactCaching.RestoreCacheV1.RestoreCache@1
  inputs:
    keyfile: "yarn.lock"
    targetfolder: "node_modules"
    vstsFeed: "$(ArtifactFeed)"
    alias: "Packages"

- script: |
    yarn install
  displayName: Install Dependencies
  condition: ne(variables['CacheRestored-Packages'], 'true')

这里，一个名为 Packages 的别名被附加到环境变量输出中，允许我们在单个构建作业中缓存 NPM 包和编译输出。我们终于去除了大量 CI 工作的重复，这些工作现在可以只执行一次，并在特定平台的代理之间共享。

对于一个特定的用例，还有一个最后的优化空间：构建重新提交。我们有时必须在之前构建过的提交上重新触发 VS Code 构建，因为测试可能不稳定或者某些代理可能随机失败。理想情况下，共享代理不会还原或重新编译通用代码，而是交由依赖平台的代理来执行它们的工作。我们注意到的问题是，编译缓存包非常大，还原它们需要大约8分钟——而这一切都是徒劳的，因为如果该缓存存在，共享代理只会简单地让出控制权。因此，一个新的可选参数 dryRun 再次被添加到了 Azure Pipelines Artifact Caching Tasks 中，它允许我们检查缓存包是否存在而无需还原它——有效地为我们的构建重新提交减少了8分钟的时间。

在我们的构建中使用 dryRun 参数看起来是这样的：

- task: 1ESLighthouseEng.PipelineArtifactCaching.RestoreCacheV1.RestoreCache@1
  inputs:
    keyfile: commit
    targetfolder: output
    vstsFeed: "$(ArtifactFeed)"
    dryRun: true

- script: |
    npm run compile install
  displayName: Install Dependencies
  condition: ne(variables['CacheExists'], 'true')

注意，这也引入了一个新的 CacheExists 变量，它与 dryRun 参数协同工作。

结果

这些更改实施后，我们看到了总构建时间的显著减少。下表显示了 VS Code 针对的每个平台的总构建时间变化：

Linux Arm 和 Linux Alpine 目标只构建 VS Code 远程服务器组件，所以它们最初的构建时间已经足够好了。但由于它们与标准的 VS Code 客户端平台共享一些通用任务，我们决定让它们依赖于通用的构建代理。这导致在一种情况下，由于开销增加，构建时间略有增加。

构建重新提交看到了显著的改善，因为共享代理任务可以被完全跳过。例如，以下是 macOS 的一些数据：

总的来说，我们很高兴地看到 VS Code 的 CI 构建时间总共减少了约 50%！最好的消息是，您可以从我们的构建定义中汲取灵感，实现您自己的构建时间改进。

祝您缓存愉快，

Ethan Dennis，开发者服务高级软件工程师 @erdennis13

João Moreno，VS Code 高级软件工程师 @joaomoreno