Add store command shop id analytics

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

@@ -177,7 +177,8 @@ export function createRuntimeMetadataContainer<
 
 // We want to track anything that ends up getting sent to monorail as `cmd_all_*`,
 // `cmd_app_*`, `cmd_theme_*`, `store_*`, and `env_auto_upgrade_*`
-type CmdFieldsFromMonorail = PickByPrefix<MonorailEventPublic, 'cmd_all_'> &
+type CmdFieldsFromMonorail = Pick<MonorailEventPublic, 'shop_id'> &
+  PickByPrefix<MonorailEventPublic, 'cmd_all_'> &
   PickByPrefix<MonorailEventPublic, 'cmd_app_'> &
   PickByPrefix<MonorailEventPublic, 'cmd_create_app_'> &
   PickByPrefix<MonorailEventPublic, 'cmd_theme_'> &

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

@@ -10,7 +10,7 @@ const url = 'https://monorail-edge.shopifysvc.com/v1/produce'
 type Optional<T> = T | null
 
 // This is the topic name of the main event we log to Monorail, the command tracker
-export const MONORAIL_COMMAND_TOPIC = 'app_cli3_command/1.22'
+export const MONORAIL_COMMAND_TOPIC = 'app_cli3_command/1.23'
 
 export interface Schemas {
   [MONORAIL_COMMAND_TOPIC]: {
@@ -45,6 +45,7 @@ export interface Schemas {
       node_version: string
       is_employee: boolean
       store_fqdn_hash?: Optional<string>
+      shop_id?: Optional<number>
       user_id: string
 
       // Any and all commands

packages/store/src/cli/services/store/auth/index.test.ts

@@ -1,7 +1,7 @@
 import {authenticateStoreWithApp} from './index.js'
 import {setStoredStoreAppSession} from './session-store.js'
 import {STORE_AUTH_APP_CLIENT_ID} from './config.js'
-import {recordStoreCommandUserId} from '../metrics.js'
+import {recordStoreCommandShopIdFromAdminApi, recordStoreCommandUserId} from '../metrics.js'
 import {describe, expect, test, vi} from 'vitest'
 
 vi.mock('./session-store.js')
@@ -55,6 +55,7 @@ describe('store auth service', () => {
     )
     expect(presenter.success).toHaveBeenCalledWith(result)
     expect(recordStoreCommandUserId).toHaveBeenCalledWith('42')
+    expect(recordStoreCommandShopIdFromAdminApi).toHaveBeenCalledWith({store: 'shop.myshopify.com', accessToken: 'token'})
 
     const storedSession = vi.mocked(setStoredStoreAppSession).mock.calls[0]![0]
     expect(storedSession.store).toBe('shop.myshopify.com')

packages/store/src/cli/services/store/auth/index.ts

@@ -6,7 +6,7 @@ import {createPkceBootstrap} from './pkce.js'
 import {mergeRequestedAndStoredScopes, parseStoreAuthScopes, resolveGrantedScopes} from './scopes.js'
 import {resolveExistingStoreAuthScopes, type ResolvedStoreAuthScopes} from './existing-scopes.js'
 import {createStoreAuthPresenter, type StoreAuthPresenter, type StoreAuthResult} from './result.js'
-import {recordStoreCommandUserId} from '../metrics.js'
+import {recordStoreCommandShopIdFromAdminApi, recordStoreCommandUserId} from '../metrics.js'
 import {openURL} from '@shopify/cli-kit/node/system'
 import {outputContent, outputDebug, outputToken} from '@shopify/cli-kit/node/output'
 import {AbortError} from '@shopify/cli-kit/node/error'
@@ -75,6 +75,7 @@ export async function authenticateStoreWithApp(
     throw new AbortError('Shopify did not return associated user information for the online access token.')
   }
   recordStoreCommandUserId(userId)
+  await recordStoreCommandShopIdFromAdminApi({store, accessToken: tokenResponse.access_token})
 
   const now = Date.now()
   const expiresAt = tokenResponse.expires_in ? new Date(now + tokenResponse.expires_in * 1000).toISOString() : undefined

packages/store/src/cli/services/store/execute/admin-context.test.ts

@@ -2,7 +2,7 @@ import {prepareAdminStoreGraphQLContext} from './admin-context.js'
 import {fetchPublicApiVersions} from './admin-transport.js'
 import {loadStoredStoreSession} from '../auth/session-lifecycle.js'
 import {STORE_AUTH_APP_CLIENT_ID} from '../auth/config.js'
-import {recordStoreCommandUserId} from '../metrics.js'
+import {recordStoreCommandShopIdFromAdminApi, recordStoreCommandUserId} from '../metrics.js'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {beforeEach, describe, expect, test, vi} from 'vitest'
 
@@ -86,6 +86,7 @@ describe('prepareAdminStoreGraphQLContext', () => {
       session: storedSession,
     })
     expect(fetchPublicApiVersions).not.toHaveBeenCalled()
+    expect(recordStoreCommandShopIdFromAdminApi).toHaveBeenCalledWith({store, accessToken: 'token'})
   })
 
   test('throws when the requested API version is invalid', async () => {

packages/store/src/cli/services/store/execute/admin-context.ts

@@ -1,6 +1,6 @@
 import {fetchPublicApiVersions} from './admin-transport.js'
 import {loadStoredStoreSession} from '../auth/session-lifecycle.js'
-import {recordStoreCommandUserId} from '../metrics.js'
+import {recordStoreCommandShopIdFromAdminApi, recordStoreCommandUserId} from '../metrics.js'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import type {AdminSession} from '@shopify/cli-kit/node/session'
 import type {StoredStoreAppSession} from '../auth/session-store.js'
@@ -44,6 +44,9 @@ export async function prepareAdminStoreGraphQLContext(input: {
     storeFqdn: session.store,
   }
   const version = await resolveApiVersion({session, adminSession, userSpecifiedVersion: input.userSpecifiedVersion})
+  if (version === 'unstable') {
+    await recordStoreCommandShopIdFromAdminApi({store: session.store, accessToken: session.accessToken})
+  }
 
   return {adminSession, version, session}
 }

packages/store/src/cli/services/store/execute/admin-transport.test.ts

@@ -6,13 +6,15 @@ import {
 } from './admin-transport.js'
 import {clearStoredStoreAppSession} from '../auth/session-store.js'
 import {STORE_AUTH_APP_CLIENT_ID} from '../auth/config.js'
+import {recordStoreCommandShopIdFromAdminGid} from '../metrics.js'
 import {beforeEach, describe, expect, test, vi} from 'vitest'
 import {adminUrl} from '@shopify/cli-kit/node/api/admin'
 import {graphqlRequest} from '@shopify/cli-kit/node/api/graphql'
 import {AbortError, BugError} from '@shopify/cli-kit/node/error'
 import {renderSingleTask} from '@shopify/cli-kit/node/ui'
 
 vi.mock('../auth/session-store.js')
+vi.mock('../metrics.js')
 vi.mock('@shopify/cli-kit/node/api/graphql')
 vi.mock('@shopify/cli-kit/node/ui')
 vi.mock('@shopify/cli-kit/node/api/admin', async () => {
@@ -188,6 +190,7 @@ describe('fetchPublicApiVersions', () => {
         {handle: '2025-10', supported: true},
         {handle: '2025-07', supported: true},
       ],
+      shop: {id: 'gid://shopify/Shop/123'},
     })
 
     const result = await fetchPublicApiVersions({adminSession, session})
@@ -196,6 +199,7 @@ describe('fetchPublicApiVersions', () => {
       {handle: '2025-10', supported: true},
       {handle: '2025-07', supported: true},
     ])
+    expect(recordStoreCommandShopIdFromAdminGid).toHaveBeenCalledWith('gid://shopify/Shop/123')
     expect(adminUrl).toHaveBeenCalledWith(store, 'unstable', adminSession)
     expect(graphqlRequest).toHaveBeenCalledWith(
       expect.objectContaining({

packages/store/src/cli/services/store/execute/admin-transport.ts

@@ -1,5 +1,6 @@
 import {throwReauthenticateStoreAuthError} from '../auth/recovery.js'
 import {clearStoredStoreAppSession} from '../auth/session-store.js'
+import {recordStoreCommandShopIdFromAdminGid} from '../metrics.js'
 import {adminUrl} from '@shopify/cli-kit/node/api/admin'
 import {graphqlRequest} from '@shopify/cli-kit/node/api/graphql'
 import {AbortError} from '@shopify/cli-kit/node/error'
@@ -15,12 +16,22 @@ interface ApiVersion {
   supported: boolean
 }
 
+interface PublicApiVersionsResponse {
+  publicApiVersions: ApiVersion[]
+  shop?: {
+    id?: string
+  }
+}
+
 const PUBLIC_API_VERSIONS_QUERY = `
   query StoreExecutePublicApiVersions {
     publicApiVersions {
       handle
       supported
     }
+    shop {
+      id
+    }
   }
 `
 
@@ -34,13 +45,14 @@ export async function fetchPublicApiVersions(input: {
   session: StoredStoreAppSession
 }): Promise<ApiVersion[]> {
   try {
-    const response = await graphqlRequest<{publicApiVersions: ApiVersion[]}>({
+    const response = await graphqlRequest<PublicApiVersionsResponse>({
       query: PUBLIC_API_VERSIONS_QUERY,
       api: 'Admin',
       url: adminUrl(input.adminSession.storeFqdn, 'unstable', input.adminSession),
       token: input.adminSession.token,
       responseOptions: {handleErrors: false},
     })
+    await recordStoreCommandShopIdFromAdminGid(response.shop?.id)
     return response.publicApiVersions
   } catch (error) {
     const status = graphQLClientErrorStatus(error)

packages/store/src/cli/services/store/metrics.test.ts

@@ -1,16 +1,26 @@
-import {recordStoreCommandUserId, recordStoreFqdnMetadata} from './metrics.js'
+import {
+  recordStoreCommandShopIdFromAdminApi,
+  recordStoreCommandShopIdFromAdminGid,
+  recordStoreCommandUserId,
+  recordStoreFqdnMetadata,
+} from './metrics.js'
+import {adminUrl} from '@shopify/cli-kit/node/api/admin'
+import {graphqlRequest} from '@shopify/cli-kit/node/api/graphql'
 import {hashString} from '@shopify/cli-kit/node/crypto'
 import {addPublicMetadata} from '@shopify/cli-kit/node/metadata'
 import {setLastSeenUserId} from '@shopify/cli-kit/node/session'
 import {beforeEach, describe, expect, test, vi} from 'vitest'
 
+vi.mock('@shopify/cli-kit/node/api/admin')
+vi.mock('@shopify/cli-kit/node/api/graphql')
 vi.mock('@shopify/cli-kit/node/crypto')
 vi.mock('@shopify/cli-kit/node/metadata')
 vi.mock('@shopify/cli-kit/node/session')
 
 describe('store command metrics', () => {
   beforeEach(() => {
     vi.clearAllMocks()
+    vi.mocked(adminUrl).mockReturnValue('https://shop.myshopify.com/admin/api/unstable/graphql.json')
     vi.mocked(hashString).mockReturnValue('hashed-store')
   })
 
@@ -27,4 +37,34 @@ describe('store command metrics', () => {
 
     expect(setLastSeenUserId).toHaveBeenCalledWith('42')
   })
+
+  test('records numeric shop_id from an Admin Shop gid', async () => {
+    await recordStoreCommandShopIdFromAdminGid('gid://shopify/Shop/123')
+
+    expect(addPublicMetadata).toHaveBeenCalledWith(expect.any(Function))
+    expect(vi.mocked(addPublicMetadata).mock.calls[0]![0]()).toEqual({shop_id: 123})
+  })
+
+  test('ignores malformed Admin Shop gids', async () => {
+    await recordStoreCommandShopIdFromAdminGid('gid://shopify/Product/123')
+
+    expect(addPublicMetadata).not.toHaveBeenCalled()
+  })
+
+  test('fetches and records shop_id from the Admin API', async () => {
+    vi.mocked(graphqlRequest).mockResolvedValue({shop: {id: 'gid://shopify/Shop/456'}})
+
+    await recordStoreCommandShopIdFromAdminApi({store: 'shop.myshopify.com', accessToken: 'token'})
+
+    expect(adminUrl).toHaveBeenCalledWith('shop.myshopify.com', 'unstable')
+    expect(graphqlRequest).toHaveBeenCalledWith(
+      expect.objectContaining({
+        api: 'Admin',
+        token: 'token',
+        url: 'https://shop.myshopify.com/admin/api/unstable/graphql.json',
+        responseOptions: {handleErrors: false},
+      }),
+    )
+    expect(vi.mocked(addPublicMetadata).mock.calls[0]![0]()).toEqual({shop_id: 456})
+  })
 })

packages/store/src/cli/services/store/metrics.ts

@@ -1,6 +1,24 @@
+import {adminUrl} from '@shopify/cli-kit/node/api/admin'
+import {graphqlRequest} from '@shopify/cli-kit/node/api/graphql'
 import {hashString} from '@shopify/cli-kit/node/crypto'
 import {addPublicMetadata} from '@shopify/cli-kit/node/metadata'
+import {outputContent, outputDebug, outputToken} from '@shopify/cli-kit/node/output'
 import {setLastSeenUserId} from '@shopify/cli-kit/node/session'
+import {tryParseInt} from '@shopify/cli-kit/common/string'
+
+const STORE_ID_QUERY = `#graphql
+  query StoreCommandShopId {
+    shop {
+      id
+    }
+  }
+`
+
+interface StoreIdResponse {
+  shop?: {
+    id?: string
+  }
+}
 
 export async function recordStoreFqdnMetadata(storeFqdn: string): Promise<void> {
   await addPublicMetadata(() => ({store_fqdn_hash: hashString(storeFqdn)}))
@@ -9,3 +27,37 @@ export async function recordStoreFqdnMetadata(storeFqdn: string): Promise<void>
 export function recordStoreCommandUserId(userId: string): void {
   setLastSeenUserId(userId)
 }
+
+export async function recordStoreCommandShopIdFromAdminGid(shopGid: string | undefined): Promise<void> {
+  const shopId = numericIdFromShopGid(shopGid)
+  if (shopId === undefined) return
+
+  await addPublicMetadata(() => ({shop_id: shopId}))
+}
+
+export async function recordStoreCommandShopIdFromAdminApi(options: {
+  store: string
+  accessToken: string
+}): Promise<void> {
+  try {
+    const response = await graphqlRequest<StoreIdResponse>({
+      query: STORE_ID_QUERY,
+      api: 'Admin',
+      url: adminUrl(options.store, 'unstable'),
+      token: options.accessToken,
+      responseOptions: {handleErrors: false},
+    })
+    await recordStoreCommandShopIdFromAdminGid(response.shop?.id)
+  } catch (error) {
+    outputDebug(
+      outputContent`Failed to record store command shop_id for ${outputToken.raw(options.store)}: ${outputToken.raw(
+        error instanceof Error ? error.message : String(error),
+      )}`,
+    )
+  }
+}
+
+function numericIdFromShopGid(gid: string | undefined): number | undefined {
+  const id = gid?.match(/^gid:\/\/shopify\/Shop\/(\d+)$/)?.[1]
+  return tryParseInt(id)
+}