Merge from vscode aba87f135229c17c4624341b7a2499dcedafcb87 (#6430)

* Merge from vscode aba87f135229c17c4624341b7a2499dcedafcb87

* fix compile errors

src/vs/platform/telemetry/browser/workbenchCommonProperties.ts

@@ -0,0 +1,86 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { IStorageService, StorageScope } from 'vs/platform/storage/common/storage';
+
+export const instanceStorageKey = 'telemetry.instanceId';
+export const currentSessionDateStorageKey = 'telemetry.currentSessionDate';
+export const firstSessionDateStorageKey = 'telemetry.firstSessionDate';
+export const lastSessionDateStorageKey = 'telemetry.lastSessionDate';
+
+import * as Platform from 'vs/base/common/platform';
+import * as uuid from 'vs/base/common/uuid';
+
+export async function resolveWorkbenchCommonProperties(storageService: IStorageService, commit: string | undefined, version: string | undefined, machineId: string, remoteAuthority?: string): Promise<{ [name: string]: string | undefined }> {
+	const result: { [name: string]: string | undefined; } = Object.create(null);
+	const instanceId = storageService.get(instanceStorageKey, StorageScope.GLOBAL)!;
+	const firstSessionDate = storageService.get(firstSessionDateStorageKey, StorageScope.GLOBAL)!;
+	const lastSessionDate = storageService.get(lastSessionDateStorageKey, StorageScope.GLOBAL)!;
+
+	// __GDPR__COMMON__ "common.firstSessionDate" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+	result['common.firstSessionDate'] = firstSessionDate;
+	// __GDPR__COMMON__ "common.lastSessionDate" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+	result['common.lastSessionDate'] = lastSessionDate || '';
+	// __GDPR__COMMON__ "common.isNewSession" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+	result['common.isNewSession'] = !lastSessionDate ? '1' : '0';
+	// __GDPR__COMMON__ "common.instanceId" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+	result['common.instanceId'] = instanceId;
+	// __GDPR__COMMON__ "common.remoteAuthority" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }
+	result['common.remoteAuthority'] = cleanRemoteAuthority(remoteAuthority);
+
+	// __GDPR__COMMON__ "common.machineId" : { "endPoint": "MacAddressHash", "classification": "EndUserPseudonymizedInformation", "purpose": "FeatureInsight" }
+	result['common.machineId'] = machineId;
+	// __GDPR__COMMON__ "sessionID" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+	result['sessionID'] = uuid.generateUuid() + Date.now();
+	// __GDPR__COMMON__ "commitHash" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }
+	result['commitHash'] = commit;
+	// __GDPR__COMMON__ "version" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+	result['version'] = version;
+	// __GDPR__COMMON__ "common.platform" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+	result['common.platform'] = Platform.PlatformToString(Platform.platform);
+	// __GDPR__COMMON__ "common.product" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }
+	result['common.product'] = 'web';
+	// __GDPR__COMMON__ "common.userAgent" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+	result['common.userAgent'] = Platform.userAgent;
+
+	// dynamic properties which value differs on each call
+	let seq = 0;
+	const startTime = Date.now();
+	Object.defineProperties(result, {
+		// __GDPR__COMMON__ "timestamp" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
+		'timestamp': {
+			get: () => new Date(),
+			enumerable: true
+		},
+		// __GDPR__COMMON__ "common.timesincesessionstart" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true }
+		'common.timesincesessionstart': {
+			get: () => Date.now() - startTime,
+			enumerable: true
+		},
+		// __GDPR__COMMON__ "common.sequence" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true }
+		'common.sequence': {
+			get: () => seq++,
+			enumerable: true
+		}
+	});
+
+	return result;
+}
+
+function cleanRemoteAuthority(remoteAuthority?: string): string {
+	if (!remoteAuthority) {
+		return 'none';
+	}
+
+	let ret = 'other';
+	// Whitelisted remote authorities
+	['ssh-remote', 'dev-container', 'wsl'].forEach((res: string) => {
+		if (remoteAuthority!.indexOf(`${res}+`) === 0) {
+			ret = res;
+		}
+	});
+
+	return ret;
+}

src/vs/platform/telemetry/common/telemetryUtils.ts

@@ -9,6 +9,8 @@ import { IKeybindingService, KeybindingSource } from 'vs/platform/keybinding/com
 import { ITelemetryService, ITelemetryInfo, ITelemetryData } from 'vs/platform/telemetry/common/telemetry';
 import { ILogService } from 'vs/platform/log/common/log';
 import { ClassifiedEvent, StrictPropertyCheck, GDPRClassification } from 'vs/platform/telemetry/common/gdprTypings';
+import { safeStringify } from 'vs/base/common/objects';
+import { isObject } from 'vs/base/common/types';
 
 export const NullTelemetryService = new class implements ITelemetryService {
 	_serviceBrand: undefined;
@@ -243,6 +245,77 @@ export function keybindingsTelemetry(telemetryService: ITelemetryService, keybin
 	});
 }
 
+
+export interface Properties {
+	[key: string]: string;
+}
+
+export interface Measurements {
+	[key: string]: number;
+}
+
+export function validateTelemetryData(data?: any): { properties: Properties, measurements: Measurements } {
+
+	const properties: Properties = Object.create(null);
+	const measurements: Measurements = Object.create(null);
+
+	const flat = Object.create(null);
+	flatten(data, flat);
+
+	for (let prop in flat) {
+		// enforce property names less than 150 char, take the last 150 char
+		prop = prop.length > 150 ? prop.substr(prop.length - 149) : prop;
+		const value = flat[prop];
+
+		if (typeof value === 'number') {
+			measurements[prop] = value;
+
+		} else if (typeof value === 'boolean') {
+			measurements[prop] = value ? 1 : 0;
+
+		} else if (typeof value === 'string') {
+			//enforce property value to be less than 1024 char, take the first 1024 char
+			properties[prop] = value.substring(0, 1023);
+
+		} else if (typeof value !== 'undefined' && value !== null) {
+			properties[prop] = value;
+		}
+	}
+
+	return {
+		properties,
+		measurements
+	};
+}
+
+function flatten(obj: any, result: { [key: string]: any }, order: number = 0, prefix?: string): void {
+	if (!obj) {
+		return;
+	}
+
+	for (let item of Object.getOwnPropertyNames(obj)) {
+		const value = obj[item];
+		const index = prefix ? prefix + item : item;
+
+		if (Array.isArray(value)) {
+			result[index] = safeStringify(value);
+
+		} else if (value instanceof Date) {
+			// TODO unsure why this is here and not in _getData
+			result[index] = value.toISOString();
+
+		} else if (isObject(value)) {
+			if (order < 2) {
+				flatten(value, result, order + 1, index + '.');
+			} else {
+				result[index] = safeStringify(value);
+			}
+		} else {
+			result[index] = value;
+		}
+	}
+}
+
 function flattenKeys(value: Object | undefined): string[] {
 	if (!value) {
 		return [];

src/vs/platform/telemetry/node/appInsightsAppender.ts

@@ -4,9 +4,8 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as appInsights from 'applicationinsights';
-import { isObject } from 'vs/base/common/types';
-import { safeStringify, mixin } from 'vs/base/common/objects';
-import { ITelemetryAppender } from 'vs/platform/telemetry/common/telemetryUtils';
+import { mixin } from 'vs/base/common/objects';
+import { ITelemetryAppender, validateTelemetryData } from 'vs/platform/telemetry/common/telemetryUtils';
 import { ILogService } from 'vs/platform/log/common/log';
 
 function getClient(aiKey: string): appInsights.TelemetryClient {
@@ -35,13 +34,6 @@ function getClient(aiKey: string): appInsights.TelemetryClient {
 	return client;
 }
 
-interface Properties {
-	[key: string]: string;
-}
-
-interface Measurements {
-	[key: string]: number;
-}
 
 export class AppInsightsAppender implements ITelemetryAppender {
 
@@ -64,74 +56,12 @@ export class AppInsightsAppender implements ITelemetryAppender {
 		}
 	}
 
-	private static _getData(data?: any): { properties: Properties, measurements: Measurements } {
-
-		const properties: Properties = Object.create(null);
-		const measurements: Measurements = Object.create(null);
-
-		const flat = Object.create(null);
-		AppInsightsAppender._flaten(data, flat);
-
-		for (let prop in flat) {
-			// enforce property names less than 150 char, take the last 150 char
-			prop = prop.length > 150 ? prop.substr(prop.length - 149) : prop;
-			const value = flat[prop];
-
-			if (typeof value === 'number') {
-				measurements[prop] = value;
-
-			} else if (typeof value === 'boolean') {
-				measurements[prop] = value ? 1 : 0;
-
-			} else if (typeof value === 'string') {
-				//enforce property value to be less than 1024 char, take the first 1024 char
-				properties[prop] = value.substring(0, 1023);
-
-			} else if (typeof value !== 'undefined' && value !== null) {
-				properties[prop] = value;
-			}
-		}
-
-		return {
-			properties,
-			measurements
-		};
-	}
-
-	private static _flaten(obj: any, result: { [key: string]: any }, order: number = 0, prefix?: string): void {
-		if (!obj) {
-			return;
-		}
-
-		for (let item of Object.getOwnPropertyNames(obj)) {
-			const value = obj[item];
-			const index = prefix ? prefix + item : item;
-
-			if (Array.isArray(value)) {
-				result[index] = safeStringify(value);
-
-			} else if (value instanceof Date) {
-				// TODO unsure why this is here and not in _getData
-				result[index] = value.toISOString();
-
-			} else if (isObject(value)) {
-				if (order < 2) {
-					AppInsightsAppender._flaten(value, result, order + 1, index + '.');
-				} else {
-					result[index] = safeStringify(value);
-				}
-			} else {
-				result[index] = value;
-			}
-		}
-	}
-
 	log(eventName: string, data?: any): void {
 		if (!this._aiClient) {
 			return;
 		}
 		data = mixin(data, this._defaultData);
-		data = AppInsightsAppender._getData(data);
+		data = validateTelemetryData(data);
 
 		if (this._logService) {
 			this._logService.trace(`telemetry/${eventName}`, data);

src/vs/platform/telemetry/node/telemetry.ts

@@ -8,34 +8,36 @@ import { readdirSync } from 'vs/base/node/pfs';
 import { statSync, readFileSync } from 'fs';
 import { join } from 'vs/base/common/path';
 
-export function buildTelemetryMessage(appRoot: string, extensionsPath: string): string {
-	// Gets all the directories inside the extension directory
-	const dirs = readdirSync(extensionsPath).filter(files => {
-		// This handles case where broken symbolic links can cause statSync to throw and error
-		try {
-			return statSync(join(extensionsPath, files)).isDirectory();
-		} catch {
-			return false;
-		}
-	});
-	const telemetryJsonFolders: string[] = [];
-	dirs.forEach((dir) => {
-		const files = readdirSync(join(extensionsPath, dir)).filter(file => file === 'telemetry.json');
-		// We know it contains a telemetry.json file so we add it to the list of folders which have one
-		if (files.length === 1) {
-			telemetryJsonFolders.push(dir);
-		}
-	});
+export function buildTelemetryMessage(appRoot: string, extensionsPath?: string): string {
 	const mergedTelemetry = Object.create(null);
 	// Simple function to merge the telemetry into one json object
 	const mergeTelemetry = (contents: string, dirName: string) => {
 		const telemetryData = JSON.parse(contents);
 		mergedTelemetry[dirName] = telemetryData;
 	};
-	telemetryJsonFolders.forEach((folder) => {
-		const contents = readFileSync(join(extensionsPath, folder, 'telemetry.json')).toString();
-		mergeTelemetry(contents, folder);
-	});
+	if (extensionsPath) {
+		// Gets all the directories inside the extension directory
+		const dirs = readdirSync(extensionsPath).filter(files => {
+			// This handles case where broken symbolic links can cause statSync to throw and error
+			try {
+				return statSync(join(extensionsPath, files)).isDirectory();
+			} catch {
+				return false;
+			}
+		});
+		const telemetryJsonFolders: string[] = [];
+		dirs.forEach((dir) => {
+			const files = readdirSync(join(extensionsPath, dir)).filter(file => file === 'telemetry.json');
+			// We know it contains a telemetry.json file so we add it to the list of folders which have one
+			if (files.length === 1) {
+				telemetryJsonFolders.push(dir);
+			}
+		});
+		telemetryJsonFolders.forEach((folder) => {
+			const contents = readFileSync(join(extensionsPath, folder, 'telemetry.json')).toString();
+			mergeTelemetry(contents, folder);
+		});
+	}
 	let contents = readFileSync(join(appRoot, 'telemetry-core.json')).toString();
 	mergeTelemetry(contents, 'vscode-core');
 	contents = readFileSync(join(appRoot, 'telemetry-extensions.json')).toString();