Adds sourceKeyWithoutExtId to editTelemetry.editSources.details

hediet · hediet · commit 49e7cf8dbbab · 2025-07-08T18:20:45.000+02:00
diff --git a/src/vs/editor/common/textModelEditReason.ts b/src/vs/editor/common/textModelEditReason.ts
@@ -35,7 +35,7 @@ export class TextModelEditReason {
 	 * Converts the metadata to a key string.
 	 * Only includes properties/values that have `level` many `$` prefixes or less.
 	*/
-	public toKey(level: number, filter: { [TKey in keyof ITextModelEditReasonMetadata]?: boolean } = {}): string {
+	public toKey(level: number, filter: { [TKey in ITextModelEditReasonMetadataKeys]?: boolean } = {}): string {
 		const metadata = this.metadata;
 		const keys = Object.entries(metadata).filter(([key, value]) => {
 			const filterVal = (filter as Record<string, boolean>)[key];
@@ -133,6 +133,8 @@ function toProperties(version: ProviderId | undefined) {
 
 type Values<T> = T[keyof T];
 type ITextModelEditReasonMetadata = Values<{ [TKey in keyof typeof EditReasons]: ReturnType<typeof EditReasons[TKey]>['metadataT'] }>;
+type ITextModelEditReasonMetadataKeys = Values<{ [TKey in keyof typeof EditReasons]: keyof ReturnType<typeof EditReasons[TKey]>['metadataT'] }>;
+
 
 function avoidPathRedaction(str: string | undefined): string | undefined {
 	if (str === undefined) {
diff --git a/src/vs/workbench/contrib/editTelemetry/browser/documentWithAnnotatedEdits.ts b/src/vs/workbench/contrib/editTelemetry/browser/documentWithAnnotatedEdits.ts
@@ -13,7 +13,7 @@ import { IEditorWorkerService } from '../../../../editor/common/services/editorW
 import { TextModelEditReason } from '../../../../editor/common/textModelEditReason.js';
 import { IObservableDocument } from './observableWorkspace.js';
 
-export interface IDocumentWithAnnotatedEdits<TEditData extends IEditData<TEditData> = EditSourceData> {
+export interface IDocumentWithAnnotatedEdits<TEditData extends IEditData<TEditData> = EditKeySourceData> {
 	readonly value: IObservableWithChange<StringText, { edit: AnnotatedStringEdit<TEditData> }>;
 	waitForQueue(): Promise<void>;
 }
@@ -22,8 +22,8 @@ export interface IDocumentWithAnnotatedEdits<TEditData extends IEditData<TEditDa
  * Creates a document that is a delayed copy of the original document,
  * but with edits annotated with the source of the edit.
 */
-export class DocumentWithAnnotatedEdits extends Disposable implements IDocumentWithAnnotatedEdits<EditReasonData> {
-	public readonly value: IObservableWithChange<StringText, { edit: AnnotatedStringEdit<EditReasonData> }>;
+export class DocumentWithSourceAnnotatedEdits extends Disposable implements IDocumentWithAnnotatedEdits<EditSourceData> {
+	public readonly value: IObservableWithChange<StringText, { edit: AnnotatedStringEdit<EditSourceData> }>;
 
 	constructor(private readonly _originalDoc: IObservableDocument) {
 		super();
@@ -32,7 +32,7 @@ export class DocumentWithAnnotatedEdits extends Disposable implements IDocumentW
 
 		this._register(runOnChange(this._originalDoc.value, (val, _prevVal, edits) => {
 			const eComposed = AnnotatedStringEdit.compose(edits.map(e => {
-				const editSourceData = new EditReasonData(e.reason);
+				const editSourceData = new EditSourceData(e.reason);
 				return e.mapData(() => editSourceData);
 			}));
 
@@ -46,9 +46,9 @@ export class DocumentWithAnnotatedEdits extends Disposable implements IDocumentW
 }
 
 /**
- * Only joins touching edits if the source and the metadata is the same.
+ * Only joins touching edits if the source and the metadata is the same (e.g. requestUuids must be equal).
 */
-export class EditReasonData implements IEditData<EditReasonData> {
+export class EditSourceData implements IEditData<EditSourceData> {
 	public readonly source;
 	public readonly key;
 
@@ -59,31 +59,33 @@ export class EditReasonData implements IEditData<EditReasonData> {
 		this.source = EditSourceBase.create(this.editReason);
 	}
 
-	join(data: EditReasonData): EditReasonData | undefined {
+	join(data: EditSourceData): EditSourceData | undefined {
 		if (this.editReason !== data.editReason) {
 			return undefined;
 		}
 		return this;
 	}
 
-	toEditSourceData(): EditSourceData {
-		return new EditSourceData(this.key, this.source);
+	toEditSourceData(): EditKeySourceData {
+		return new EditKeySourceData(this.key, this.source, this.editReason);
 	}
 }
 
-export class EditSourceData implements IEditData<EditSourceData> {
+export class EditKeySourceData implements IEditData<EditKeySourceData> {
 	constructor(
 		public readonly key: string,
 		public readonly source: EditSource,
+		public readonly representative: TextModelEditReason,
 	) { }
 
-	join(data: EditSourceData): EditSourceData | undefined {
+	join(data: EditKeySourceData): EditKeySourceData | undefined {
 		if (this.key !== data.key) {
 			return undefined;
 		}
 		if (this.source !== data.source) {
 			return undefined;
 		}
+		// The representatives could be different! (But equal modulo key)
 		return this;
 	}
 }
@@ -197,7 +199,7 @@ class UnknownEditSource extends EditSourceBase {
 	public getColor(): string { return '#ff000033'; }
 }
 
-export class CombineStreamedChanges<TEditData extends EditSourceData & IEditData<TEditData>> extends Disposable implements IDocumentWithAnnotatedEdits<TEditData> {
+export class CombineStreamedChanges<TEditData extends (EditKeySourceData | EditSourceData) & IEditData<TEditData>> extends Disposable implements IDocumentWithAnnotatedEdits<TEditData> {
 	private readonly _value: ISettableObservable<StringText, { edit: AnnotatedStringEdit<TEditData> }>;
 	readonly value: IObservableWithChange<StringText, { edit: AnnotatedStringEdit<TEditData> }>;
 	private readonly _runStore = this._register(new DisposableStore());
@@ -265,7 +267,7 @@ export class CombineStreamedChanges<TEditData extends EditSourceData & IEditData
 	}
 }
 
-function isChatEdit(next: { value: StringText; change: { edit: AnnotatedStringEdit<EditSourceData> }[] }) {
+function isChatEdit(next: { value: StringText; change: { edit: AnnotatedStringEdit<EditKeySourceData | EditSourceData> }[] }) {
 	return next.change.every(c => c.edit.replacements.every(e => {
 		if (e.data.source.category === 'ai' && e.data.source.feature === 'chat') {
 			return true;
diff --git a/src/vs/workbench/contrib/editTelemetry/browser/editSourceTrackingImpl.ts b/src/vs/workbench/contrib/editTelemetry/browser/editSourceTrackingImpl.ts
@@ -12,11 +12,12 @@ import { URI } from '../../../../base/common/uri.js';
 import { generateUuid } from '../../../../base/common/uuid.js';
 import { AnnotatedStringEdit, BaseStringEdit } from '../../../../editor/common/core/edits/stringEdit.js';
 import { StringText } from '../../../../editor/common/core/text/abstractText.js';
+import { TextModelEditReason } from '../../../../editor/common/textModelEditReason.js';
 import { IInstantiationService } from '../../../../platform/instantiation/common/instantiation.js';
 import { ITelemetryService } from '../../../../platform/telemetry/common/telemetry.js';
 import { ISCMRepository, ISCMService } from '../../scm/common/scm.js';
 import { ArcTracker } from './arcTracker.js';
-import { CombineStreamedChanges, DocumentWithAnnotatedEdits, EditReasonData, EditSource, EditSourceData, IDocumentWithAnnotatedEdits, MinimizeEditsProcessor } from './documentWithAnnotatedEdits.js';
+import { CombineStreamedChanges, DocumentWithSourceAnnotatedEdits, EditKeySourceData, EditSource, EditSourceData, IDocumentWithAnnotatedEdits, MinimizeEditsProcessor } from './documentWithAnnotatedEdits.js';
 import { DocumentEditSourceTracker, TrackedEdit } from './editTracker.js';
 import { ObservableWorkspace, IObservableDocument } from './observableWorkspace.js';
 
@@ -89,9 +90,9 @@ class TrackedDocumentInfo extends Disposable {
 		super();
 
 		// Use the listener service and special events from core to annotate where an edit came from (is async)
-		let processedDoc: IDocumentWithAnnotatedEdits<EditReasonData> = this._store.add(new DocumentWithAnnotatedEdits(_doc));
+		let processedDoc: IDocumentWithAnnotatedEdits<EditSourceData> = this._store.add(new DocumentWithSourceAnnotatedEdits(_doc));
 		// Combine streaming edits into one and make edit smaller
-		processedDoc = this._store.add(this._instantiationService.createInstance((CombineStreamedChanges<EditReasonData>), processedDoc));
+		processedDoc = this._store.add(this._instantiationService.createInstance((CombineStreamedChanges<EditSourceData>), processedDoc));
 		// Remove common suffix and prefix from edits
 		processedDoc = this._store.add(new MinimizeEditsProcessor(processedDoc));
 
@@ -223,6 +224,10 @@ class TrackedDocumentInfo extends Disposable {
 			isTrackedByGit: isTrackedByGit ? 1 : 0,
 		});
 
+		const sourceKeyToRepresentative = new Map<string, TextModelEditReason>();
+		for (const r of ranges) {
+			sourceKeyToRepresentative.set(r.sourceKey, r.sourceRepresentative);
+		}
 
 		const sums = sumByCategory(ranges, r => r.range.length, r => r.sourceKey);
 		const entries = Object.entries(sums).filter(([key, value]) => value !== undefined);
@@ -233,9 +238,21 @@ class TrackedDocumentInfo extends Disposable {
 			if (value === undefined) {
 				continue;
 			}
+
+
+			const repr = sourceKeyToRepresentative.get(key);
+			const cleanedKey = repr?.toKey(1, { $extensionId: false, $extensionVersion: false });
+
+			const metadata = repr?.metadata;
+			const extensionId = metadata && '$extensionId' in metadata ? metadata.$extensionId : undefined;
+			const extensionVersion = metadata && '$extensionVersion' in metadata ? metadata.$extensionVersion : undefined;
+
 			this._telemetryService.publicLog2<{
 				mode: string;
-				reasonKey: string;
+				sourceKey: string;
+				extensionId: string;
+				extensionVersion: string;
+				sourceKeyWithoutExtId: string;
 				languageId: string;
 				statsUuid: string;
 				modifiedCount: number;
@@ -244,16 +261,22 @@ class TrackedDocumentInfo extends Disposable {
 				owner: 'hediet';
 				comment: 'Reports distribution of various edit kinds.';
 
-				reasonKey: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The reason for the edit.' };
+				sourceKey: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The source of the edit.' };
 				mode: { classification: 'SystemMetaData'; purpose: 'PerformanceAndHealth'; comment: 'longterm or 5minWindow' };
 				languageId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The language id of the document.' };
 				statsUuid: { classification: 'SystemMetaData'; purpose: 'PerformanceAndHealth'; comment: 'The unique identifier for the telemetry event.' };
+				extensionId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The extension id which provided this inline completion.' };
+				extensionVersion: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The version of the extension.' };
+				sourceKeyWithoutExtId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The source of the edit.' };
 
 				modifiedCount: { classification: 'SystemMetaData'; purpose: 'PerformanceAndHealth'; comment: 'Fraction of nes modified characters'; isMeasurement: true };
 				totalModifiedCount: { classification: 'SystemMetaData'; purpose: 'PerformanceAndHealth'; comment: 'Total number of characters'; isMeasurement: true };
 			}>('editTelemetry.editSources.details', {
 				mode,
-				reasonKey: key,
+				sourceKey: key,
+				extensionId: extensionId ?? '',
+				extensionVersion: extensionVersion ?? '',
+				sourceKeyWithoutExtId: cleanedKey ?? '',
 				languageId: this._doc.languageId.get(),
 				statsUuid: statsUuid,
 				modifiedCount: value,
@@ -312,8 +335,8 @@ function mapObservableDelta<T, TDelta, TDeltaNew>(obs: IObservableWithChange<T,
 /**
  * Removing the metadata allows touching edits from the same source to merged, even if they were caused by different actions (e.g. two user edits).
  */
-function createDocWithJustReason(docWithAnnotatedEdits: IDocumentWithAnnotatedEdits<EditReasonData>, store: DisposableStore): IDocumentWithAnnotatedEdits<EditSourceData> {
-	const docWithJustReason: IDocumentWithAnnotatedEdits<EditSourceData> = {
+function createDocWithJustReason(docWithAnnotatedEdits: IDocumentWithAnnotatedEdits<EditSourceData>, store: DisposableStore): IDocumentWithAnnotatedEdits<EditKeySourceData> {
+	const docWithJustReason: IDocumentWithAnnotatedEdits<EditKeySourceData> = {
 		value: mapObservableDelta(docWithAnnotatedEdits.value, edit => ({ edit: edit.edit.mapData(d => d.data.toEditSourceData()) }), store),
 		waitForQueue: () => docWithAnnotatedEdits.waitForQueue(),
 	};
@@ -322,7 +345,7 @@ function createDocWithJustReason(docWithAnnotatedEdits: IDocumentWithAnnotatedEd
 
 class ArcTelemetrySender extends Disposable {
 	constructor(
-		docWithAnnotatedEdits: IDocumentWithAnnotatedEdits<EditReasonData>,
+		docWithAnnotatedEdits: IDocumentWithAnnotatedEdits<EditSourceData>,
 		scmRepoBridge: ScmRepoBridge | undefined,
 		@IInstantiationService private readonly _instantiationService: IInstantiationService,
 	) {
diff --git a/src/vs/workbench/contrib/editTelemetry/browser/editTracker.ts b/src/vs/workbench/contrib/editTelemetry/browser/editTracker.ts
@@ -8,14 +8,15 @@ import { Disposable } from '../../../../base/common/lifecycle.js';
 import { observableSignal, runOnChange, IReader } from '../../../../base/common/observable.js';
 import { AnnotatedStringEdit } from '../../../../editor/common/core/edits/stringEdit.js';
 import { OffsetRange } from '../../../../editor/common/core/ranges/offsetRange.js';
-import { IDocumentWithAnnotatedEdits, EditSourceData, EditSource } from './documentWithAnnotatedEdits.js';
+import { TextModelEditReason } from '../../../../editor/common/textModelEditReason.js';
+import { IDocumentWithAnnotatedEdits, EditKeySourceData, EditSource } from './documentWithAnnotatedEdits.js';
 
 /**
  * Tracks a single document.
 */
 export class DocumentEditSourceTracker<T = void> extends Disposable {
-	private _edits: AnnotatedStringEdit<EditSourceData> = AnnotatedStringEdit.empty;
-	private _pendingExternalEdits: AnnotatedStringEdit<EditSourceData> = AnnotatedStringEdit.empty;
+	private _edits: AnnotatedStringEdit<EditKeySourceData> = AnnotatedStringEdit.empty;
+	private _pendingExternalEdits: AnnotatedStringEdit<EditKeySourceData> = AnnotatedStringEdit.empty;
 
 	private readonly _update = observableSignal(this);
 
@@ -55,8 +56,7 @@ export class DocumentEditSourceTracker<T = void> extends Disposable {
 		const ranges = this._edits.getNewRanges();
 		return ranges.map((r, idx) => {
 			const e = this._edits.replacements[idx];
-			const reason = e.data.source;
-			const te = new TrackedEdit(e.replaceRange, r, reason, e.data.key);
+			const te = new TrackedEdit(e.replaceRange, r, e.data.key, e.data.source, e.data.representative);
 			return te;
 		});
 	}
@@ -90,7 +90,8 @@ export class TrackedEdit {
 	constructor(
 		public readonly originalRange: OffsetRange,
 		public readonly range: OffsetRange,
-		public readonly source: EditSource,
 		public readonly sourceKey: string,
+		public readonly source: EditSource,
+		public readonly sourceRepresentative: TextModelEditReason,
 	) { }
 }
