Files
pnpm/cli/default-reporter/test/reportingProgress.ts
Zoltan Kochan 187049055f chore: upgrade @typescript/native-preview to 7.0.0-dev.20260421.2 (#11332)
* chore: upgrade @typescript/native-preview to 7.0.0-dev.20260421.2

- Add explicit `types: ["node"]` to the shared tsconfig because tsgo
  20260421 no longer auto-acquires `@types/*` from `node_modules`.
- Refactor test files to explicitly import jest globals (`describe`,
  `it`, `test`, `expect`, `beforeEach`, etc.) from `@jest/globals`
  instead of relying on `@types/jest` ambient declarations. Under the
  new tsgo build, `import { jest } from '@jest/globals'` shadows the
  ambient `jest` namespace, breaking `@types/jest`'s `declare var
  describe: jest.Describe;` globals.
- Add `@jest/globals` to each package's devDependencies where tests
  now import from it, and add `@types/node` to packages that need it
  but were relying on hoisted resolution.
- Replace `fail()` calls with `throw new Error(...)` since `fail` is
  no longer globally available.

* chore: fix remaining tsgo type-strictness errors

- Strip `as <PnpmType>` casts on objects passed to toMatchObject /
  toStrictEqual / toEqual; @jest/globals rejects the typed objects
  (which include AsymmetricMatchers) vs. the repo-specific type.
- Type `jest.fn<...>()` explicitly where the mock's signature matters
  for toHaveBeenCalledWith.
- Replace `beforeEach(() => X)` with `beforeEach(() => { X })` so the
  return value is void, as the stricter jest typing requires.
- Use `expect.objectContaining({...})` in one place where the full
  expected object triggered stricter type resolution.
- Cast `prompt.mock.calls` arg through `as unknown as Record<...>[]`
  for patch.test.ts's nested-array matchers.
- Fix off-by-one `<reference path>` in pnpm/test/getConfig.test.ts
  that only surfaced now.
- Move `@jest/globals` from devDependencies to dependencies in the
  two `__utils__` packages that import it from `src/`.
- Clean up unused imports from the @jest/globals migration.

* chore: address Copilot review on #11332

- Move misplaced `@jest/globals` imports to the top import block in
  checkEngine, run.ts, and workspace/root-finder tests where the
  script dropped them below executable code.
- Replace `try { await x(); throw new Error('should have thrown') } catch`
  in bins/linker, lockfile/fs, and resolving/local-resolver tests with
  `await expect(x()).rejects.toMatchObject({...})`. The old pattern
  swallowed an unrelated `throw` if the under-test call silently
  succeeded, which would fail on the catch-block assertion with a
  misleading message.
2026-04-21 22:50:40 +02:00

445 lines
12 KiB
TypeScript

import { expect, test } from '@jest/globals'
import { toOutput$ } from '@pnpm/cli.default-reporter'
import type { Config, ConfigContext } from '@pnpm/config.reader'
import {
fetchingProgressLogger,
progressLogger,
stageLogger,
statsLogger,
} from '@pnpm/core-loggers'
import {
createStreamParser,
logger,
} from '@pnpm/logger'
import chalk from 'chalk'
import normalizeNewline from 'normalize-newline'
import { firstValueFrom } from 'rxjs'
import { map, skip, take, toArray } from 'rxjs/operators'
import { formatWarn } from '../src/reporterForClient/utils/formatWarn.js'
const hlValue = chalk.cyanBright
const EOL = '\n'
test('prints progress beginning', async () => {
const output$ = toOutput$({
context: {
argv: ['install'],
config: { dir: '/src/project' } as Config & ConfigContext,
},
streamParser: createStreamParser(),
})
stageLogger.debug({
prefix: '/src/project',
stage: 'resolution_started',
})
progressLogger.debug({
packageId: 'registry.npmjs.org/foo/1.0.0',
requester: '/src/project',
status: 'resolved',
})
expect.assertions(1)
const output = await firstValueFrom(output$)
expect(output).toBe(`Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}`)
})
test('prints progress without added packages stats', async () => {
const output$ = toOutput$({
context: {
argv: ['install'],
config: { dir: '/src/project' } as Config & ConfigContext,
},
reportingOptions: {
hideAddedPkgsProgress: true,
},
streamParser: createStreamParser(),
})
stageLogger.debug({
prefix: '/src/project',
stage: 'resolution_started',
})
progressLogger.debug({
packageId: 'registry.npmjs.org/foo/1.0.0',
requester: '/src/project',
status: 'resolved',
})
expect.assertions(1)
const output = await firstValueFrom(output$)
expect(output).toBe(`Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}`)
})
test('prints all progress stats', async () => {
const output$ = toOutput$({
context: {
argv: ['install'],
config: { dir: '/src/project' } as Config & ConfigContext,
},
streamParser: createStreamParser(),
})
stageLogger.debug({
prefix: '/src/project',
stage: 'resolution_started',
})
progressLogger.debug({
packageId: 'registry.npmjs.org/foo/1.0.0',
requester: '/src/project',
status: 'resolved',
})
progressLogger.debug({
packageId: 'registry.npmjs.org/foo/1.0.0',
requester: '/src/project',
status: 'fetched',
})
progressLogger.debug({
packageId: 'registry.npmjs.org/bar/1.0.0',
requester: '/src/project',
status: 'found_in_store',
})
progressLogger.debug({
method: 'hardlink',
requester: '/src/project',
status: 'imported',
to: '/node_modules/.pnpm/foo@1.0.0',
})
expect.assertions(1)
const output = await firstValueFrom(output$.pipe(skip(3), take(1)))
expect(output).toBe(`Progress: resolved ${hlValue('1')}, reused ${hlValue('1')}, downloaded ${hlValue('1')}, added ${hlValue('1')}`)
})
test('prints progress beginning of node_modules from not cwd', async () => {
const output$ = toOutput$({
context: {
argv: ['install'],
config: { dir: '/src/projects' } as Config & ConfigContext,
},
streamParser: createStreamParser(),
})
stageLogger.debug({
prefix: '/src/projects/foo',
stage: 'resolution_started',
})
progressLogger.debug({
packageId: 'registry.npmjs.org/foo/1.0.0',
requester: '/src/projects/foo',
status: 'resolved',
})
expect.assertions(1)
const output = await firstValueFrom(output$)
expect(output).toBe(`foo | Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}`)
})
test('prints progress beginning of node_modules from not cwd, when progress prefix is hidden', async () => {
const output$ = toOutput$({
context: {
argv: ['install'],
config: { dir: '/src/projects' } as Config & ConfigContext,
},
streamParser: createStreamParser(),
reportingOptions: {
hideProgressPrefix: true,
},
})
stageLogger.debug({
prefix: '/src/projects/foo',
stage: 'resolution_started',
})
progressLogger.debug({
packageId: 'registry.npmjs.org/foo/1.0.0',
requester: '/src/projects/foo',
status: 'resolved',
})
expect.assertions(1)
const output = await firstValueFrom(output$)
expect(output).toBe(`Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}`)
})
test('prints progress beginning when appendOnly is true', async () => {
const output$ = toOutput$({
context: {
argv: ['install'],
config: { dir: '/src/project' } as Config & ConfigContext,
},
reportingOptions: {
appendOnly: true,
},
streamParser: createStreamParser(),
})
stageLogger.debug({
prefix: '/src/project',
stage: 'resolution_started',
})
progressLogger.debug({
packageId: 'registry.npmjs.org/foo/1.0.0',
requester: '/src/project',
status: 'resolved',
})
expect.assertions(1)
const output = await firstValueFrom(output$)
expect(output).toBe(`Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}`)
})
test('prints progress beginning during recursive install', async () => {
const output$ = toOutput$({
context: {
argv: ['install'],
config: {
dir: '/src/project',
recursive: true,
} as Config & ConfigContext,
},
streamParser: createStreamParser(),
})
stageLogger.debug({
prefix: '/src/project',
stage: 'resolution_started',
})
progressLogger.debug({
packageId: 'registry.npmjs.org/foo/1.0.0',
requester: '/src/project',
status: 'resolved',
})
expect.assertions(1)
const output = await firstValueFrom(output$)
expect(output).toBe(`Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}`)
})
test('prints progress on first download', async () => {
expect.assertions(1)
const output$ = toOutput$({
context: {
argv: ['install'],
config: { dir: '/src/project' } as Config & ConfigContext,
},
reportingOptions: { throttleProgress: 0 },
streamParser: createStreamParser(),
})
const packageId = 'registry.npmjs.org/foo/1.0.0'
stageLogger.debug({
prefix: '/src/project',
stage: 'resolution_started',
})
progressLogger.debug({
packageId,
requester: '/src/project',
status: 'resolved',
})
progressLogger.debug({
packageId,
requester: '/src/project',
status: 'fetched',
})
const output = await firstValueFrom(output$.pipe(skip(1), take(1)))
expect(output).toBe(`Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('1')}, added ${hlValue('0')}`)
})
test('moves fixed line to the end', async () => {
expect.assertions(1)
const prefix = '/src/project'
const output$ = toOutput$({
context: {
argv: ['install'],
config: { dir: prefix } as Config & ConfigContext,
},
reportingOptions: { throttleProgress: 0 },
streamParser: createStreamParser(),
})
const packageId = 'registry.npmjs.org/foo/1.0.0'
stageLogger.debug({
prefix,
stage: 'resolution_started',
})
progressLogger.debug({
packageId,
requester: prefix,
status: 'resolved',
})
progressLogger.debug({
packageId,
requester: prefix,
status: 'fetched',
})
logger.warn({ message: 'foo', prefix })
stageLogger.debug({
prefix,
stage: 'resolution_done',
})
stageLogger.debug({
prefix,
stage: 'importing_done',
})
const output = await firstValueFrom(output$.pipe(skip(3), take(1), map(normalizeNewline)))
expect(output).toBe(formatWarn('foo') + EOL +
`Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('1')}, added ${hlValue('0')}, done`)
})
test('prints "Already up to date"', async () => {
const output$ = toOutput$({
context: { argv: ['install'] },
streamParser: createStreamParser(),
})
const prefix = process.cwd()
statsLogger.debug({ added: 0, prefix })
statsLogger.debug({ removed: 0, prefix })
expect.assertions(1)
const output = await firstValueFrom(output$.pipe(take(1), map(normalizeNewline)))
expect(output).toBe('Already up to date')
})
test('prints progress of big files download', async () => {
expect.assertions(6)
const output$ = toOutput$({
context: {
argv: ['install'],
config: { dir: '/src/project' } as Config & ConfigContext,
},
reportingOptions: { throttleProgress: 0 },
streamParser: createStreamParser(),
})
const pkgId1 = 'registry.npmjs.org/foo/1.0.0'
const pkgId2 = 'registry.npmjs.org/bar/2.0.0'
const pkgId3 = 'registry.npmjs.org/qar/3.0.0'
stageLogger.debug({
prefix: '/src/project',
stage: 'resolution_started',
})
progressLogger.debug({
packageId: pkgId1,
requester: '/src/project',
status: 'resolved',
})
fetchingProgressLogger.debug({
attempt: 1,
packageId: pkgId1,
size: 1024 * 1024 * 10, // 10 MB
status: 'started',
})
fetchingProgressLogger.debug({
downloaded: 1024 * 1024 * 5.5, // 5.5 MB
packageId: pkgId1,
status: 'in_progress',
})
progressLogger.debug({
packageId: pkgId2,
requester: '/src/project',
status: 'resolved',
})
fetchingProgressLogger.debug({
attempt: 1,
packageId: pkgId1,
size: 10, // 10 B
status: 'started',
})
fetchingProgressLogger.debug({
downloaded: 1024 * 1024 * 7,
packageId: pkgId1,
status: 'in_progress',
})
progressLogger.debug({
packageId: pkgId3,
requester: '/src/project',
status: 'resolved',
})
fetchingProgressLogger.debug({
attempt: 1,
packageId: pkgId3,
size: 1024 * 1024 * 20, // 20 MB
status: 'started',
})
fetchingProgressLogger.debug({
downloaded: 1024 * 1024 * 19, // 19 MB
packageId: pkgId3,
status: 'in_progress',
})
fetchingProgressLogger.debug({
downloaded: 1024 * 1024 * 10, // 10 MB
packageId: pkgId1,
status: 'in_progress',
})
const output = await firstValueFrom(output$.pipe(take(9), map(normalizeNewline), toArray()))
output.forEach((output, index) => {
switch (index) {
case 0:
expect(output).toBe(`Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}`)
return
case 1:
expect(output).toBe(`\
Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}
Downloading ${pkgId1}: ${hlValue('0.00 B')}/${hlValue('10.48 MB')}`)
return
case 2:
expect(output).toBe(`\
Progress: resolved ${hlValue('1')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}
Downloading ${pkgId1}: ${hlValue('5.76 MB')}/${hlValue('10.48 MB')}`)
return
case 4:
expect(output).toBe(`\
Progress: resolved ${hlValue('2')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}
Downloading ${pkgId1}: ${hlValue('7.34 MB')}/${hlValue('10.48 MB')}`)
return
case 7:
expect(output).toBe(`\
Progress: resolved ${hlValue('3')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}
Downloading ${pkgId1}: ${hlValue('7.34 MB')}/${hlValue('10.48 MB')}
Downloading ${pkgId3}: ${hlValue('19.92 MB')}/${hlValue('20.97 MB')}`)
return
case 8:
expect(output).toBe(`\
Downloading ${pkgId1}: ${hlValue('10.48 MB')}/${hlValue('10.48 MB')}, done
Progress: resolved ${hlValue('3')}, reused ${hlValue('0')}, downloaded ${hlValue('0')}, added ${hlValue('0')}
Downloading ${pkgId3}: ${hlValue('19.92 MB')}/${hlValue('20.97 MB')}`)
return
}
})
})