Initial support for 1ds sdk

Author: lramos15

package-lock.json

@@ -18,6 +18,8 @@
     "compile": "tsc -noEmit -p 'src/browser/tsconfig.json' && tsc -noEmit -p 'src/node/tsconfig.json' && npm run build"
   },
   "devDependencies": {
+    "@microsoft/1ds-core-js": "^3.2.3",
+    "@microsoft/1ds-post-js": "^3.2.3",
     "@microsoft/applicationinsights-web": "^2.6.4",
     "@types/mocha": "^9.1.1",
     "@types/node": "^16.11.32",

package.json

@@ -0,0 +1,24 @@
+/*---------------------------------------------------------
+ * Copyright (C) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------*/
+
+import * as vscode from "vscode";
+import { BaseTelemetryAppender } from "../common/baseTelemetryAppender";
+import { BaseTelemetryReporter, ReplacementOption } from "../common/baseTelemetryReporter";
+import { oneDataSystemClientFactory } from "../common/1dsClientFactory";
+
+
+export default class TelemetryReporter extends BaseTelemetryReporter {
+	// TODO add ReplacementOption support
+	constructor(extensionId: string, extensionVersion: string, key: string, firstParty?: boolean, _replacementOptions?: ReplacementOption[]) {
+		const appender = new BaseTelemetryAppender(key, key => oneDataSystemClientFactory(key));
+		// First party is always true for 1DS
+		firstParty = true;
+		super(extensionId, extensionVersion, appender, {
+			release: navigator.appVersion,
+			platform: "web",
+			architecture: "web",
+		}, vscode, firstParty);
+	}
+}
+

src/browser/1dsTelemetryReporter.ts

@@ -0,0 +1,89 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import type { AppInsightsCore, IExtendedConfiguration } from "@microsoft/1ds-core-js";
+import type { IChannelConfiguration, IXHROverride, PostChannel } from "@microsoft/1ds-post-js";
+import type { BaseTelemetryClient } from "./baseTelemetryAppender";
+import { AppenderData } from "./baseTelemetryReporter";
+
+/**
+ * Configures 1DS properly and returns the core client object
+ * @param key The ingestion key
+ * @param xhrOverride An optional override to use for requests instead of the XHTMLRequest object. Useful for node environments
+ * @returns The AI core object
+ */
+const getAICore = async (key: string, xhrOverride?: IXHROverride): Promise<AppInsightsCore> => {
+	const oneDs = await import("@microsoft/1ds-core-js");
+	const postPlugin = await import("@microsoft/1ds-post-js");
+	const appInsightsCore = new oneDs.AppInsightsCore();
+	const collectorChannelPlugin: PostChannel = new postPlugin.PostChannel();
+	// Configure the app insights core to send to collector++ and disable logging of debug info
+	const coreConfig: IExtendedConfiguration = {
+		instrumentationKey: key,
+		endpointUrl: "https://mobile.events.data.microsoft.com/OneCollector/1.0",
+		loggingLevelTelemetry: 0,
+		loggingLevelConsole: 0,
+		disableCookiesUsage: true,
+		disableDbgExt: true,
+		disableInstrumentationKeyValidation: true,
+		channels: [[
+			collectorChannelPlugin
+		]]
+	};
+
+	if (xhrOverride) {
+		coreConfig.extensionConfig = {};
+		// Configure the channel to use a XHR Request override since it's not available in node
+		const channelConfig: IChannelConfiguration = {
+			alwaysUseXhrOverride: true,
+			httpXHROverride: xhrOverride
+		};
+		coreConfig.extensionConfig[collectorChannelPlugin.identifier] = channelConfig;
+	}
+
+	appInsightsCore.initialize(coreConfig, []);
+
+	appInsightsCore.addTelemetryInitializer((envelope) => {
+		envelope["ext"] = envelope["ext"] ?? {};
+		envelope["ext"]["utc"] = envelope["ext"]["utc"] ?? {};
+		// Sets it to be internal only based on Windows UTC flagging
+		envelope["ext"]["utc"]["flags"] = 0x0000811ECD;
+	});
+
+	return appInsightsCore;
+};
+
+/**
+ * Configures and creates a telemetry client using the 1DS sdk
+ * @param key The ingestion key
+ * @param xhrOverride An optional override to use for requests instead of the XHTMLRequest object. Useful for node environments
+ */
+export const oneDataSystemClientFactory = async (key: string, xhrOverride?: IXHROverride): Promise<BaseTelemetryClient> => {
+	const appInsightsCore = await getAICore(key, xhrOverride);
+	// Shape the app insights core from 1DS into a standard format
+	const telemetryClient: BaseTelemetryClient = {
+		logEvent: (eventName: string, data?: AppenderData) => {
+			try {
+				appInsightsCore?.track({
+					name: eventName,
+					data: { ...data?.properties, ...data?.measurements },
+				});
+			} catch (e: any) {
+				throw new Error("Failed to log event to app insights!\n" + e.message);
+			}
+		},
+		logException: (_exception: Error, _data?: AppenderData) => {
+			throw new Error("1DS SDK does not support logging exceptions, please use logEvent for exception tracking");
+		},
+		flush: async () => {
+			try {
+				appInsightsCore?.unload();
+			} catch (e: any) {
+				throw new Error("Failed to flush app insights!\n" + e.message);
+			}
+		}
+	};
+	return telemetryClient;
+};

src/common/1dsClientFactory.ts

@@ -0,0 +1,59 @@
+/*---------------------------------------------------------
+ * Copyright (C) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------*/
+
+import type { IPayloadData, IXHROverride } from "@microsoft/1ds-post-js";
+import * as os from "os";
+import * as https from "https";
+import * as vscode from "vscode";
+import { BaseTelemetryAppender } from "../common/baseTelemetryAppender";
+import { BaseTelemetryReporter, ReplacementOption } from "../common/baseTelemetryReporter";
+import { oneDataSystemClientFactory } from "../common/1dsClientFactory";
+
+
+function getXHROverride() {
+	// Override the way events get sent since node doesn't have XHTMLRequest
+	const customHttpXHROverride: IXHROverride = {
+		sendPOST: (payload: IPayloadData, oncomplete) => {
+			const options = {
+				method: "POST",
+				headers: {
+					...payload.headers,
+					"Content-Type": "application/json",
+					"Content-Length": Buffer.byteLength(payload.data)
+				}
+			};
+			try {
+				const req = https.request(payload.urlString, options, res => {
+					res.on("data", function (responseData) {
+						oncomplete(res.statusCode ?? 200, res.headers as Record<string, any>, responseData.toString());
+					});
+					// On response with error send status of 0 and a blank response to oncomplete so we can retry events
+					res.on("error", function () {
+						oncomplete(0, {});
+					});
+				});
+				req.write(payload.data);
+				req.end();
+			} catch {
+				// If it errors out, send status of 0 and a blank response to oncomplete so we can retry events
+				oncomplete(0, {});
+			}
+		}
+	};
+	return customHttpXHROverride;
+}
+
+export default class TelemetryReporter extends BaseTelemetryReporter {
+	// TODO add ReplacementOption support
+	constructor(extensionId: string, extensionVersion: string, key: string, firstParty?: boolean, _replacementOptions?: ReplacementOption[]) {
+		const appender = new BaseTelemetryAppender(key, (key) => oneDataSystemClientFactory(key, getXHROverride()));
+		// 1DS only supports first party so this is always true
+		firstParty = true;
+		super(extensionId, extensionVersion, appender, {
+			release: os.release(),
+			platform: os.platform(),
+			architecture: os.arch(),
+		}, vscode, firstParty);
+	}
+}

src/node/1dsTelemetryReporter.ts

@@ -3,6 +3,7 @@
 		"noEmitOnError": false,
 		"strict": true,
 		"target": "ES2020",
+		"module": "ES2020",
 		"esModuleInterop": true,
 		"forceConsistentCasingInFileNames": true,
 		"sourceMap": true,