Add event for when inlay hints are provided (#191134)

extensions/typescript-language-features/src/languageFeatures/inlayHints.ts

@@ -6,6 +6,7 @@
 import * as vscode from 'vscode';
 import { DocumentSelector } from '../configuration/documentSelector';
 import { LanguageDescription } from '../configuration/languageDescription';
+import { TelemetryReporter } from '../logging/telemetry';
 import { API } from '../tsServer/api';
 import type * as Proto from '../tsServer/protocol/protocol';
 import { Location, Position } from '../typeConverters';
@@ -29,13 +30,16 @@ class TypeScriptInlayHintsProvider extends Disposable implements vscode.InlayHin
 
 	public static readonly minVersion = API.v440;
 
-	private readonly _onDidChangeInlayHints = new vscode.EventEmitter<void>();
+	private readonly _onDidChangeInlayHints = this._register(new vscode.EventEmitter<void>());
 	public readonly onDidChangeInlayHints = this._onDidChangeInlayHints.event;
 
+	private hasReportedTelemetry = false;
+
 	constructor(
 		private readonly language: LanguageDescription,
 		private readonly client: ITypeScriptServiceClient,
-		private readonly fileConfigurationManager: FileConfigurationManager
+		private readonly fileConfigurationManager: FileConfigurationManager,
+		private readonly telemetryReporter: TelemetryReporter,
 	) {
 		super();
 
@@ -54,31 +58,47 @@ class TypeScriptInlayHintsProvider extends Disposable implements vscode.InlayHin
 		}));
 	}
 
-	async provideInlayHints(model: vscode.TextDocument, range: vscode.Range, token: vscode.CancellationToken): Promise<vscode.InlayHint[]> {
+	async provideInlayHints(model: vscode.TextDocument, range: vscode.Range, token: vscode.CancellationToken): Promise<vscode.InlayHint[] | undefined> {
 		const filepath = this.client.toOpenTsFilePath(model);
 		if (!filepath) {
-			return [];
+			return;
 		}
 
 		if (!areInlayHintsEnabledForFile(this.language, model)) {
-			return [];
+			return;
 		}
 
 		const start = model.offsetAt(range.start);
 		const length = model.offsetAt(range.end) - start;
 
 		await this.fileConfigurationManager.ensureConfigurationForDocument(model, token);
+		if (token.isCancellationRequested) {
+			return;
+		}
+
+		if (!this.hasReportedTelemetry) {
+			this.hasReportedTelemetry = true;
+			/* __GDPR__
+				"inlayHints.provide" : {
+					"owner": "mjbvz",
+					"${include}": [
+						"${TypeScriptCommonProperties}"
+					]
+				}
+			*/
+			this.telemetryReporter.logTelemetry('inlayHints.provide', {});
+		}
 
 		const response = await this.client.execute('provideInlayHints', { file: filepath, start, length }, token);
 		if (response.type !== 'response' || !response.success || !response.body) {
-			return [];
+			return;
 		}
 
 		return response.body.map(hint => {
 			const result = new vscode.InlayHint(
 				Position.fromLocation(hint.position),
 				this.convertInlayHintText(hint),
-				hint.kind && fromProtocolInlayHintKind(hint.kind)
+				fromProtocolInlayHintKind(hint.kind)
 			);
 			result.paddingLeft = hint.whitespaceBefore;
 			result.paddingRight = hint.whitespaceAfter;
@@ -127,13 +147,14 @@ export function register(
 	selector: DocumentSelector,
 	language: LanguageDescription,
 	client: ITypeScriptServiceClient,
-	fileConfigurationManager: FileConfigurationManager
+	fileConfigurationManager: FileConfigurationManager,
+	telemetryReporter: TelemetryReporter,
 ) {
 	return conditionalRegistration([
 		requireMinVersion(client, TypeScriptInlayHintsProvider.minVersion),
 		requireSomeCapability(client, ClientCapability.Semantic),
 	], () => {
-		const provider = new TypeScriptInlayHintsProvider(language, client, fileConfigurationManager);
+		const provider = new TypeScriptInlayHintsProvider(language, client, fileConfigurationManager, telemetryReporter);
 		return vscode.languages.registerInlayHintsProvider(selector.semantic, provider);
 	});
 }

extensions/typescript-language-features/src/languageProvider.ts

@@ -74,7 +74,7 @@ export default class LanguageProvider extends Disposable {
 			import('./languageFeatures/formatting').then(provider => this._register(provider.register(selector, this.description, this.client, this.fileConfigurationManager))),
 			import('./languageFeatures/hover').then(provider => this._register(provider.register(selector, this.client, this.fileConfigurationManager))),
 			import('./languageFeatures/implementations').then(provider => this._register(provider.register(selector, this.client))),
-			import('./languageFeatures/inlayHints').then(provider => this._register(provider.register(selector, this.description, this.client, this.fileConfigurationManager))),
+			import('./languageFeatures/inlayHints').then(provider => this._register(provider.register(selector, this.description, this.client, this.fileConfigurationManager, this.telemetryReporter))),
 			import('./languageFeatures/jsDocCompletions').then(provider => this._register(provider.register(selector, this.description, this.client, this.fileConfigurationManager))),
 			import('./languageFeatures/linkedEditing').then(provider => this._register(provider.register(selector, this.client))),
 			import('./languageFeatures/organizeImports').then(provider => this._register(provider.register(selector, this.client, this.commandManager, this.fileConfigurationManager, this.telemetryReporter))),