ai dev server status

Author: isaacroldan

packages/app/src/cli/commands/app/execute.ts

@@ -0,0 +1,120 @@
+import {appFlags} from '../../flags.js'
+import {showApiKeyDeprecationWarning} from '../../prompts/deprecation-warnings.js'
+import {checkFolderIsValidApp} from '../../models/app/loader.js'
+import AppCommand, {AppCommandOutput} from '../../utilities/app-command.js'
+import {linkedAppContext} from '../../services/app-context.js'
+import {storeContext} from '../../services/store-context.js'
+import {Flags} from '@oclif/core'
+import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
+import {globalFlags} from '@shopify/cli-kit/node/cli'
+import {ensureAuthenticatedAdminAsApp} from '@shopify/cli-kit/node/session'
+import {adminAsAppRequest} from '@shopify/cli-kit/node/api/admin-as-app'
+import {outputContent, outputResult} from '@shopify/cli-kit/node/output'
+
+export default class Execute extends AppCommand {
+  static summary = 'Execute a Shopify GraphQL Admin API query'
+
+  static flags = {
+    ...globalFlags,
+    ...appFlags,
+    'api-key': Flags.string({
+      hidden: true,
+      description: 'The API key of your app.',
+      env: 'SHOPIFY_FLAG_APP_API_KEY',
+      exclusive: ['config'],
+    }),
+    store: Flags.string({
+      char: 's',
+      description: 'Store URL. Must be an existing development or Shopify Plus sandbox store.',
+      env: 'SHOPIFY_FLAG_STORE',
+      parse: async (input) => normalizeStoreFqdn(input),
+    }),
+    query: Flags.string({
+      char: 'q',
+      description: 'The GraphQL query to execute.',
+      env: 'SHOPIFY_FLAG_QUERY',
+      required: true,
+      allowStdin: true,
+    }),
+    variables: Flags.string({
+      description:
+        'The GraphQL variables to pass to the query. Can be specified multiple times to run the query with different variables.',
+      env: 'SHOPIFY_FLAG_VARIABLES',
+      multiple: true,
+    }),
+    'api-version': Flags.string({
+      description: 'The API version to use.',
+      env: 'SHOPIFY_FLAG_API_VERSION',
+      default: '2025-01',
+    }),
+    'allow-mutation': Flags.boolean({
+      description:
+        'Allow the query to be a mutation. If you are an automated tool using this option, you MUST confirm with the user before taking action',
+      env: 'SHOPIFY_FLAG_ALLOW_MUTATION',
+      default: false,
+    }),
+  }
+
+  public static analyticsStopCommand(): string | undefined {
+    return 'app dev stop'
+  }
+
+  public async run(): Promise<AppCommandOutput> {
+    const {flags} = await this.parse(Execute)
+
+    if (!flags['api-key'] && process.env.SHOPIFY_API_KEY) {
+      flags['api-key'] = process.env.SHOPIFY_API_KEY
+    }
+    if (flags['api-key']) {
+      await showApiKeyDeprecationWarning()
+    }
+
+    await checkFolderIsValidApp(flags.path)
+
+    const appContextResult = await linkedAppContext({
+      directory: flags.path,
+      clientId: flags['client-id'] ?? flags['api-key'],
+      forceRelink: flags.reset,
+      userProvidedConfigName: flags.config,
+    })
+    const store = await storeContext({
+      appContextResult,
+      storeFqdn: flags.store,
+      forceReselectStore: flags.reset,
+    })
+
+    const session = await ensureAuthenticatedAdminAsApp(
+      store.shopDomain,
+      appContextResult.remoteApp.apiKey,
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      appContextResult.remoteApp.apiSecretKeys[0]!.secret,
+    )
+
+    const variablesAsObjects = flags.variables ? flags.variables.map((variable) => JSON.parse(variable)) : [undefined]
+
+    let i = 0
+    for (const variable of variablesAsObjects) {
+      // eslint-disable-next-line no-await-in-loop
+      const result = await adminAsAppRequest(
+        flags.query,
+        flags['allow-mutation'],
+        session,
+        flags['api-version'],
+        variable,
+      )
+
+      if (result.status === 'blocked') {
+        outputResult(outputContent`Use the --allow-mutation flag to execute mutations.`)
+        return {app: appContextResult.app}
+      } else {
+        if (flags.variables !== undefined && flags.variables.length > 0) {
+          outputResult(`${i}:`)
+        }
+        outputResult(outputContent`${JSON.stringify(result.data, null, 2)}`)
+      }
+      i++
+    }
+
+    return {app: appContextResult.app}
+  }
+}

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

@@ -24,10 +24,16 @@ export default class Init extends AppCommand {
   static flags = {
     ...globalFlags,
     name: Flags.string({
+      description: 'The name of the app.',
       char: 'n',
       env: 'SHOPIFY_FLAG_NAME',
       hidden: false,
     }),
+    organization: Flags.string({
+      description: 'The ID of the organization to create the app in. You must have access to this organization.',
+      env: 'SHOPIFY_FLAG_ORGANIZATION',
+      hidden: false,
+    }),
     path: Flags.string({
       char: 'p',
       env: 'SHOPIFY_FLAG_PATH',
@@ -62,13 +68,17 @@ export default class Init extends AppCommand {
       description:
         'The Client ID of your app. Use this to automatically link your new project to an existing app. Using this flag avoids the app selection prompt.',
       env: 'SHOPIFY_FLAG_CLIENT_ID',
-      exclusive: ['config'],
+      exclusive: ['config', 'organization'],
     }),
   }
 
   async run(): Promise<AppCommandOutput> {
     const {flags} = await this.parse(Init)
 
+    // Allow template and flavor to fail when prompted
+    const requiredNonTTYFlags = ['name']
+    this.failMissingNonTTYFlags(flags, requiredNonTTYFlags)
+
     validateTemplateValue(flags.template)
     validateFlavorValue(flags.template, flags.flavor)
 
@@ -81,7 +91,9 @@ export default class Init extends AppCommand {
 
     const promptAnswers = await initPrompt({
       template: flags.template,
+      templateFlagName: Init.flags.template.name,
       flavor: flags.flavor,
+      flavorFlagName: Init.flags.flavor.name,
     })
 
     let selectAppResult: SelectAppOrNewAppNameResult
@@ -93,10 +105,19 @@ export default class Init extends AppCommand {
       developerPlatformClient = selectedApp.developerPlatformClient ?? developerPlatformClient
       selectAppResult = {result: 'existing', app: selectedApp}
     } else {
-      const org = await selectOrg()
-      developerPlatformClient = selectDeveloperPlatformClient({organization: org})
-      const {organization, apps, hasMorePages} = await developerPlatformClient.orgAndApps(org.id)
-      selectAppResult = await selectAppOrNewAppName(name, apps, hasMorePages, organization, developerPlatformClient)
+      const org = await selectOrg({
+        organization: flags.organization,
+        flagName: Init.flags.organization.name,
+      })
+      if (flags.organization && flags.name) {
+        // No client id provided, and organization and name flags are provided
+        // Assume the user wants to create a new app in the given organization
+        selectAppResult = {result: 'new', name, org}
+      } else {
+        developerPlatformClient = selectDeveloperPlatformClient({organization: org})
+        const {organization, apps, hasMorePages} = await developerPlatformClient.orgAndApps(org.id)
+        selectAppResult = await selectAppOrNewAppName(name, apps, hasMorePages, organization, developerPlatformClient)
+      }
       appName = selectAppResult.result === 'new' ? selectAppResult.name : selectAppResult.app.title
     }
 

packages/app/src/cli/constants.ts

@@ -42,6 +42,7 @@ export const blocks = {
 export const ports = {
   graphiql: 3457,
   localhost: 3458,
+  devStatusServer: 3459,
 } as const
 
 export const EsbuildEnvVarRegex = /^([a-zA-Z_$])([a-zA-Z0-9_$])*$/

packages/app/src/cli/index.ts

@@ -27,6 +27,7 @@ import gatherPublicMetadata from './hooks/public_metadata.js'
 import gatherSensitiveMetadata from './hooks/sensitive_metadata.js'
 import AppCommand from './utilities/app-command.js'
 import DevClean from './commands/app/dev/clean.js'
+import Execute from './commands/app/execute.js'
 
 /**
  * All app commands should extend AppCommand.
@@ -57,6 +58,7 @@ export const commands: {[key: string]: typeof AppCommand} = {
   'app:webhook:trigger': WebhookTrigger,
   'webhook:trigger': WebhookTriggerDeprecated,
   'demo:watcher': DemoWatcher,
+  'app:execute': Execute,
 }
 
 export const AppSensitiveMetadataHook = gatherSensitiveMetadata

packages/app/src/cli/prompts/dev.ts

@@ -20,7 +20,17 @@ import {
 } from '@shopify/cli-kit/node/ui'
 import {outputCompleted} from '@shopify/cli-kit/node/output'
 
-export async function selectOrganizationPrompt(organizations: Organization[]): Promise<Organization> {
+interface SelectOrganizationPromptOptions {
+  organizations: Organization[]
+  flagName?: string
+  flagValues?: string[]
+}
+
+export async function selectOrganizationPrompt({
+  organizations,
+  flagName,
+  flagValues,
+}: SelectOrganizationPromptOptions): Promise<Organization> {
   if (organizations.length === 1) {
     return organizations[0]!
   }
@@ -43,6 +53,8 @@ export async function selectOrganizationPrompt(organizations: Organization[]): P
   const id = await renderAutocompletePrompt({
     message: `Which organization is this work for?`,
     choices: orgList,
+    flagName,
+    flagValues,
   })
   return organizations.find((org) => org.id === id)!
 }

packages/app/src/cli/prompts/generate/extension.ts

@@ -81,10 +81,14 @@ const generateExtensionPrompts = async (
       throw new AbortError('You have reached the limit for the number of extensions you can create.')
     }
 
+    const choices = buildChoices(extensionTemplates, options.unavailableExtensions)
+
     // eslint-disable-next-line require-atomic-updates
     templateType = await renderAutocompletePrompt({
       message: 'Type of extension?',
-      choices: buildChoices(extensionTemplates, options.unavailableExtensions),
+      choices,
+      flagName: 'template',
+      flagValues: choices.map((choice) => choice.value),
     })
   }
 
@@ -109,6 +113,7 @@ async function promptName(directory: string, defaultName: string, number = 1): P
   return renderTextPrompt({
     message: 'Name your extension:',
     defaultValue: name,
+    flagName: 'name',
   })
 }
 
@@ -130,6 +135,8 @@ async function promptFlavor(extensionTemplate: ExtensionTemplate): Promise<Exten
       }
     }),
     defaultValue: 'react',
+    flagName: 'flavor',
+    flagValues: extensionTemplate.supportedFlavors.map((choice) => choice.value),
   })
 }
 

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

@@ -3,7 +3,9 @@ import {renderSelectPrompt} from '@shopify/cli-kit/node/ui'
 
 export interface InitOptions {
   template?: string
+  templateFlagName?: string
   flavor?: string
+  flavorFlagName?: string
 }
 
 interface InitOutput {
@@ -92,6 +94,8 @@ const init = async (options: InitOptions): Promise<InitOutput> => {
       }),
       message: 'Get started building your app:',
       defaultValue: allTemplates.find((key) => templates[key].url === defaults.template),
+      flagName: options.templateFlagName,
+      flagValues: templateOptionsInOrder.map((option) => option),
     })
   }
 
@@ -118,6 +122,8 @@ const init = async (options: InitOptions): Promise<InitOutput> => {
             value: branch.branch,
             label: branch.label,
           })),
+          flagName: options.flavorFlagName,
+          flagValues: Object.keys(selectedTemplate.branches.options),
         })
       }
     }

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

@@ -282,14 +282,33 @@ export async function fetchOrCreateOrganizationApp(options: CreateAppOptions): P
   return remoteApp
 }
 
+interface SelectOrgOptions {
+  organization?: string
+  flagName?: string
+}
+
 /**
  * Fetch all orgs the user belongs to and show a prompt to select one of them
  * @param developerPlatformClient - The client to access the platform API
  * @returns The selected organization ID
  */
-export async function selectOrg(): Promise<Organization> {
+export async function selectOrg({organization, flagName}: SelectOrgOptions = {}): Promise<Organization> {
   const orgs = await fetchOrganizations()
-  const org = await selectOrganizationPrompt(orgs)
+  if (organization) {
+    const matchingOrgs = orgs.filter((org) => org.id === organization)
+    if (matchingOrgs.length === 0) {
+      throw new AbortError(`Organization not found: ${organization}`)
+    }
+    if (matchingOrgs.length > 1) {
+      throw new AbortError(`Multiple organizations found with ID: ${organization}`)
+    }
+    return matchingOrgs[0] as Organization
+  }
+  const org = await selectOrganizationPrompt({
+    organizations: orgs,
+    flagName,
+    flagValues: orgs.map((org) => `${org.id} (${org.businessName})`),
+  })
   return org
 }
 

packages/app/src/cli/services/dev/app-events/app-event-watcher.ts

@@ -204,6 +204,16 @@ export class AppEventWatcher extends EventEmitter {
     return this
   }
 
+  /**
+   * Get the current app instance.
+   * This will be the latest version of the app after any reloads due to configuration changes.
+   *
+   * @returns The current app instance
+   */
+  get currentApp(): AppLinkedInterface {
+    return this.app
+  }
+
   onError(listener: (error: Error) => Promise<void> | void) {
     // eslint-disable-next-line @typescript-eslint/no-misused-promises
     this.addListener('error', listener)

packages/app/src/cli/services/dev/processes/dev-session/dev-session-process.ts

@@ -3,7 +3,8 @@ import {DevSession} from './dev-session.js'
 import {BaseProcess, DevProcessFunction} from '../types.js'
 import {DeveloperPlatformClient} from '../../../../utilities/developer-platform-client.js'
 import {AppLinkedInterface} from '../../../../models/app/app.js'
-import {AppEventWatcher} from '../../app-events/app-event-watcher.js'
+import {AppEvent, AppEventWatcher} from '../../app-events/app-event-watcher.js'
+import {SerialBatchProcessor} from '@shopify/cli-kit/node/serial-batch-processor'
 
 export interface DevSessionProcessOptions {
   developerPlatformClient: DeveloperPlatformClient
@@ -17,6 +18,7 @@ export interface DevSessionProcessOptions {
   appPreviewURL: string
   appLocalProxyURL: string
   devSessionStatusManager: DevSessionStatusManager
+  appEventsProcessor: SerialBatchProcessor<AppEvent>
 }
 
 export interface DevSessionProcess extends BaseProcess<DevSessionProcessOptions> {