fix: log tarball retrieval from cache (#403)

If tarballs are cached, the npm install log contains no information on where it got the tarball from. This helps troubleshoot issues with caching and `preferOnline/preferOffline`, for example. --------- Co-authored-by: Gar <[email protected]>
npm · Oct 15, 2024 · 2b2948f · 2b2948f
1 parent a9fc4d1
commit 2b2948f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/lib/fetcher.js b/lib/fetcher.js
@@ -188,7 +188,15 @@ class FetcherBase {
  // private
  // Note: cacache will raise a EINTEGRITY error if the integrity doesn't match
  #tarballFromCache () {
- return cacache.get.stream.byDigest(this.cache, this.integrity, this.opts)
+ const startTime = Date.now()
+ const stream = cacache.get.stream.byDigest(this.cache, this.integrity, this.opts)
+ const elapsedTime = Date.now() - startTime
+ // cache is good, so log it as a hit in particular since there was no fetch logged
+ log.http(
+ 'cache',
+ `${this.spec} ${elapsedTime}ms (cache hit)`
+ )
+ return stream
  }
 
  get [_.cacheFetches] () {

diff --git a/test/fetcher.js b/test/fetcher.js
@@ -207,6 +207,10 @@ t.test('extract', t => {
  }).extract(target + '/badcache')
  .then(({ resolved, integrity }) => {
  t.match(logs, [
+ ['http',
+ 'cache',
+ /file:test\/fixtures\/abbrev-1.1.1.tgz.*(cache hit)/,
+ ],
  ['warn', 'tar', 'zlib: incorrect header check'],
  [
  'silly',
@@ -298,7 +302,11 @@ t.test('extract', t => {
  algorithm: 'sha512',
  sri: Object,
  }, 'got expected error')
- t.same(logs, [
+ t.match(logs, [
+ ['http',
+ 'cache',
+ /file:test\/fixtures\/abbrev-1.1.1.tgz.*(cache hit)/,
+ ],
  [
  'silly',
  'tarball',