src/vs/platform/telemetry/node/1dsAppender.ts
117 LOC · 52 covered · 65 uncovered · 7 ranges · 1493 concepts · 2 introducers · 688 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
/*---------------------------------------------------------------------------------------------
agentHostMicrosoftTelemetry.ts ×7
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import type { IPayloadData, IXHROverride } from '@microsoft/1ds-post-js';
import { streamToBuffer } from '../../../base/common/buffer.js';
import { CancellationToken } from '../../../base/common/cancellation.js';
import { IRequestOptions } from '../../../base/parts/request/common/request.js';
import { IRequestService, NO_FETCH_TELEMETRY } from '../../request/common/request.js';
import { AbstractOneDataSystemAppender, IAppInsightsCore } from '../common/1dsAppender.js';
type OnCompleteFunc = (status: number, headers: { [headerName: string]: string }, response?: string) => void;
interface IResponseData {
headers: { [headerName: string]: string };
statusCode: number;
responseData: string;
}
/**
* Completes a request to submit telemetry to the server utilizing the request service
* @param options The options which will be used to make the request
* @param requestService The request service
* @returns An object containing the headers, statusCode, and responseData
*/
async function makeTelemetryRequest(options: IRequestOptions, requestService: IRequestService): Promise<IResponseData> {
const response = await requestService.request(options, CancellationToken.None);
const responseData = (await streamToBuffer(response.stream)).toString();
const statusCode = response.res.statusCode ?? 200;
const headers = response.res.headers as Record<string, string>;
return {
headers,
statusCode,
responseData
};
}
/**
* Complete a request to submit telemetry to the server utilizing the https module. Only used when the request service is not available
* @param options The options which will be used to make the request
* @returns An object containing the headers, statusCode, and responseData
*/
async function makeLegacyTelemetryRequest(options: IRequestOptions): Promise<IResponseData> {
const https = await import('https'); // Lazy due to https://github.com/nodejs/node/issues/59686
const httpsOptions = {
method: options.type,
headers: options.headers
};
const responsePromise = new Promise<IResponseData>((resolve, reject) => {
const req = https.request(options.url ?? '', httpsOptions, res => {
res.on('data', function (responseData) {
resolve({
headers: res.headers as Record<string, string>,
statusCode: res.statusCode ?? 200,
responseData: 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 (err) {
reject(err);
});
});
req.write(options.data, (err) => {
if (err) {
reject(err);
}
});
req.end();
});
return responsePromise;
}
async function sendPostAsync(requestService: IRequestService | undefined, payload: IPayloadData, oncomplete: OnCompleteFunc) {
const telemetryRequestData = typeof payload.data === 'string' ? payload.data : new TextDecoder().decode(payload.data);
const requestOptions: IRequestOptions = {
type: 'POST',
headers: {
...payload.headers,
'Content-Type': 'application/json',
'Content-Length': Buffer.byteLength(payload.data).toString()
},
url: payload.urlString,
data: telemetryRequestData,
callSite: NO_FETCH_TELEMETRY
};
try {
const responseData = requestService ? await makeTelemetryRequest(requestOptions, requestService) : await makeLegacyTelemetryRequest(requestOptions);
oncomplete(responseData.statusCode, responseData.headers, responseData.responseData);
} catch {
// If it errors out, send status of 0 and a blank response to oncomplete so we can retry events
oncomplete(0, {});
}
}
export class OneDataSystemAppender extends AbstractOneDataSystemAppender {
constructor(
isInternalTelemetry: boolean,
eventPrefix: string,
defaultData: { [key: string]: unknown } | null,
iKeyOrClientFactory: string | (() => IAppInsightsCore), // allow factory function for testing
) {
// Override the way events get sent since node doesn't have XHTMLRequest
const customHttpXHROverride: IXHROverride = {
sendPOST: (payload: IPayloadData, oncomplete: OnCompleteFunc) => {
// Fire off the async request without awaiting it
sendPostAsync(requestService, payload, oncomplete);
}
super(isInternalTelemetry, eventPrefix, defaultData, iKeyOrClientFactory, customHttpXHROverride);
}