@sanity/cli 3.65.2-corel.472 → 3.66.0

package/src/commands/upgrade/upgradeDependencies.ts

@@ -1,289 +0,0 @@
-import {promises as fs} from 'node:fs'
-import path from 'node:path'
-import util from 'node:util'
-
-import boxen from 'boxen'
-import {noop, padStart} from 'lodash'
-import resolveFrom from 'resolve-from'
-import rimrafCb from 'rimraf'
-import semver from 'semver'
-
-import {type CliCommandContext} from '../..'
-import {
-  findSanityModuleVersions,
-  type ModuleVersionResult,
-} from '../../actions/versions/findSanityModuleVersions'
-import {debug} from '../../debug'
-import {type CliCommandAction, type PackageJson} from '../../types'
-import {getFormatters} from '../versions/printVersionResult'
-
-const rimraf = util.promisify(rimrafCb)
-
-const unsupportedMessage = `
-\`sanity upgrade\` is not supported as of sanity v3.
-Use npm-check-updates or similar (https://www.npmjs.com/package/npm-check-updates)
-`.trim()
-
-export interface UpgradeCommandFlags {
-  'range'?: string
-  'tag'?: string
-  'offline'?: boolean
-  'save-exact'?: boolean
-}
-
-const upgradeDependencies: CliCommandAction<UpgradeCommandFlags> =
-  async function upgradeDependencies(args, context) {
-    const {output, workDir, yarn, chalk, sanityMajorVersion} = context
-    if (sanityMajorVersion >= 3) {
-      throw new Error(unsupportedMessage)
-    }
-
-    const {extOptions, argsWithoutOptions} = args
-    const modules = argsWithoutOptions.slice()
-    const {range, tag} = extOptions
-    const saveExact = extOptions['save-exact']
-    const targetRange = tag || range
-
-    if (range && tag) {
-      throw new Error('Both --tag and --range specified, can only use one')
-    }
-
-    if (range && !semver.validRange(range)) {
-      throw new Error(`Invalid semver range "${range}"`)
-    }
-
-    // Find which modules needs update according to the target range
-    const versions = await findSanityModuleVersions(context, {
-      target: targetRange,
-      includeCli: false,
-    })
-    const allNeedsUpdate = versions.filter((mod) => mod.needsUpdate)
-
-    debug('In need of update: %s', allNeedsUpdate.map((mod) => mod.name).join(', '))
-
-    const needsUpdate =
-      modules.length === 0
-        ? allNeedsUpdate
-        : allNeedsUpdate.filter((outOfDate) => modules.indexOf(outOfDate.name) !== -1)
-
-    const semverBreakingUpgrades = versions.filter(hasSemverBreakingUpgrade)
-    const baseMajorUpgrade = semverBreakingUpgrades.find((mod) => mod.name === '@sanity/base')
-    const majorUpgrades = semverBreakingUpgrades.filter((mod) => mod.name !== '@sanity/base')
-    schedulePrintMajorUpgrades({baseMajorUpgrade, majorUpgrades}, context)
-
-    // If all modules are up-to-date, say so and exit
-    if (needsUpdate.length === 0) {
-      const specified = modules.length === 0 ? 'All' : 'All *specified*'
-      context.output.print(
-        `${chalk.green('✔')} ${specified} Sanity modules are at latest compatible versions`,
-      )
-      return
-    }
-
-    // Ignore modules that are pinned, but give some indication that this has happened
-    const pinned = needsUpdate.filter((mod) => mod.isPinned)
-    const nonPinned = needsUpdate.filter((mod) => !mod.isPinned)
-    const pinnedNames = pinned.map((mod) => mod.name).join(`\n - `)
-    if (nonPinned.length === 0) {
-      context.output.warn(
-        `${chalk.yellow(
-          '⚠',
-        )} All modules are pinned to specific versions, not upgrading:\n - ${pinnedNames}`,
-      )
-      return
-    }
-
-    if (pinned.length > 0) {
-      context.output.warn(
-        `${chalk.yellow(
-          '⚠',
-        )} The follow modules are pinned to specific versions, not upgrading:\n - ${pinnedNames}`,
-      )
-    }
-
-    // Yarn fails to upgrade `react-ace` in some versions, see function for details
-    await maybeDeleteReactAce(nonPinned, workDir)
-
-    // Forcefully remove non-symlinked module paths to force upgrade
-    await Promise.all(
-      nonPinned.map((mod) =>
-        deleteIfNotSymlink(
-          path.join(context.workDir, 'node_modules', mod.name.replace(/\//g, path.sep)),
-        ),
-      ),
-    )
-
-    // Replace versions in `package.json`
-    const versionPrefix = saveExact ? '' : '^'
-    const oldManifest = await readLocalManifest(workDir)
-    const newManifest = nonPinned.reduce((target, mod) => {
-      if (oldManifest.dependencies && oldManifest.dependencies[mod.name]) {
-        target.dependencies[mod.name] =
-          mod.latestInRange === 'unknown'
-            ? oldManifest.dependencies[mod.name]
-            : versionPrefix + mod.latestInRange
-      }
-
-      if (oldManifest.devDependencies && oldManifest.devDependencies[mod.name]) {
-        target.devDependencies[mod.name] =
-          mod.latestInRange === 'unknown'
-            ? oldManifest.devDependencies[mod.name]
-            : versionPrefix + mod.latestInRange
-      }
-
-      return target
-    }, oldManifest)
-
-    // Write new `package.json`
-    const manifestPath = path.join(context.workDir, 'package.json')
-    await writeJson(manifestPath, newManifest)
-
-    // Run `yarn install`
-    const flags = extOptions.offline ? ['--offline'] : []
-    const cmd = ['install'].concat(flags)
-
-    debug('Running yarn %s', cmd.join(' '))
-    await yarn(cmd, {...output, rootDir: workDir})
-
-    context.output.print('')
-    context.output.print(`${chalk.green('✔')} Modules upgraded:`)
-
-    const {versionLength, formatName} = getFormatters(nonPinned)
-    nonPinned.forEach((mod) => {
-      const current = chalk.yellow(padStart(mod.installed || '<missing>', versionLength))
-      const latest = chalk.green(mod.latestInRange)
-      context.output.print(`${formatName(mod.name)} ${current} → ${latest}`)
-    })
-  }
-
-export default upgradeDependencies
-
-function writeJson(filePath: string, data: PackageJson) {
-  return fs.writeFile(filePath, `${JSON.stringify(data, null, 2)}\n`)
-}
-
-async function deleteIfNotSymlink(modPath: string): Promise<void | null> {
-  const stats = await fs.lstat(modPath).catch(noop)
-  if (!stats || stats.isSymbolicLink()) {
-    return null
-  }
-
-  return rimraf(modPath)
-}
-
-function hasSemverBreakingUpgrade(mod: ModuleVersionResult): boolean {
-  const current = mod.installed || semver.minVersion(mod.declared)?.toString() || ''
-  return !semver.satisfies(mod.latest, `^${current}`) && semver.gt(mod.latest, current)
-}
-
-function getMajorUpgradeText(
-  mods: ModuleVersionResult[],
-  chalk: CliCommandContext['chalk'],
-): string {
-  const modNames = mods.map((mod) => `${mod.name} (v${semver.major(mod.latest)})`).join('\n - ')
-
-  return [
-    `The following modules has new major versions\n`,
-    `released and will have to be manually upgraded:\n\n`,
-    ` - ${modNames}\n\n`,
-    chalk.yellow('⚠'),
-    ` Note that major versions can contain backwards\n`,
-    `  incompatible changes and should be handled with care.`,
-  ].join('')
-}
-
-function getMajorStudioUpgradeText(
-  mod: ModuleVersionResult,
-  chalk: CliCommandContext['chalk'],
-): string {
-  const prev = semver.major(mod.installed || semver.minVersion(mod.declared)?.toString() || '')
-  const next = semver.major(mod.latest)
-  return [
-    'There is now a new major version of Sanity Studio!',
-    '',
-    'Read more about the new version and how to upgrade:',
-    chalk.blueBright(`https://www.sanity.io/changelog/studio?from=v${prev}&to=v${next}`),
-  ].join('\n')
-}
-
-function schedulePrintMajorUpgrades(
-  {
-    baseMajorUpgrade,
-    majorUpgrades,
-  }: {baseMajorUpgrade?: ModuleVersionResult; majorUpgrades: ModuleVersionResult[]},
-  {chalk, output}: CliCommandContext,
-): void {
-  if (majorUpgrades.length === 0 && !baseMajorUpgrade) {
-    return
-  }
-
-  process.on('beforeExit', () => {
-    output.print('') // Separate previous output with a newline
-
-    if (baseMajorUpgrade) {
-      output.warn(
-        boxen(getMajorStudioUpgradeText(baseMajorUpgrade, chalk), {
-          borderColor: 'green',
-          padding: 1,
-        }),
-      )
-      return
-    }
-
-    output.warn(
-      boxen(getMajorUpgradeText(majorUpgrades, chalk), {
-        borderColor: 'yellow',
-        padding: 1,
-      }),
-    )
-  })
-}
-
-// Workaround for https://github.com/securingsincity/react-ace/issues/1048
-// Yarn fails to upgrade `react-ace` because `react-ace.min.js` is a _file_ in one version
-// but a _folder_ in the next. If we're upgrading the `@sanity/code-input`, remove the
-// `react-ace` dependency before installing
-async function maybeDeleteReactAce(toUpgrade: ModuleVersionResult[], workDir: string) {
-  const codeInputUpdate = toUpgrade.find((mod) => mod.name === '@sanity/code-input')
-  if (!codeInputUpdate) {
-    return
-  }
-
-  // Assume it is an old version if we can't figure out which one is installed
-  const installed = codeInputUpdate.installed ? codeInputUpdate.installed : '2.4.0'
-  const upgradeTo = codeInputUpdate.latestInRange
-
-  // react-ace was upgraded in 2.24.1, so if we're going from <= 2.24.0 to => 2.24.1,
-  // we should remove it.
-  const shouldDelete = semver.lte(installed, '2.24.0') && semver.gte(upgradeTo, '2.24.1')
-  if (!shouldDelete) {
-    return
-  }
-
-  // Try to find the path to it from `@sanity/code-input`, otherwise try the studio root `node_modules`
-  const depRootPath = path.join(workDir, 'node_modules')
-  const closestReactAcePath =
-    getModulePath('react-ace', path.join(depRootPath, '@sanity', 'code-input')) ||
-    path.join(depRootPath, 'react-ace')
-
-  await rimraf(closestReactAcePath)
-}
-
-function getModulePath(modName: string, fromPath: string): string | undefined {
-  const manifestFile = `${modName.replace(/\//g, path.sep)}/package.json`
-  const manifestPath = resolveFrom.silent(fromPath, manifestFile)
-  return manifestPath ? path.dirname(manifestPath) : undefined
-}
-
-async function readLocalManifest(dirName: string, fileName = 'package.json') {
-  try {
-    const content = await fs.readFile(path.join(dirName, fileName), 'utf8')
-    return JSON.parse(content)
-  } catch (err) {
-    if (err.code === 'ENOENT') {
-      return {}
-    }
-
-    throw new Error(`Error while attempting to read projects "${fileName}":\n${err.message}`)
-  }
-}