Files
pnpm/exec/commands/test/verifyDepsBeforeRun.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

131 lines
3.5 KiB
TypeScript

import fs from 'node:fs'
import path from 'node:path'
import { expect, jest, test } from '@jest/globals'
import type { VerifyDepsBeforeRun } from '@pnpm/config.reader'
import { prepare } from '@pnpm/prepare'
import { DEFAULT_OPTS } from './utils/index.js'
const originalModule = await import('@pnpm/logger')
jest.unstable_mockModule('@pnpm/logger', () => {
return {
...originalModule,
globalWarn: jest.fn(),
}
})
jest.unstable_mockModule('enquirer', () => ({
default: {
prompt: jest.fn(),
},
}))
const { run } = await import('@pnpm/exec.commands')
const { default: enquirer } = await import('enquirer')
const { globalWarn } = await import('@pnpm/logger')
const rootProjectManifest = {
name: 'root',
private: true,
dependencies: {
'is-positive': '1.0.0',
},
scripts: {
test: 'echo hello from script',
},
}
async function runTest (verifyDepsBeforeRun: VerifyDepsBeforeRun): Promise<void> {
await run.handler({
...DEFAULT_OPTS,
bin: 'node_modules/.bin',
dir: process.cwd(),
extraBinPaths: [],
extraEnv: {},
pnpmHomeDir: '',
verifyDepsBeforeRun,
rootProjectManifest,
rootProjectManifestDir: process.cwd(),
}, ['test'])
}
test('throw an error if verifyDepsBeforeRun is set to error', async () => {
prepare(rootProjectManifest)
let err!: Error
try {
await runTest('error')
} catch (_err) {
err = _err as Error
}
expect(err.message).toContain('Cannot check whether dependencies are outdated')
})
test('install the dependencies if verifyDepsBeforeRun is set to install', async () => {
prepare(rootProjectManifest)
await runTest('install')
expect(fs.existsSync(path.resolve('node_modules'))).toBeTruthy()
})
test('log a warning if verifyDepsBeforeRun is set to warn', async () => {
prepare(rootProjectManifest)
await runTest('warn')
expect(globalWarn).toHaveBeenCalledWith(
expect.stringContaining('Your node_modules are out of sync with your lockfile')
)
expect(fs.existsSync(path.resolve('node_modules'))).toBeFalsy()
})
test('prompt the user if verifyDepsBeforeRun is set to prompt', async () => {
prepare(rootProjectManifest)
// Mock the user confirming the prompt
jest.mocked(enquirer.prompt).mockResolvedValue({ runInstall: true })
const originalIsTTY = process.stdin.isTTY
Object.defineProperty(process.stdin, 'isTTY', { value: true, configurable: true })
try {
await runTest('prompt')
} finally {
Object.defineProperty(process.stdin, 'isTTY', { value: originalIsTTY, configurable: true })
}
expect(enquirer.prompt).toHaveBeenCalledWith({
type: 'confirm',
name: 'runInstall',
message: expect.stringContaining(
'Your "node_modules" directory is out of sync with the "pnpm-lock.yaml" file'
),
initial: true,
})
expect(fs.existsSync(path.resolve('node_modules'))).toBeTruthy()
})
test('throw an error if verifyDepsBeforeRun is set to prompt in non-TTY environment', async () => {
prepare(rootProjectManifest)
// Mock non-TTY environment
const originalIsTTY = process.stdin.isTTY
Object.defineProperty(process.stdin, 'isTTY', { value: false, configurable: true })
let err!: Error
try {
await runTest('prompt')
} catch (_err) {
err = _err as Error
} finally {
// Restore original value
Object.defineProperty(process.stdin, 'isTTY', { value: originalIsTTY, configurable: true })
}
expect(err.message).toContain('Cannot check whether dependencies are outdated')
expect(fs.existsSync(path.resolve('node_modules'))).toBeFalsy()
})