Merge pull request #6291 from Shopify/jb-multi-env-unsupported

Refactor commands that don't support multiple environments to use ThemeCommand's run method

Author: dejmedus

.changeset/slow-buckets-battle.md

@@ -0,0 +1,6 @@
+---
+'@shopify/theme': minor
+'@shopify/cli': minor
+---
+
+Display warning when multiple environment flags are provided to profile, metafields pull, open, dev, or console theme commands

packages/cli/oclif.manifest.json

@@ -5212,6 +5212,7 @@
       "hiddenAliases": [
       ],
       "id": "theme:console",
+      "multiEnvironmentsFlags": null,
       "pluginAlias": "@shopify/cli",
       "pluginName": "@shopify/cli",
       "pluginType": "core",
@@ -5524,6 +5525,7 @@
       "hiddenAliases": [
       ],
       "id": "theme:dev",
+      "multiEnvironmentsFlags": null,
       "pluginAlias": "@shopify/cli",
       "pluginName": "@shopify/cli",
       "pluginType": "core",
@@ -6020,6 +6022,7 @@
       "hiddenAliases": [
       ],
       "id": "theme:metafields:pull",
+      "multiEnvironmentsFlags": null,
       "pluginAlias": "@shopify/cli",
       "pluginName": "@shopify/cli",
       "pluginType": "core",
@@ -6124,6 +6127,7 @@
       "hiddenAliases": [
       ],
       "id": "theme:open",
+      "multiEnvironmentsFlags": null,
       "pluginAlias": "@shopify/cli",
       "pluginName": "@shopify/cli",
       "pluginType": "core",
@@ -6275,6 +6279,7 @@
       "hiddenAliases": [
       ],
       "id": "theme:profile",
+      "multiEnvironmentsFlags": null,
       "pluginAlias": "@shopify/cli",
       "pluginName": "@shopify/cli",
       "pluginType": "core",
@@ -7011,6 +7016,7 @@
       "hiddenAliases": [
       ],
       "id": "theme:serve",
+      "multiEnvironmentsFlags": null,
       "pluginAlias": "@shopify/cli",
       "pluginName": "@shopify/cli",
       "pluginType": "core",

packages/theme/src/cli/commands/theme/console.ts

@@ -1,12 +1,14 @@
 import {themeFlags} from '../../flags.js'
-import ThemeCommand from '../../utilities/theme-command.js'
-import {ensureThemeStore} from '../../utilities/theme-store.js'
+import ThemeCommand, {RequiredFlags} from '../../utilities/theme-command.js'
 import {ensureReplEnv, initializeRepl} from '../../services/console.js'
 import {validateThemePassword} from '../../services/flags-validation.js'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
-import {ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
+import {AdminSession} from '@shopify/cli-kit/node/session'
 import {Flags} from '@oclif/core'
 import {recordEvent} from '@shopify/cli-kit/node/analytics'
+import {InferredFlags} from '@oclif/core/interfaces'
+
+type ConsoleFlags = InferredFlags<typeof Console.flags>
 
 export default class Console extends ThemeCommand {
   static summary = 'Shopify Liquid REPL (read-eval-print loop) tool'
@@ -33,15 +35,12 @@ export default class Console extends ThemeCommand {
     }),
   }
 
-  async run() {
-    const {flags} = await this.parse(Console)
-
-    validateThemePassword(flags.password)
+  static multiEnvironmentsFlags: RequiredFlags = null
 
-    const store = ensureThemeStore(flags)
+  async command(flags: ConsoleFlags, adminSession: AdminSession) {
     const {url, password: themeAccessPassword} = flags
 
-    const adminSession = await ensureAuthenticatedThemes(store, themeAccessPassword)
+    validateThemePassword(themeAccessPassword)
 
     const {themeId, storePassword} = await ensureReplEnv(adminSession, flags['store-password'])
 

packages/theme/src/cli/commands/theme/dev.ts

@@ -1,6 +1,5 @@
 import {themeFlags} from '../../flags.js'
-import {ensureThemeStore} from '../../utilities/theme-store.js'
-import ThemeCommand, {FlagValues} from '../../utilities/theme-command.js'
+import ThemeCommand, {RequiredFlags} from '../../utilities/theme-command.js'
 import {dev} from '../../services/dev.js'
 import {DevelopmentThemeManager} from '../../utilities/development-theme-manager.js'
 import {findOrSelectTheme} from '../../utilities/theme-selector.js'
@@ -10,10 +9,13 @@ import {validateThemePassword} from '../../services/flags-validation.js'
 import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
 import {Theme} from '@shopify/cli-kit/node/themes/types'
-import {ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
 import {recordEvent} from '@shopify/cli-kit/node/analytics'
+import {AdminSession} from '@shopify/cli-kit/node/session'
+import {InferredFlags} from '@oclif/core/interfaces'
 import type {ErrorOverlayMode, LiveReload} from '../../utilities/theme-environment/types.js'
 
+type DevFlags = InferredFlags<typeof Dev.flags>
+
 export default class Dev extends ThemeCommand {
   static summary =
     'Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to your terminal. While running, changes will push to the store in real time.'
@@ -124,30 +126,27 @@ You can run this command only in a directory that matches the [default Shopify t
     }),
   }
 
-  async run(): Promise<void> {
-    const parsed = await this.parse(Dev)
-    let flags = parsed.flags as typeof parsed.flags & FlagValues
-    const {ignore = [], only = []} = flags
-
-    validateThemePassword(flags.password)
+  static multiEnvironmentsFlags: RequiredFlags = null
 
-    const store = ensureThemeStore(flags)
-    const adminSession = await ensureAuthenticatedThemes(store, flags.password)
+  async command(devFlags: DevFlags, adminSession: AdminSession) {
+    const {ignore = [], only = []} = devFlags
 
+    validateThemePassword(devFlags.password)
     recordEvent('theme-command:dev:single-env:authenticated')
 
     let theme: Theme
+    let flags
 
-    if (flags.theme) {
-      const filter = {filter: {theme: flags.theme}}
+    if (devFlags.theme) {
+      const filter = {filter: {theme: devFlags.theme}}
       theme = await findOrSelectTheme(adminSession, filter)
 
-      flags = {...flags, theme: theme.id.toString()}
+      flags = {...devFlags, theme: theme.id.toString(), store: adminSession.storeFqdn}
     } else {
       theme = await new DevelopmentThemeManager(adminSession).findOrCreate()
-      const overwriteJson = flags['theme-editor-sync'] && theme.createdAtRuntime
+      const overwriteJson = devFlags['theme-editor-sync'] && theme.createdAtRuntime
 
-      flags = {...flags, theme: theme.id.toString(), 'overwrite-json': overwriteJson}
+      flags = {...devFlags, theme: theme.id.toString(), store: adminSession.storeFqdn, 'overwrite-json': overwriteJson}
     }
 
     const confirmed = await ensureLiveThemeConfirmed(theme, 'start development mode')
@@ -158,7 +157,7 @@ You can run this command only in a directory that matches the [default Shopify t
     await dev({
       adminSession,
       directory: flags.path,
-      store,
+      store: flags.store,
       password: flags.password,
       storePassword: flags['store-password'],
       theme,

packages/theme/src/cli/commands/theme/language-server.ts

@@ -13,8 +13,7 @@ export default class LanguageServer extends ThemeCommand {
     ...globalFlags,
   }
 
-  async run(): Promise<void> {
-    await this.parse(LanguageServer)
+  async command() {
     startServer()
   }
 }

packages/theme/src/cli/commands/theme/metafields/pull.ts

@@ -1,8 +1,11 @@
 import {themeFlags} from '../../../flags.js'
 import {metafieldsPull, MetafieldsPullFlags} from '../../../services/metafields-pull.js'
-import ThemeCommand from '../../../utilities/theme-command.js'
+import ThemeCommand, {RequiredFlags} from '../../../utilities/theme-command.js'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
 import {Flags} from '@oclif/core'
+import {InferredFlags} from '@oclif/core/interfaces'
+
+type MetafieldsFlags = InferredFlags<typeof MetafieldsPull.flags>
 
 export default class MetafieldsPull extends ThemeCommand {
   static summary = 'Download metafields definitions from your shop into a local file.'
@@ -24,8 +27,9 @@ If the metafields file already exists, it will be overwritten.`
     }),
   }
 
-  async run(): Promise<void> {
-    const {flags} = await this.parse(MetafieldsPull)
+  static multiEnvironmentsFlags: RequiredFlags = null
+
+  async command(flags: MetafieldsFlags) {
     const args: MetafieldsPullFlags = {
       path: flags.path,
       password: flags.password,

packages/theme/src/cli/commands/theme/open.ts

@@ -1,11 +1,12 @@
-import {ensureThemeStore} from '../../utilities/theme-store.js'
-import ThemeCommand from '../../utilities/theme-command.js'
+import ThemeCommand, {RequiredFlags} from '../../utilities/theme-command.js'
 import {themeFlags} from '../../flags.js'
 import {open} from '../../services/open.js'
 import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
-import {ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
+import {AdminSession} from '@shopify/cli-kit/node/session'
+import {InferredFlags} from '@oclif/core/interfaces'
 
+type OpenFlags = InferredFlags<typeof Open.flags>
 export default class Open extends ThemeCommand {
   static summary = 'Opens the preview of your remote theme.'
 
@@ -43,11 +44,9 @@ export default class Open extends ThemeCommand {
     }),
   }
 
-  async run(): Promise<void> {
-    const {flags} = await this.parse(Open)
-    const store = ensureThemeStore(flags)
-    const adminSession = await ensureAuthenticatedThemes(store, flags.password)
+  static multiEnvironmentsFlags: RequiredFlags = null
 
+  async command(flags: OpenFlags, adminSession: AdminSession) {
     await open(adminSession, flags)
   }
 }

packages/theme/src/cli/commands/theme/package.ts

@@ -2,7 +2,9 @@ import {themeFlags} from '../../flags.js'
 import ThemeCommand from '../../utilities/theme-command.js'
 import {packageTheme} from '../../services/package.js'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
+import {InferredFlags} from '@oclif/core/interfaces'
 
+type PackageFlags = InferredFlags<typeof Package.flags>
 export default class Package extends ThemeCommand {
   static summary = 'Package your theme into a .zip file, ready to upload to the Online Store.'
 
@@ -21,8 +23,7 @@ export default class Package extends ThemeCommand {
     path: themeFlags.path,
   }
 
-  async run(): Promise<void> {
-    const {flags} = await this.parse(Package)
+  async command(flags: PackageFlags) {
     await packageTheme(flags.path)
   }
 }

packages/theme/src/cli/commands/theme/profile.ts

@@ -1,15 +1,16 @@
 import {themeFlags} from '../../flags.js'
-import ThemeCommand from '../../utilities/theme-command.js'
+import ThemeCommand, {RequiredFlags} from '../../utilities/theme-command.js'
 import {profile} from '../../services/profile.js'
-import {ensureThemeStore} from '../../utilities/theme-store.js'
 import {findOrSelectTheme} from '../../utilities/theme-selector.js'
 import {renderTasksToStdErr} from '../../utilities/theme-ui.js'
 import {validateThemePassword} from '../../services/flags-validation.js'
-import {ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
 import {Flags} from '@oclif/core'
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 import {Task} from '@shopify/cli-kit/node/ui'
+import {InferredFlags} from '@oclif/core/interfaces'
+import {AdminSession} from '@shopify/cli-kit/node/session'
 
+type ProfileFlags = InferredFlags<typeof Profile.flags>
 export default class Profile extends ThemeCommand {
   static summary = 'Profile the Liquid rendering of a theme page.'
 
@@ -41,15 +42,13 @@ export default class Profile extends ThemeCommand {
     ...jsonFlag,
   }
 
-  async run(): Promise<void> {
-    const {flags} = await this.parse(Profile)
+  static multiEnvironmentsFlags: RequiredFlags = null
 
-    validateThemePassword(flags.password)
-
-    const store = ensureThemeStore(flags)
+  async command(flags: ProfileFlags, adminSession: AdminSession) {
     const {password: themeAccessPassword} = flags
 
-    const adminSession = await ensureAuthenticatedThemes(store, themeAccessPassword)
+    validateThemePassword(themeAccessPassword)
+
     let filter
     if (flags.theme) {
       filter = {filter: {theme: flags.theme}}
@@ -60,7 +59,7 @@ export default class Profile extends ThemeCommand {
 
     const tasks: Task[] = [
       {
-        title: `Generating Liquid profile for ${store + flags.url}`,
+        title: `Generating Liquid profile for ${adminSession.storeFqdn} ${flags.url}`,
         task: async () => {
           await profile(
             adminSession,

packages/theme/src/cli/utilities/theme-command.test.ts

@@ -4,10 +4,10 @@ import {describe, vi, expect, test, beforeEach} from 'vitest'
 import {Config, Flags} from '@oclif/core'
 import {AdminSession, ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session'
 import {loadEnvironment} from '@shopify/cli-kit/node/environments'
-import {renderConcurrent, renderConfirmationPrompt, renderError} from '@shopify/cli-kit/node/ui'
 import {fileExistsSync} from '@shopify/cli-kit/node/fs'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {resolvePath} from '@shopify/cli-kit/node/path'
+import {renderConcurrent, renderConfirmationPrompt, renderError, renderWarning} from '@shopify/cli-kit/node/ui'
 import type {Writable} from 'stream'
 
 vi.mock('@shopify/cli-kit/node/session')
@@ -120,6 +120,10 @@ class TestUnauthenticatedThemeCommand extends ThemeCommand {
   }
 }
 
+class TestNoMultiEnvThemeCommand extends TestThemeCommand {
+  static multiEnvironmentsFlags: RequiredFlags = null
+}
+
 describe('ThemeCommand', () => {
   let mockSession: AdminSession
 
@@ -227,6 +231,31 @@ describe('ThemeCommand', () => {
       await expect(command.run()).rejects.toThrow(AbortError)
       expect(fileExistsSync).toHaveBeenCalledWith('current/working/directory')
     })
+
+    test('multiple environments provided - displays warning if not allowed', async () => {
+      // Given
+      const environmentConfig = {store: 'store.myshopify.com'}
+      vi.mocked(loadEnvironment).mockResolvedValue(environmentConfig)
+      vi.mocked(ensureAuthenticatedThemes).mockResolvedValue(mockSession)
+
+      vi.mocked(renderConcurrent).mockResolvedValue(undefined)
+
+      await CommandConfig.load()
+      const command = new TestNoMultiEnvThemeCommand(
+        ['--environment', 'development', '--environment', 'staging'],
+        CommandConfig,
+      )
+
+      // When
+      await command.run()
+
+      // Then
+      expect(renderWarning).toHaveBeenCalledWith(
+        expect.objectContaining({
+          body: 'This command does not support multiple environments.',
+        }),
+      )
+    })
   })
 
   describe('multi environment', () => {