Create app with latest api version

Author: jamieguerrero

packages/app/src/cli/utilities/developer-platform-client/app-management-client.test.ts

@@ -7,13 +7,19 @@ import {
   versionDeepLink,
 } from './app-management-client.js'
 import {OrganizationBetaFlagsQuerySchema} from './app-management-client/graphql/organization_beta_flags.js'
-import {testUIExtension, testRemoteExtensionTemplates, testOrganizationApp} from '../../models/app/app.test-data.js'
+import {
+  testUIExtension,
+  testRemoteExtensionTemplates,
+  testOrganizationApp,
+  testOrganization,
+} from '../../models/app/app.test-data.js'
 import {ExtensionInstance} from '../../models/extensions/extension-instance.js'
 import {ListApps} from '../../api/graphql/app-management/generated/apps.js'
 import {PublicApiVersionsQuery} from '../../api/graphql/webhooks/generated/public-api-versions.js'
 import {AvailableTopicsQuery} from '../../api/graphql/webhooks/generated/available-topics.js'
 import {CliTesting, CliTestingMutation} from '../../api/graphql/webhooks/generated/cli-testing.js'
 import {SendSampleWebhookVariables} from '../../services/webhook/request-sample.js'
+import {CreateApp} from '../../api/graphql/app-management/generated/create-app.js'
 import {describe, expect, test, vi} from 'vitest'
 import {CLI_KIT_VERSION} from '@shopify/cli-kit/common/version'
 import {fetch} from '@shopify/cli-kit/node/http'
@@ -295,6 +301,83 @@ describe('searching for apps', () => {
   })
 })
 
+describe('createApp', () => {
+  test('fetches latest stable API version for webhooks module', async () => {
+    // Given
+    const client = new AppManagementClient()
+    const org = testOrganization()
+    const mockedApiVersionResult: PublicApiVersionsQuery = {
+      publicApiVersions: [{handle: '2024-07'}, {handle: '2024-10'}, {handle: '2025-01'}, {handle: 'unstable'}],
+    }
+    vi.mocked(webhooksRequest).mockResolvedValueOnce(mockedApiVersionResult)
+    vi.mocked(appManagementRequestDoc).mockResolvedValueOnce({appCreate: {app: {id: '1', key: 'key'}, userErrors: []}})
+
+    // When
+    client.token = () => Promise.resolve('token')
+    await client.createApp(org, 'app-name')
+
+    // Then
+    expect(webhooksRequest).toHaveBeenCalledWith(org.id, expect.anything(), 'token', expect.any(Object))
+    expect(appManagementRequestDoc).toHaveBeenCalledWith(
+      org.id,
+      CreateApp,
+      'token',
+      expect.objectContaining({
+        appSource: {
+          appModules: expect.arrayContaining([
+            {
+              config: {
+                api_version: '2025-01',
+              },
+              specificationIdentifier: 'webhooks',
+              uid: 'webhooks',
+            },
+          ]),
+        },
+      }),
+    )
+  })
+
+  test('creates app successfully and returns expected app structure', async () => {
+    // Given
+    const appName = 'app-name'
+    const client = new AppManagementClient()
+    const org = testOrganization()
+    const expectedApp = {
+      id: '1',
+      key: 'api-key',
+      apiKey: 'api-key',
+      apiSecretKeys: [],
+      flags: [],
+      grantedScopes: [],
+      organizationId: '1',
+      title: appName,
+      newApp: true,
+      developerPlatformClient: expect.any(AppManagementClient),
+    }
+
+    vi.mocked(webhooksRequest).mockResolvedValueOnce({
+      publicApiVersions: [{handle: '2024-07'}, {handle: '2024-10'}, {handle: '2025-01'}, {handle: 'unstable'}],
+    })
+    vi.mocked(appManagementRequestDoc).mockResolvedValueOnce({
+      appCreate: {
+        app: {
+          id: expectedApp.id,
+          key: expectedApp.key,
+        },
+        userErrors: [],
+      },
+    })
+
+    // When
+    client.token = () => Promise.resolve('token')
+    const result = await client.createApp(org, appName)
+
+    // Then
+    expect(result).toMatchObject(expectedApp)
+  })
+})
+
 describe('apiVersions', () => {
   test('fetches available public API versions', async () => {
     // Given

packages/app/src/cli/utilities/developer-platform-client/app-management-client.ts

@@ -75,7 +75,6 @@ import {
 import {ListOrganizations} from '../../api/graphql/business-platform-destinations/generated/organizations.js'
 import {AppHomeSpecIdentifier} from '../../models/extensions/specifications/app_config_app_home.js'
 import {BrandingSpecIdentifier} from '../../models/extensions/specifications/app_config_branding.js'
-import {WebhooksSpecIdentifier} from '../../models/extensions/specifications/app_config_webhook.js'
 import {AppAccessSpecIdentifier} from '../../models/extensions/specifications/app_config_app_access.js'
 import {CONFIG_EXTENSION_IDS} from '../../models/extensions/extension-instance.js'
 import {DevSessionCreate, DevSessionCreateMutation} from '../../api/graphql/app-dev/generated/dev-session-create.js'
@@ -117,6 +116,7 @@ import {
   SchemaDefinitionByApiTypeQuery,
   SchemaDefinitionByApiTypeQueryVariables,
 } from '../../api/graphql/functions/generated/schema-definition-by-api-type.js'
+import {WebhooksSpecIdentifier} from '../../models/extensions/specifications/app_config_webhook.js'
 import {ensureAuthenticatedAppManagement, ensureAuthenticatedBusinessPlatform} from '@shopify/cli-kit/node/session'
 import {isUnitTest} from '@shopify/cli-kit/node/context/local'
 import {AbortError, BugError} from '@shopify/cli-kit/node/error'
@@ -369,7 +369,15 @@ export class AppManagementClient implements DeveloperPlatformClient {
       directory?: string
     },
   ): Promise<OrganizationApp> {
-    const variables = createAppVars(name, options?.isLaunchable, options?.scopesArray)
+    // Query for latest api version
+    const apiVersions = await this.apiVersions(org.id)
+    const apiVersion =
+      apiVersions.publicApiVersions
+        .filter((version) => version !== 'unstable')
+        .sort()
+        .at(-1) ?? 'unstable'
+
+    const variables = createAppVars(name, options?.isLaunchable, options?.scopesArray, apiVersion)
 
     const mutation = CreateApp
     const result = await appManagementRequestDoc(org.id, mutation, await this.token(), variables)
@@ -909,7 +917,12 @@ export class AppManagementClient implements DeveloperPlatformClient {
 const MAGIC_URL = 'https://shopify.dev/apps/default-app-home'
 const MAGIC_REDIRECT_URL = 'https://shopify.dev/apps/default-app-home/api/auth'
 
-function createAppVars(name: string, isLaunchable = true, scopesArray?: string[]): CreateAppMutationVariables {
+function createAppVars(
+  name: string,
+  isLaunchable = true,
+  scopesArray?: string[],
+  apiVersion?: string,
+): CreateAppMutationVariables {
   return {
     appSource: {
       appModules: [
@@ -932,7 +945,7 @@ function createAppVars(name: string, isLaunchable = true, scopesArray?: string[]
           // Change the uid to WebhooksSpecIdentifier
           uid: 'webhooks',
           specificationIdentifier: WebhooksSpecIdentifier,
-          config: {api_version: '2024-01'},
+          config: {api_version: apiVersion},
         },
         {
           // Change the uid to AppAccessSpecIdentifier