chore: Anonymous usage tracking for Recorder, Generator, Validator (#771)

Author: going-confetti

src/components/Profile/GrafanaCloudSignIn/index.tsx

@@ -2,6 +2,7 @@ import { Button, Flex } from '@radix-ui/themes'
 import { useCallback, useEffect, useRef, useState } from 'react'
 
 import { UserProfiles } from '@/schemas/profile'
+import { UsageEventName } from '@/services/usageTracking/types'
 import { SignInProcessState, SignInResult, Stack } from '@/types/auth'
 import { exhaustive } from '@/utils/typescript'
 
@@ -89,6 +90,9 @@ export function GrafanaCloudSignIn({
     switch (result.type) {
       case 'authenticated':
         onSignInRef.current(result.profiles)
+        window.studio.app.trackEvent({
+          event: UsageEventName.UserLoggedIn,
+        })
         break
 
       case 'timed-out':

src/handlers/app/index.ts

@@ -1,6 +1,8 @@
 import { ipcMain, app } from 'electron'
 
 import { showWindow } from '@/main/window'
+import { trackEvent } from '@/services/usageTracking'
+import { UsageEvent } from '@/services/usageTracking/types'
 import { browserWindowFromEvent } from '@/utils/electron'
 
 import { AppHandler } from './types'
@@ -35,4 +37,8 @@ export function initialize() {
       showWindow(browserWindow)
     }
   })
+
+  ipcMain.on(AppHandler.TRACK_EVENT, (_, event: UsageEvent) => {
+    trackEvent(event)
+  })
 }

src/handlers/app/preload.ts

@@ -1,5 +1,7 @@
 import { ipcRenderer } from 'electron'
 
+import { UsageEvent } from '@/services/usageTracking/types'
+
 import { createListener } from '../utils'
 
 import { AppHandler } from './types'
@@ -22,6 +24,10 @@ export function changeRoute(route: string) {
   return ipcRenderer.send(AppHandler.CHANGE_ROUTE, route)
 }
 
+export function trackEvent(event: UsageEvent) {
+  return ipcRenderer.send(AppHandler.TRACK_EVENT, event)
+}
+
 export function onDeepLink(callback: (url: string) => void) {
   return createListener(AppHandler.DEEP_LINK, callback)
 }

src/handlers/app/types.ts

@@ -3,4 +3,5 @@ export enum AppHandler {
   CHANGE_ROUTE = 'app:change-route',
   SPLASHSCREEN_CLOSE = 'app:splashscreen-close',
   DEEP_LINK = 'app:deep-link',
+  TRACK_EVENT = 'app:track-event',
 }

src/handlers/cloud/index.ts

@@ -4,6 +4,8 @@ import { basename, extname, isAbsolute, join } from 'path'
 
 import { SCRIPTS_PATH } from '@/constants/workspace'
 import { getTempScriptName } from '@/main/script'
+import { trackEvent } from '@/services/usageTracking'
+import { UsageEventName } from '@/services/usageTracking/types'
 import { browserWindowFromEvent } from '@/utils/electron'
 import { logError } from '@/utils/errors'
 
@@ -66,6 +68,9 @@ export function initialize() {
       const result = await stateMachine.run()
 
       if (result.type === 'started') {
+        trackEvent({
+          event: UsageEventName.ScriptRunInCloud,
+        })
         await shell.openExternal(result.testRunUrl)
       }
 

src/handlers/generator/index.ts

@@ -6,6 +6,8 @@ import invariant from 'tiny-invariant'
 import { INVALID_FILENAME_CHARS } from '@/constants/files'
 import { GENERATORS_PATH } from '@/constants/workspace'
 import { GeneratorFileDataSchema } from '@/schemas/generator'
+import { trackEvent } from '@/services/usageTracking'
+import { UsageEventName } from '@/services/usageTracking/types'
 import { GeneratorFileData } from '@/types/generator'
 import { createFileWithUniqueName } from '@/utils/fileSystem'
 import { createNewGeneratorFile } from '@/utils/generator'
@@ -23,6 +25,10 @@ export function initialize() {
       prefix: 'Generator',
     })
 
+    trackEvent({
+      event: UsageEventName.GeneratorCreated,
+    })
+
     return fileName
   })
 
@@ -36,6 +42,10 @@ export function initialize() {
         path.join(GENERATORS_PATH, fileName),
         JSON.stringify(generator, null, 2)
       )
+
+      trackEvent({
+        event: UsageEventName.GeneratorUpdated,
+      })
     }
   )
 

src/handlers/har/index.ts

@@ -3,6 +3,8 @@ import { readFile, copyFile } from 'fs/promises'
 import path from 'path'
 
 import { RECORDINGS_PATH } from '@/constants/workspace'
+import { trackEvent } from '@/services/usageTracking'
+import { UsageEventName } from '@/services/usageTracking/types'
 import { HarWithOptionalResponse } from '@/types/har'
 import { browserWindowFromEvent } from '@/utils/electron'
 import { createFileWithUniqueName } from '@/utils/fileSystem'
@@ -22,6 +24,10 @@ export function initialize() {
         prefix,
       })
 
+      trackEvent({
+        event: UsageEventName.RecordingCreated,
+      })
+
       return fileName
     }
   )
@@ -63,6 +69,10 @@ export function initialize() {
       path.join(RECORDINGS_PATH, path.basename(filePath))
     )
 
+    trackEvent({
+      event: UsageEventName.RecordingImported,
+    })
+
     return path.basename(filePath)
   })
 }

src/handlers/script/index.ts

@@ -10,6 +10,8 @@ import {
   runScript,
   type K6Process,
 } from '@/main/script'
+import { trackEvent } from '@/services/usageTracking'
+import { UsageEventName } from '@/services/usageTracking/types'
 import { browserWindowFromEvent, sendToast } from '@/utils/electron'
 
 import { ScriptHandler } from './types'
@@ -60,6 +62,10 @@ export function initialize() {
         proxyPort: k6StudioState.appSettings.proxy.port,
         usageReport: k6StudioState.appSettings.telemetry.usageReport,
       })
+
+      trackEvent({
+        event: UsageEventName.ScriptValidated,
+      })
     }
   )
 
@@ -89,6 +95,10 @@ export function initialize() {
         usageReport: k6StudioState.appSettings.telemetry.usageReport,
       })
 
+      trackEvent({
+        event: UsageEventName.ScriptValidated,
+      })
+
       await unlink(TEMP_GENERATOR_SCRIPT_PATH)
     }
   )
@@ -101,6 +111,10 @@ export function initialize() {
       try {
         const filePath = path.join(SCRIPTS_PATH, fileName)
         await writeFile(filePath, script)
+
+        trackEvent({
+          event: UsageEventName.ScriptExported,
+        })
         sendToast(browserWindow.webContents, {
           title: 'Script exported successfully',
           status: 'success',

src/services/usageTracking/types.ts

@@ -3,6 +3,20 @@ import { Arch, Platform } from '@/types/electron'
 export enum UsageEventName {
   // General
   AppInstalled = 'app_installed',
+  UserLoggedIn = 'user_logged_in',
+
+  // Recorder
+  RecordingCreated = 'recording_created',
+  RecordingImported = 'recording_imported',
+
+  // Generator
+  GeneratorCreated = 'generator_created',
+  GeneratorUpdated = 'generator_updated',
+
+  // Script
+  ScriptExported = 'script_exported',
+  ScriptValidated = 'script_validated',
+  ScriptRunInCloud = 'script_run_in_cloud',
 }
 
 export interface UsageEventMetadata {
@@ -13,10 +27,51 @@ export interface UsageEventMetadata {
   arch: Arch
 }
 
-export interface AppInstalledEvent {
+interface AppInstalledEvent {
   event: UsageEventName.AppInstalled
 }
 
-export type UsageEvent = AppInstalledEvent
+interface UserLoggedInEvent {
+  event: UsageEventName.UserLoggedIn
+}
+
+interface RecordingCreatedEvent {
+  event: UsageEventName.RecordingCreated
+}
+
+interface RecordingImportedEvent {
+  event: UsageEventName.RecordingImported
+}
+
+interface GeneratorCreatedEvent {
+  event: UsageEventName.GeneratorCreated
+}
+
+interface GeneratorUpdatedEvent {
+  event: UsageEventName.GeneratorUpdated
+}
+
+interface ScriptExportedEvent {
+  event: UsageEventName.ScriptExported
+}
+
+interface ScriptValidatedEvent {
+  event: UsageEventName.ScriptValidated
+}
+
+interface ScriptRunInCloudEvent {
+  event: UsageEventName.ScriptRunInCloud
+}
+
+export type UsageEvent =
+  | AppInstalledEvent
+  | UserLoggedInEvent
+  | RecordingCreatedEvent
+  | RecordingImportedEvent
+  | GeneratorCreatedEvent
+  | GeneratorUpdatedEvent
+  | ScriptExportedEvent
+  | ScriptValidatedEvent
+  | ScriptRunInCloudEvent
 
 export type UsageEventWithMetadata = UsageEvent & UsageEventMetadata