@npmcli/arborist 2.2.8 → 2.4.1

package/lib/link.js

@@ -23,13 +23,19 @@ class Link extends Node {
       : null),
     })
 
-    this.target = target || new Node({
-      ...options,
-      path: realpath,
-      parent: null,
-      fsParent: null,
-      root: this.root,
-    })
+    if (target)
+      this.target = target
+    else if (this.realpath === this.root.path)
+      this.target = this.root
+    else {
+      this.target = new Node({
+        ...options,
+        path: realpath,
+        parent: null,
+        fsParent: null,
+        root: this.root,
+      })
+    }
   }
 
   get version () {

package/lib/node.js

@@ -28,6 +28,7 @@
 // where we need to quickly find all instances of a given package name within a
 // tree.
 
+const semver = require('semver')
 const nameFromFolder = require('@npmcli/name-from-folder')
 const Edge = require('./edge.js')
 const Inventory = require('./inventory.js')
@@ -685,6 +686,7 @@ class Node {
       ...this.children.values(),
       ...this.inventory.values(),
     ].filter(n => n !== this))
+
     for (const child of family) {
       if (child.root !== root) {
         child[_delistFromMeta]()
@@ -704,12 +706,14 @@ class Node {
     }
 
     // if we had a target, and didn't find one in the new root, then bring
-    // it over as well.
-    if (this.isLink && target && !this.target)
+    // it over as well, but only if we're setting the link into a new root,
+    // as we don't want to lose the target any time we remove a link.
+    if (this.isLink && target && !this.target && root !== this)
       target.root = root
 
     // tree should always be valid upon root setter completion.
     treeCheck(this)
+    treeCheck(root)
   }
 
   get root () {
@@ -882,6 +886,43 @@ class Node {
     return node.canReplaceWith(this)
   }
 
+  // return true if it's safe to remove this node, because anything that
+  // is depending on it would be fine with the thing that they would resolve
+  // to if it was removed, or nothing is depending on it in the first place.
+  canDedupe (preferDedupe = false) {
+    // not allowed to mess with shrinkwraps or bundles
+    if (this.inDepBundle || this.inShrinkwrap)
+      return false
+
+    // it's a top level pkg, or a dep of one
+    if (!this.parent || !this.parent.parent)
+      return false
+
+    // no one wants it, remove it
+    if (this.edgesIn.size === 0)
+      return true
+
+    const other = this.parent.parent.resolve(this.name)
+
+    // nothing else, need this one
+    if (!other)
+      return false
+
+    // if it's the same thing, then always fine to remove
+    if (other.matches(this))
+      return true
+
+    // if the other thing can't replace this, then skip it
+    if (!other.canReplace(this))
+      return false
+
+    // if we prefer dedupe, or if the version is greater/equal, take the other
+    if (preferDedupe || semver.gte(other.version, this.version))
+      return true
+
+    return false
+  }
+
   satisfies (requested) {
     if (requested instanceof Edge)
       return this.name === requested.name && requested.satisfiedBy(this)

package/lib/printable.js

@@ -2,6 +2,7 @@
 // of the current node and its descendents
 
 const util = require('util')
+const relpath = require('./relpath.js')
 
 class ArboristNode {
   constructor (tree, path) {
@@ -28,6 +29,15 @@ class ArboristNode {
       this.peer = true
     if (tree.inBundle)
       this.bundled = true
+    if (tree.inDepBundle)
+      this.bundler = tree.getBundler().location
+    const bd = tree.package && tree.package.bundleDependencies
+    if (bd && bd.length)
+      this.bundleDependencies = bd
+    if (tree.inShrinkwrap)
+      this.inShrinkwrap = true
+    else if (tree.hasShrinkwrap)
+      this.hasShrinkwrap = true
     if (tree.error)
       this.error = treeError(tree.error)
     if (tree.errors && tree.errors.length)
@@ -47,6 +57,11 @@ class ArboristNode {
         .map(edge => new EdgeIn(edge)))
     }
 
+    if (tree.workspaces && tree.workspaces.size) {
+      this.workspaces = new Map([...tree.workspaces.entries()]
+        .map(([name, path]) => [name, relpath(tree.root.realpath, path)]))
+    }
+
     // fsChildren sorted by path
     if (tree.fsChildren.size) {
       this.fsChildren = new Set([...tree.fsChildren]
@@ -126,6 +141,9 @@ class EdgeIn extends Edge {
 }
 
 const printableTree = (tree, path = []) => {
+  if (!tree)
+    return tree
+
   const Cls = tree.isLink ? ArboristLink
     : tree.sourceReference ? ArboristVirtualNode
     : ArboristNode

package/lib/tree-check.js

@@ -1,6 +1,8 @@
 const debug = require('./debug.js')
 
 const checkTree = (tree, checkUnreachable = true) => {
+  const log = [['START TREE CHECK', tree.path]]
+
   // this can only happen in tests where we have a "tree" object
   // that isn't actually a tree.
   if (!tree.root || !tree.root.inventory)
@@ -9,8 +11,21 @@ const checkTree = (tree, checkUnreachable = true) => {
   const { inventory } = tree.root
   const seen = new Set()
   const check = (node, via = tree, viaType = 'self') => {
+    log.push([
+      'CHECK',
+      node && node.location,
+      via && via.location,
+      viaType,
+      'seen=' + seen.has(node),
+      'promise=' + !!(node && node.then),
+      'root=' + !!(node && node.isRoot),
+    ])
+
     if (!node || seen.has(node) || node.then)
       return
+
+    seen.add(node)
+
     if (node.isRoot && node !== tree.root) {
       throw Object.assign(new Error('double root'), {
         node: node.path,
@@ -19,6 +34,7 @@ const checkTree = (tree, checkUnreachable = true) => {
         root: tree.root.path,
         via: via.path,
         viaType,
+        log,
       })
     }
 
@@ -31,6 +47,7 @@ const checkTree = (tree, checkUnreachable = true) => {
         via: via.path,
         viaType,
         otherRoot: node.root && node.root.path,
+        log,
       })
     }
 
@@ -43,6 +60,7 @@ const checkTree = (tree, checkUnreachable = true) => {
         viaType,
         inventory: [...node.inventory.values()].map(node =>
           [node.path, node.location]),
+        log,
       })
     }
 
@@ -53,6 +71,7 @@ const checkTree = (tree, checkUnreachable = true) => {
         root: tree.root.path,
         via: via.path,
         viaType,
+        log,
       })
     }
 
@@ -65,14 +84,38 @@ const checkTree = (tree, checkUnreachable = true) => {
         via: via.path,
         viaType,
         devEdges: devEdges.map(e => [e.type, e.name, e.spec, e.error]),
+        log,
+      })
+    }
+
+    if (node.path === tree.root.path && node !== tree.root) {
+      throw Object.assign(new Error('node with same path as root'), {
+        node: node.path,
+        tree: tree.path,
+        root: tree.root.path,
+        via: via.path,
+        viaType,
+        log,
+      })
+    }
+
+    if (!node.isLink && node.path !== node.realpath) {
+      throw Object.assign(new Error('non-link with mismatched path/realpath'), {
+        node: node.path,
+        tree: tree.path,
+        realpath: node.realpath,
+        root: tree.root.path,
+        via: via.path,
+        viaType,
+        log,
       })
     }
 
     const { parent, fsParent, target } = node
-    seen.add(node)
     check(parent, node, 'parent')
     check(fsParent, node, 'fsParent')
     check(target, node, 'target')
+    log.push(['CHILDREN', node.location, ...node.children.keys()])
     for (const kid of node.children.values())
       check(kid, node, 'children')
     for (const kid of node.fsChildren)
@@ -81,6 +124,7 @@ const checkTree = (tree, checkUnreachable = true) => {
       check(link, node, 'linksIn')
     for (const top of node.tops)
       check(top, node, 'tops')
+    log.push(['DONE', node.location])
   }
   check(tree)
   if (checkUnreachable) {
@@ -92,6 +136,7 @@ const checkTree = (tree, checkUnreachable = true) => {
           location: node.location,
           root: tree.root.path,
           tree: tree.path,
+          log,
         })
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/arborist",
-  "version": "2.2.8",
+  "version": "2.4.1",
   "description": "Manage node_modules trees",
   "dependencies": {
     "@npmcli/installed-package-contents": "^1.0.7",
@@ -14,19 +14,19 @@
     "cacache": "^15.0.3",
     "common-ancestor-path": "^1.0.1",
     "json-parse-even-better-errors": "^2.3.1",
-    "json-stringify-nice": "^1.1.1",
+    "json-stringify-nice": "^1.1.2",
     "mkdirp-infer-owner": "^2.0.0",
     "npm-install-checks": "^4.0.0",
     "npm-package-arg": "^8.1.0",
     "npm-pick-manifest": "^6.1.0",
-    "npm-registry-fetch": "^9.0.0",
+    "npm-registry-fetch": "^10.0.0",
     "pacote": "^11.2.6",
     "parse-conflict-json": "^1.1.1",
     "promise-all-reject-late": "^1.0.0",
     "promise-call-limit": "^1.0.1",
     "read-package-json-fast": "^2.0.2",
     "readdir-scoped-modules": "^1.1.0",
-    "semver": "^7.3.4",
+    "semver": "^7.3.5",
     "tar": "^6.1.0",
     "treeverse": "^1.0.4",
     "walk-up-path": "^1.0.0"
@@ -41,8 +41,7 @@
     "eslint-plugin-standard": "^4.0.1",
     "minify-registry-metadata": "^2.1.0",
     "mutate-fs": "^2.1.1",
-    "require-inject": "^1.4.4",
-    "tap": "^14.11.0",
+    "tap": "^15.0.4",
     "tcompare": "^3.0.4"
   },
   "scripts": {
@@ -76,10 +75,8 @@
     "arborist": "bin/index.js"
   },
   "tap": {
-    "100": true,
     "after": "test/fixtures/cleanup.js",
     "coverage-map": "map.js",
-    "esm": false,
     "test-env": [
       "NODE_OPTIONS=--no-warnings"
     ],
@@ -87,6 +84,6 @@
       "--no-warnings",
       "--no-deprecation"
     ],
-    "timeout": "120"
+    "timeout": "240"
   }
 }