fix(query): support package-lock-only in workspaces

Author: watilde

lib/commands/query.js

@@ -57,16 +57,16 @@ class Query extends BaseCommand {
   }
 
   async exec (args) {
-    const packageLock = this.npm.config.get('package-lock-only')
+    const packageLockOnly = this.npm.config.get('package-lock-only')
     const Arborist = require('@npmcli/arborist')
     const arb = new Arborist({
       ...this.npm.flatOptions,
       // one dir up from wherever node_modules lives
       path: resolve(this.npm.dir, '..'),
-      forceActual: !packageLock,
+      forceActual: !packageLockOnly,
     })
     let tree
-    if (packageLock) {
+    if (packageLockOnly) {
       try {
         tree = await arb.loadVirtual()
       } catch (err) {
@@ -84,20 +84,33 @@ class Query extends BaseCommand {
 
   async execWorkspaces (args) {
     await this.setWorkspaces()
+    const packageLockOnly = this.npm.config.get('package-lock-only')
     const Arborist = require('@npmcli/arborist')
     const arb = new Arborist({
       ...this.npm.flatOptions,
       path: this.npm.prefix,
+      forceActual: !packageLockOnly,
     })
-    // FIXME: Workspace support in query does not work as expected so this does not
-    // do the same package-lock-only check as this.exec().
-    // https://github.com/npm/cli/pull/6732#issuecomment-1708804921
-    const tree = await arb.loadActual()
+    let tree
+    if (packageLockOnly) {
+      try {
+        tree = await arb.loadVirtual()
+      } catch (err) {
+        log.verbose('loadVirtual', err.stack)
+        throw this.usageError(
+          'A package lock or shrinkwrap file is required in package-lock-only mode'
+        )
+      }
+    } else {
+      tree = await arb.loadActual()
+    }
     for (const path of this.workspacePaths) {
       const wsTree = path === tree.root.path
         ? tree // --includes-workspace-root
-        : await tree.querySelectorAll(`.workspace:path(${path})`).then(r => r[0].target)
-      await this.#queryTree(wsTree, args[0])
+        : await tree.querySelectorAll(`.workspace:path(${path})`).then(r => r[0]?.target)
+      if (wsTree) {
+        await this.#queryTree(wsTree, args[0])
+      }
     }
     this.#output()
   }

tap-snapshots/test/lib/commands/query.js.test.cjs

@@ -124,6 +124,10 @@ exports[`test/lib/commands/query.js TAP missing > should return missing node 1`]
 ]
 `
 
+exports[`test/lib/commands/query.js TAP package-lock-only missing workspace in tree > should return empty array for missing workspace 1`] = `
+[]
+`
+
 exports[`test/lib/commands/query.js TAP package-lock-only with package lock > should return valid response with only lock info 1`] = `
 [
   {
@@ -172,6 +176,48 @@ exports[`test/lib/commands/query.js TAP package-lock-only with package lock > sh
 ]
 `
 
+exports[`test/lib/commands/query.js TAP package-lock-only with package lock and workspace > should return workspace object with package-lock-only 1`] = `
+[
+  {
+    "name": "root",
+    "workspaces": [
+      "packages/*"
+    ],
+    "pkgid": "root@",
+    "location": "",
+    "path": "{CWD}/prefix",
+    "realpath": "{CWD}/prefix",
+    "resolved": null,
+    "from": [],
+    "to": [
+      "node_modules/a"
+    ],
+    "dev": false,
+    "inBundle": false,
+    "deduped": false,
+    "overridden": false,
+    "queryContext": {}
+  },
+  {
+    "name": "a",
+    "version": "1.0.0",
+    "_id": "[email protected]",
+    "pkgid": "[email protected]",
+    "location": "packages/a",
+    "path": "{CWD}/prefix/packages/a",
+    "realpath": "{CWD}/prefix/packages/a",
+    "resolved": null,
+    "from": [],
+    "to": [],
+    "dev": false,
+    "inBundle": false,
+    "deduped": false,
+    "overridden": false,
+    "queryContext": {}
+  }
+]
+`
+
 exports[`test/lib/commands/query.js TAP recursive tree > should return everything in the tree, accounting for recursion 1`] = `
 [
   {

test/lib/commands/query.js

@@ -236,6 +236,98 @@ t.test('package-lock-only', t => {
     await npm.exec('query', ['*'])
     t.matchSnapshot(joinedOutput(), 'should return valid response with only lock info')
   })
+
+  t.test('with package lock and workspace', async t => {
+    const { npm, joinedOutput } = await loadMockNpm(t, {
+      config: {
+        'package-lock-only': true,
+        workspace: ['a'],
+      },
+      prefixDir: {
+        'package.json': JSON.stringify({
+          name: 'root',
+          workspaces: ['packages/*'],
+        }),
+        'package-lock.json': JSON.stringify({
+          name: 'root',
+          lockfileVersion: 3,
+          requires: true,
+          packages: {
+            '': {
+              name: 'root',
+              workspaces: ['packages/*'],
+            },
+            'node_modules/a': {
+              resolved: 'packages/a',
+              link: true,
+            },
+            'packages/a': {
+              name: 'a',
+              version: '1.0.0',
+            },
+          },
+        }),
+        packages: {
+          a: {
+            'package.json': JSON.stringify({
+              name: 'a',
+              version: '1.0.0',
+            }),
+          },
+        },
+      },
+    })
+    await npm.exec('query', ['*'])
+    t.matchSnapshot(joinedOutput(), 'should return workspace object with package-lock-only')
+  })
+
+  t.test('no package lock and workspace', async t => {
+    const { npm } = await loadMockNpm(t, {
+      config: {
+        'package-lock-only': true,
+        workspace: ['a'],
+      },
+      prefixDir: {
+        'package.json': JSON.stringify({
+          name: 'root',
+          workspaces: ['packages/*'],
+        }),
+        packages: {
+          a: {
+            'package.json': JSON.stringify({
+              name: 'a',
+              version: '1.0.0',
+            }),
+          },
+        },
+      },
+    })
+    await t.rejects(npm.exec('query', ['*']), { code: 'EUSAGE' })
+  })
+
+  t.test('missing workspace in tree', async t => {
+    const { npm, joinedOutput } = await loadMockNpm(t, {
+      config: {
+        workspace: ['a'],
+      },
+      prefixDir: {
+        'package.json': JSON.stringify({
+          name: 'root',
+          workspaces: ['packages/*'],
+        }),
+        packages: {
+          a: {
+            'package.json': JSON.stringify({
+              name: 'a',
+              version: '1.0.0',
+            }),
+          },
+        },
+      },
+    })
+    await npm.exec('query', ['*'])
+    t.matchSnapshot(joinedOutput(), 'should return empty array for missing workspace')
+  })
   t.end()
 })