Adds scope into tracking

Author: eamodio

docs/telemetry-events.md

@@ -2022,13 +2022,18 @@ or
 ```typescript
 {
   'context.period': 'all' | `${number}|D` | `${number}|M` | `${number}|Y`,
+  'context.scope.hasBase': boolean,
+  'context.scope.hasHead': boolean,
   'context.scope.type': 'file' | 'folder' | 'repo',
   'context.showAllBranches': boolean,
   'context.sliceBy': 'branch' | 'author',
   'context.webview.host': 'editor' | 'view',
   'context.webview.id': string,
   'context.webview.instanceId': string,
-  'context.webview.type': string
+  'context.webview.type': string,
+  'scope.hasBase': boolean,
+  'scope.hasHead': boolean,
+  'scope.type': 'file' | 'folder' | 'repo'
 }
 ```
 
@@ -2039,6 +2044,8 @@ or
 ```typescript
 {
   'context.period': 'all' | `${number}|D` | `${number}|M` | `${number}|Y`,
+  'context.scope.hasBase': boolean,
+  'context.scope.hasHead': boolean,
   'context.scope.type': 'file' | 'folder' | 'repo',
   'context.showAllBranches': boolean,
   'context.sliceBy': 'branch' | 'author',
@@ -2056,6 +2063,8 @@ or
 ```typescript
 {
   'context.period': 'all' | `${number}|D` | `${number}|M` | `${number}|Y`,
+  'context.scope.hasBase': boolean,
+  'context.scope.hasHead': boolean,
   'context.scope.type': 'file' | 'folder' | 'repo',
   'context.showAllBranches': boolean,
   'context.sliceBy': 'branch' | 'author',
@@ -2076,6 +2085,8 @@ or
 ```typescript
 {
   'context.period': 'all' | `${number}|D` | `${number}|M` | `${number}|Y`,
+  'context.scope.hasBase': boolean,
+  'context.scope.hasHead': boolean,
   'context.scope.type': 'file' | 'folder' | 'repo',
   'context.showAllBranches': boolean,
   'context.sliceBy': 'branch' | 'author',
@@ -2093,6 +2104,8 @@ or
 ```typescript
 {
   'context.period': 'all' | `${number}|D` | `${number}|M` | `${number}|Y`,
+  'context.scope.hasBase': boolean,
+  'context.scope.hasHead': boolean,
   'context.scope.type': 'file' | 'folder' | 'repo',
   'context.showAllBranches': boolean,
   'context.sliceBy': 'branch' | 'author',
@@ -2125,6 +2138,8 @@ or
   'context.config.allowMultiple': boolean,
   'context.config.queryLimit': number,
   'context.period': 'all' | `${number}|D` | `${number}|M` | `${number}|Y`,
+  'context.scope.hasBase': boolean,
+  'context.scope.hasHead': boolean,
   'context.scope.type': 'file' | 'folder' | 'repo',
   'context.showAllBranches': boolean,
   'context.sliceBy': 'branch' | 'author',

src/constants.telemetry.ts

@@ -258,7 +258,7 @@ export interface TelemetryEvents extends WebviewShowAbortedEvents, WebviewShownE
 	/** Sent when the Visual History is shown */
 	'timeline/shown': TimelineShownEvent;
 	/** Sent when the user clicks on the "Open in Editor" button on the Visual History */
-	'timeline/action/openInEditor': TimelineContextEventData;
+	'timeline/action/openInEditor': TimelineActionOpenInEditorEvent;
 	/** Sent when the editor changes on the Visual History */
 	'timeline/editor/changed': TimelineContextEventData;
 	/** Sent when the user selects (clicks on) a commit on the Visual History */
@@ -877,6 +877,8 @@ export interface SubscriptionEventDataWithPrevious
 
 type TimelineContextEventData = WebviewTelemetryContext & {
 	'context.period': TimelinePeriod | undefined;
+	'context.scope.hasHead': boolean | undefined;
+	'context.scope.hasBase': boolean | undefined;
 	'context.scope.type': TimelineScopeType | undefined;
 	'context.showAllBranches': boolean | undefined;
 	'context.sliceBy': TimelineSliceBy | undefined;
@@ -894,6 +896,12 @@ interface TimelineConfigChangedEvent extends TimelineContextEventData {
 	sliceBy: TimelineSliceBy;
 }
 
+interface TimelineActionOpenInEditorEvent extends TimelineContextEventData {
+	'scope.type': TimelineScopeType;
+	'scope.hasHead': boolean;
+	'scope.hasBase': boolean;
+}
+
 interface UsageTrackEvent {
 	'usage.key': TrackedUsageKeys;
 	'usage.count': number;

src/webviews/plus/timeline/timelineWebview.ts

@@ -166,6 +166,8 @@ export class TimelineWebviewProvider implements WebviewProvider<State, State, Ti
 		return {
 			...this.host.getTelemetryContext(),
 			'context.period': this._context.config.period,
+			'context.scope.hasHead': this._context.scope?.head != null,
+			'context.scope.hasBase': this._context.scope?.base != null,
 			'context.scope.type': this._context.scope?.type,
 			'context.showAllBranches': this._context.config.showAllBranches,
 			'context.sliceBy': this._context.config.sliceBy,
@@ -236,7 +238,12 @@ export class TimelineWebviewProvider implements WebviewProvider<State, State, Ti
 						if (this._context.scope?.type !== 'file') return;
 
 						void executeCommand<TimelineScope>('gitlens.visualizeHistory', this._context.scope);
-						this.container.telemetry.sendEvent('timeline/action/openInEditor', this.getTelemetryContext());
+						this.container.telemetry.sendEvent('timeline/action/openInEditor', {
+							...this.getTelemetryContext(),
+							'scope.type': this._context.scope.type,
+							'scope.hasHead': this._context.scope.head != null,
+							'scope.hasBase': this._context.scope.base != null,
+						});
 					},
 					this,
 				),
@@ -504,6 +511,12 @@ export class TimelineWebviewProvider implements WebviewProvider<State, State, Ti
 		// If we are changing the type, and in the view, open it in the editor
 		if (this.host.is('view') || e.params.altOrShift) {
 			void executeCommand<TimelineScope>('gitlens.visualizeHistory', scope);
+			this.container.telemetry.sendEvent('timeline/action/openInEditor', {
+				...this.getTelemetryContext(),
+				'scope.type': scope.type,
+				'scope.hasHead': scope.head != null,
+				'scope.hasBase': scope.base != null,
+			});
 			return;
 		}