Support custom fetchers + fix version injection (#233)

Author: lramos15

dist/telemetryReporter.d.ts

@@ -26,13 +26,26 @@ export interface ReplacementOption {
 	replacementString?: string;
 }
 
+/**
+ * A custom fetcher function that can be used to send telemetry data.
+ * Compatible with the Node.js fetch API signature.
+ * @param url The URL to send the request to
+ * @param init The request initialization options including method, headers, and body
+ * @returns A promise that resolves to a Response object
+ */
+export type CustomFetcher = (
+	url: string,
+	init?: { method: "POST"; headers?: Record<string, string>; body?: string }
+) => Promise<{text: () => Promise<string>; status: number; headers: Iterable<[string, string]>}>;
+
 export class TelemetryReporter {
 	/**
 	 * @param connectionString The app insights connection string
 	 * @param replacementOptions A list of replacement options for the app insights client. This allows the sender to filter out any sensitive or unnecessary information from the telemetry server.
 	 * @param initializationOptions Options for configuring the telemetry reporter, including additional common properties to be sent with each event.
+	 * @param customFetcher An optional custom fetcher function to use for sending telemetry data. If not provided, the default HTTPS module will be used. Compatible with Node.js fetch API.
 	 */
-	constructor(connectionString: string, replacementOptions?: ReplacementOption[], initializationOptions?: import("vscode").TelemetryLoggerOptions);
+	constructor(connectionString: string, replacementOptions?: ReplacementOption[], initializationOptions?: import("vscode").TelemetryLoggerOptions, customFetcher?: CustomFetcher);
 
 	/**
 	 * A string representation of the current level of telemetry being collected

injectVersion.js

@@ -11,7 +11,12 @@ const baseUtil = fs.readFileSync('./dist/node/common/util.js', 'utf8');
 const newBaseUtil = baseUtil.replace(/PACKAGE_JSON_VERSION/g, packageJson.version);
 fs.writeFileSync('./dist/node/common/util.js', newBaseUtil);
 
+// Reads dist/node-esm/common/util.js and replaces PACKAGE_JSON_VERSION with the number from the package.json
+const baseUtilEsm = fs.readFileSync('./dist/node-esm/common/util.js', 'utf8');
+const newBaseUtilEsm = baseUtilEsm.replace(/PACKAGE_JSON_VERSION/g, packageJson.version);
+fs.writeFileSync('./dist/node-esm/common/util.js', newBaseUtilEsm);
+
 // Reads dist/browser/common/util.js and replaces PACKAGE_JSON_VERSION with the number from the package.json
 const baseUtilBrowser = fs.readFileSync('./dist/browser/common/util.js', 'utf8');
 const newBaseUtilBrowser = baseUtilBrowser.replace(/PACKAGE_JSON_VERSION/g, packageJson.version);
-fs.writeFileSync('./dist/browser/common/util.js', newBaseUtilBrowser);
+fs.writeFileSync('./dist/browser/common/util.js', newBaseUtilBrowser);

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@vscode/extension-telemetry",
   "description": "A module for Visual Studio Code extensions to report consistent telemetry.",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "author": {
     "name": "Microsoft Corporation"
   },

package.json

@@ -12,11 +12,23 @@ import { BaseTelemetryReporter, ReplacementOption } from "../common/baseTelemetr
 import { BaseTelemetrySender } from "../common/baseTelemetrySender";
 import { TelemetryUtil } from "../common/util";
 
+/**
+ * A custom fetcher function that can be used to send telemetry data.
+ * Compatible with the Node.js fetch API signature.
+ * @param url The URL to send the request to
+ * @param init The request initialization options including method, headers, and body
+ * @returns A promise that resolves to a Response object
+ */
+export type CustomFetcher = (
+	url: string,
+	init?: { method: "POST"; headers?: Record<string, string>; body?: string }
+) => Promise<{text: () => Promise<string>; status: number; headers: Iterable<[string, string]>}>;
+
 /**
  * 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() {
+function getDefaultXHROverride(): IXHROverride {
 	// Override the way events get sent since node doesn't have XHTMLRequest
 	const customHttpXHROverride: IXHROverride = {
 		sendPOST: (payload: IPayloadData, oncomplete) => {
@@ -31,7 +43,7 @@ function getXHROverride() {
 			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());
+						oncomplete(res.statusCode ?? 200, res.headers as Record<string, string>, 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 () {
@@ -53,12 +65,46 @@ function getXHROverride() {
 	return customHttpXHROverride;
 }
 
+/**
+ * Create an XHR override from a custom fetcher function.
+ * @param fetcher The custom fetcher function to use for sending telemetry data
+ * @returns A XHR override object used to override the XHTMLRequest object in the 1DS SDK
+ */
+function createXHROverrideFromFetcher(fetcher: CustomFetcher): IXHROverride {
+	const xhrOverride: IXHROverride = {
+		sendPOST: (payload: IPayloadData, oncomplete) => {
+			const dataString = typeof payload.data === "string" ? payload.data : Buffer.from(payload.data).toString();
+
+			fetcher(payload.urlString, { method: "POST", headers: payload.headers, body: dataString })
+				.then(async (response) => {
+					const responseHeaders: Record<string, string> = {};
+					for (const [key, value] of response.headers) {
+						responseHeaders[key] = value;
+					}
+					const body = await response.text();
+					oncomplete(response.status, responseHeaders, body);
+				})
+				.catch(() => {
+					// If it errors out, send status of 0 and a blank response to oncomplete so we can retry events
+					oncomplete(0, {});
+				});
+		}
+	};
+	return xhrOverride;
+}
+
 export class TelemetryReporter extends BaseTelemetryReporter {
-	constructor(connectionString: string, replacementOptions?: ReplacementOption[], initializationOptions?: vscode.TelemetryLoggerOptions) {
-		let clientFactory = (connectionString: string) => appInsightsClientFactory(connectionString, vscode.env.machineId, vscode.env.sessionId, getXHROverride(), replacementOptions);
+	constructor(
+		connectionString: string,
+		replacementOptions?: ReplacementOption[],
+		initializationOptions?: vscode.TelemetryLoggerOptions,
+		customFetcher?: CustomFetcher
+	) {
+		const xhrOverride = customFetcher ? createXHROverrideFromFetcher(customFetcher) : getDefaultXHROverride();
+		let clientFactory = (connectionString: string) => appInsightsClientFactory(connectionString, vscode.env.machineId, vscode.env.sessionId, xhrOverride, replacementOptions);
 		// If connection string is usable by 1DS use the 1DS SDk
 		if (TelemetryUtil.shouldUseOneDataSystemSDK(connectionString)) {
-			clientFactory = (key: string) => oneDataSystemClientFactory(key, vscode, getXHROverride());
+			clientFactory = (key: string) => oneDataSystemClientFactory(key, vscode, xhrOverride);
 		}
 
 		const osShim = {