pnpm/pkg-manager/plugin-commands-installation/test/update/update.ts

import path from 'path'
import { type PnpmError } from '@pnpm/error'
import { install, update } from '@pnpm/plugin-commands-installation'
import { prepare, preparePackages } from '@pnpm/prepare'
import { addDistTag } from '@pnpm/registry-mock'
import { type ProjectManifest } from '@pnpm/types'
import loadJsonFile from 'load-json-file'
import { DEFAULT_OPTS } from '../utils'

test('update with "*" pattern', async () => {
  await addDistTag({ package: '@pnpm.e2e/peer-a', version: '1.0.1', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/peer-c', version: '2.0.0', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/foo', version: '2.0.0', distTag: 'latest' })

  const project = prepare({
    dependencies: {
      '@pnpm.e2e/peer-a': '1.0.0',
      '@pnpm.e2e/peer-c': '1.0.0',
      '@pnpm.e2e/foo': '1.0.0',
    },
  })

  await install.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
  })

  await update.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    latest: true,
  }, ['@pnpm.e2e/peer-*'])

  const lockfile = project.readLockfile()

  expect(lockfile.packages['@pnpm.e2e/peer-a@1.0.1']).toBeTruthy()
  expect(lockfile.packages['@pnpm.e2e/peer-c@2.0.0']).toBeTruthy()
  expect(lockfile.packages['@pnpm.e2e/foo@1.0.0']).toBeTruthy()
})

test('update with negation pattern', async () => {
  await addDistTag({ package: '@pnpm.e2e/peer-a', version: '1.0.1', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/peer-c', version: '2.0.0', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/foo', version: '2.0.0', distTag: 'latest' })

  const project = prepare({
    dependencies: {
      '@pnpm.e2e/peer-a': '1.0.0',
      '@pnpm.e2e/peer-c': '1.0.0',
      '@pnpm.e2e/foo': '1.0.0',
    },
  })

  await install.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
  })

  await update.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    latest: true,
  }, ['!@pnpm.e2e/peer-*'])

  const lockfile = project.readLockfile()

  expect(lockfile.packages['@pnpm.e2e/peer-a@1.0.0']).toBeTruthy()
  expect(lockfile.packages['@pnpm.e2e/peer-c@1.0.0']).toBeTruthy()
  expect(lockfile.packages['@pnpm.e2e/foo@2.0.0']).toBeTruthy()
})

test('update: fail when both "latest" and "workspace" are true', async () => {
  preparePackages([
    {
      name: 'project-1',
      version: '1.0.0',
    },
    {
      name: 'project-2',
      version: '2.0.0',
    },
  ])

  let err!: PnpmError
  try {
    await update.handler({
      ...DEFAULT_OPTS,
      dir: path.resolve('project-1'),
      latest: true,
      linkWorkspacePackages: false,
      saveWorkspaceProtocol: false,
      workspace: true,
      workspaceDir: process.cwd(),
    }, ['project-2'])
  } catch (_err: any) { // eslint-disable-line
    err = _err
  }
  expect(err.code).toBe('ERR_PNPM_BAD_OPTIONS')
  expect(err.message).toBe('Cannot use --latest with --workspace simultaneously')
})

test('update --latest forbids specs', async () => {
  prepare()

  let err!: PnpmError
  try {
    await update.handler({
      ...DEFAULT_OPTS,
      dir: process.cwd(),
      latest: true,
      workspaceDir: process.cwd(),
    }, ['foo@latest', 'bar@next', 'baz'])
  } catch (_err: any) { // eslint-disable-line
    err = _err
  }
  expect(err.code).toBe('ERR_PNPM_LATEST_WITH_SPEC')
  expect(err.message).toBe('Specs are not allowed to be used with --latest (foo@latest, bar@next)')
})

describe('update by package name', () => {
  beforeAll(async () => {
    prepare({
      dependencies: {
        '@pnpm.e2e/peer-a': '1.0.0',
        '@pnpm.e2e/peer-c': '1.0.0',
      },
    })
    await install.handler({
      ...DEFAULT_OPTS,
      dir: process.cwd(),
    })
  })
  it("should fail when the package isn't in the direct dependencies and depth is 0", async () => {
    let err!: PnpmError
    try {
      await update.handler({
        ...DEFAULT_OPTS,
        depth: 0,
        dir: process.cwd(),
        sharedWorkspaceLockfile: true,
      }, ['@pnpm.e2e/peer-b'])
    } catch (_err: any) { // eslint-disable-line
      err = _err
    }
    expect(err.code).toBe('ERR_PNPM_NO_PACKAGE_IN_DEPENDENCIES')
    expect(err.message).toBe('None of the specified packages were found in the dependencies.')
  })
  it("shouldn't fail when the package isn't in the direct dependencies", async () => {
    await update.handler({
      ...DEFAULT_OPTS,
      dir: process.cwd(),
      sharedWorkspaceLockfile: true,
    }, ['@pnpm.e2e/peer-b'])
  })
})

test('update --no-save should not update package.json and pnpm-lock.yaml', async () => {
  await addDistTag({ package: '@pnpm.e2e/peer-a', version: '1.0.0', distTag: 'latest' })

  const project = prepare({
    dependencies: {
      '@pnpm.e2e/peer-a': '^1.0.0',
    },
  })

  await install.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
  })

  {
    const manifest = loadJsonFile.sync<ProjectManifest>('package.json')
    expect(manifest.dependencies?.['@pnpm.e2e/peer-a']).toBe('^1.0.0')

    const lockfile = project.readLockfile()
    expect(lockfile.importers['.'].dependencies?.['@pnpm.e2e/peer-a'].specifier).toBe('^1.0.0')
    expect(lockfile.packages['@pnpm.e2e/peer-a@1.0.0']).toBeTruthy()
  }

  await addDistTag({ package: '@pnpm.e2e/peer-a', version: '1.0.1', distTag: 'latest' })

  await update.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    latest: true,
    save: false,
  }, [])

  {
    const manifest = loadJsonFile.sync<ProjectManifest>('package.json')
    expect(manifest.dependencies?.['@pnpm.e2e/peer-a']).toBe('^1.0.0')

    const lockfile = project.readLockfile()
    expect(lockfile.importers['.'].dependencies?.['@pnpm.e2e/peer-a'].specifier).toBe('^1.0.0')
    expect(lockfile.packages['@pnpm.e2e/peer-a@1.0.1']).toBeTruthy()
  }
})

// fix: https://github.com/pnpm/pnpm/issues/4196
test('update should work normal when set empty string version', async () => {
  await addDistTag({ package: '@pnpm.e2e/peer-a', version: '1.0.1', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/peer-c', version: '2.0.0', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/foo', version: '2.0.0', distTag: 'latest' })

  const project = prepare({
    dependencies: {
      '@pnpm.e2e/peer-a': '1.0.0',
    },
    devDependencies: {
      '@pnpm.e2e/foo': '',
      '@pnpm.e2e/peer-c': '',
    },
  })

  await install.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
  })

  await update.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    latest: true,
  }, ['*'])

  const lockfile = project.readLockfile()
  expect(lockfile.packages['@pnpm.e2e/peer-a@1.0.1']).toBeTruthy()
  expect(lockfile.packages['@pnpm.e2e/peer-c@2.0.0']).toBeTruthy()
  expect(lockfile.packages['@pnpm.e2e/foo@2.0.0']).toBeTruthy()
  expect(lockfile.importers['.'].dependencies?.['@pnpm.e2e/peer-a'].version).toEqual('1.0.1')
  expect(lockfile.importers['.'].devDependencies?.['@pnpm.e2e/foo'].version).toEqual('2.0.0')
  expect(lockfile.importers['.'].devDependencies?.['@pnpm.e2e/peer-c'].version).toEqual('2.0.0')
})

test('ignore packages in package.json > updateConfig.ignoreDependencies fields in update command', async () => {
  await addDistTag({ package: '@pnpm.e2e/foo', version: '100.0.0', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/bar', version: '100.0.0', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/qar', version: '100.0.0', distTag: 'latest' })

  const project = prepare({
    dependencies: {
      '@pnpm.e2e/foo': '100.0.0',
      '@pnpm.e2e/bar': '100.0.0',
      '@pnpm.e2e/qar': '100.0.0',
    },
    pnpm: {
      updateConfig: {
        ignoreDependencies: [
          '@pnpm.e2e/foo',
          '@pnpm.e2e/bar',
        ],
      },
    },
  })

  await install.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
  })

  const lockfile = project.readLockfile()

  expect(lockfile.packages['@pnpm.e2e/foo@100.0.0']).toBeTruthy()
  expect(lockfile.packages['@pnpm.e2e/bar@100.0.0']).toBeTruthy()
  expect(lockfile.packages['@pnpm.e2e/qar@100.0.0']).toBeTruthy()

  await addDistTag({ package: '@pnpm.e2e/foo', version: '100.1.0', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/bar', version: '100.1.0', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/qar', version: '100.1.0', distTag: 'latest' })

  await update.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    latest: true,
  })

  const lockfileUpdated = project.readLockfile()

  expect(lockfileUpdated.packages['@pnpm.e2e/foo@100.0.0']).toBeTruthy()
  expect(lockfileUpdated.packages['@pnpm.e2e/bar@100.0.0']).toBeTruthy()
  expect(lockfileUpdated.packages['@pnpm.e2e/qar@100.1.0']).toBeTruthy()
})

test('not ignore packages if these are specified in parameter even if these are listed in package.json > pnpm.update.ignoreDependencies fields in update command', async () => {
  await addDistTag({ package: '@pnpm.e2e/foo', version: '100.0.0', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/bar', version: '100.0.0', distTag: 'latest' })

  const project = prepare({
    dependencies: {
      '@pnpm.e2e/foo': '100.0.0',
      '@pnpm.e2e/bar': '100.0.0',
    },
    pnpm: {
      updateConfig: {
        ignoreDependencies: [
          '@pnpm.e2e/foo',
        ],
      },
    },
  })

  await install.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
  })

  const lockfile = project.readLockfile()

  expect(lockfile.packages['@pnpm.e2e/foo@100.0.0']).toBeTruthy()
  expect(lockfile.packages['@pnpm.e2e/bar@100.0.0']).toBeTruthy()

  await addDistTag({ package: '@pnpm.e2e/foo', version: '100.1.0', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/bar', version: '100.1.0', distTag: 'latest' })

  await update.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
  }, ['@pnpm.e2e/foo@latest', '@pnpm.e2e/bar@latest'])

  const lockfileUpdated = project.readLockfile()

  expect(lockfileUpdated.packages['@pnpm.e2e/foo@100.1.0']).toBeTruthy()
  expect(lockfileUpdated.packages['@pnpm.e2e/bar@100.1.0']).toBeTruthy()
})

test('do not update anything if all the dependencies are ignored and trying to update to latest', async () => {
  await addDistTag({ package: '@pnpm.e2e/foo', version: '100.1.0', distTag: 'latest' })

  const project = prepare({
    dependencies: {
      '@pnpm.e2e/foo': '100.0.0',
    },
    pnpm: {
      updateConfig: {
        ignoreDependencies: [
          '@pnpm.e2e/foo',
        ],
      },
    },
  })

  await install.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
  })

  await update.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    latest: true,
  }, [])

  const lockfileUpdated = project.readLockfile()
  expect(lockfileUpdated.packages['@pnpm.e2e/foo@100.0.0']).toBeTruthy()
})

test('should not update tag version when --latest not set', async () => {
  await addDistTag({ package: '@pnpm.e2e/peer-a', version: '1.0.1', distTag: 'latest' })
  await addDistTag({ package: '@pnpm.e2e/peer-c', version: '2.0.0', distTag: 'canary' })
  await addDistTag({ package: '@pnpm.e2e/foo', version: '2.0.0', distTag: 'latest' })

  prepare({
    dependencies: {
      '@pnpm.e2e/peer-a': 'latest',
      '@pnpm.e2e/peer-c': 'canary',
      '@pnpm.e2e/foo': '1.0.0',
    },
  })

  await install.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
  })

  await update.handler({
    ...DEFAULT_OPTS,
    dir: process.cwd(),
    latest: false,
  })

  const manifest = loadJsonFile.sync<ProjectManifest>('package.json')
  expect(manifest.dependencies?.['@pnpm.e2e/peer-a']).toBe('latest')
  expect(manifest.dependencies?.['@pnpm.e2e/peer-c']).toBe('canary')
  expect(manifest.dependencies?.['@pnpm.e2e/foo']).toBe('1.0.0')
})