Merge pull request microsoft#262895 from microsoft/tyriar/refine_telemetry

Refine sub-command telemetry, trust it and shell/prompt types

Author: Tyriar

src/vs/workbench/contrib/terminal/browser/terminalTelemetry.ts

@@ -10,6 +10,7 @@ import { Event } from '../../../../base/common/event.js';
 import { Disposable, DisposableStore } from '../../../../base/common/lifecycle.js';
 import { basename } from '../../../../base/common/path.js';
 import { ITelemetryService } from '../../../../platform/telemetry/common/telemetry.js';
+import { TelemetryTrustedValue } from '../../../../platform/telemetry/common/telemetryUtils.js';
 import { TerminalCapability } from '../../../../platform/terminal/common/capabilities/capabilities.js';
 import { TerminalLocation, type IShellLaunchConfig, type ShellIntegrationInjectionFailureReason } from '../../../../platform/terminal/common/terminal.js';
 import type { IWorkbenchContribution } from '../../../common/contributions.js';
@@ -66,8 +67,8 @@ export class TerminalTelemetryContribution extends Disposable implements IWorkbe
 		type TerminalCreationTelemetryData = {
 			location: string;
 
-			shellType: string;
-			promptType: string | undefined;
+			shellType: TelemetryTrustedValue<string>;
+			promptType: TelemetryTrustedValue<string | undefined>;
 
 			isCustomPtyImplementation: boolean;
 			isExtensionOwnedTerminal: boolean;
@@ -107,8 +108,8 @@ export class TerminalTelemetryContribution extends Disposable implements IWorkbe
 					? (isInAuxWindow ? 'editor-auxwindow' : 'editor')
 					: 'unknown'),
 
-			shellType: getSanitizedShellType(slc),
-			promptType: commandDetection?.promptType,
+			shellType: new TelemetryTrustedValue(getSanitizedShellType(slc)),
+			promptType: new TelemetryTrustedValue(commandDetection?.promptType),
 
 			isCustomPtyImplementation: !!slc.customPtyImplementation,
 			isExtensionOwnedTerminal: !!slc.isExtensionOwnedTerminal,

src/vs/workbench/contrib/terminalContrib/chatAgentTools/browser/runInTerminalToolTelemetry.ts

@@ -4,6 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { ITelemetryService } from '../../../../../platform/telemetry/common/telemetry.js';
+import { TelemetryTrustedValue } from '../../../../../platform/telemetry/common/telemetryUtils.js';
 import type { ITerminalInstance } from '../../../terminal/browser/terminal.js';
 import { ShellIntegrationQuality } from './toolTerminalCreator.js';
 
@@ -21,41 +22,42 @@ export class RunInTerminalToolTelemetry {
 		autoApproveDefault: boolean | undefined;
 	}) {
 		const subCommandsSanitized = state.subCommands.map(e => {
-			let commandName = e.split(' ')[0].toLowerCase();
-			if (!commandAllowList.has(commandName)) {
-				if (/[\\\/]/.test(commandName)) {
-					commandName = '(unknown:path)';
-				} else if (/^(?:[A-Z][a-z0-9]+)+(?:-(?:[A-Z][a-z0-9]+))*$/.test(commandName)) {
-					commandName = '(unknown:pwsh)';
-				} else if (/^[a-z0-9_-]+$/i.test(commandName)) {
+			const commandName = e.split(' ')[0];
+			let sanitizedCommandName = commandName.toLowerCase();
+			if (!commandAllowList.has(sanitizedCommandName)) {
+				if (/^(?:[A-Z][a-z0-9]+)+(?:-(?:[A-Z][a-z0-9]+))*$/.test(commandName)) {
+					sanitizedCommandName = '(unknown:pwsh)';
+				} else if (/^[a-z0-9_\-\.\\\/:;]+$/i.test(commandName)) {
 					const properties: string[] = [];
 					if (/[a-z]/.test(commandName)) {
-						properties.push('alpha_lowercase');
+						properties.push('ascii_lower');
 					}
 					if (/[A-Z]/.test(commandName)) {
-						properties.push('alpha_uppercase');
+						properties.push('ascii_upper');
 					}
 					if (/[0-9]/.test(commandName)) {
 						properties.push('numeric');
 					}
-					if (commandName.includes('-')) {
-						properties.push('hyphen');
+					const chars: string[] = [];
+					for (const c of ['.', '-', '_', '/', '\\', ':', ';']) {
+						if (commandName.includes(c)) {
+							chars.push(c);
+						}
 					}
-					if (commandName.includes('_')) {
-						properties.push('underscore');
-					}
-					commandName = `(unknown:${properties.join(',')})`;
+					sanitizedCommandName = `(unknown:${properties.join(',')}:${chars.join('')})`;
+				} else if (/[^\x00-\x7F]/.test(commandName)) {
+					sanitizedCommandName = '(unknown:unicode)';
 				} else {
-					commandName = '(unknown)';
+					sanitizedCommandName = '(unknown)';
 				}
 			}
-			return commandName;
+			return sanitizedCommandName;
 		});
 
 		type TelemetryEvent = {
 			terminalToolSessionId: string | undefined;
 
-			subCommands: string;
+			subCommands: TelemetryTrustedValue<string>;
 			autoApproveResult: string;
 			autoApproveReason: string | undefined;
 			autoApproveDefault: boolean | undefined;
@@ -74,7 +76,7 @@ export class RunInTerminalToolTelemetry {
 
 		this._telemetryService.publicLog2<TelemetryEvent, TelemetryClassification>('toolUse.runInTerminal.prepare', {
 			terminalToolSessionId: state.terminalToolSessionId,
-			subCommands: JSON.stringify(subCommandsSanitized),
+			subCommands: new TelemetryTrustedValue(JSON.stringify(subCommandsSanitized)),
 			autoApproveResult: state.autoApproveResult,
 			autoApproveReason: state.autoApproveReason,
 			autoApproveDefault: state.autoApproveDefault,