Add shown duration to inline completions (microsoft#251918)

add shown duration

Author: benibenj

src/vs/editor/common/languages.ts

@@ -939,6 +939,8 @@ export type InlineCompletionEndOfLifeReason<TInlineCompletion = InlineCompletion
 export type LifetimeSummary = {
 	requestUuid: string;
 	shown: boolean;
+	shownDuration: number;
+	shownDurationUncollapsed: number;
 	editorType: string;
 	viewKind: string | undefined;
 	error: string | undefined;

src/vs/editor/contrib/inlineCompletions/browser/model/inlineCompletionsModel.ts

@@ -41,11 +41,12 @@ import { GhostText, GhostTextOrReplacement, ghostTextOrReplacementEquals, ghostT
 import { InlineCompletionsSource } from './inlineCompletionsSource.js';
 import { InlineEdit } from './inlineEdit.js';
 import { InlineCompletionItem, InlineEditItem, InlineSuggestionItem } from './inlineSuggestionItem.js';
-import { InlineCompletionContextWithoutUuid } from './provideInlineCompletions.js';
+import { InlineCompletionContextWithoutUuid, InlineCompletionEditorType } from './provideInlineCompletions.js';
 import { singleTextEditAugments, singleTextRemoveCommonPrefix } from './singleTextEditHelpers.js';
 import { SuggestItemInfo } from './suggestWidgetAdapter.js';
 import { TextModelEditReason } from '../../../../common/textModelEditReason.js';
 import { ICodeEditorService } from '../../../../browser/services/codeEditorService.js';
+import { InlineCompletionViewKind } from '../view/inlineEdits/inlineEditsViewInterface.js';
 
 export class InlineCompletionsModel extends Disposable {
 	private readonly _source;
@@ -524,13 +525,15 @@ export class InlineCompletionsModel extends Disposable {
 			return s.cursorAtInlineEdit.read(reader);
 		});
 
-		const [diffEditor] = this._codeEditorService.listDiffEditors()
-			.filter(d =>
-				d.getOriginalEditor().getId() === this._editor.getId() ||
-				d.getModifiedEditor().getId() === this._editor.getId());
+		{ // Determine editor type
+			const [diffEditor] = this._codeEditorService.listDiffEditors()
+				.filter(d =>
+					d.getOriginalEditor().getId() === this._editor.getId() ||
+					d.getModifiedEditor().getId() === this._editor.getId());
 
-		this.editorType = !!diffEditor ? 'diffEditor' : 'textEditor';
-		this.isInDiffEditor = !!diffEditor;
+			this.editorType = !!diffEditor ? InlineCompletionEditorType.DiffEditor : InlineCompletionEditorType.TextEditor;
+			this.isInDiffEditor = this.editorType === InlineCompletionEditorType.DiffEditor;
+		}
 
 		this._register(recomputeInitiallyAndOnChange(this._fetchInlineCompletionsPromise));
 
@@ -539,7 +542,7 @@ export class InlineCompletionsModel extends Disposable {
 			const item = this.inlineCompletionState.read(reader);
 			const completion = item?.inlineCompletion;
 			if (completion) {
-				this.handleInlineSuggestionShown(completion, 'ghostText');
+				this.handleInlineSuggestionShown(completion, InlineCompletionViewKind.GhostText);
 			}
 		}));
 
@@ -752,7 +755,7 @@ export class InlineCompletionsModel extends Disposable {
 
 	public readonly isInDiffEditor;
 
-	public readonly editorType: 'textEditor' | 'diffEditor';
+	public readonly editorType: InlineCompletionEditorType;
 
 	private async _deltaSelectedInlineCompletionIndex(delta: 1 | -1): Promise<void> {
 		await this.triggerExplicitly();
@@ -1019,7 +1022,7 @@ export class InlineCompletionsModel extends Disposable {
 		});
 	}
 
-	public async handleInlineSuggestionShown(inlineCompletion: InlineSuggestionItem, viewKind: string): Promise<void> {
+	public async handleInlineSuggestionShown(inlineCompletion: InlineSuggestionItem, viewKind: InlineCompletionViewKind): Promise<void> {
 		await inlineCompletion.reportInlineEditShown(this._commandService, viewKind);
 	}
 }

src/vs/editor/contrib/inlineCompletions/browser/model/inlineCompletionsSource.ts

@@ -27,7 +27,7 @@ import { IModelContentChangedEvent } from '../../../../common/textModelEvents.js
 import { formatRecordableLogEntry, IRecordableEditorLogEntry, IRecordableLogEntry, StructuredLogger } from '../structuredLogger.js';
 import { wait } from '../utils.js';
 import { InlineSuggestionIdentity, InlineSuggestionItem } from './inlineSuggestionItem.js';
-import { InlineCompletionContextWithoutUuid, InlineCompletionProviderResult, provideInlineCompletions } from './provideInlineCompletions.js';
+import { InlineCompletionContextWithoutUuid, InlineCompletionEditorType, InlineCompletionProviderResult, provideInlineCompletions } from './provideInlineCompletions.js';
 
 export class InlineCompletionsSource extends Disposable {
 	private static _requestId = 0;
@@ -116,7 +116,7 @@ export class InlineCompletionsSource extends Disposable {
 	private readonly _loadingCount;
 	public readonly loading;
 
-	public fetch(providers: InlineCompletionsProvider[], position: Position, context: InlineCompletionContextWithoutUuid, activeInlineCompletion: InlineSuggestionIdentity | undefined, withDebounce: boolean, userJumpedToActiveCompletion: IObservable<boolean>, providerhasChangedCompletion: boolean, editorType: string): Promise<boolean> {
+	public fetch(providers: InlineCompletionsProvider[], position: Position, context: InlineCompletionContextWithoutUuid, activeInlineCompletion: InlineSuggestionIdentity | undefined, withDebounce: boolean, userJumpedToActiveCompletion: IObservable<boolean>, providerhasChangedCompletion: boolean, editorType: InlineCompletionEditorType): Promise<boolean> {
 		const request = new UpdateRequest(position, context, this._textModel.getVersionId());
 
 		const target = context.selectedSuggestionInfo ? this.suggestWidgetInlineCompletions.get() : this.inlineCompletions.get();

src/vs/editor/contrib/inlineCompletions/browser/model/inlineSuggestionItem.ts

@@ -24,6 +24,7 @@ import { TextModelText } from '../../../../common/model/textModelText.js';
 import { IDisplayLocation, InlineSuggestData, InlineSuggestionList, SnippetInfo } from './provideInlineCompletions.js';
 import { singleTextRemoveCommonPrefix } from './singleTextEditHelpers.js';
 import { getPositionOffsetTransformerFromTextModel } from '../../../../common/core/text/getPositionOffsetTransformerFromTextModel.js';
+import { InlineCompletionViewKind } from '../view/inlineEdits/inlineEditsViewInterface.js';
 
 export type InlineSuggestionItem = InlineEditItem | InlineCompletionItem;
 
@@ -99,7 +100,7 @@ abstract class InlineSuggestionItemBase {
 		this.source.removeRef();
 	}
 
-	public reportInlineEditShown(commandService: ICommandService, viewKind: string) {
+	public reportInlineEditShown(commandService: ICommandService, viewKind: InlineCompletionViewKind) {
 		this._data.reportInlineEditShown(commandService, this.insertText, viewKind);
 	}
 

src/vs/editor/contrib/inlineCompletions/browser/model/provideInlineCompletions.ts

@@ -26,6 +26,7 @@ import { getReadonlyEmptyArray } from '../utils.js';
 import { groupByMap } from '../../../../../base/common/collections.js';
 import { DirectedGraph } from './graph.js';
 import { CachedFunction } from '../../../../../base/common/cache.js';
+import { InlineCompletionViewKind } from '../view/inlineEdits/inlineEditsViewInterface.js';
 
 export type InlineCompletionContextWithoutUuid = Omit<InlineCompletionContext, 'requestUuid'>;
 
@@ -34,7 +35,7 @@ export async function provideInlineCompletions(
 	position: Position,
 	model: ITextModel,
 	context: InlineCompletionContextWithoutUuid,
-	editorType: string,
+	editorType: InlineCompletionEditorType,
 	baseToken: CancellationToken = CancellationToken.None,
 	languageConfigurationService?: ILanguageConfigurationService,
 ): Promise<InlineCompletionProviderResult> {
@@ -197,7 +198,7 @@ function createInlineCompletionItem(
 	textModel: ITextModel,
 	languageConfigurationService: ILanguageConfigurationService | undefined,
 	context: InlineCompletionContext,
-	editorType: string,
+	editorType: InlineCompletionEditorType,
 ): InlineSuggestData {
 	let insertText: string;
 	let snippetInfo: SnippetInfo | undefined;
@@ -276,13 +277,18 @@ function createInlineCompletionItem(
 }
 
 export type InlineSuggestViewData = {
-	editorType: string;
-	viewKind?: string;
+	editorType: InlineCompletionEditorType;
+	viewKind?: InlineCompletionViewKind;
 	error?: string;
 };
 
 export class InlineSuggestData {
 	private _didShow = false;
+	private _showStartTime: number | undefined = undefined;
+	private _shownDuration: number = 0;
+	private _showUncollapsedStartTime: number | undefined = undefined;
+	private _showUncollapsedDuration: number = 0;
+
 	private _viewData: InlineSuggestViewData;
 	private _didReportEndOfLife = false;
 	private _lastSetEndOfLifeReason: InlineCompletionEndOfLifeReason | undefined = undefined;
@@ -299,7 +305,7 @@ export class InlineSuggestData {
 		public readonly context: InlineCompletionContext,
 		public readonly isInlineEdit: boolean,
 
-		editorType: string,
+		editorType: InlineCompletionEditorType,
 	) {
 		this._viewData = { editorType };
 	}
@@ -310,7 +316,9 @@ export class InlineSuggestData {
 		return new TextReplacement(this.range, this.insertText);
 	}
 
-	public async reportInlineEditShown(commandService: ICommandService, updatedInsertText: string, viewKind: string): Promise<void> {
+	public async reportInlineEditShown(commandService: ICommandService, updatedInsertText: string, viewKind: InlineCompletionViewKind): Promise<void> {
+		this.updateShownDuration(viewKind);
+
 		if (this._didShow) {
 			return;
 		}
@@ -343,6 +351,7 @@ export class InlineSuggestData {
 			return;
 		}
 		this._didReportEndOfLife = true;
+		this.reportInlineEditHidden();
 
 		if (!reason) {
 			reason = this._lastSetEndOfLifeReason ?? { kind: InlineCompletionEndOfLifeReasonKind.Ignored, userTypingDisagreed: false, supersededBy: undefined };
@@ -356,9 +365,11 @@ export class InlineSuggestData {
 			const summary: LifetimeSummary = {
 				requestUuid: this.context.requestUuid,
 				shown: this._didShow,
+				shownDuration: this._shownDuration,
+				shownDurationUncollapsed: this._showUncollapsedDuration,
 				editorType: this._viewData.editorType,
 				viewKind: this._viewData.viewKind,
-				error: this._viewData.error
+				error: this._viewData.error,
 			};
 			this.source.provider.handleEndOfLifetime(this.source.inlineSuggestions, this.sourceInlineCompletion, reason, summary);
 		}
@@ -376,8 +387,40 @@ export class InlineSuggestData {
 	 * Sets the end of life reason, but does not send the event to the provider yet.
 	*/
 	public setEndOfLifeReason(reason: InlineCompletionEndOfLifeReason): void {
+		this.reportInlineEditHidden();
 		this._lastSetEndOfLifeReason = reason;
 	}
+
+	private updateShownDuration(viewKind: InlineCompletionViewKind) {
+		const timeNow = Date.now();
+		if (!this._showStartTime) {
+			this._showStartTime = timeNow;
+		}
+
+		const isCollapsed = viewKind === InlineCompletionViewKind.Collapsed;
+		if (!isCollapsed && this._showUncollapsedStartTime === undefined) {
+			this._showUncollapsedStartTime = timeNow;
+		}
+
+		if (isCollapsed && this._showUncollapsedStartTime !== undefined) {
+			this._showUncollapsedDuration += timeNow - this._showUncollapsedStartTime;
+		}
+	}
+
+	private reportInlineEditHidden() {
+		if (this._showStartTime === undefined) {
+			return;
+		}
+		const timeNow = Date.now();
+		this._shownDuration += timeNow - this._showStartTime;
+		this._showStartTime = undefined;
+
+		if (this._showUncollapsedStartTime === undefined) {
+			return;
+		}
+		this._showUncollapsedDuration += timeNow - this._showUncollapsedStartTime;
+		this._showUncollapsedStartTime = undefined;
+	}
 }
 
 export interface SnippetInfo {
@@ -391,6 +434,11 @@ export interface IDisplayLocation {
 	label: string;
 }
 
+export enum InlineCompletionEditorType {
+	TextEditor = 'textEditor',
+	DiffEditor = 'diffEditor'
+}
+
 /**
  * A ref counted pointer to the computed `InlineCompletions` and the `InlineCompletionsProvider` that
  * computed them.

src/vs/editor/contrib/inlineCompletions/browser/view/inlineEdits/inlineEditsModel.ts

@@ -14,7 +14,7 @@ import { StringText } from '../../../../../common/core/text/abstractText.js';
 import { Command, InlineCompletionCommand, InlineCompletionDisplayLocation } from '../../../../../common/languages.js';
 import { InlineCompletionsModel } from '../../model/inlineCompletionsModel.js';
 import { InlineCompletionItem } from '../../model/inlineSuggestionItem.js';
-import { IInlineEditHost, IInlineEditModel, InlineEditTabAction } from './inlineEditsViewInterface.js';
+import { IInlineEditHost, IInlineEditModel, InlineCompletionViewKind, InlineEditTabAction } from './inlineEditsViewInterface.js';
 import { InlineEditWithChanges } from './inlineEditWithChanges.js';
 
 export class InlineEditModel implements IInlineEditModel {
@@ -55,7 +55,7 @@ export class InlineEditModel implements IInlineEditModel {
 		this._model.stop();
 	}
 
-	handleInlineEditShown(viewKind: string) {
+	handleInlineEditShown(viewKind: InlineCompletionViewKind) {
 		this._model.handleInlineSuggestionShown(this.inlineEdit.inlineCompletion, viewKind);
 	}
 }