Inline store analytics user-id helper

Author: dmerand

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

@@ -1,11 +1,11 @@
 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 {setLastSeenUserId} from '@shopify/cli-kit/node/session'
 import {describe, expect, test, vi} from 'vitest'
 
 vi.mock('./session-store.js')
-vi.mock('../metrics.js')
+vi.mock('@shopify/cli-kit/node/session')
 vi.mock('@shopify/cli-kit/node/system', () => ({openURL: vi.fn().mockResolvedValue(true)}))
 vi.mock('@shopify/cli-kit/node/crypto', () => ({randomUUID: vi.fn().mockReturnValue('state-123')}))
 
@@ -54,7 +54,7 @@ describe('store auth service', () => {
       }),
     )
     expect(presenter.success).toHaveBeenCalledWith(result)
-    expect(recordStoreCommandUserId).toHaveBeenCalledWith('42')
+    expect(setLastSeenUserId).toHaveBeenCalledWith('42')
 
     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 {setLastSeenUserId} from '@shopify/cli-kit/node/session'
 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'
@@ -74,7 +74,7 @@ export async function authenticateStoreWithApp(
   if (!userId) {
     throw new AbortError('Shopify did not return associated user information for the online access token.')
   }
-  recordStoreCommandUserId(userId)
+  setLastSeenUserId(userId)
 
   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,12 +2,12 @@ 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 {AbortError} from '@shopify/cli-kit/node/error'
+import {setLastSeenUserId} from '@shopify/cli-kit/node/session'
 import {beforeEach, describe, expect, test, vi} from 'vitest'
 
 vi.mock('../auth/session-lifecycle.js', () => ({loadStoredStoreSession: vi.fn()}))
-vi.mock('../metrics.js')
+vi.mock('@shopify/cli-kit/node/session')
 vi.mock('./admin-transport.js', () => ({
   fetchPublicApiVersions: vi.fn(),
   // runAdminStoreGraphQLOperation isn't exercised here, but we re-export it for type completeness.
@@ -39,7 +39,7 @@ describe('prepareAdminStoreGraphQLContext', () => {
     const result = await prepareAdminStoreGraphQLContext({store})
 
     expect(loadStoredStoreSession).toHaveBeenCalledWith(store)
-    expect(recordStoreCommandUserId).toHaveBeenCalledWith('42')
+    expect(setLastSeenUserId).toHaveBeenCalledWith('42')
     expect(fetchPublicApiVersions).toHaveBeenCalledWith({
       adminSession: {token: 'token', storeFqdn: store},
       session: storedSession,

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

@@ -1,7 +1,7 @@
 import {fetchPublicApiVersions} from './admin-transport.js'
 import {loadStoredStoreSession} from '../auth/session-lifecycle.js'
-import {recordStoreCommandUserId} from '../metrics.js'
 import {AbortError} from '@shopify/cli-kit/node/error'
+import {setLastSeenUserId} from '@shopify/cli-kit/node/session'
 import type {AdminSession} from '@shopify/cli-kit/node/session'
 import type {StoredStoreAppSession} from '../auth/session-store.js'
 
@@ -38,7 +38,7 @@ export async function prepareAdminStoreGraphQLContext(input: {
   userSpecifiedVersion?: string
 }): Promise<AdminStoreGraphQLContext> {
   const session = await loadStoredStoreSession(input.store)
-  recordStoreCommandUserId(session.userId)
+  setLastSeenUserId(session.userId)
   const adminSession = {
     token: session.accessToken,
     storeFqdn: session.store,

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

@@ -1,12 +1,10 @@
-import {recordStoreCommandUserId, recordStoreFqdnMetadata} from './metrics.js'
+import {recordStoreFqdnMetadata} from './metrics.js'
 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/crypto')
 vi.mock('@shopify/cli-kit/node/metadata')
-vi.mock('@shopify/cli-kit/node/session')
 
 describe('store command metrics', () => {
   beforeEach(() => {
@@ -22,9 +20,4 @@ describe('store command metrics', () => {
     expect(hashString).toHaveBeenCalledWith('shop.myshopify.com')
   })
 
-  test('sets the command analytics user id from store auth identity', () => {
-    recordStoreCommandUserId('42')
-
-    expect(setLastSeenUserId).toHaveBeenCalledWith('42')
-  })
 })

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

@@ -1,11 +1,6 @@
 import {hashString} from '@shopify/cli-kit/node/crypto'
 import {addPublicMetadata} from '@shopify/cli-kit/node/metadata'
-import {setLastSeenUserId} from '@shopify/cli-kit/node/session'
 
 export async function recordStoreFqdnMetadata(storeFqdn: string): Promise<void> {
   await addPublicMetadata(() => ({store_fqdn_hash: hashString(storeFqdn)}))
 }
-
-export function recordStoreCommandUserId(userId: string): void {
-  setLastSeenUserId(userId)
-}