fix #1534 - Error with relative dependency path and --peer and yarn v4 (#1537)

Author: rbnayax

.github/workflows/test.yml

@@ -26,7 +26,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [18, 20]
+        node: [18, 20, 22]
         os: [ubuntu-latest, windows-latest]
 
     steps:
@@ -39,6 +39,9 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: npm
 
+      - name: Enable corepack
+        run: corepack enable
+
       - name: Install npm dependencies
         run: npm ci
 

package.json

@@ -33,6 +33,7 @@
     "prepare": "src/scripts/install-hooks",
     "prepublishOnly": "npm run build",
     "prettier": "prettier . --check",
+    "prettier:fix": "prettier . --write",
     "test": "npm run test:unit && npm run test:e2e",
     "test:bun": "test/bun-install.sh && mocha test/bun",
     "test:unit": "mocha test test/package-managers/*",

src/lib/getPeerDependenciesFromRegistry.ts

@@ -60,7 +60,7 @@ async function getPeerDependenciesFromRegistry(packageMap: Index<Version>, optio
   }
 
   return Object.entries(packageMap).reduce(async (accumPromise, [pkg, version]) => {
-    const dep = await packageManager.getPeerDependencies!(pkg, version)
+    const dep = await packageManager.getPeerDependencies!(pkg, version, { cwd: options.cwd })
     if (bar) {
       bar.tick()
     }

src/package-managers/npm.ts

@@ -22,6 +22,7 @@ import { NpmConfig } from '../types/NpmConfig'
 import { NpmOptions } from '../types/NpmOptions'
 import { Options } from '../types/Options'
 import { Packument } from '../types/Packument'
+import { SpawnOptions } from '../types/SpawnOptions'
 import { SpawnPleaseOptions } from '../types/SpawnPleaseOptions'
 import { Version } from '../types/Version'
 import { VersionResult } from '../types/VersionResult'
@@ -678,11 +679,16 @@ export const greatest: GetVersion = async (
  *
  * @param packageName
  * @param version
+ * @param spawnOptions
  * @returns Promised {packageName: version} collection
  */
-export const getPeerDependencies = async (packageName: string, version: Version): Promise<Index<Version>> => {
+export const getPeerDependencies = async (
+  packageName: string,
+  version: Version,
+  spawnOptions: SpawnOptions,
+): Promise<Index<Version>> => {
   const args = ['view', `${packageName}@${version}`, 'peerDependencies']
-  const result = await spawnNpm(args, {}, { rejectOnError: false })
+  const result = await spawnNpm(args, {}, { rejectOnError: false }, spawnOptions)
   return result ? parseJson(result, { command: [...args, '--json'].join(' ') }) : {}
 }
 

src/package-managers/yarn.ts

@@ -181,6 +181,30 @@ function parseJsonLines(result: string): Promise<{ dependencies: Index<ParsedDep
   })
 }
 
+/**
+ * Extract first json line from muli line yarn output
+ *
+ * @param result    Output from yarn command to be parsed
+ */
+function extractFirstJsonLine(result: string): Promise<string> {
+  return new Promise((resolve, reject) => {
+    const parser = jsonlines.parse()
+    let firstFound = false
+
+    parser.on('data', value => {
+      if (!firstFound) {
+        firstFound = true
+        resolve(JSON.stringify(value))
+      }
+    })
+    parser.on('error', reject)
+
+    parser.write(result)
+
+    parser.end()
+  })
+}
+
 const cmd = process.platform === 'win32' ? 'yarn.cmd' : 'yarn'
 
 /**
@@ -297,20 +321,49 @@ export const semver = withNpmConfigFromYarn(npm.semver)
  *
  * @param packageName
  * @param version
+ * @param spawnOptions
  * @returns Promised {packageName: version} collection
  */
-export const getPeerDependencies = async (packageName: string, version: Version): Promise<Index<Version>> => {
-  const { stdout: yarnVersion } = await spawn(cmd, ['--version'], { rejectOnError: false }, {})
+export const getPeerDependencies = async (
+  packageName: string,
+  version: Version,
+  spawnOptions: SpawnOptions,
+): Promise<Index<Version>> => {
+  const { stdout: yarnVersion } = await spawn(cmd, ['--version'], { rejectOnError: false }, spawnOptions)
   if (yarnVersion.startsWith('1')) {
     const args = ['--json', 'info', `${packageName}@${version}`, 'peerDependencies']
-    const { stdout } = await spawn(cmd, args, { rejectOnError: false }, {})
+    const { stdout } = await spawn(cmd, args, { rejectOnError: false }, spawnOptions)
     return stdout ? npm.parseJson<{ data?: Index<Version> }>(stdout, { command: args.join(' ') }).data || {} : {}
   } else {
     const args = ['--json', 'npm', 'info', `${packageName}@${version}`, '--fields', 'peerDependencies']
-    const { stdout } = await spawn(cmd, args, { rejectOnError: false }, {})
-    return stdout
-      ? npm.parseJson<{ peerDependencies?: Index<Version> }>(stdout, { command: args.join(' ') }).peerDependencies || {}
-      : {}
+    const { stdout } = await spawn(cmd, args, { rejectOnError: false }, spawnOptions)
+    if (!stdout) {
+      return {}
+    }
+    try {
+      return (
+        npm.parseJson<{ peerDependencies?: Index<Version> }>(stdout, { command: args.join(' ') }).peerDependencies || {}
+      )
+    } catch (parseError) {
+      /*
+      If package does not exist, yarn returns multiple json errors. As such, we want to extract just the first one, instead of crashing.
+      Example response:
+      {"type":"error","name":35,"displayName":"YN0035","indent":"","data":"Package not found"}
+{"type":"error","name":35,"displayName":"YN0035","indent":"","data":"  \u001b[96mResponse Code\u001b[39m: \u001b]8;;https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404\u0007\u001b[93m404\u001b[39m (Not Found)\u001b]8;;\u0007"}
+{"type":"error","name":35,"displayName":"YN0035","indent":"","data":"  \u001b[96mRequest Method\u001b[39m: GET"}
+{"type":"error","name":35,"displayName":"YN0035","indent":"","data":"  \u001b[96mRequest URL\u001b[39m: \u001b[95mhttps://registry.yarnpkg.com/fffffffffffff\u001b[39m"}
+       */
+      try {
+        const firstObj = await extractFirstJsonLine(stdout)
+        if (firstObj) {
+          return (
+            npm.parseJson<{ peerDependencies?: Index<Version> }>(firstObj, { command: args.join(' ') })
+              .peerDependencies || {}
+          )
+        }
+      } catch {}
+      throw parseError
+    }
   }
 }
 

src/types/PackageManager.ts

@@ -2,6 +2,7 @@ import { GetVersion } from './GetVersion'
 import { Index } from './IndexType'
 import { NpmConfig } from './NpmConfig'
 import { Options } from './Options'
+import { SpawnOptions } from './SpawnOptions'
 import { Version } from './Version'
 import { VersionSpec } from './VersionSpec'
 
@@ -21,7 +22,7 @@ export interface PackageManager {
     to: VersionSpec,
     options?: Options,
   ) => Promise<boolean>
-  getPeerDependencies?: (packageName: string, version: Version) => Promise<Index<Version>>
+  getPeerDependencies?: (packageName: string, version: Version, spawnOptions: SpawnOptions) => Promise<Index<Version>>
   getEngines?: (
     packageName: string,
     version: Version,

test/package-managers/npm/index.test.ts

@@ -26,8 +26,9 @@ describe('npm', function () {
   })
 
   it('getPeerDependencies', async () => {
-    await npm.getPeerDependencies('ncu-test-return-version', '1.0.0').should.eventually.deep.equal({})
-    await npm.getPeerDependencies('ncu-test-peer', '1.0.0').should.eventually.deep.equal({
+    const spawnOptions = { cwd: __dirname }
+    await npm.getPeerDependencies('ncu-test-return-version', '1.0.0', spawnOptions).should.eventually.deep.equal({})
+    await npm.getPeerDependencies('ncu-test-peer', '1.0.0', spawnOptions).should.eventually.deep.equal({
       'ncu-test-return-version': '1.x',
     })
   })

test/package-managers/yarn/default/package.json

@@ -1,5 +1,6 @@
 {
   "license": "MIT",
+  "packageManager": "yarn@1.22.22",
   "dependencies": {
     "chalk": "^3.0.0"
   }

test/package-managers/yarn/index.test.ts

@@ -16,6 +16,15 @@ const localYarnSpawnOptions = {
   },
 }
 
+const filteredPath = (process.env.PATH || '')
+  .split(path.delimiter)
+  .filter(p => !p.includes(path.join('node_modules', '.bin'))) // Avoid running yarn form the node module bin
+  .join(path.delimiter)
+const cleanEnv = {
+  ...process.env,
+  PATH: filteredPath,
+}
+
 describe('yarn', function () {
   it('list', async () => {
     const testDir = path.join(__dirname, 'default')
@@ -46,11 +55,24 @@ describe('yarn', function () {
     await yarn.list({ cwd: testDir }, localYarnSpawnOptions).should.eventually.be.rejectedWith(lockFileErrorMessage)
   })
 
-  it('getPeerDependencies', async () => {
-    await yarn.getPeerDependencies('ncu-test-return-version', '1.0.0').should.eventually.deep.equal({})
-    await yarn.getPeerDependencies('ncu-test-peer', '1.0.0').should.eventually.deep.equal({
+  it('getPeerDependencies v1', async () => {
+    const testDir = path.join(__dirname, 'default')
+    const spawnOptions = { cwd: testDir, env: cleanEnv }
+    await yarn.getPeerDependencies('ncu-test-return-version', '1.0.0', spawnOptions).should.eventually.deep.equal({})
+    await yarn.getPeerDependencies('ncu-test-peer', '1.0.0', spawnOptions).should.eventually.deep.equal({
+      'ncu-test-return-version': '1.x',
+    })
+    await yarn.getPeerDependencies('fffffffffffff', '1.0.0', spawnOptions).should.eventually.deep.equal({})
+  })
+
+  it('getPeerDependencies v4', async () => {
+    const testDir = path.join(__dirname, 'v4')
+    const spawnOptions = { cwd: testDir, env: cleanEnv }
+    await yarn.getPeerDependencies('ncu-test-return-version', '1.0.0', spawnOptions).should.eventually.deep.equal({})
+    await yarn.getPeerDependencies('ncu-test-peer', '1.0.0', spawnOptions).should.eventually.deep.equal({
       'ncu-test-return-version': '1.x',
     })
+    await yarn.getPeerDependencies('fffffffffffff', '1.0.0', spawnOptions).should.eventually.deep.equal({})
   })
 
   describe('npmAuthTokenKeyValue', () => {

test/package-managers/yarn/v4/package.json

@@ -0,0 +1,7 @@
+{
+  "license": "MIT",
+  "packageManager": "yarn@4.9.2",
+  "dependencies": {
+    "chalk": "^3.0.0"
+  }
+}