feat(manifest): optionally have manifest() add some annotation inform…

…ation to its output

lib/util/opt-check.js

@@ -5,6 +5,7 @@ var silentlog = require('./silentlog')
 function PacoteOptions (opts) {
   opts = opts || {}
   this._isPacoteOptions = true
+  this.annotate = opts.annotate
   this.auth = opts.auth
   this.scopeTargets = opts.scopeTargets || {}
   this.defaultTag = opts.defaultTag || 'latest'

manifest.js

@@ -39,11 +39,11 @@ function manifest (spec, opts) {
         return finalizeManifest(manifest, res, opts)
       }).then(manifest => {
         // Metadata about the way this manifest was requested
-        manifest._requested = res
-        manifest._spec = spec
-        manifest._where = opts.where
-        if (!manifest._args) manifest._args = []
-        manifest._args.push([res, opts.where])
+        if (opts.annotate) {
+          manifest._requested = res
+          manifest._spec = spec
+          manifest._where = opts.where
+        }
 
         const elapsedTime = Date.now() - startTime
         opts.log.verbose('pacote', `${res.type} manifest for ${res.name}@${res.spec} fetched in ${elapsedTime}ms`)

test/registry.manifest.cache.js

@@ -31,6 +31,7 @@ const PKG = new Manifest({
   _integrity: BASE.dist.integrity,
   _resolved: BASE.dist.tarball
 })
+
 const META = {
   'dist-tags': {
     latest: '1.2.3'

test/registry.manifest.js

@@ -311,3 +311,31 @@ test('recovers from request errors', t => {
     t.deepEqual(pkg, PKG, 'got a manifest')
   })
 })
+
+test('optionally annotates manifest with request-related metadata', t => {
+  const srv = tnock(t, OPTS.registry)
+  const opts = {
+    log: OPTS.log,
+    registry: OPTS.registry,
+    retry: false,
+    annotate: true,
+    where: 'right here'
+  }
+  const annotated = new Manifest(BASE)
+  annotated._requested = {
+    escapedName: 'foo',
+    name: 'foo',
+    raw: 'foo@1.2.3',
+    rawSpec: '1.2.3',
+    scope: null,
+    spec: '1.2.3',
+    type: 'version'
+  }
+  annotated._spec = 'foo@1.2.3'
+  annotated._where = opts.where
+
+  srv.get('/foo').reply(200, META)
+  return manifest('foo@1.2.3', opts).then(pkg => {
+    t.deepEqual(pkg, annotated, 'additional data was added to pkg')
+  })
+})