better cache status (#54)

* feat: reflect the cache status in the log messages

* chore: update npm in ci

* fixup! feat: reflect the cache status in the log messages

Author: nlf

.github/workflows/ci.yml

@@ -37,6 +37,9 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
+      - name: update npm
+        run: npm i -g npm@latest
+
       ################################################################################
       # Install Dependencies
       #

check-response.js

@@ -38,7 +38,8 @@ function logRequest (method, res, startTime, opts) {
   const elapsedTime = Date.now() - startTime
   const attempt = res.headers.get('x-fetch-attempts')
   const attemptStr = attempt && attempt > 1 ? ` attempt #${attempt}` : ''
-  const cacheStr = res.headers.get('x-local-cache') ? ' (from cache)' : ''
+  const cacheStatus = res.headers.get('x-local-cache-status')
+  const cacheStr = cacheStatus ? ` (cache ${cacheStatus})` : ''
 
   let urlStr
   try {

package-lock.json

@@ -29,7 +29,7 @@
   },
   "license": "ISC",
   "dependencies": {
-    "make-fetch-happen": "^8.0.9",
+    "make-fetch-happen": "^9.0.1",
     "minipass": "^3.1.3",
     "minipass-fetch": "^1.3.0",
     "minipass-json-stream": "^1.0.1",

package.json

@@ -168,3 +168,31 @@ More info here: https://github.com/npm/cli/wiki/No-auth-for-URI,-but-auth-presen
     },
   }), errors.HttpErrorGeneral)
 })
+
+t.test('logs the value of x-local-cache-status when set', t => {
+  const headers = new Headers()
+  const EE = require('events')
+  headers.get = header => header === 'x-local-cache-status' ? 'hit' : undefined
+  const res = Object.assign({}, mockFetchRes, {
+    headers,
+    status: 200,
+    url: 'http://username:[email protected]/foo/bar/baz',
+    body: new EE(),
+  })
+  t.plan(2)
+  checkResponse({
+    method: 'get',
+    res,
+    registry,
+    startTime,
+    opts: {
+      log: Object.assign({}, silentLog, {
+        http (header, msg) {
+          t.equal(header, 'fetch')
+          t.match(msg, /^GET 200 http:\/\/username:\*\*\*@example.com\/foo\/bar\/baz [0-9]+m?s \(cache hit\)$/)
+        },
+      }),
+    },
+  })
+  res.body.emit('end')
+})