Auto-upgrade

Co-Authored-By: Alfonso Noriega <alfonso.noriega.meneses@gmail.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

Author: 3 people

docs-shopify.dev/commands/upgrade.doc.ts

@@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'upgrade',
-  description: `Shows details on how to upgrade Shopify CLI.`,
-  overviewPreviewDescription: `Shows details on how to upgrade Shopify CLI.`,
+  description: `Upgrades Shopify CLI using your package manager.`,
+  overviewPreviewDescription: `Upgrades Shopify CLI.`,
   type: 'command',
   isVisualComponent: false,
   defaultExample: {

docs-shopify.dev/generated/generated_docs_data.json

@@ -7815,8 +7815,8 @@
   },
   {
     "name": "upgrade",
-    "description": "Shows details on how to upgrade Shopify CLI.",
-    "overviewPreviewDescription": "Shows details on how to upgrade Shopify CLI.",
+    "description": "Upgrades Shopify CLI using your package manager.",
+    "overviewPreviewDescription": "Upgrades Shopify CLI.",
     "type": "command",
     "isVisualComponent": false,
     "defaultExample": {

packages/app/src/cli/services/app/config/link.test.ts

@@ -37,6 +37,9 @@ vi.mock('@shopify/cli-kit/node/ui')
 vi.mock('../../context/partner-account-info.js')
 vi.mock('../../context.js')
 vi.mock('../select-app.js')
+vi.mock('@shopify/cli-kit/node/is-global', () => ({
+  currentProcessIsGlobal: () => false,
+}))
 
 const DEFAULT_REMOTE_CONFIGURATION = {
   name: 'app1',

packages/app/src/cli/services/app/config/use.test.ts

@@ -19,6 +19,9 @@ vi.mock('../../local-storage.js')
 vi.mock('../../../models/app/loader.js')
 vi.mock('@shopify/cli-kit/node/ui')
 vi.mock('../../context.js')
+vi.mock('@shopify/cli-kit/node/is-global', () => ({
+  currentProcessIsGlobal: () => false,
+}))
 
 describe('use', () => {
   test('clears currentConfiguration when reset is true', async () => {
@@ -31,6 +34,7 @@ describe('use', () => {
         developerPlatformClient: testDeveloperPlatformClient(),
       }
       writeFileSync(joinPath(tmp, 'package.json'), '{}')
+      writeFileSync(joinPath(tmp, 'shopify.app.toml'), '')
 
       // When
       await use(options)

packages/app/src/cli/services/generate.test.ts

@@ -38,6 +38,9 @@ vi.mock('../prompts/generate/extension.js')
 vi.mock('../services/generate/extension.js')
 vi.mock('../services/context.js')
 vi.mock('./local-storage.js')
+vi.mock('@shopify/cli-kit/node/is-global', () => ({
+  currentProcessIsGlobal: () => false,
+}))
 
 afterEach(() => {
   mockAndCaptureOutput().clear()

packages/app/src/cli/services/init/init.ts

@@ -124,6 +124,7 @@ async function init(options: InitOptions) {
               await appendFile(joinPath(templateScaffoldDir, '.npmrc'), `auto-install-peers=true\n`)
               break
             }
+            case 'homebrew':
             case 'unknown':
               throw new UnknownPackageManagerError()
           }

packages/cli-kit/src/private/node/constants.ts

@@ -46,6 +46,7 @@ export const environmentVariables = {
   neverUsePartnersApi: 'SHOPIFY_CLI_NEVER_USE_PARTNERS_API',
   skipNetworkLevelRetry: 'SHOPIFY_CLI_SKIP_NETWORK_LEVEL_RETRY',
   maxRequestTimeForNetworkCalls: 'SHOPIFY_CLI_MAX_REQUEST_TIME_FOR_NETWORK_CALLS',
+  noAutoUpgrade: 'SHOPIFY_CLI_NO_AUTO_UPGRADE',
 }
 
 export const defaultThemeKitAccessDomain = 'theme-kit-access.shopifyapps.com'

packages/cli-kit/src/public/node/context/local.ts

@@ -292,4 +292,14 @@ export function opentelemetryDomain(env = process.env): string {
   return isSet(domain) ? domain : 'https://otlp-http-production-cli.shopifysvc.com'
 }
 
+/**
+ * Returns true if the CLIshould not automatically upgrade.
+ *
+ * @param env - The environment variables from the environment of the current process.
+ * @returns True if the CLI should not automatically upgrade.
+ */
+export function noAutoUpgrade(env = process.env): boolean {
+  return isTruthy(env[environmentVariables.noAutoUpgrade])
+}
+
 export type CIMetadata = Metadata

packages/cli-kit/src/public/node/fs.ts

@@ -15,7 +15,7 @@ import {
 
 import {temporaryDirectory, temporaryDirectoryTask} from 'tempy'
 import {sep, join} from 'pathe'
-import {findUp as internalFindUp} from 'find-up'
+import {findUp as internalFindUp, findUpSync as internalFindUpSync} from 'find-up'
 import {minimatch} from 'minimatch'
 import fastGlobLib from 'fast-glob'
 import {
@@ -650,6 +650,23 @@ export async function findPathUp(
   return got ? normalizePath(got) : undefined
 }
 
+/**
+ * Find a file by walking parent directories.
+ *
+ * @param matcher - A pattern or an array of patterns to match a file name.
+ * @param options - Options for the search.
+ * @returns The first path found that matches or `undefined` if none could be found.
+ */
+export function findPathUpSync(
+  matcher: OverloadParameters<typeof internalFindUp>[0],
+  options: OverloadParameters<typeof internalFindUp>[1],
+): ReturnType<typeof internalFindUpSync> {
+  // findUp has odd typing
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const got = internalFindUpSync(matcher as any, options)
+  return got ? normalizePath(got) : undefined
+}
+
 export interface MatchGlobOptions {
   matchBase: boolean
   noglobstar: boolean

packages/cli-kit/src/public/node/hooks/postrun.test.ts

@@ -0,0 +1,83 @@
+import {autoUpgradeIfNeeded} from './postrun.js'
+import {mockAndCaptureOutput} from '../testing/output.js'
+import {getOutputUpdateCLIReminder, runCLIUpgrade, versionToAutoUpgrade} from '../upgrade.js'
+import {isMajorVersionChange} from '../version.js'
+import {describe, expect, test, vi, afterEach} from 'vitest'
+
+vi.mock('../upgrade.js', async (importOriginal) => {
+  const actual: any = await importOriginal()
+  return {
+    ...actual,
+    runCLIUpgrade: vi.fn(),
+    getOutputUpdateCLIReminder: vi.fn(),
+    versionToAutoUpgrade: vi.fn(),
+  }
+})
+
+vi.mock('../version.js', async (importOriginal) => {
+  const actual: any = await importOriginal()
+  return {
+    ...actual,
+    isMajorVersionChange: vi.fn(),
+  }
+})
+
+afterEach(() => {
+  mockAndCaptureOutput().clear()
+})
+
+describe('autoUpgradeIfNeeded', () => {
+  test('runs the upgrade when versionToAutoUpgrade returns a version', async () => {
+    // Given
+    vi.mocked(versionToAutoUpgrade).mockReturnValue('3.91.0')
+    vi.mocked(runCLIUpgrade).mockResolvedValue()
+
+    // When
+    await autoUpgradeIfNeeded()
+
+    // Then
+    expect(runCLIUpgrade).toHaveBeenCalled()
+  })
+
+  test('falls back to warning when the upgrade fails', async () => {
+    // Given
+    const outputMock = mockAndCaptureOutput()
+    vi.mocked(versionToAutoUpgrade).mockReturnValue('3.91.0')
+    vi.mocked(runCLIUpgrade).mockRejectedValue(new Error('upgrade failed'))
+    const installReminder = '💡 Version 3.91.0 available! Run `npm install @shopify/cli@latest`'
+    vi.mocked(getOutputUpdateCLIReminder).mockReturnValue(installReminder)
+
+    // When
+    await autoUpgradeIfNeeded()
+
+    // Then
+    expect(outputMock.warn()).toMatch(installReminder)
+  })
+
+  test('does nothing when versionToAutoUpgrade returns undefined', async () => {
+    // Given
+    vi.mocked(versionToAutoUpgrade).mockReturnValue(undefined)
+
+    // When
+    await autoUpgradeIfNeeded()
+
+    // Then
+    expect(runCLIUpgrade).not.toHaveBeenCalled()
+  })
+
+  test('shows warning instead of upgrading for a major version change', async () => {
+    // Given
+    const outputMock = mockAndCaptureOutput()
+    vi.mocked(versionToAutoUpgrade).mockReturnValue('4.0.0')
+    vi.mocked(isMajorVersionChange).mockReturnValue(true)
+    const installReminder = '💡 Version 4.0.0 available! Run `npm install @shopify/cli@latest`'
+    vi.mocked(getOutputUpdateCLIReminder).mockReturnValue(installReminder)
+
+    // When
+    await autoUpgradeIfNeeded()
+
+    // Then
+    expect(runCLIUpgrade).not.toHaveBeenCalled()
+    expect(outputMock.warn()).toMatch(installReminder)
+  })
+})