Change code citation message, add telemetry (microsoft#223159)

Author: roblourens

src/vs/workbench/contrib/chat/browser/chatContentParts/chatCodeCitationContentPart.ts

@@ -9,24 +9,32 @@ import { Disposable } from 'vs/base/common/lifecycle';
 import { Schemas } from 'vs/base/common/network';
 import { URI } from 'vs/base/common/uri';
 import { localize } from 'vs/nls';
+import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
 import { ChatTreeItem } from 'vs/workbench/contrib/chat/browser/chat';
 import { IChatContentPart, IChatContentPartRenderContext } from 'vs/workbench/contrib/chat/browser/chatContentParts/chatContentParts';
 import { IChatCodeCitations, IChatRendererContent } from 'vs/workbench/contrib/chat/common/chatViewModel';
 import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
 
+type ChatCodeCitationOpenedClassification = {
+	owner: 'roblourens';
+	comment: 'Indicates when a user opens chat code citations';
+};
+
 export class ChatCodeCitationContentPart extends Disposable implements IChatContentPart {
 	public readonly domNode: HTMLElement;
 
 	constructor(
 		citations: IChatCodeCitations,
 		context: IChatContentPartRenderContext,
-		@IEditorService private readonly editorService: IEditorService
+		@IEditorService private readonly editorService: IEditorService,
+		@ITelemetryService private readonly telemetryService: ITelemetryService
 	) {
 		super();
 
-		const label = citations.citations.length > 1 ?
-			localize('codeCitationsPlural', "This code matches {0} references in public repositories", citations.citations.length) :
-			localize('codeCitation', "This code matches 1 reference in a public repository", citations.citations.length);
+		const licenseTypes = citations.citations.reduce((set, c) => set.add(c.license), new Set<string>());
+		const label = licenseTypes.size === 1 ?
+			localize('codeCitation', "Similar code found with 1 license type", licenseTypes.size) :
+			localize('codeCitations', "Similar code found with {0} license types", licenseTypes.size);
 		const elements = dom.h('.chat-code-citation-message@root', [
 			dom.h('span.chat-code-citation-label@label'),
 			dom.h('.chat-code-citation-button-container@button'),
@@ -42,10 +50,11 @@ export class ChatCodeCitationContentPart extends Disposable implements IChatCont
 			buttonSecondaryHoverBackground: undefined,
 			buttonSeparator: undefined
 		}));
-		button.label = localize('viewReferences', "View references");
+		button.label = localize('viewMatches', "View matches");
 		this._register(button.onDidClick(() => {
 			const citationText = citations.citations.map(c => `# [${c.license}]\n${c.value.toString()}\n\n\`\`\`\n${c.snippet}\n\`\`\`\n\n`).join('\n');
-			this.editorService.openEditor({ resource: URI.from({ scheme: Schemas.untitled, path: 'Code references' }), contents: citationText, languageId: 'markdown' });
+			this.editorService.openEditor({ resource: URI.from({ scheme: Schemas.untitled, path: 'Code Matches' }), contents: citationText, languageId: 'markdown' });
+			this.telemetryService.publicLog2<{}, ChatCodeCitationOpenedClassification>('openedChatCodeCitations');
 		}));
 		this.domNode = elements.root;
 	}

src/vs/workbench/contrib/chat/common/chatModel.ts

@@ -3,7 +3,6 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { localize } from 'vs/nls';
 import { asArray, firstOrDefault } from 'vs/base/common/arrays';
 import { DeferredPromise } from 'vs/base/common/async';
 import { Emitter, Event } from 'vs/base/common/event';
@@ -17,11 +16,12 @@ import { URI, UriComponents, UriDto, isUriComponents } from 'vs/base/common/uri'
 import { generateUuid } from 'vs/base/common/uuid';
 import { IOffsetRange, OffsetRange } from 'vs/editor/common/core/offsetRange';
 import { TextEdit } from 'vs/editor/common/languages';
+import { localize } from 'vs/nls';
 import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
 import { ILogService } from 'vs/platform/log/common/log';
 import { ChatAgentLocation, IChatAgentCommand, IChatAgentData, IChatAgentHistoryEntry, IChatAgentRequest, IChatAgentResult, IChatAgentService, reviveSerializedAgent } from 'vs/workbench/contrib/chat/common/chatAgents';
 import { ChatRequestTextPart, IParsedChatRequest, getPromptText, reviveParsedChatRequest } from 'vs/workbench/contrib/chat/common/chatParserTypes';
-import { IChatAgentMarkdownContentWithVulnerability, IChatCommandButton, IChatConfirmation, IChatContentInlineReference, IChatContentReference, IChatFollowup, IChatMarkdownContent, IChatProgressMessage, IChatResponseProgressFileTreeData, IChatTask, IChatTextEdit, IChatTreeData, IChatUsedContext, IChatWarningMessage, ChatAgentVoteDirection, isIUsedContext, IChatProgress, IChatCodeCitation } from 'vs/workbench/contrib/chat/common/chatService';
+import { ChatAgentVoteDirection, IChatAgentMarkdownContentWithVulnerability, IChatCodeCitation, IChatCommandButton, IChatConfirmation, IChatContentInlineReference, IChatContentReference, IChatFollowup, IChatMarkdownContent, IChatProgress, IChatProgressMessage, IChatResponseProgressFileTreeData, IChatTask, IChatTextEdit, IChatTreeData, IChatUsedContext, IChatWarningMessage, isIUsedContext } from 'vs/workbench/contrib/chat/common/chatService';
 import { IChatRequestVariableValue } from 'vs/workbench/contrib/chat/common/chatVariables';
 
 export interface IChatRequestVariableEntry {

src/vs/workbench/contrib/chat/common/chatServiceImpl.ts

@@ -52,6 +52,7 @@ type ChatProviderInvokedEvent = {
 	agent: string;
 	slashCommand: string | undefined;
 	location: ChatAgentLocation;
+	citations: number;
 };
 
 type ChatProviderInvokedClassification = {
@@ -62,7 +63,8 @@ type ChatProviderInvokedClassification = {
 	chatSessionId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'A random ID for the session.' };
 	agent: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The type of agent used.' };
 	slashCommand?: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The type of slashCommand used.' };
-	location?: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The location at which chat request was made.' };
+	location: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The location at which chat request was made.' };
+	citations: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The number of public code citations that were returned with the response.' };
 	owner: 'roblourens';
 	comment: 'Provides insight into the performance of Chat agents.';
 };
@@ -461,6 +463,7 @@ export class ChatService extends Disposable implements IChatService {
 					slashCommand: agentSlashCommandPart ? agentSlashCommandPart.command.name : commandPart?.slashCommand.command,
 					chatSessionId: model.sessionId,
 					location,
+					citations: request?.response?.codeCitations.length ?? 0
 				});
 
 				model.cancelRequest(request);
@@ -546,7 +549,8 @@ export class ChatService extends Disposable implements IChatService {
 						agent: agentPart?.agent.id ?? '',
 						slashCommand: agentSlashCommandPart ? agentSlashCommandPart.command.name : commandPart?.slashCommand.command,
 						chatSessionId: model.sessionId,
-						location
+						location,
+						citations: request.response?.codeCitations.length ?? 0
 					});
 					model.setResponse(request, rawResult);
 					completeResponseCreated();
@@ -569,7 +573,8 @@ export class ChatService extends Disposable implements IChatService {
 					agent: agentPart?.agent.id ?? '',
 					slashCommand: agentSlashCommandPart ? agentSlashCommandPart.command.name : commandPart?.slashCommand.command,
 					chatSessionId: model.sessionId,
-					location
+					location,
+					citations: 0
 				});
 				this.logService.error(`Error while handling chat request: ${toErrorMessage(err, true)}`);
 				if (request) {