提升 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. Lint TypeScript 和 JavaScript
3. 将 TypeScript 编译为 JavaScript
4. 运行单元测试套件
5. 运行集成测试套件
6. 打包 VS Code

我们的缓存任务是加快“恢复依赖项”步骤的明显选择。例如，既然 package-lock.json 文件很少更改，为什么还要运行昂贵的 npm install 步骤，而不是缓存上次运行的结果呢？由于我们之前已经讨论过缓存包，所以这篇文章的有趣之处在于我们如何将缓存应用于其他步骤。

由于 Linting 和编译是平台独立的，因此这些步骤可以由一个构建代理轻松运行，该代理将其结果与其他依赖于平台的代理共享，而不是让所有代理重复执行此工作。我们创建了一个 Linux 构建代理，其唯一职责就是：恢复包、进行 Linting 和编译源代码。我们所要做的就是与其他代理共享结果。

缓存一切

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

以下是 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 指的是哪个缓存。因此，又一次，我们在 Azure Pipelines Artifact Caching Tasks 中添加了另一个可选的 alias 参数。

以下是我们使用 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 分钟——如果该缓存存在，共享代理将简单地放弃控制，所以这样做毫无意义。因此，Azure Pipelines Artifact Caching Tasks 中又添加了一个新的可选 dryRun 参数，它允许我们检查缓存包是否存在而无需恢复它——这有效地将我们的构建重新提交时间缩短了 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