pnpm/reviewing/plugin-commands-listing/test/why.ts

import path from 'path'
import fs from 'fs'
import { type PnpmError } from '@pnpm/error'
import { why } from '@pnpm/plugin-commands-listing'
import { prepare } from '@pnpm/prepare'
import { REGISTRY_MOCK_PORT } from '@pnpm/registry-mock'
import execa from 'execa'
import { stripVTControlCharacters as stripAnsi } from 'util'

const pnpmBin = path.join(import.meta.dirname, '../../../pnpm/bin/pnpm.mjs')

test('`pnpm why` should fail if no package name was provided', async () => {
  prepare()

  let err!: PnpmError
  try {
    await why.handler({
      dir: process.cwd(),
      virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
    }, [])
  } catch (_err: any) { // eslint-disable-line
    err = _err
  }

  expect(err.code).toBe('ERR_PNPM_MISSING_PACKAGE_NAME')
  expect(err.message).toMatch(/`pnpm why` requires the package name/)
})

test('"why" should show reverse dependency tree for a non-direct dependency', async () => {
  prepare({
    dependencies: {
      '@pnpm.e2e/dep-of-pkg-with-1-dep': '100.0.0',
      '@pnpm.e2e/pkg-with-1-dep': '100.0.0',
    },
  })

  await execa('node', [pnpmBin, 'install', '--registry', `http://localhost:${REGISTRY_MOCK_PORT}`])

  const output = await why.handler({
    dev: false,
    dir: process.cwd(),
    optional: false,
    virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
  }, ['@pnpm.e2e/dep-of-pkg-with-1-dep'])

  const lines = stripAnsi(output).split('\n')
  // Root is the searched package
  expect(lines[0]).toBe('@pnpm.e2e/dep-of-pkg-with-1-dep@100.0.0')
  // It should show project@0.0.0 as a direct dependent
  expect(lines.some(l => l.includes('project@0.0.0'))).toBe(true)
  // It should show @pnpm.e2e/pkg-with-1-dep as a dependent (transitive path)
  expect(lines.some(l => l.includes('@pnpm.e2e/pkg-with-1-dep@100.0.0'))).toBe(true)
})

test('"why" should find packages by alias name when using npm: protocol', async () => {
  prepare({
    dependencies: {
      foo: 'npm:@pnpm.e2e/pkg-with-1-dep@100.0.0',
    },
  })

  await execa('node', [pnpmBin, 'install', '--registry', `http://localhost:${REGISTRY_MOCK_PORT}`])

  const output = await why.handler({
    dev: false,
    dir: process.cwd(),
    optional: false,
    virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
  }, ['foo'])

  const lines = stripAnsi(output).split('\n')
  // Root should show the canonical package name
  expect(lines[0]).toBe('@pnpm.e2e/pkg-with-1-dep@100.0.0')
  expect(lines.some(l => l.includes('project@0.0.0'))).toBe(true)
})

test('"why" should find packages by actual package name when using npm: protocol', async () => {
  prepare({
    dependencies: {
      foo: 'npm:@pnpm.e2e/pkg-with-1-dep@100.0.0',
    },
  })

  await execa('node', [pnpmBin, 'install', '--registry', `http://localhost:${REGISTRY_MOCK_PORT}`])

  const output = await why.handler({
    dev: false,
    dir: process.cwd(),
    optional: false,
    virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
  }, ['@pnpm.e2e/pkg-with-1-dep'])

  const lines = stripAnsi(output).split('\n')
  expect(lines[0]).toBe('@pnpm.e2e/pkg-with-1-dep@100.0.0')
  expect(lines.some(l => l.includes('project@0.0.0'))).toBe(true)
})

test('"why" should display parseable output', async () => {
  prepare({
    dependencies: {
      '@pnpm.e2e/dep-of-pkg-with-1-dep': '100.0.0',
      '@pnpm.e2e/pkg-with-1-dep': '100.0.0',
    },
  })

  await execa('node', [pnpmBin, 'install', '--registry', `http://localhost:${REGISTRY_MOCK_PORT}`])

  const output = await why.handler({
    dev: false,
    dir: process.cwd(),
    optional: false,
    parseable: true,
    virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
  }, ['@pnpm.e2e/dep-of-pkg-with-1-dep'])

  const lines = output.split('\n')
  // Parseable output should have paths from importer to target
  expect(lines.some(line => line.includes('project@0.0.0'))).toBe(true)
  expect(lines.some(line => line.includes('@pnpm.e2e/dep-of-pkg-with-1-dep@100.0.0'))).toBe(true)
})

test('"why" should display finder message in tree output', async () => {
  prepare({
    dependencies: {
      '@pnpm.e2e/pkg-with-1-dep': '100.0.0',
    },
  })

  await execa('node', [pnpmBin, 'install', '--registry', `http://localhost:${REGISTRY_MOCK_PORT}`])

  const output = await why.handler({
    dir: process.cwd(),
    virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
    findBy: ['test-finder'],
    finders: {
      'test-finder': (ctx) => {
        if (ctx.name === '@pnpm.e2e/pkg-with-1-dep') {
          return 'Found: has 1 dep'
        }
        return false
      },
    },
  }, [])

  const lines = stripAnsi(output).split('\n')
  expect(lines[0]).toBe('@pnpm.e2e/pkg-with-1-dep@100.0.0')
  expect(lines[1]).toBe('│ Found: has 1 dep')
})

test('"why" should display finder message in JSON output', async () => {
  prepare({
    dependencies: {
      '@pnpm.e2e/pkg-with-1-dep': '100.0.0',
    },
  })

  await execa('node', [pnpmBin, 'install', '--registry', `http://localhost:${REGISTRY_MOCK_PORT}`])

  const output = await why.handler({
    dir: process.cwd(),
    json: true,
    virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
    findBy: ['test-finder'],
    finders: {
      'test-finder': (ctx) => {
        if (ctx.name === '@pnpm.e2e/pkg-with-1-dep') {
          return 'custom message'
        }
        return false
      },
    },
  }, [])

  const parsed = JSON.parse(output)
  const match = parsed.find((r: any) => r.name === '@pnpm.e2e/pkg-with-1-dep') // eslint-disable-line
  expect(match).toBeDefined()
  expect(match.searchMessage).toBe('custom message')
})

test('"why" finder can read manifest from store', async () => {
  prepare({
    dependencies: {
      '@pnpm.e2e/pkg-with-1-dep': '100.0.0',
    },
  })

  await execa('node', [pnpmBin, 'install', '--registry', `http://localhost:${REGISTRY_MOCK_PORT}`])

  const output = await why.handler({
    dir: process.cwd(),
    json: true,
    virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
    findBy: ['manifest-reader'],
    finders: {
      'manifest-reader': (ctx) => {
        const manifest = ctx.readManifest()
        // The manifest should contain the actual package name
        if (manifest.name === '@pnpm.e2e/pkg-with-1-dep') {
          return `description: ${manifest.description ?? 'none'}`
        }
        return false
      },
    },
  }, [])

  const parsed = JSON.parse(output)
  const match = parsed.find((r: any) => r.name === '@pnpm.e2e/pkg-with-1-dep') // eslint-disable-line
  expect(match).toBeDefined()
  // The finder should have been able to read the manifest and produce a message
  expect(match.searchMessage).toMatch(/^description: /)
})

test('"why" should find file: protocol local packages', async () => {
  prepare({
    dependencies: {
      'my-alias': 'file:./local-pkg',
    },
  })

  // Create a local package after prepare() changes directory
  const localPkgDir = path.join(process.cwd(), 'local-pkg')
  fs.mkdirSync(localPkgDir, { recursive: true })
  fs.writeFileSync(
    path.join(localPkgDir, 'package.json'),
    JSON.stringify({ name: 'my-local-pkg', version: '1.0.0' })
  )

  await execa('node', [pnpmBin, 'install'])

  const output = await why.handler({
    dev: false,
    dir: process.cwd(),
    optional: false,
    virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
  }, ['my-local-pkg'])

  const lines = stripAnsi(output).split('\n')
  // Should find the local package and show reverse tree
  expect(lines[0]).toContain('my-local-pkg')
  expect(lines.some(l => l.includes('project@0.0.0'))).toBe(true)
})