bug: pnpm cache hits provide little install speedup because lockfile verification is not cached

未关闭
#1,672 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 7 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
52/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
github-actions, node.js, typescript
领域
ci-cd, devops

调研方向

Read the pnpm cache handling in actions/setup-node and trace how it resolves, restores, and saves the package store cache. Check the existing tests for pnpm caching, then identify how a separate key can use the OS, architecture, and lockfile hash while keeping failures non-fatal. Done when the verification log is independently restored and saved, including on a store cache hit, with npm and Yarn behavior unchanged.

由索引模型根据 Issue 内容生成。

描述

bug needs triage

Description

With pnpm 11+, actions/setup-node's cache: pnpm can provide little or no installation speedup, even when the cache is successfully restored.

The reason is that setup-node caches only pnpm's package store, while pnpm stores lockfile verification results separately in <cacheDir>/lockfile-verified.jsonl.

These results allow pnpm to avoid repeating registry-backed verification of lockfile entries, including integrity checks and applicable supply-chain policies such as minimumReleaseAge and trustPolicy.

Because the verification log is not included in the cache, every CI job repeats the verification, even when the package store is fully cached and the lockfile is unchanged.

In workloads where verification dominates installation time, the store cache becomes largely ineffective.

Action version

actions/[email protected]

Platform

  • Ubuntu
  • macOS
  • Windows

Runner type

  • Hosted
  • Self-hosted

Tools version

  • pnpm: 12.16.1
  • Node.js: Not recorded
  • Lockfile: Approximately 2,000 entries (868 KB)
  • Configuration:
    • minimumReleaseAge: 1440
    • trustPolicy: no-downgrade

Repro steps

  1. Configure actions/setup-node with cache: pnpm in a repository using pnpm 12 and the supply-chain policies above.
  2. Run pnpm install --frozen-lockfile.
  3. Run the workflow again without changing the lockfile.
  4. Confirm that the package store cache is restored successfully.
  5. Compare installation times with and without the cache, and with the lockfile verification log restored separately.
Measurements
Scenario Result
GitHub Actions, warm store (27 install jobs) 13–22s/job, 392s total
Cold install without any cache 13–14s
Controlled test: warm store, verification log missing 26s
Controlled test: warm store, verification log restored 20s
Parallel CI fleet (25 jobs), before → after Median 32s → 18s; aggregate 818s → 455s

Despite a successful store cache hit, installation time was comparable to a completely uncached installation.

Restoring the verification log reduced dependency setup time by approximately 6 seconds per job in the controlled experiment.

The fleet-level improvement was larger, although it also included other configuration changes.

Similar results were reported in pnpm/setup#30: lockfile verification accounted for 16.6 of 17.6 seconds on Linux and 40.1 of 42.4 seconds on Windows.

Expected behavior

When the lockfile is unchanged and previously computed verification results remain valid, cache: pnpm should reuse those results along with the package store.

A successful cache hit should avoid redundant verification work, allowing subsequent installations to benefit from caching.

Actual behavior

setup-node restores only the package store.

The lockfile verification log is never restored, so pnpm repeats registry-backed verification on every job.

As a result, cache: pnpm provides almost no performance benefit in workloads dominated by lockfile verification, despite reporting successful cache hits.

Suggested solution

Cache <cacheDir>/lockfile-verified.jsonl independently of the package store.

  1. Resolve the cache directory using pnpm cache path, available in pnpm 12. If unavailable, retain the existing behavior.
  2. Use a separate cache key, incorporating the OS, architecture, and lockfile hash, without prefix-based fallback.
  3. Restore the verification log independently of whether the package store cache hits or misses.
  4. Save the verification log even when the package store cache hits. The current implementation skips saving on an exact store cache hit. Simply adding this file to the existing store cache paths would not populate verification logs for existing cache entries.
  5. Keep failures non-fatal. A missing or unusable verification cache should cause pnpm to perform its normal verification.
  6. Leave npm and Yarn unchanged.

Only the verification log should be cached, rather than the entire pnpm cache directory.

Security considerations

Restoring the verification log does not bypass pnpm's supply-chain protections.

pnpm itself determines whether previously recorded verification results can be trusted for the current lockfile and policy configuration. Unusable results trigger normal verification.

This approach is already implemented by pnpm/setup.

References

主要语言
TypeScript
星标
5k
派生
1.7k
平均合并
5 天 1 小时
30 天内合并 PR
1

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

actions/setup-node 的其他 Issue

查看 actions/setup-node 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。