@npmcli/arborist 7.4.2 → 7.5.1

package/bin/index.js

@@ -2,6 +2,7 @@
 
 const fs = require('fs')
 const path = require('path')
+const { time } = require('proc-log')
 
 const { bin, arb: options } = require('./lib/options')
 const version = require('../package.json').version
@@ -72,11 +73,11 @@ for (const file of commandFiles) {
 
     log.info(name, options)
 
-    process.emit('time', totalTime)
-    process.emit('time', scriptTime)
+    const timeEnd = time.start(totalTime)
+    const scriptEnd = time.start(scriptTime)
 
     return command(options, (result) => {
-      process.emit('timeEnd', scriptTime)
+      scriptEnd()
       return {
         result,
         timing: {
@@ -95,7 +96,7 @@ for (const file of commandFiles) {
         return err
       })
       .then((r) => {
-        process.emit('timeEnd', totalTime)
+        timeEnd()
         if (bin.loglevel !== 'silent') {
           console[process.exitCode ? 'error' : 'log'](r)
         }

package/bin/lib/logging.js

@@ -1,4 +1,4 @@
-const log = require('proc-log')
+const { log } = require('proc-log')
 const fs = require('fs')
 const { dirname } = require('path')
 const os = require('os')

package/bin/lib/timers.js

@@ -4,22 +4,22 @@ const log = require('./logging.js')
 const timers = new Map()
 const finished = new Map()
 
-process.on('time', name => {
-  if (timers.has(name)) {
-    throw new Error('conflicting timer! ' + name)
-  }
-  timers.set(name, process.hrtime.bigint())
-})
-
-process.on('timeEnd', name => {
-  if (!timers.has(name)) {
-    throw new Error('timer not started! ' + name)
-  }
-  const elapsed = Number(process.hrtime.bigint() - timers.get(name))
-  timers.delete(name)
-  finished.set(name, elapsed)
-  if (options.timing) {
-    log.info('timeEnd', `${name} ${elapsed / 1e9}s`, log.meta({ force: options.timing === 'always' }))
+process.on('time', (level, name) => {
+  if (level === 'start') {
+    if (timers.has(name)) {
+      throw new Error('conflicting timer! ' + name)
+    }
+    timers.set(name, process.hrtime.bigint())
+  } else if (level === 'end') {
+    if (!timers.has(name)) {
+      throw new Error('timer not started! ' + name)
+    }
+    const elapsed = Number(process.hrtime.bigint() - timers.get(name))
+    timers.delete(name)
+    finished.set(name, elapsed)
+    if (options.timing) {
+      log.info('timeEnd', `${name} ${elapsed / 1e9}s`, log.meta({ force: options.timing === 'always' }))
+    }
   }
 })
 

package/lib/add-rm-pkg-deps.js

@@ -1,6 +1,6 @@
 // add and remove dependency specs to/from pkg manifest
 
-const log = require('proc-log')
+const { log } = require('proc-log')
 const localeCompare = require('@isaacs/string-locale-compare')('en')
 
 const add = ({ pkg, add, saveBundle, saveType }) => {

package/lib/arborist/build-ideal-tree.js

@@ -11,7 +11,7 @@ const treeCheck = require('../tree-check.js')
 const { readdirScoped } = require('@npmcli/fs')
 const { lstat, readlink } = require('fs/promises')
 const { depth } = require('treeverse')
-const log = require('proc-log')
+const { log, time } = require('proc-log')
 const { redact } = require('@npmcli/redact')
 
 const {
@@ -179,7 +179,7 @@ module.exports = cls => class IdealTreeBuilder extends cls {
       options.rm = null
     }
 
-    process.emit('time', 'idealTree')
+    const timeEnd = time.start('idealTree')
 
     if (!options.add && !options.rm && !options.update && this.options.global) {
       throw new Error('global requires add, rm, or update option')
@@ -205,7 +205,7 @@ module.exports = cls => class IdealTreeBuilder extends cls {
       await this.#pruneFailedOptional()
       await this.#checkEngineAndPlatform()
     } finally {
-      process.emit('timeEnd', 'idealTree')
+      timeEnd()
       this.finishTracker('idealTree')
     }
 
@@ -278,7 +278,7 @@ module.exports = cls => class IdealTreeBuilder extends cls {
   // load the initial tree, either the virtualTree from a shrinkwrap,
   // or just the root node from a package.json
   async #initTree () {
-    process.emit('time', 'idealTree:init')
+    const timeEnd = time.start('idealTree:init')
     let root
     if (this.options.global) {
       root = await this.#globalRootNode()
@@ -356,7 +356,7 @@ module.exports = cls => class IdealTreeBuilder extends cls {
         // if you want another one, load another copy.
         this.idealTree = tree
         this.virtualTree = null
-        process.emit('timeEnd', 'idealTree:init')
+        timeEnd()
         return tree
       })
   }
@@ -420,7 +420,7 @@ module.exports = cls => class IdealTreeBuilder extends cls {
   // process the add/rm requests by modifying the root node, and the
   // update.names request by queueing nodes dependent on those named.
   async #applyUserRequests (options) {
-    process.emit('time', 'idealTree:userRequests')
+    const timeEnd = time.start('idealTree:userRequests')
     const tree = this.idealTree.target
 
     if (!this.options.workspaces.length) {
@@ -436,7 +436,7 @@ module.exports = cls => class IdealTreeBuilder extends cls {
       await Promise.all(appliedRequests)
     }
 
-    process.emit('timeEnd', 'idealTree:userRequests')
+    timeEnd()
   }
 
   async #applyUserRequestsToNode (tree, options) {
@@ -463,7 +463,7 @@ module.exports = cls => class IdealTreeBuilder extends cls {
           }
           const dir = resolve(nm, name)
           const st = await lstat(dir)
-            .catch(/* istanbul ignore next */ er => null)
+            .catch(/* istanbul ignore next */ () => null)
           if (st && st.isSymbolicLink()) {
             const target = await readlink(dir)
             const real = resolve(dirname(dir), target).replace(/#/g, '%23')
@@ -691,7 +691,7 @@ module.exports = cls => class IdealTreeBuilder extends cls {
     // if the lockfile is from node v5 or earlier, then we'll have to reload
     // all the manifests of everything we encounter.  this is costly, but at
     // least it's just a one-time hit.
-    process.emit('time', 'idealTree:inflate')
+    const timeEnd = time.start('idealTree:inflate')
 
     // don't warn if we're not gonna actually write it back anyway.
     const heading = ancient ? 'ancient lockfile' : 'old lockfile'
@@ -758,14 +758,14 @@ This is a one-time fix-up, please be patient...
       meta.originalLockfileVersion = defaultLockfileVersion
     }
     this.finishTracker('idealTree:inflate')
-    process.emit('timeEnd', 'idealTree:inflate')
+    timeEnd()
   }
 
   // at this point we have a virtual tree with the actual root node's
   // package deps, which may be partly or entirely incomplete, invalid
   // or extraneous.
   #buildDeps () {
-    process.emit('time', 'idealTree:buildDeps')
+    const timeEnd = time.start('idealTree:buildDeps')
     const tree = this.idealTree.target
     tree.assertRootOverrides()
     this.#depsQueue.push(tree)
@@ -773,15 +773,14 @@ This is a one-time fix-up, please be patient...
     // in the override list
     log.silly('idealTree', 'buildDeps')
     this.addTracker('idealTree', tree.name, '')
-    return this.#buildDepStep()
-      .then(() => process.emit('timeEnd', 'idealTree:buildDeps'))
+    return this.#buildDepStep().then(timeEnd)
   }
 
   async #buildDepStep () {
     // removes tracker of previous dependency in the queue
     if (this.#currentDep) {
       const { location, name } = this.#currentDep
-      process.emit('timeEnd', `idealTree:${location || '#root'}`)
+      time.end(`idealTree:${location || '#root'}`)
       this.finishTracker('idealTree', name, location)
       this.#currentDep = null
     }
@@ -807,7 +806,7 @@ This is a one-time fix-up, please be patient...
 
     this.#depsSeen.add(node)
     this.#currentDep = node
-    process.emit('time', `idealTree:${node.location || '#root'}`)
+    time.start(`idealTree:${node.location || '#root'}`)
 
     // if we're loading a _complete_ ideal tree, for a --package-lock-only
     // installation for example, we have to crack open the tarball and
@@ -1025,7 +1024,7 @@ This is a one-time fix-up, please be patient...
           for (const e of this.#problemEdges(placed)) {
             promises.push(() =>
               this.#fetchManifest(npa.resolve(e.name, e.spec, fromPath(placed, e)))
-                .catch(er => null)
+                .catch(() => null)
             )
           }
         },
@@ -1274,7 +1273,7 @@ This is a one-time fix-up, please be patient...
       })
   }
 
-  #linkFromSpec (name, spec, parent, edge) {
+  #linkFromSpec (name, spec, parent) {
     const realpath = spec.fetchSpec
     const { installLinks, legacyPeerDeps } = this
     return rpj(realpath + '/package.json').catch(() => ({})).then(pkg => {
@@ -1449,7 +1448,7 @@ This is a one-time fix-up, please be patient...
   }
 
   #fixDepFlags () {
-    process.emit('time', 'idealTree:fixDepFlags')
+    const timeEnd = time.start('idealTree:fixDepFlags')
     const metaFromDisk = this.idealTree.meta.loadedFromDisk
     const flagsSuspect = this[_flagsSuspect]
     const mutateTree = this.#mutateTree
@@ -1496,7 +1495,7 @@ This is a one-time fix-up, please be patient...
       }
     }
 
-    process.emit('timeEnd', 'idealTree:fixDepFlags')
+    timeEnd()
   }
 
   #idealTreePrune () {

package/lib/arborist/index.js

@@ -30,7 +30,7 @@ const { resolve } = require('path')
 const { homedir } = require('os')
 const { depth } = require('treeverse')
 const mapWorkspaces = require('@npmcli/map-workspaces')
-const log = require('proc-log')
+const { log, time } = require('proc-log')
 
 const { saveTypeMap } = require('../add-rm-pkg-deps.js')
 const AuditReport = require('../audit-report.js')
@@ -66,7 +66,7 @@ const lockfileVersion = lfv => {
 
 class Arborist extends Base {
   constructor (options = {}) {
-    process.emit('time', 'arborist:ctor')
+    const timeEnd = time.start('arborist:ctor')
     super(options)
     this.options = {
       nodeVersion: process.version,
@@ -74,20 +74,26 @@ class Arborist extends Base {
       Arborist: this.constructor,
       binLinks: 'binLinks' in options ? !!options.binLinks : true,
       cache: options.cache || `${homedir()}/.npm/_cacache`,
+      dryRun: !!options.dryRun,
+      formatPackageLock: 'formatPackageLock' in options ? !!options.formatPackageLock : true,
       force: !!options.force,
       global: !!options.global,
       ignoreScripts: !!options.ignoreScripts,
       installStrategy: options.global ? 'shallow' : (options.installStrategy ? options.installStrategy : 'hoisted'),
       lockfileVersion: lockfileVersion(options.lockfileVersion),
+      packageLockOnly: !!options.packageLockOnly,
       packumentCache: options.packumentCache || new Map(),
       path: options.path || '.',
       rebuildBundle: 'rebuildBundle' in options ? !!options.rebuildBundle : true,
       replaceRegistryHost: options.replaceRegistryHost,
+      savePrefix: 'savePrefix' in options ? options.savePrefix : '^',
       scriptShell: options.scriptShell,
       workspaces: options.workspaces || [],
       workspacesEnabled: options.workspacesEnabled !== false,
     }
-    // TODO is this even used? If not is that a bug?
+    // TODO we only ever look at this.options.replaceRegistryHost, not
+    // this.replaceRegistryHost.  Defaulting needs to be written back to
+    // this.options to work properly
     this.replaceRegistryHost = this.options.replaceRegistryHost =
       (!this.options.replaceRegistryHost || this.options.replaceRegistryHost === 'npmjs') ?
         'registry.npmjs.org' : this.options.replaceRegistryHost
@@ -96,8 +102,9 @@ class Arborist extends Base {
       throw new Error(`Invalid saveType ${options.saveType}`)
     }
     this.cache = resolve(this.options.cache)
+    this.diff = null
     this.path = resolve(this.options.path)
-    process.emit('timeEnd', 'arborist:ctor')
+    timeEnd()
   }
 
   // TODO: We should change these to static functions instead
@@ -223,7 +230,7 @@ class Arborist extends Base {
     // XXX: deprecate separate method options objects.
     options = { ...this.options, ...options }
 
-    process.emit('time', 'audit')
+    const timeEnd = time.start('audit')
     let tree
     if (options.packageLock === false) {
       // build ideal tree
@@ -246,10 +253,28 @@ class Arborist extends Base {
     }
     this.auditReport = await AuditReport.load(tree, options)
     const ret = options.fix ? this.reify(options) : this.auditReport
-    process.emit('timeEnd', 'audit')
+    timeEnd()
     this.finishTracker('audit')
     return ret
   }
+
+  async dedupe (options = {}) {
+    // allow the user to set options on the ctor as well.
+    // XXX: deprecate separate method options objects.
+    options = { ...this.options, ...options }
+    const tree = await this.loadVirtual().catch(() => this.loadActual())
+    const names = []
+    for (const name of tree.inventory.query('name')) {
+      if (tree.inventory.query('name', name).size > 1) {
+        names.push(name)
+      }
+    }
+    return this.reify({
+      ...options,
+      preferDedupe: true,
+      update: { names },
+    })
+  }
 }
 
 module.exports = Arborist

package/lib/arborist/isolated-reifier.js

@@ -1,7 +1,7 @@
 const _makeIdealGraph = Symbol('makeIdealGraph')
 const _createIsolatedTree = Symbol.for('createIsolatedTree')
 const _createBundledTree = Symbol('createBundledTree')
-const fs = require('fs')
+const { mkdirSync } = require('fs')
 const pacote = require('pacote')
 const { join } = require('path')
 const { depth } = require('treeverse')
@@ -108,7 +108,7 @@ module.exports = cls => class IsolatedReifier extends cls {
         '.store',
         `${node.name}@${node.version}`
       )
-      fs.mkdirSync(dir, { recursive: true })
+      mkdirSync(dir, { recursive: true })
       // TODO this approach feels wrong
       // and shouldn't be necessary for shrinkwraps
       await pacote.extract(node.resolved, dir, {
@@ -212,7 +212,7 @@ module.exports = cls => class IsolatedReifier extends cls {
     return { edges, nodes }
   }
 
-  async [_createIsolatedTree] (idealTree) {
+  async [_createIsolatedTree] () {
     await this[_makeIdealGraph](this.options)
 
     const proxiedIdealTree = this.idealGraph

package/lib/arborist/load-actual.js

@@ -336,8 +336,8 @@ module.exports = cls => class ActualLoader extends cls {
       await this.#loadFSChildren(node.target)
       return Promise.all(
         [...node.target.children.entries()]
-          .filter(([name, kid]) => !did.has(kid.realpath))
-          .map(([name, kid]) => this.#loadFSTree(kid))
+          .filter(([, kid]) => !did.has(kid.realpath))
+          .map(([, kid]) => this.#loadFSTree(kid))
       )
     }
   }

package/lib/arborist/load-virtual.js

@@ -283,7 +283,7 @@ module.exports = cls => class VirtualLoader extends cls {
     return node
   }
 
-  #loadLink (location, targetLoc, target, meta) {
+  #loadLink (location, targetLoc, target) {
     const path = resolve(this.path, location)
     const link = new Link({
       installLinks: this.installLinks,

package/lib/arborist/rebuild.js

@@ -9,11 +9,8 @@ const binLinks = require('bin-links')
 const runScript = require('@npmcli/run-script')
 const { callLimit: promiseCallLimit } = require('promise-call-limit')
 const { resolve } = require('path')
-const {
-  isNodeGypPackage,
-  defaultGypInstallScript,
-} = require('@npmcli/node-gyp')
-const log = require('proc-log')
+const { isNodeGypPackage, defaultGypInstallScript } = require('@npmcli/node-gyp')
+const { log, time } = require('proc-log')
 
 const boolEnv = b => b ? '1' : ''
 const sortNodes = (a, b) =>
@@ -54,7 +51,7 @@ module.exports = cls => class Builder extends cls {
 
     // separates links nodes so that it can run
     // prepare scripts and link bins in the expected order
-    process.emit('time', 'build')
+    const timeEnd = time.start('build')
 
     const {
       depNodes,
@@ -70,7 +67,7 @@ module.exports = cls => class Builder extends cls {
       await this.#build(linkNodes, { type: 'links' })
     }
 
-    process.emit('timeEnd', 'build')
+    timeEnd()
   }
 
   // if we don't have a set of nodes, then just rebuild
@@ -147,7 +144,7 @@ module.exports = cls => class Builder extends cls {
   }
 
   async #build (nodes, { type = 'deps' }) {
-    process.emit('time', `build:${type}`)
+    const timeEnd = time.start(`build:${type}`)
 
     await this.#buildQueues(nodes)
 
@@ -168,11 +165,11 @@ module.exports = cls => class Builder extends cls {
       await this.#runScripts('postinstall')
     }
 
-    process.emit('timeEnd', `build:${type}`)
+    timeEnd()
   }
 
   async #buildQueues (nodes) {
-    process.emit('time', 'build:queue')
+    const timeEnd = time.start('build:queue')
     const set = new Set()
 
     const promises = []
@@ -210,7 +207,7 @@ module.exports = cls => class Builder extends cls {
         }
       }
     }
-    process.emit('timeEnd', 'build:queue')
+    timeEnd()
   }
 
   async [_checkBins] (node) {
@@ -286,7 +283,7 @@ module.exports = cls => class Builder extends cls {
       return
     }
 
-    process.emit('time', `build:run:${event}`)
+    const timeEnd = time.start(`build:run:${event}`)
     const stdio = this.options.foregroundScripts ? 'inherit' : 'pipe'
     const limit = this.options.foregroundScripts ? 1 : undefined
     await promiseCallLimit(queue.map(node => async () => {
@@ -309,8 +306,7 @@ module.exports = cls => class Builder extends cls {
         return
       }
 
-      const timer = `build:run:${event}:${location}`
-      process.emit('time', timer)
+      const timeEndLocation = time.start(`build:run:${event}:${location}`)
       log.info('run', pkg._id, event, location, pkg.scripts[event])
       const env = {
         npm_package_resolved: resolved,
@@ -356,9 +352,9 @@ module.exports = cls => class Builder extends cls {
         ? this[_handleOptionalFailure](node, p)
         : p)
 
-      process.emit('timeEnd', timer)
+      timeEndLocation()
     }), { limit })
-    process.emit('timeEnd', `build:run:${event}`)
+    timeEnd()
   }
 
   async #linkAllBins () {
@@ -367,7 +363,7 @@ module.exports = cls => class Builder extends cls {
       return
     }
 
-    process.emit('time', 'build:link')
+    const timeEnd = time.start('build:link')
     const promises = []
     // sort the queue by node path, so that the module-local collision
     // detector in bin-links will always resolve the same way.
@@ -377,7 +373,7 @@ module.exports = cls => class Builder extends cls {
     }
 
     await promiseAllRejectLate(promises)
-    process.emit('timeEnd', 'build:link')
+    timeEnd()
   }
 
   async #createBinLinks (node) {
@@ -385,7 +381,7 @@ module.exports = cls => class Builder extends cls {
       return
     }
 
-    process.emit('time', `build:link:${node.location}`)
+    const timeEnd = time.start(`build:link:${node.location}`)
 
     const p = binLinks({
       pkg: node.package,
@@ -399,6 +395,6 @@ module.exports = cls => class Builder extends cls {
       ? this[_handleOptionalFailure](node, p)
       : p)
 
-    process.emit('timeEnd', `build:link:${node.location}`)
+    timeEnd()
   }
 }