Merge pull request #6323 from Shopify/working-analytics-theme-commands

Fix monorail reporting for theme events

Author: EvilGenius13

.changeset/selfish-wombats-smoke.md

@@ -0,0 +1,5 @@
+---
+'@shopify/cli-kit': patch
+---
+
+Fix theme event reporting for monorail

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

@@ -2,7 +2,7 @@ import {isUnitTest} from './context/local.js'
 import {performance} from 'node:perf_hooks'
 import type {PickByPrefix} from '../common/ts/pick-by-prefix.js'
 import type {AnyJson} from '../../private/common/json.js'
-import type {MonorailEventPublic} from './monorail.js'
+import type {MonorailEventPublic, MonorailEventSensitive} from './monorail.js'
 
 type ProvideMetadata<T> = () => Partial<T> | Promise<Partial<T>>
 
@@ -175,11 +175,13 @@ export function createRuntimeMetadataContainer<
   }
 }
 
-// We want to track anything that ends up getting sent to monorail as `cmd_all_*` and
-// `cmd_app_*`
+// We want to track anything that ends up getting sent to monorail as `cmd_all_*`,
+// `cmd_app_*`, `cmd_theme_*`, and `store_*`
 type CmdFieldsFromMonorail = PickByPrefix<MonorailEventPublic, 'cmd_all_'> &
   PickByPrefix<MonorailEventPublic, 'cmd_app_'> &
-  PickByPrefix<MonorailEventPublic, 'cmd_create_app_'>
+  PickByPrefix<MonorailEventPublic, 'cmd_create_app_'> &
+  PickByPrefix<MonorailEventPublic, 'cmd_theme_'> &
+  PickByPrefix<MonorailEventPublic, 'store_'>
 
 const coreData = createRuntimeMetadataContainer<
   CmdFieldsFromMonorail,
@@ -190,7 +192,7 @@ const coreData = createRuntimeMetadataContainer<
       startTopic?: string
       startArgs: string[]
     }
-  } & {environmentFlags: string}
+  } & {environmentFlags: string} & PickByPrefix<MonorailEventSensitive, 'store_'>
 >({cmd_all_timing_network_ms: 0, cmd_all_timing_prompts_ms: 0})
 
 export const {getAllPublicMetadata, getAllSensitiveMetadata, addPublicMetadata, addSensitiveMetadata, runWithTimer} =

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

@@ -8,6 +8,7 @@ import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 import {outputResult} from '@shopify/cli-kit/node/output'
 import {renderInfo} from '@shopify/cli-kit/node/ui'
 import {OutputFlags} from '@oclif/core/interfaces'
+import {recordTiming} from '@shopify/cli-kit/node/analytics'
 
 type InfoFlags = OutputFlags<typeof Info.flags>
 
@@ -34,6 +35,7 @@ export default class Info extends ThemeCommand {
   static multiEnvironmentsFlags = ['store', 'password']
 
   async command(flags: InfoFlags, adminSession: AdminSession): Promise<void> {
+    recordTiming('theme-command:info')
     if (flags.theme || flags.development) {
       const output = await fetchThemeInfo(adminSession, flags)
       if (!output) {
@@ -50,5 +52,6 @@ export default class Info extends ThemeCommand {
       const infoMessage = await fetchDevInfo({cliVersion: this.config.version})
       renderInfo({customSections: infoMessage})
     }
+    recordTiming('theme-command:info')
   }
 }

packages/theme/src/cli/metadata.ts

@@ -1,6 +1,5 @@
 import {ensureThemeStore} from './theme-store.js'
 import {configurationFileName} from '../constants.js'
-import metadata from '../metadata.js'
 import {useThemeStoreContext} from '../services/local-storage.js'
 import {hashString} from '@shopify/cli-kit/node/crypto'
 import {Input} from '@oclif/core/interfaces'
@@ -15,7 +14,8 @@ import {
   renderError,
 } from '@shopify/cli-kit/node/ui'
 import {AbortController} from '@shopify/cli-kit/node/abort'
-import {recordEvent} from '@shopify/cli-kit/node/analytics'
+import {recordEvent, compileData} from '@shopify/cli-kit/node/analytics'
+import {addPublicMetadata, addSensitiveMetadata} from '@shopify/cli-kit/node/metadata'
 import type {Writable} from 'stream'
 
 export interface FlagValues {
@@ -93,6 +93,7 @@ export default abstract class ThemeCommand extends Command {
       recordEvent(`theme-command:${commandName}:single-env:authenticated`)
 
       await this.command(flags, session)
+      await this.logAnalyticsData(session)
       return
     }
 
@@ -288,7 +289,7 @@ export default abstract class ThemeCommand extends Command {
     const store = flags.store as string
     const password = flags.password as string
     const session = await ensureAuthenticatedThemes(ensureThemeStore({store}), password)
-    await this.logStoreMetadata(session)
+    await this.logAnalyticsData(session)
 
     return session
   }
@@ -322,12 +323,18 @@ export default abstract class ThemeCommand extends Command {
     return true
   }
 
-  private async logStoreMetadata(session: AdminSession): Promise<void> {
-    await metadata.addPublicMetadata(() => ({
+  private async logAnalyticsData(session: AdminSession): Promise<void> {
+    const data = compileData()
+
+    await addPublicMetadata(() => ({
       store_fqdn_hash: hashString(session.storeFqdn),
-    }))
 
-    await metadata.addSensitiveMetadata(() => ({
+      cmd_theme_timings: JSON.stringify(data.timings),
+      cmd_theme_errors: JSON.stringify(data.errors),
+      cmd_theme_retries: JSON.stringify(data.retries),
+      cmd_theme_events: JSON.stringify(data.events),
+    }))
+    await addSensitiveMetadata(() => ({
       store_fqdn: session.storeFqdn,
     }))
   }