chore: update test to use a real npx inventory setup

Author: owlstronaut

workspaces/libnpmexec/test/fixtures/setup.js

@@ -6,6 +6,7 @@ const binLinks = require('bin-links')
 const MockRegistry = require('@npmcli/mock-registry')
 const justExtend = require('just-extend')
 const set = require('just-safe-set')
+const crypto = require('node:crypto')
 
 const merge = (...args) => justExtend(true, ...args)
 
@@ -118,35 +119,19 @@ const createTestdir = (...objs) => {
   return testdirHelper(merge(...objs))
 }
 
-const mockNpxInventoryCache = (packageName, fakeVersion) => {
-  const Arborist = require('@npmcli/arborist')
-  const originalLoadActual = Arborist.prototype.loadActual
-
-  Arborist.prototype.loadActual = async function () {
-    const tree = await originalLoadActual.call(this)
-    if (this.path.includes('npxCache')) {
-      const originalQuery = tree.inventory.query.bind(tree.inventory)
-      tree.inventory.query = (key, name) => {
-        if (key === 'packageName' && name === packageName) {
-          return [{
-            package: {
-              version: fakeVersion,
-              name: packageName,
-              resolved: 'dummy-resolved',
-            },
-            pkgid: `${packageName}@${fakeVersion}`,
-            depth: 0,
-          }]
-        }
-        return originalQuery(key, name)
-      }
-    }
-    return tree
-  }
-
-  return () => {
-    Arborist.prototype.loadActual = originalLoadActual
+const setupNpxInventory = async (basePath, name, version, packageSpec) => {
+  const npxCachePath = resolve(basePath, 'npxCache')
+  const hash = crypto.createHash('sha512')
+    .update(packageSpec)
+    .digest('hex')
+    .slice(0, 16)
+  const installDir = resolve(npxCachePath, hash)
+  await fs.mkdir(installDir, { recursive: true })
+  const cachedPkg = {
+    name,
+    version,
   }
+  await fs.writeFile(resolve(installDir, 'package.json'), JSON.stringify(cachedPkg, null, 2))
 }
 
 const setup = (t, {
@@ -285,4 +270,4 @@ const setup = (t, {
 module.exports.setup = setup
 module.exports.createPkg = createPkg
 module.exports.merge = merge
-module.exports.mockNpxInventoryCache = mockNpxInventoryCache
+module.exports.setupNpxInventory = setupNpxInventory

workspaces/libnpmexec/test/registry.js

@@ -1,6 +1,6 @@
 const { resolve } = require('node:path')
 const t = require('tap')
-const { setup, createPkg, merge, mockNpxInventoryCache } = require('./fixtures/setup.js')
+const { setup, createPkg, merge, setupNpxInventory } = require('./fixtures/setup.js')
 
 t.test('run from registry - no local packages', async t => {
   const { fixtures, package } = createPkg({ versions: ['2.0.0'] })
@@ -246,16 +246,11 @@ t.test('run from registry - non existant global path', async t => {
   })
 })
 
-t.test('npx tree triggers manifest fetch when local version does satisfy range', async t => {
-  // Outdated npx inventory version meets semver range
-  const restore = mockNpxInventoryCache('@npmcli/create-index', '2.0.0')
-  t.teardown(() => {
-    restore()
-  })
-
+t.test('npx tree triggers manifest fetch when local version does satisfy range using real npx cache inventory', async t => {
+  // The local installation is version 1.0.0, which does NOT satisfy the spec ^2.0.0.
   const pkgData = createPkg({
-    localVersion: '1.0.1',
-    versions: ['1.0.1', '2.0.0', '2.0.1'],
+    localVersion: '1.0.0',
+    versions: ['1.0.0', '2.0.0', '2.0.1'],
     name: '@npmcli/create-index',
   })
   const { fixtures, package: pkg } = pkgData
@@ -264,14 +259,20 @@ t.test('npx tree triggers manifest fetch when local version does satisfy range',
     testdir: { ...fixtures },
   })
 
+  // We need an npx inventory with a node that would match semver, but is disregarded because we always update the npx tree
+  await setupNpxInventory(path, '@npmcli/create-index', '2.0.0', '@npmcli/create-index@^2.0.0')
+
+  // Set up the registry package so that a manifest fetch returns version 2.0.1.
   await pkg({
     registry,
     path,
     tarballs: ['2.0.1'],
   })
   await binLinks()
 
-  // npx is true, but semver range is also satisfied, it still triggers a manifest fetch
+  // Execute in npx mode with the spec ^2.0.0.
+  // The local tree returns a manifest because its version (1.0.0) does not satisfy ^2.0.0.
+  // Then the npx tree returns a manifest because its version (2.0.0) is not the most up-to-date version (2.0.1).
   await execFn({
     args: ['create-index'],
     packages: ['@npmcli/create-index@^2.0.0'],