Merge pull request microsoft#167385 from microsoft/hediet/conflict-marker-telemetry

Add telemetry for conflict markers

Author: hediet

extensions/merge-conflict/package.json

@@ -19,6 +19,9 @@
       "supported": true
     }
   },
+  "enabledApiProposals": [
+    "telemetryLogger"
+  ],
   "activationEvents": [
     "onStartupFinished"
   ],
@@ -165,7 +168,9 @@
       }
     }
   },
-  "dependencies": {},
+  "dependencies": {
+    "@vscode/extension-telemetry": "0.7.1-preview"
+  },
   "devDependencies": {
     "@types/node": "16.x"
   },

extensions/merge-conflict/src/documentMergeConflict.ts

@@ -4,6 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 import * as interfaces from './interfaces';
 import * as vscode from 'vscode';
+import type TelemetryReporter from '@vscode/extension-telemetry';
 
 export class DocumentMergeConflict implements interfaces.IDocumentMergeConflict {
 
@@ -13,7 +14,7 @@ export class DocumentMergeConflict implements interfaces.IDocumentMergeConflict
 	public commonAncestors: interfaces.IMergeRegion[];
 	public splitter: vscode.Range;
 
-	constructor(descriptor: interfaces.IDocumentMergeConflictDescriptor) {
+	constructor(descriptor: interfaces.IDocumentMergeConflictDescriptor, private readonly telemetryReporter: TelemetryReporter) {
 		this.range = descriptor.range;
 		this.current = descriptor.current;
 		this.incoming = descriptor.incoming;
@@ -22,6 +23,25 @@ export class DocumentMergeConflict implements interfaces.IDocumentMergeConflict
 	}
 
 	public commitEdit(type: interfaces.CommitType, editor: vscode.TextEditor, edit?: vscode.TextEditorEdit): Thenable<boolean> {
+		function commitTypeToString(type: interfaces.CommitType): string {
+			switch (type) {
+				case interfaces.CommitType.Current:
+					return 'current';
+				case interfaces.CommitType.Incoming:
+					return 'incoming';
+				case interfaces.CommitType.Both:
+					return 'both';
+			}
+		}
+
+		/* __GDPR__
+			"mergeMarkers.accept" : {
+				"owner": "hediet",
+				"comment": "Used to understand how the inline merge editor experience is used.",
+				"resolution": { "classification": "SystemMetaData", "purpose": "FeatureInsight", "comment": "Indicates how the merge conflict was resolved by the user" }
+			}
+		*/
+		this.telemetryReporter.sendTelemetryEvent('mergeMarkers.accept', { resolution: commitTypeToString(type) });
 
 		if (edit) {
 

extensions/merge-conflict/src/documentTracker.ts

@@ -7,6 +7,7 @@ import * as vscode from 'vscode';
 import { MergeConflictParser } from './mergeConflictParser';
 import * as interfaces from './interfaces';
 import { Delayer } from './delayer';
+import TelemetryReporter from '@vscode/extension-telemetry';
 
 class ScanTask {
 	public origins: Set<string> = new Set<string>();
@@ -47,6 +48,8 @@ export default class DocumentMergeConflictTracker implements vscode.Disposable,
 	private cache: Map<string, ScanTask> = new Map();
 	private delayExpireTime: number = 0;
 
+	constructor(private readonly telemetryReporter: TelemetryReporter) { }
+
 	getConflicts(document: vscode.TextDocument, origin: string): PromiseLike<interfaces.IDocumentMergeConflict[]> {
 		// Attempt from cache
 
@@ -109,14 +112,35 @@ export default class DocumentMergeConflictTracker implements vscode.Disposable,
 		this.cache.clear();
 	}
 
+	private readonly seenDocumentsWithConflicts = new Set<string>();
+
 	private getConflictsOrEmpty(document: vscode.TextDocument, _origins: string[]): interfaces.IDocumentMergeConflict[] {
 		const containsConflict = MergeConflictParser.containsConflict(document);
 
 		if (!containsConflict) {
 			return [];
 		}
 
-		const conflicts = MergeConflictParser.scanDocument(document);
+		const conflicts = MergeConflictParser.scanDocument(document, this.telemetryReporter);
+
+		const key = document.uri.toString();
+		// Don't report telemetry for the same document twice. This is an approximation, but good enough.
+		// Otherwise redo/undo could trigger this event multiple times.
+		if (!this.seenDocumentsWithConflicts.has(key)) {
+			this.seenDocumentsWithConflicts.add(key);
+
+			/* __GDPR__
+				"mergeMarkers.documentWithConflictMarkersOpened" : {
+					"owner": "hediet",
+					"comment": "Used to determine how many documents with conflicts are opened.",
+					"conflictCount": { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true, "comment": "Total number of conflict counts" }
+				}
+			*/
+			this.telemetryReporter.sendTelemetryEvent('mergeMarkers.documentWithConflictMarkersOpened', {}, {
+				conflictCount: conflicts.length,
+			});
+		}
+
 		return conflicts;
 	}
 

extensions/merge-conflict/src/mergeConflictParser.ts

@@ -5,6 +5,7 @@
 import * as vscode from 'vscode';
 import * as interfaces from './interfaces';
 import { DocumentMergeConflict } from './documentMergeConflict';
+import TelemetryReporter from '@vscode/extension-telemetry';
 
 const startHeaderMarker = '<<<<<<<';
 const commonAncestorsMarker = '|||||||';
@@ -20,7 +21,7 @@ interface IScanMergedConflict {
 
 export class MergeConflictParser {
 
-	static scanDocument(document: vscode.TextDocument): interfaces.IDocumentMergeConflict[] {
+	static scanDocument(document: vscode.TextDocument, telemetryReporter: TelemetryReporter): interfaces.IDocumentMergeConflict[] {
 
 		// Scan each line in the document, we already know there is at least a <<<<<<< and
 		// >>>>>> marker within the document, we need to group these into conflict ranges.
@@ -81,7 +82,7 @@ export class MergeConflictParser {
 
 		return conflictDescriptors
 			.filter(Boolean)
-			.map(descriptor => new DocumentMergeConflict(descriptor));
+			.map(descriptor => new DocumentMergeConflict(descriptor, telemetryReporter));
 	}
 
 	private static scanItemTolMergeConflictDescriptor(document: vscode.TextDocument, scanned: IScanMergedConflict): interfaces.IDocumentMergeConflictDescriptor | null {

extensions/merge-conflict/src/services.ts

@@ -9,20 +9,25 @@ import CommandHandler from './commandHandler';
 import ContentProvider from './contentProvider';
 import Decorator from './mergeDecorator';
 import * as interfaces from './interfaces';
+import TelemetryReporter from '@vscode/extension-telemetry';
 
 const ConfigurationSectionName = 'merge-conflict';
 
 export default class ServiceWrapper implements vscode.Disposable {
 
 	private services: vscode.Disposable[] = [];
+	private telemetryReporter: TelemetryReporter;
 
 	constructor(private context: vscode.ExtensionContext) {
+		const { aiKey } = context.extension.packageJSON as { aiKey: string };
+		this.telemetryReporter = new TelemetryReporter(aiKey);
+		context.subscriptions.push(this.telemetryReporter);
 	}
 
 	begin() {
 
 		const configuration = this.createExtensionConfiguration();
-		const documentTracker = new DocumentTracker();
+		const documentTracker = new DocumentTracker(this.telemetryReporter);
 
 		this.services.push(
 			documentTracker,