Add custom User-Agent header to web requests for telemetry tracking

sample/tsconfig.json

@@ -6,6 +6,7 @@
 		"lib": [
 			"es6"
 		],
+		"skipLibCheck": true,
 		"sourceMap": true,
 		"rootDir": "src",
 		"strict": true   /* enable all strict type-checking options */

vscode-dotnet-runtime-extension/tsconfig.json

@@ -6,6 +6,7 @@
 		"lib": [
 			"es6"
 		],
+		"skipLibCheck": true,
 		"sourceMap": true,
 		"rootDir": "src",
 		"declaration": true,

vscode-dotnet-runtime-library/src/Utils/WebRequestWorkerSingleton.ts

@@ -61,11 +61,24 @@ export class WebRequestWorkerSingleton
     protected static instance: WebRequestWorkerSingleton;
     private clientCreationError: any;
 
+    /**
+     * @returns The axios client instance for testing purposes
+     * @remarks This is exposed for testing only
+     */
+    public getClient(): AxiosCacheInstance | null
+    {
+        return this.client;
+    }
+
     protected constructor()
     {
         try
         {
-            const uncachedAxiosClient = Axios.create();
+            const uncachedAxiosClient = Axios.create({
+                headers: {
+                    'User-Agent': 'vscode-dotnet-runtime'
+                }
+            });
 
             // Wrap the client with a retry interceptor. We don't need to return a new client, it should be applied automatically.
             axiosRetry(uncachedAxiosClient, {
@@ -194,7 +207,12 @@ export class WebRequestWorkerSingleton
         ctx.eventStream.post(new WebRequestUsingAltClient(url, `Using fetch over axios, as axios failed. Axios failure: ${this.clientCreationError ? JSON.stringify(this.clientCreationError) : ''}`));
         try
         {
-            const response = await fetch(url, { signal: AbortSignal.timeout(ctx.timeoutSeconds * 1000) });
+            const response = await fetch(url, { 
+                signal: AbortSignal.timeout(ctx.timeoutSeconds * 1000),
+                headers: {
+                    'User-Agent': 'vscode-dotnet-runtime'
+                }
+            });
             if (url.includes('json'))
             {
                 const responseJson = await response.json();

vscode-dotnet-runtime-library/src/test/unit/WebRequestWorker.test.ts

@@ -1,139 +1,155 @@
-/*---------------------------------------------------------------------------------------------
-*  Licensed to the .NET Foundation under one or more agreements.
-*  The .NET Foundation licenses this file to you under the MIT license.
-*--------------------------------------------------------------------------------------------*/
-import * as chai from 'chai';
-
-import * as chaiAsPromised from 'chai-as-promised';
-import * as path from 'path';
-import { DotnetCoreAcquisitionWorker } from '../../Acquisition/DotnetCoreAcquisitionWorker';
-import { IInstallScriptAcquisitionWorker } from '../../Acquisition/IInstallScriptAcquisitionWorker';
-import
-{
-    DotnetFallbackInstallScriptUsed,
-    DotnetInstallScriptAcquisitionError,
-    WebRequestTime,
-} from '../../EventStream/EventStreamEvents';
-import
-{
-    ErrorAcquisitionInvoker,
-    MockEventStream,
-    MockInstallScriptWorker,
-    MockInstallTracker,
-    MockTrackingWebRequestWorker,
-    MockVSCodeExtensionContext,
-} from '../mocks/MockObjects';
-
-import { LocalMemoryCacheSingleton } from '../../LocalMemoryCacheSingleton';
-import { WebRequestWorkerSingleton } from '../../Utils/WebRequestWorkerSingleton';
-import { getMockAcquisitionContext, getMockUtilityContext } from './TestUtility';
-
-const assert = chai.assert;
-chai.use(chaiAsPromised);
-
-const maxTimeoutTime = 10000;
-// Website used for the sake of it returning the same response always (tm)
-const staticWebsiteUrl = 'https://builds.dotnet.microsoft.com/dotnet/release-metadata/2.1/releases.json';
-
-suite('WebRequestWorker Unit Tests', function ()
-{
-    this.afterEach(async () =>
-    {
-        // Tear down tmp storage for fresh run
-        WebRequestWorkerSingleton.getInstance().destroy();
-        LocalMemoryCacheSingleton.getInstance().invalidate();
-    });
-
-    test('Acquire Version Network Failure', async () =>
-    {
-        const eventStream = new MockEventStream();
-        const mockContext = getMockAcquisitionContext('runtime', '1.0', undefined, eventStream);
-        const acquisitionWorker = new DotnetCoreAcquisitionWorker(getMockUtilityContext(), new MockVSCodeExtensionContext());
-        const invoker = new ErrorAcquisitionInvoker(eventStream);
-        const tracker = new MockInstallTracker(eventStream, mockContext.extensionState);
-
-        try
-        {
-            await assert.isRejected(acquisitionWorker.acquireLocalRuntime(mockContext, invoker), Error, 'Command Failed');
-        }
-        finally
-        {
-            await tracker.endAnySingletonTrackingSessions();
-        }
-    }).timeout(maxTimeoutTime);
-
-    test('Install Script Request Failure', async () =>
-    {
-        const eventStream = new MockEventStream();
-        const installScriptWorker: IInstallScriptAcquisitionWorker = new MockInstallScriptWorker(getMockAcquisitionContext('runtime', '', undefined, eventStream), true);
-        await assert.isRejected(installScriptWorker.getDotnetInstallScriptPath(), Error, 'Failed to Acquire Dotnet Install Script');
-        assert.exists(eventStream.events.find(event => event instanceof DotnetInstallScriptAcquisitionError));
-    });
-
-    test('Install Script Request Failure With Fallback Install Script', async () =>
-    {
-        const eventStream = new MockEventStream();
-
-        const installScriptWorker: IInstallScriptAcquisitionWorker = new MockInstallScriptWorker(getMockAcquisitionContext('runtime', '', undefined, eventStream), true, true);
-
-        const scriptPath = await installScriptWorker.getDotnetInstallScriptPath();
-
-        assert.equal(scriptPath, path.join(__dirname, '..'));
-
-        assert.exists(eventStream.events.find(event => event instanceof DotnetInstallScriptAcquisitionError));
-        assert.exists(eventStream.events.find(event => event instanceof DotnetFallbackInstallScriptUsed));
-    });
-
-    test('Install Script File Manipulation Failure', async () =>
-    {
-        const eventStream = new MockEventStream();
-        const installScriptWorker: IInstallScriptAcquisitionWorker = new MockInstallScriptWorker(getMockAcquisitionContext('runtime', '', undefined, eventStream), true);
-        await assert.isRejected(installScriptWorker.getDotnetInstallScriptPath(), Error, 'Failed to Acquire Dotnet Install Script')
-        assert.exists(eventStream.events.find(event => event instanceof DotnetInstallScriptAcquisitionError));
-    });
-
-    test('Web Requests Cached on Repeated calls', async () =>
-    {
-        const ctx = getMockAcquisitionContext('runtime', '');
-        const webWorker = new MockTrackingWebRequestWorker();
-
-        const uncachedResult = await webWorker.getCachedData(staticWebsiteUrl, ctx);
-        // The data should now be cached.
-        const cachedResult = await webWorker.getCachedData(staticWebsiteUrl, ctx);
-
-        assert.exists(uncachedResult);
-        assert.deepEqual(uncachedResult, cachedResult);
-
-        const requestCount = webWorker.getRequestCount();
-        assert.isAtMost(requestCount, 1);
-    }).timeout(maxTimeoutTime);
-
-    test('Web Requests Cached Does Not Live Forever', async () =>
-    {
-        const ctx = getMockAcquisitionContext('runtime', '');
-        const uri = 'https://microsoft.com';
-
-        const webWorker = new MockTrackingWebRequestWorker(true);
-        const uncachedResult = await webWorker.getCachedData(uri, ctx);
-        await new Promise(resolve => setTimeout(resolve, 120000));
-        const cachedResult = await webWorker.getCachedData(uri, ctx);
-        assert.exists(uncachedResult);
-        const requestCount = webWorker.getRequestCount();
-        assert.isAtLeast(requestCount, 2);
-    }).timeout((maxTimeoutTime * 7) + 120000);
-
-    test('It actually times requests', async () =>
-    {
-        const eventStream = new MockEventStream();
-        const ctx = getMockAcquisitionContext('runtime', '', 600, eventStream);
-        const webWorker = new MockTrackingWebRequestWorker();
-
-        const _ = await webWorker.getCachedData(staticWebsiteUrl, ctx);
-        const timerEvents = eventStream.events.find(event => event instanceof WebRequestTime);
-        assert.exists(timerEvents, 'There exist WebRequestTime Events');
-        assert.equal(timerEvents?.finished, 'true', 'The timed event time finished');
-        assert.isTrue(Number(timerEvents?.durationMs) > 0, 'The timed event time is > 0');
-        assert.isTrue(String(timerEvents?.status).startsWith('2'), 'The timed event has a status 2XX');
-    });
-});
-
+/*---------------------------------------------------------------------------------------------
+*  Licensed to the .NET Foundation under one or more agreements.
+*  The .NET Foundation licenses this file to you under the MIT license.
+*--------------------------------------------------------------------------------------------*/
+import * as chai from 'chai';
+
+import * as chaiAsPromised from 'chai-as-promised';
+import * as path from 'path';
+import { DotnetCoreAcquisitionWorker } from '../../Acquisition/DotnetCoreAcquisitionWorker';
+import { IInstallScriptAcquisitionWorker } from '../../Acquisition/IInstallScriptAcquisitionWorker';
+import
+{
+    DotnetFallbackInstallScriptUsed,
+    DotnetInstallScriptAcquisitionError,
+    WebRequestTime,
+} from '../../EventStream/EventStreamEvents';
+import
+{
+    ErrorAcquisitionInvoker,
+    MockEventStream,
+    MockInstallScriptWorker,
+    MockInstallTracker,
+    MockTrackingWebRequestWorker,
+    MockVSCodeExtensionContext,
+} from '../mocks/MockObjects';
+
+import { LocalMemoryCacheSingleton } from '../../LocalMemoryCacheSingleton';
+import { WebRequestWorkerSingleton } from '../../Utils/WebRequestWorkerSingleton';
+import { getMockAcquisitionContext, getMockUtilityContext } from './TestUtility';
+
+const assert = chai.assert;
+chai.use(chaiAsPromised);
+
+const maxTimeoutTime = 10000;
+// Website used for the sake of it returning the same response always (tm)
+const staticWebsiteUrl = 'https://builds.dotnet.microsoft.com/dotnet/release-metadata/2.1/releases.json';
+
+suite('WebRequestWorker Unit Tests', function ()
+{
+    this.afterEach(async () =>
+    {
+        // Tear down tmp storage for fresh run
+        WebRequestWorkerSingleton.getInstance().destroy();
+        LocalMemoryCacheSingleton.getInstance().invalidate();
+    });
+
+    test('Acquire Version Network Failure', async () =>
+    {
+        const eventStream = new MockEventStream();
+        const mockContext = getMockAcquisitionContext('runtime', '1.0', undefined, eventStream);
+        const acquisitionWorker = new DotnetCoreAcquisitionWorker(getMockUtilityContext(), new MockVSCodeExtensionContext());
+        const invoker = new ErrorAcquisitionInvoker(eventStream);
+        const tracker = new MockInstallTracker(eventStream, mockContext.extensionState);
+
+        try
+        {
+            await assert.isRejected(acquisitionWorker.acquireLocalRuntime(mockContext, invoker), Error, 'Command Failed');
+        }
+        finally
+        {
+            await tracker.endAnySingletonTrackingSessions();
+        }
+    }).timeout(maxTimeoutTime);
+
+    test('Install Script Request Failure', async () =>
+    {
+        const eventStream = new MockEventStream();
+        const installScriptWorker: IInstallScriptAcquisitionWorker = new MockInstallScriptWorker(getMockAcquisitionContext('runtime', '', undefined, eventStream), true);
+        await assert.isRejected(installScriptWorker.getDotnetInstallScriptPath(), Error, 'Failed to Acquire Dotnet Install Script');
+        assert.exists(eventStream.events.find(event => event instanceof DotnetInstallScriptAcquisitionError));
+    });
+
+    test('Install Script Request Failure With Fallback Install Script', async () =>
+    {
+        const eventStream = new MockEventStream();
+
+        const installScriptWorker: IInstallScriptAcquisitionWorker = new MockInstallScriptWorker(getMockAcquisitionContext('runtime', '', undefined, eventStream), true, true);
+
+        const scriptPath = await installScriptWorker.getDotnetInstallScriptPath();
+
+        assert.equal(scriptPath, path.join(__dirname, '..'));
+
+        assert.exists(eventStream.events.find(event => event instanceof DotnetInstallScriptAcquisitionError));
+        assert.exists(eventStream.events.find(event => event instanceof DotnetFallbackInstallScriptUsed));
+    });
+
+    test('Install Script File Manipulation Failure', async () =>
+    {
+        const eventStream = new MockEventStream();
+        const installScriptWorker: IInstallScriptAcquisitionWorker = new MockInstallScriptWorker(getMockAcquisitionContext('runtime', '', undefined, eventStream), true);
+        await assert.isRejected(installScriptWorker.getDotnetInstallScriptPath(), Error, 'Failed to Acquire Dotnet Install Script')
+        assert.exists(eventStream.events.find(event => event instanceof DotnetInstallScriptAcquisitionError));
+    });
+
+    test('Web Requests Cached on Repeated calls', async () =>
+    {
+        const ctx = getMockAcquisitionContext('runtime', '');
+        const webWorker = new MockTrackingWebRequestWorker();
+
+        const uncachedResult = await webWorker.getCachedData(staticWebsiteUrl, ctx);
+        // The data should now be cached.
+        const cachedResult = await webWorker.getCachedData(staticWebsiteUrl, ctx);
+
+        assert.exists(uncachedResult);
+        assert.deepEqual(uncachedResult, cachedResult);
+
+        const requestCount = webWorker.getRequestCount();
+        assert.isAtMost(requestCount, 1);
+    }).timeout(maxTimeoutTime);
+
+    test('Web Requests Cached Does Not Live Forever', async () =>
+    {
+        const ctx = getMockAcquisitionContext('runtime', '');
+        const uri = 'https://microsoft.com';
+
+        const webWorker = new MockTrackingWebRequestWorker(true);
+        const uncachedResult = await webWorker.getCachedData(uri, ctx);
+        await new Promise(resolve => setTimeout(resolve, 120000));
+        const cachedResult = await webWorker.getCachedData(uri, ctx);
+        assert.exists(uncachedResult);
+        const requestCount = webWorker.getRequestCount();
+        assert.isAtLeast(requestCount, 2);
+    }).timeout((maxTimeoutTime * 7) + 120000);
+
+    test('It actually times requests', async () =>
+    {
+        const eventStream = new MockEventStream();
+        const ctx = getMockAcquisitionContext('runtime', '', 600, eventStream);
+        const webWorker = new MockTrackingWebRequestWorker();
+
+        const _ = await webWorker.getCachedData(staticWebsiteUrl, ctx);
+        const timerEvents = eventStream.events.find(event => event instanceof WebRequestTime);
+        assert.exists(timerEvents, 'There exist WebRequestTime Events');
+        assert.equal(timerEvents?.finished, 'true', 'The timed event time finished');
+        assert.isTrue(Number(timerEvents?.durationMs) > 0, 'The timed event time is > 0');
+        assert.isTrue(String(timerEvents?.status).startsWith('2'), 'The timed event has a status 2XX');
+    });
+
+    test('Custom User-Agent header is set correctly', async () =>
+    {
+        const webWorker = WebRequestWorkerSingleton.getInstance();
+        const client = webWorker.getClient();
+
+        // Verify the client has the custom User-Agent header
+        assert.exists(client, 'Axios client should be initialized');
+        if (client && client.defaults && client.defaults.headers)
+        {
+            // Check if User-Agent is set in the default headers
+            const headers = client.defaults.headers;
+            const userAgent = 'User-Agent' in headers ? headers['User-Agent'] : undefined;
+            assert.equal(userAgent, 'vscode-dotnet-runtime', 'User-Agent header should be set to vscode-dotnet-runtime');
+        }
+    });
+});
+

vscode-dotnet-sdk-extension/tsconfig.json

@@ -6,6 +6,7 @@
 		"lib": [
 			"es6"
 		],
+		"skipLibCheck": true,
 		"sourceMap": true,
 		"rootDir": "src",
 		"declaration": true,