feat: add option to override recorded registry

lib/arborist/build-ideal-tree.js

@@ -34,6 +34,7 @@ const optionalSet = require('../optional-set.js')
 const { checkEngine, checkPlatform } = require('npm-install-checks')
 
 const relpath = require('../relpath.js')
+const { resolveOptions } = require('../override-resolves')
 
 // note: some of these symbols are shared so we can hit
 // them with unit tests and reuse them across mixins
@@ -311,6 +312,7 @@ module.exports = cls => class IdealTreeBuilder extends cls {
         ? Shrinkwrap.reset({
           path: this.path,
           lockfileVersion: this.options.lockfileVersion,
+          resolveOptions: resolveOptions(this.options),
         }).then(meta => Object.assign(root, { meta }))
         : this.loadVirtual({ root }))
 
@@ -354,6 +356,7 @@ module.exports = cls => class IdealTreeBuilder extends cls {
     const meta = new Shrinkwrap({
       path: this.path,
       lockfileVersion: this.options.lockfileVersion,
+      resolveOptions: resolveOptions(this.options),
     })
     meta.reset()
     root.meta = meta

lib/arborist/load-actual.js

@@ -8,6 +8,7 @@ const readdir = promisify(require('readdir-scoped-modules'))
 const walkUp = require('walk-up-path')
 const ancestorPath = require('common-ancestor-path')
 const treeCheck = require('../tree-check.js')
+const { resolveOptions } = require('../override-resolves')
 
 const Shrinkwrap = require('../shrinkwrap.js')
 const calcDepFlags = require('../calc-dep-flags.js')
@@ -147,6 +148,7 @@ module.exports = cls => class ActualLoader extends cls {
     const meta = await Shrinkwrap.load({
       path: this[_actualTree].path,
       hiddenLockfile: true,
+      resolveOptions: resolveOptions(this.options),
     })
     if (meta.loadedFromDisk) {
       this[_actualTree].meta = meta
@@ -155,6 +157,7 @@ module.exports = cls => class ActualLoader extends cls {
       const meta = await Shrinkwrap.load({
         path: this[_actualTree].path,
         lockfileVersion: this.options.lockfileVersion,
+        resolveOptions: resolveOptions(this.options),
       })
       this[_actualTree].meta = meta
       return this[_loadActualActually]({ root, ignoreMissing })

lib/arborist/load-virtual.js

@@ -12,6 +12,7 @@ const relpath = require('../relpath.js')
 const calcDepFlags = require('../calc-dep-flags.js')
 const rpj = require('read-package-json-fast')
 const treeCheck = require('../tree-check.js')
+const { resolveOptions } = require('../override-resolves')
 
 const loadFromShrinkwrap = Symbol('loadFromShrinkwrap')
 const resolveNodes = Symbol('resolveNodes')
@@ -57,6 +58,7 @@ module.exports = cls => class VirtualLoader extends cls {
     const s = await Shrinkwrap.load({
       path: this.path,
       lockfileVersion: this.options.lockfileVersion,
+      resolveOptions: resolveOptions(this.options),
     })
     if (!s.loadedFromDisk && !options.root) {
       const er = new Error('loadVirtual requires existing shrinkwrap file')

lib/override-resolves.js

@@ -0,0 +1,21 @@
+
+function resolveOptions (opts) {
+  return {
+    omitLockfileRegistryResolved: opts.omitLockfileRegistryResolved,
+    registry: opts.registry,
+    recordResolvedRegistry: opts.recordResolvedRegistry,
+  }
+}
+
+function overrideResolves (resolved, opts) {
+  if (opts.omitLockfileRegistryResolved) {
+    return undefined
+  }
+  if (opts.registry && opts.recordResolvedRegistry && resolved.startsWith(opts.registry)) {
+    // TODO handle scoped packages with their own registries.
+    return opts.recordResolvedRegistry + resolved.slice(opts.registry.length)
+  }
+  return resolved
+}
+
+module.exports = { overrideResolves, resolveOptions }

lib/shrinkwrap.js

@@ -95,6 +95,7 @@ const specFromResolved = resolved => {
 const relpath = require('./relpath.js')
 
 const consistentResolve = require('./consistent-resolve.js')
+const { overrideResolves } = require('./override-resolves.js')
 
 const maybeReadFile = file => {
   return readFile(file, 'utf8').then(d => d, er => {
@@ -300,8 +301,11 @@ class Shrinkwrap {
 
     const resolved = consistentResolve(node.resolved, node.path, path, true)
     // hide resolved from registry dependencies.
-    if (resolved &&
-      !(options.omitLockfileRegistryResolved && node.isRegistryDependency)) {
+    if (!resolved) {
+      // no-op
+    } else if (node.isRegistryDependency) {
+      meta.resolved = overrideResolves(resolved, options)
+    } else {
       meta.resolved = resolved
     }
 
@@ -333,7 +337,7 @@ class Shrinkwrap {
       hiddenLockfile = false,
       log = procLog,
       lockfileVersion,
-      omitLockfileRegistryResolved = false,
+      resolveOptions = {},
     } = options
 
     this.lockfileVersion = hiddenLockfile ? 3
@@ -352,7 +356,7 @@ class Shrinkwrap {
     this.yarnLock = null
     this.hiddenLockfile = hiddenLockfile
     this.loadingError = null
-    this.resolvedOptions = { omitLockfileRegistryResolved }
+    this.resolveOptions = resolveOptions
     // only load npm-shrinkwrap.json in dep trees, not package-lock
     this.shrinkwrapOnly = shrinkwrapOnly
   }
@@ -827,7 +831,7 @@ class Shrinkwrap {
           resolved,
           integrity,
           hasShrinkwrap,
-        } = Shrinkwrap.metaFromNode(node, this.path, this.resolvedOptions)
+        } = Shrinkwrap.metaFromNode(node, this.path, this.resolveOptions)
         node.resolved = node.resolved || resolved || null
         node.integrity = node.integrity || integrity || null
         node.hasShrinkwrap = node.hasShrinkwrap || hasShrinkwrap || false
@@ -886,7 +890,7 @@ class Shrinkwrap {
     this.data.packages[loc] = Shrinkwrap.metaFromNode(
       node,
       this.path,
-      this.resolvedOptions)
+      this.resolveOptions)
   }
 
   commit () {
@@ -897,7 +901,7 @@ class Shrinkwrap {
       const root = Shrinkwrap.metaFromNode(
         this.tree.target,
         this.path,
-        this.resolvedOptions)
+        this.resolveOptions)
       this.data.packages = {}
       if (Object.keys(root).length) {
         this.data.packages[''] = root
@@ -911,7 +915,7 @@ class Shrinkwrap {
         this.data.packages[loc] = Shrinkwrap.metaFromNode(
           node,
           this.path,
-          this.resolvedOptions)
+          this.resolveOptions)
       }
     } else if (this[_awaitingUpdate].size > 0) {
       for (const loc of this[_awaitingUpdate].keys()) {
@@ -1012,16 +1016,14 @@ class Shrinkwrap {
     // git, file, dir, or remote, then the resolved value is necessary.
     if (node.resolved &&
         !node.isLink &&
-        !(node.isRegistryDependency &&
-          this.resolvedOptions.omitLockfileRegistryResolved) &&
         rSpec.type !== 'git' &&
         rSpec.type !== 'file' &&
         rSpec.type !== 'directory' &&
         spec.type !== 'directory' &&
         spec.type !== 'git' &&
         spec.type !== 'file' &&
         spec.type !== 'remote') {
-      lock.resolved = node.resolved
+      lock.resolved = overrideResolves(node.resolved, this.resolveOptions)
     }
 
     if (node.integrity) {

test/shrinkwrap.js

@@ -227,19 +227,22 @@ t.test('throws when attempting to access data before loading', t => {
   t.end()
 })
 
-t.test('omitLockfileRegistryResolved', async t => {
-  const url = 'https://registry.npmjs.org/registry/-/registry-1.2.3.tgz'
-  const getData = async (omitLockfileRegistryResolved) => {
+t.test('resolveOptions', async t => {
+  const url = 'https://private.registry.org/deadbeef/registry/-/registry-1.2.3.tgz'
+  const someOtherRegistry = 'https://someother.registry.org/registry/-/registry-1.2.3.tgz'
+  const getData = async (resolveOptions) => {
     const dir = t.testdir()
     const meta = await Shrinkwrap.load({
       path: dir,
-      omitLockfileRegistryResolved})
+      resolveOptions,
+    })
 
     const root = new Node({
       pkg: {
         name: 'root',
         dependencies: {
           registry: '^1.0.0',
+          'some-other-registry': '^1.0.0',
           tar: url,
         },
       },
@@ -249,26 +252,55 @@ t.test('omitLockfileRegistryResolved', async t => {
     })
 
     const registry = new Node({
-      pkg: {name: 'registry', version: '1.2.3' },
+      pkg: { name: 'registry', version: '1.2.3' },
       resolved: url,
       integrity: 'sha512-registry',
       parent: root,
     })
 
+    const otherRegistry = new Node({
+      pkg: { name: 'some-other-registry', version: '1.2.3' },
+      resolved: someOtherRegistry,
+      integrity: 'sha512-registry',
+      parent: root,
+    })
+
     const tar = new Node({
-      pkg: {name: 'tar', version: '1.2.3'},
+      pkg: { name: 'tar', version: '1.2.3' },
       resolved: url,
       integrity: 'sha512-registry',
       parent: root,
     })
 
     calcDepFlags(root)
     meta.add(root)
-    return { data: meta.commit(), registry, tar, root }
+    return { data: meta.commit(), registry, tar, root, otherRegistry }
   }
 
-  await t.test('true', async t => {
-    const { data } = await getData(true)
+  await t.test('with recordResolvedRegistry', async t => {
+    const { data } = await getData({
+      registry: 'https://private.registry.org/deadbeef',
+      recordResolvedRegistry: 'https://registry.npmjs.org',
+    })
+
+    t.strictSame(data.packages['node_modules/registry'].resolved,
+      'https://registry.npmjs.org/registry/-/registry-1.2.3.tgz')
+    t.strictSame(data.dependencies.registry.resolved,
+      'https://registry.npmjs.org/registry/-/registry-1.2.3.tgz')
+
+    // some-other-registry is a registry dependency but the registry hosts
+    // tarballs on another host. we don't know if that url is portable, or what
+    // part of the url is the registry to replace so we have to leave it as is.
+    t.strictSame(data.packages['node_modules/some-other-registry'].resolved, someOtherRegistry)
+    t.strictSame(data.dependencies['some-other-registry'].resolved, someOtherRegistry)
+
+    // should not affect url dependencies
+    t.strictSame(data.packages['node_modules/tar'].resolved, url)
+    t.strictSame(data.dependencies.tar.resolved, undefined)
+  })
+
+  await t.test('omitLockfileRegistryResolved', async t => {
+    const { data } = await getData({ omitLockfileRegistryResolved: true })
     // registry dependencies in v2 packages and v1 dependencies should
     // have resolved stripped.
     t.strictSame(data.packages['node_modules/registry'].resolved, undefined)
@@ -280,8 +312,8 @@ t.test('omitLockfileRegistryResolved', async t => {
     t.strictSame(data.dependencies.tar.resolved, undefined)
   })
 
-  await t.test('false', async t => {
-    const { data } = await getData(false)
+  await t.test('omitLockfileRegistryResolved: false', async t => {
+    const { data } = await getData({ omitLockfileRegistryResolved: false })
     t.strictSame(data.packages['node_modules/registry'].resolved, url)
     t.strictSame(data.dependencies.registry.resolved, url)
 
@@ -292,7 +324,7 @@ t.test('omitLockfileRegistryResolved', async t => {
 
   t.test('metaFromNode default', async t => {
     // test to cover options default.
-    const { registry } = await getData(false)
+    const { registry } = await getData(undefined)
     t.strictSame(Shrinkwrap.metaFromNode(registry, '').resolved, url)
   })
 })