Adds command tracking for home

gitkraken · Jan 14, 2025 · b0c52f4 · b0c52f4
1 parent 08af6be
commit b0c52f4
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/docs/telemetry-events.md b/docs/telemetry-events.md
@@ -998,6 +998,17 @@ or
 }
 ```
 
+### home/command
+
+> Sent when a Home command is executed
+
+```typescript
+{
+  'command': string,
+  'webview': string
+}
+```
+
 ### home/createBranch
 
 > Sent when the user chooses to create a branch from the home view

diff --git a/src/constants.telemetry.ts b/src/constants.telemetry.ts
@@ -144,6 +144,8 @@ export interface TelemetryEvents extends WebviewShowAbortedEvents, WebviewShownE
 	/** Sent when the user changes the selected tab (mode) on the Graph Details view */
 	'graphDetails/mode/changed': GraphDetailsModeChangedEvent;
 
+	/** Sent when a Home command is executed */
+	'home/command': CommandEventData;
 	/** Sent when the new Home view preview is toggled on/off */
 	'home/preview/toggled': HomePreviewToggledEvent;
 	/** Sent when the user chooses to create a branch from the home view */

diff --git a/src/system/vscode/command.ts b/src/system/vscode/command.ts
@@ -46,6 +46,12 @@ export function registerCommand(command: Commands, callback: CommandCallback, th
 					'context.mode': context?.mode,
 					'context.submode': context?.submode,
 				});
+			} else if (command.startsWith('gitlens.home.')) {
+				Container.instance.telemetry.sendEvent('home/command', {
+					command: command,
+					'context.mode': context?.mode,
+					'context.submode': context?.submode,
+				});
 			}
 
 			void Container.instance.usage.track(`command:${command}:executed`).catch();
@@ -75,6 +81,11 @@ export function registerWebviewCommand(command: Commands, callback: CommandCallb
 					command: command,
 					webview: webview ?? '<missing>',
 				});
+			} else if (webview === 'gitlens.views.home' || command.startsWith('gitlens.home.')) {
+				Container.instance.telemetry.sendEvent('home/command', {
+					command: command,
+					webview: webview ?? '<missing>',
+				});
 			}
 
 			void Container.instance.usage.track(`command:${command}:executed`).catch();