Implement 1ds SDK

Author: lramos15

src/browser/1dsTelemetryReporter.ts

@@ -4,6 +4,7 @@
 
 import type { ApplicationInsights } from "@microsoft/applicationinsights-web";
 import * as vscode from "vscode";
+import { oneDataSystemClientFactory } from "../common/1dsClientFactory";
 import { BaseTelemetryAppender, BaseTelemetryClient } from "../common/baseTelemetryAppender";
 import { AppenderData, BaseTelemetryReporter, ReplacementOption } from "../common/baseTelemetryReporter";
 import { TelemetryUtil } from "../common/util";
@@ -71,8 +72,15 @@ const webAppInsightsClientFactory = async (key: string, replacementOptions?: Rep
 
 export default class TelemetryReporter extends BaseTelemetryReporter {
 	constructor(extensionId: string, extensionVersion: string, key: string, firstParty?: boolean, replacementOptions?: ReplacementOption[]) {
-		const appender = new BaseTelemetryAppender(key, key => webAppInsightsClientFactory(key, replacementOptions));
-		if (key && key.indexOf("AIF-") === 0) {
+		let clientFactory = (key: string) => webAppInsightsClientFactory(key, replacementOptions);
+		// If key is usable by 1DS use the 1DS SDk
+		if (TelemetryUtil.shouldUseOneDataSystemSDK(key)) {
+			clientFactory = (key: string) => oneDataSystemClientFactory(key);
+		}
+
+		const appender = new BaseTelemetryAppender(key, clientFactory);
+		// If it's a specialized AIF app insights key or a 1DS key then it is first party
+		if (key && (key.indexOf("AIF-") === 0 || TelemetryUtil.shouldUseOneDataSystemSDK(key))) {
 			firstParty = true;
 		}
 		super(extensionId, extensionVersion, appender, {

src/browser/telemetryReporter.ts

@@ -149,7 +149,7 @@ export class BaseTelemetryReporter {
 	// __GDPR__COMMON__ "common.isnewappinstall" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
 	// __GDPR__COMMON__ "common.product" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
 	private getCommonProperties(): TelemetryEventProperties {
-		const commonProperties = Object.create(null);
+		const commonProperties: Record<string, any> = {};
 		commonProperties["common.os"] = this.osShim.platform;
 		commonProperties["common.nodeArch"] = this.osShim.architecture;
 		commonProperties["common.platformversion"] = (this.osShim.release || "").replace(/^(\d+)(\.\d+)?(\.\d+)?(.*)/, "$1$2$3");
@@ -242,7 +242,7 @@ export class BaseTelemetryReporter {
 		if (typeof properties !== "object") {
 			return;
 		}
-		const cleanedObject = Object.create(null);
+		const cleanedObject: Record<string, any> = {};
 		// Loop through key and values of the properties object
 		for (const key of Object.keys(properties)) {
 			const value = properties[key];

src/common/baseTelemetryReporter.ts

@@ -56,6 +56,23 @@ export class TelemetryUtil {
 		}
 	}
 
+	/**
+	 * Given a key checks if it is a valid 1DS key
+	 * @param key The key to check if it's a valid 1DS key
+	 */
+	public static shouldUseOneDataSystemSDK(key: string): boolean {
+		// Simple to check to ensure the key is the right length and the dashes are in the right spot
+		return (
+			key.length === 74 &&
+			key[32] === "-" &&
+			key[41] === "-" &&
+			key[46]	=== "-" &&
+			key[51] === "-" &&
+			key[56] === "-" &&
+			key[69] === "-"
+		);
+	}
+
 	// Get singleton instance of TelemetryUtil
 	public static getInstance(vscodeAPI: typeof vscode): TelemetryUtil {
 		if (!TelemetryUtil._instance) {

src/common/util.ts

@@ -4,10 +4,13 @@
 
 import * as os from "os";
 import * as vscode from "vscode";
+import * as https from "https";
 import type { TelemetryClient } from "applicationinsights";
 import { AppenderData, BaseTelemetryReporter, ReplacementOption } from "../common/baseTelemetryReporter";
 import { BaseTelemetryAppender, BaseTelemetryClient } from "../common/baseTelemetryAppender";
 import { TelemetryUtil } from "../common/util";
+import type { IXHROverride, IPayloadData } from "@microsoft/1ds-post-js";
+import { oneDataSystemClientFactory } from "../common/1dsClientFactory";
 /**
  * A factory function which creates a telemetry client to be used by an appender to send telemetry in a node application.
  *
@@ -118,10 +121,54 @@ function addReplacementOptions(appInsightsClient: TelemetryClient, replacementOp
 	});
 }
 
+/**
+ * Create a replacement for the XHTMLRequest object utilizing nodes HTTP module.
+ * @returns A XHR override object used to override the XHTMLRequest object in the 1DS SDK
+ */
+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 {
 	constructor(extensionId: string, extensionVersion: string, key: string, firstParty?: boolean, replacementOptions?: ReplacementOption[]) {
-		const appender = new BaseTelemetryAppender(key, (key) => appInsightsClientFactory(key, replacementOptions));
-		if (key && key.indexOf("AIF-") === 0) {
+		let clientFactory = (key: string) => appInsightsClientFactory(key, replacementOptions);
+		// If key is usable by 1DS use the 1DS SDk
+		if (TelemetryUtil.shouldUseOneDataSystemSDK(key)) {
+			clientFactory = (key: string) => oneDataSystemClientFactory(key, getXHROverride());
+		}
+
+		const appender = new BaseTelemetryAppender(key, clientFactory);
+		// If it's a specialized AIF app insights key or a 1DS key then it is first party
+		if (key && (key.indexOf("AIF-") === 0 || TelemetryUtil.shouldUseOneDataSystemSDK(key))) {
 			firstParty = true;
 		}
 		super(extensionId, extensionVersion, appender, {