pnpm/pnpm11/exec/commands/test/exec.logs.ts

import fs from 'node:fs'
import path from 'node:path'

import { afterEach, expect, jest, test } from '@jest/globals'
import { preparePackages } from '@pnpm/prepare'
import { writeYamlFile } from 'write-yaml-file'

import { DEFAULT_OPTS } from './utils/index.js'

const debug = jest.fn()
jest.unstable_mockModule('@pnpm/logger', () => {
  return {
    logger: () => ({ debug }),
    globalInfo: jest.fn(),
    globalWarn: jest.fn(),
    streamParser: jest.fn(),
  }
})

const { filterProjectsBySelectorObjectsFromDir } = await import('@pnpm/workspace.projects-filter')
const { exec } = await import('@pnpm/exec.commands')

afterEach(() => {
  jest.mocked(debug).mockClear()
})

test('pnpm exec --recursive --no-reporter-hide-prefix prints prefixes', async () => {
  preparePackages([
    {
      location: 'packages/foo',
      package: { name: 'foo' },
    },
    {
      location: 'packages/bar',
      package: { name: 'bar' },
    },
  ])

  await writeYamlFile('pnpm-workspace.yaml', {
    packages: ['packages/*'],
  })

  const { selectedProjectsGraph } = await filterProjectsBySelectorObjectsFromDir(process.cwd(), [])

  const scriptFile = path.resolve('script.js')
  fs.writeFileSync(scriptFile, `
    console.log('hello from stdout')
    console.error('hello from stderr')
    console.log('name is ' + require(require('path').resolve('package.json')).name)
  `)

  await exec.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    recursive: true,
    bail: true,
    reporterHidePrefix: false,
    selectedProjectsGraph,
  }, [process.execPath, scriptFile])

  for (const name of ['foo', 'bar']) {
    const loggerOpts = {
      wd: path.resolve('packages', name),
      depPath: name,
      stage: '(exec)',
    }
    expect(debug).toHaveBeenCalledWith({
      ...loggerOpts,
      line: 'hello from stdout',
      stdio: 'stdout',
    })
    expect(debug).toHaveBeenCalledWith({
      ...loggerOpts,
      line: 'hello from stderr',
      stdio: 'stderr',
    })
    expect(debug).toHaveBeenCalledWith({
      ...loggerOpts,
      line: `name is ${name}`,
      stdio: 'stdout',
    })
    expect(debug).toHaveBeenCalledWith({
      ...loggerOpts,
      optional: false,
      exitCode: 0,
    })
  }
})

test('pnpm exec --recursive --reporter-hide-prefix does not print prefixes', async () => {
  preparePackages([
    {
      location: 'packages/foo',
      package: { name: 'foo' },
    },
    {
      location: 'packages/bar',
      package: { name: 'bar' },
    },
  ])

  await writeYamlFile('pnpm-workspace.yaml', {
    packages: ['packages/*'],
  })

  const { selectedProjectsGraph } = await filterProjectsBySelectorObjectsFromDir(process.cwd(), [])

  const scriptFile = path.resolve('script.js')
  fs.writeFileSync(scriptFile, `
    console.log('hello from stdout')
    console.error('hello from stderr')
    console.log('name is ' + require(require('path').resolve('package.json')).name)
  `)

  await exec.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    recursive: true,
    bail: true,
    reporterHidePrefix: true,
    selectedProjectsGraph,
  }, [process.execPath, scriptFile])

  expect(debug).not.toHaveBeenCalled()
})

test('pnpm exec --recursive does not print prefixes by default', async () => {
  preparePackages([
    {
      location: 'packages/foo',
      package: { name: 'foo' },
    },
    {
      location: 'packages/bar',
      package: { name: 'bar' },
    },
  ])

  await writeYamlFile('pnpm-workspace.yaml', {
    packages: ['packages/*'],
  })

  const { selectedProjectsGraph } = await filterProjectsBySelectorObjectsFromDir(process.cwd(), [])

  const scriptFile = path.resolve('script.js')
  fs.writeFileSync(scriptFile, `
    console.log('hello from stdout')
    console.error('hello from stderr')
    console.log('name is ' + require(require('path').resolve('package.json')).name)
  `)

  await exec.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    recursive: true,
    bail: true,
    selectedProjectsGraph,
  }, [process.execPath, scriptFile])

  expect(debug).not.toHaveBeenCalled()
})

test('pnpm exec --recursive --no-reporter-hide-prefix reassembles output split across chunks and drops the CR of a CRLF', async () => {
  preparePackages([
    {
      location: 'packages/foo',
      package: { name: 'foo' },
    },
  ])

  await writeYamlFile('pnpm-workspace.yaml', {
    packages: ['packages/*'],
  })

  const { selectedProjectsGraph } = await filterProjectsBySelectorObjectsFromDir(process.cwd(), [])

  // Far past the pipe's chunk size, so both a line and a multi-byte
  // character are guaranteed to straddle a chunk boundary.
  const wide = '€'.repeat(200_000)
  const scriptFile = path.resolve('script.js')
  fs.writeFileSync(scriptFile, `
    process.stdout.write(${JSON.stringify(wide)} + '\\r\\n' + 'tail\\n')
  `)

  await exec.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    recursive: true,
    bail: true,
    reporterHidePrefix: false,
    selectedProjectsGraph,
  }, [process.execPath, scriptFile])

  const lines = jest.mocked(debug).mock.calls
    .map(([log]) => (log as { line?: string }).line)
    .filter((line) => line != null)
  expect(lines).toStrictEqual([wide, 'tail'])
})