chore(arborist): Adds test for shrinkwrap ideallyInert nodes

owlstronaut · zkat · commit f36fd55489f2 · 2025-03-26T16:19:06.000-07:00
diff --git a/workspaces/arborist/lib/shrinkwrap.js b/workspaces/arborist/lib/shrinkwrap.js
@@ -144,7 +144,7 @@ const assertNoNewer = async (path, data, lockTime, dir, seen) => {
   let entries
   if (dir === path) {
     entries = [{ name: 'node_modules', isDirectory: () => true }]
-  } else if (!inert) {
+  } else {
     const { mtime: dirTime } = await stat(dir)
     if (dirTime > lockTime) {
       throw new Error(`out of date, updated: ${rel}`)
diff --git a/workspaces/arborist/tap-snapshots/test/shrinkwrap.js.test.cjs b/workspaces/arborist/tap-snapshots/test/shrinkwrap.js.test.cjs
@@ -654,6 +654,29 @@ Object {
 }
 `
 
+exports[`test/shrinkwrap.js TAP load a hidden lockfile with ideallyInert > must match snapshot 1`] = `
+Object {
+  "dependencies": Object {},
+  "lockfileVersion": 3,
+  "name": "hidden-lockfile",
+  "packages": Object {
+    "": Object {
+      "dependencies": Object {
+        "abbrev": "^1.1.1",
+      },
+    },
+    "node_modules/abbrev": Object {
+      "ideallyInert": true,
+      "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==",
+      "name": "abbrev",
+      "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz",
+      "version": "1.1.1",
+    },
+  },
+  "requires": true,
+}
+`
+
 exports[`test/shrinkwrap.js TAP load a legacy shrinkwrap without a package.json > did our best with what we had 1`] = `
 Object {
   "dependencies": Object {
@@ -2644,82 +2667,80 @@ Object {
 }
 `
 
-<<<<<<< Conflict 1 of 1
-%%%%%%% Changes from base to side #1
- exports[`test/shrinkwrap.js TAP loadActual tests selflink > shrinkwrap data 1`] = `
- Object {
-   "lockfileVersion": 3,
-   "name": "selflink",
-   "packages": Object {
-     "": Object {
-       "dependencies": Object {
-         "@scope/x": "",
-         "@scope/y": "",
-         "foo": "",
-       },
-       "name": "selflink",
-       "version": "1.2.3",
-     },
-     "node_modules/@scope/y": Object {
-       "dependencies": Object {
-         "foo": "*",
-       },
-       "version": "1.2.3",
-     },
-     "node_modules/@scope/z": Object {
-       "dependencies": Object {
-         "glob": "4",
-       },
-       "extraneous": true,
-       "version": "1.2.3",
-     },
-     "node_modules/@scope/z/node_modules/glob": Object {
-       "link": true,
-       "resolved": "node_modules/foo/node_modules/glob",
-     },
-     "node_modules/foo": Object {
-       "dependencies": Object {
-         "glob": "4",
-         "selflink": "*",
-       },
-       "version": "1.2.3",
-     },
-     "node_modules/foo/node_modules/glob": Object {
-       "version": "4.0.5",
-     },
-     "node_modules/foo/node_modules/glob/node_modules/graceful-fs": Object {
-       "extraneous": true,
-       "version": "3.0.2",
-     },
-     "node_modules/foo/node_modules/glob/node_modules/inherits": Object {
-       "extraneous": true,
-       "version": "2.0.1",
-     },
-     "node_modules/foo/node_modules/glob/node_modules/minimatch": Object {
-       "extraneous": true,
-       "version": "1.0.0",
-     },
-     "node_modules/foo/node_modules/glob/node_modules/minimatch/node_modules/lru-cache": Object {
-       "extraneous": true,
-       "version": "2.5.0",
-     },
-     "node_modules/foo/node_modules/glob/node_modules/minimatch/node_modules/sigmund": Object {
-       "extraneous": true,
-       "version": "1.0.0",
-     },
-     "node_modules/foo/node_modules/glob/node_modules/once": Object {
-       "extraneous": true,
-       "version": "1.3.0",
-     },
-     "node_modules/foo/node_modules/selflink": Object {
-       "link": true,
-       "resolved": "",
-     },
-   },
-   "requires": true,
-   "version": "1.2.3",
- }
- `
+exports[`test/shrinkwrap.js TAP loadActual tests selflink > shrinkwrap data 1`] = `
+Object {
+  "lockfileVersion": 3,
+  "name": "selflink",
+  "packages": Object {
+    "": Object {
+      "dependencies": Object {
+        "@scope/x": "",
+        "@scope/y": "",
+        "foo": "",
+      },
+      "name": "selflink",
+      "version": "1.2.3",
+    },
+    "node_modules/@scope/y": Object {
+      "dependencies": Object {
+        "foo": "*",
+      },
+      "version": "1.2.3",
+    },
+    "node_modules/@scope/z": Object {
+      "dependencies": Object {
+        "glob": "4",
+      },
+      "extraneous": true,
+      "version": "1.2.3",
+    },
+    "node_modules/@scope/z/node_modules/glob": Object {
+      "link": true,
+      "resolved": "node_modules/foo/node_modules/glob",
+    },
+    "node_modules/foo": Object {
+      "dependencies": Object {
+        "glob": "4",
+        "selflink": "*",
+      },
+      "version": "1.2.3",
+    },
+    "node_modules/foo/node_modules/glob": Object {
+      "version": "4.0.5",
+    },
+    "node_modules/foo/node_modules/glob/node_modules/graceful-fs": Object {
+      "extraneous": true,
+      "version": "3.0.2",
+    },
+    "node_modules/foo/node_modules/glob/node_modules/inherits": Object {
+      "extraneous": true,
+      "version": "2.0.1",
+    },
+    "node_modules/foo/node_modules/glob/node_modules/minimatch": Object {
+      "extraneous": true,
+      "version": "1.0.0",
+    },
+    "node_modules/foo/node_modules/glob/node_modules/minimatch/node_modules/lru-cache": Object {
+      "extraneous": true,
+      "version": "2.5.0",
+    },
+    "node_modules/foo/node_modules/glob/node_modules/minimatch/node_modules/sigmund": Object {
+      "extraneous": true,
+      "version": "1.0.0",
+    },
+    "node_modules/foo/node_modules/glob/node_modules/once": Object {
+      "extraneous": true,
+      "version": "1.3.0",
+    },
+    "node_modules/foo/node_modules/selflink": Object {
+      "link": true,
+      "resolved": "",
+    },
+  },
+  "requires": true,
+  "version": "1.2.3",
+}
+`
 
 exports[`test/shrinkwrap.js TAP loadActual tests selflink > shrinkwrap data 2`] = `
 Object {
diff --git a/workspaces/arborist/test/arborist/reify.js b/workspaces/arborist/test/arborist/reify.js
@@ -2592,7 +2592,10 @@ t.test('adding an unresolvable optional dep is OK', async t => {
   })
   createRegistry(t, true)
   const tree = await reify(path, { add: ['abbrev'] })
-  t.strictSame([...tree.children.values()], [], 'nothing actually added')
+  const children = [...tree.children.values()]
+  t.equal(children.length, 1, 'optional unresolved dep node added')
+  t.ok(children[0].ideallyInert, 'node is ideally inert')
+  t.throws(() => fs.statSync(path + '/node_modules/abbrev'), { code: 'ENOENT' }, 'optional dependency should not exist on disk')
   t.matchSnapshot(printTree(tree))
 })
 
diff --git a/workspaces/arborist/test/fixtures/hidden-lockfile-inert/node_modules/.package-lock.json b/workspaces/arborist/test/fixtures/hidden-lockfile-inert/node_modules/.package-lock.json
diff --git a/workspaces/arborist/test/fixtures/hidden-lockfile-inert/node_modules/abbrev/package.json b/workspaces/arborist/test/fixtures/hidden-lockfile-inert/node_modules/abbrev/package.json
diff --git a/workspaces/arborist/test/fixtures/hidden-lockfile-inert/package.json b/workspaces/arborist/test/fixtures/hidden-lockfile-inert/package.json
@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "abbrev": "^1.1.1"
+  }
+}
diff --git a/workspaces/arborist/test/shrinkwrap.js b/workspaces/arborist/test/shrinkwrap.js
@@ -19,6 +19,7 @@ const emptyFixture = resolve(__dirname, 'fixtures/empty')
 const depTypesFixture = resolve(__dirname, 'fixtures/dev-deps')
 const badJsonFixture = resolve(__dirname, 'fixtures/testing-peer-deps-bad-sw')
 const hiddenLockfileFixture = resolve(__dirname, 'fixtures/hidden-lockfile')
+const hiddenIdeallyInertLockfileFixture = resolve(__dirname, 'fixtures/hidden-lockfile-inert')
 const hidden = 'node_modules/.package-lock.json'
 const saxFixture = resolve(__dirname, 'fixtures/sax')
 
@@ -864,6 +865,15 @@ t.test('load a hidden lockfile', async t => {
   t.equal(data.dependencies, undefined, 'deleted legacy metadata')
 })
 
+t.test('load a hidden lockfile with ideallyInert', async t => {
+  fs.utimesSync(resolve(hiddenIdeallyInertLockfileFixture, hidden), new Date(), new Date())
+  const s = await Shrinkwrap.load({
+    path: hiddenIdeallyInertLockfileFixture,
+    hiddenLockfile: true,
+  })
+  t.matchSnapshot(s.data)
+})
+
 t.test('load a fresh hidden lockfile', async t => {
   const sw = await Shrinkwrap.reset({
     path: hiddenLockfileFixture,
