Add delay when sending telemetry

Author: Kartik Raj

src/client/deprecatedProposedApi.ts

@@ -4,6 +4,7 @@
 import { ConfigurationTarget, EventEmitter } from 'vscode';
 import { arePathsSame } from './common/platform/fs-paths';
 import { IExtensions, IInterpreterPathService, Resource } from './common/types';
+import { sleep } from './common/utils/async';
 import {
     EnvironmentsChangedParams,
     ActiveEnvironmentChangedParams,
@@ -64,16 +65,19 @@ export function buildDeprecatedProposedApi(
     const extensions = serviceContainer.get<IExtensions>(IExtensions);
     function sendApiTelemetry(apiName: string) {
         console.warn('Extension is using deprecated python APIs which will be removed soon');
-        extensions
-            .determineExtensionFromCallStack()
-            .then((info) =>
-                sendTelemetryEvent(EventName.PYTHON_ENVIRONMENTS_API, undefined, {
-                    apiName,
-                    extensionId: info.extensionId,
-                    displayName: info.displayName,
-                }),
-            )
-            .ignoreErrors();
+        // Add a delay so the calling method finishes as soon as possible.
+        sleep(1000).then(() =>
+            extensions
+                .determineExtensionFromCallStack()
+                .then((info) =>
+                    sendTelemetryEvent(EventName.PYTHON_ENVIRONMENTS_API, undefined, {
+                        apiName,
+                        extensionId: info.extensionId,
+                        displayName: info.displayName,
+                    }),
+                )
+                .ignoreErrors(),
+        );
     }
 
     const proposed: DeprecatedProposedAPI = {

src/client/deprecatedProposedApiTypes.ts

@@ -1,9 +1,8 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 import { Uri, Event } from 'vscode';
-import { ProposedExtensionAPI, Resource } from './proposedApiTypes';
+import { Resource } from './proposedApiTypes';
 import { PythonEnvKind, EnvPathType } from './pythonEnvironments/base/info';
 import { ProgressNotificationEvent, GetRefreshEnvironmentsOptions } from './pythonEnvironments/base/locator';
 

src/client/proposedApi.ts

@@ -32,6 +32,7 @@ import {
     reportActiveInterpreterChangedDeprecated,
     reportInterpretersChanged,
 } from './deprecatedProposedApi';
+import { sleep } from './common/utils/async';
 
 type ActiveEnvironmentChangeEvent = {
     resource: WorkspaceFolder | undefined;
@@ -106,16 +107,19 @@ export function buildProposedApi(
     const disposables = serviceContainer.get<IDisposableRegistry>(IDisposableRegistry);
     const extensions = serviceContainer.get<IExtensions>(IExtensions);
     function sendApiTelemetry(apiName: string) {
-        extensions
-            .determineExtensionFromCallStack()
-            .then((info) =>
-                sendTelemetryEvent(EventName.PYTHON_ENVIRONMENTS_API, undefined, {
-                    apiName,
-                    extensionId: info.extensionId,
-                    displayName: info.displayName,
-                }),
-            )
-            .ignoreErrors();
+        // Add a delay so the calling method finishes as soon as possible.
+        sleep(1000).then(() =>
+            extensions
+                .determineExtensionFromCallStack()
+                .then((info) =>
+                    sendTelemetryEvent(EventName.PYTHON_ENVIRONMENTS_API, undefined, {
+                        apiName,
+                        extensionId: info.extensionId,
+                        displayName: info.displayName,
+                    }),
+                )
+                .ignoreErrors(),
+        );
     }
     disposables.push(
         discoveryApi.onChanged((e) => {
@@ -182,7 +186,6 @@ export function buildProposedApi(
                 return onDidActiveInterpreterChangedEvent.event;
             },
             resolveEnvironment: async (env: Environment | EnvironmentId | string) => {
-                sendApiTelemetry('resolveEnvironment');
                 let path = typeof env !== 'string' ? env.path : env;
                 if (pathUtils.basename(path) === path) {
                     // Value can be `python`, `python3`, `python3.9` etc.
@@ -201,17 +204,18 @@ export function buildProposedApi(
                     }
                     path = fullyQualifiedPath;
                 }
+                sendApiTelemetry('resolveEnvironment');
                 return resolveEnvironment(path, discoveryApi);
             },
             get all(): Environment[] {
                 sendApiTelemetry('all');
                 return discoveryApi.getEnvs().map((e) => convertEnvInfoAndGetReference(e));
             },
             async refreshEnvironments(options?: RefreshOptions) {
-                sendApiTelemetry('refreshEnvironments');
                 await discoveryApi.triggerRefresh(undefined, {
                     ifNotTriggerredAlready: !options?.forceRefresh,
                 });
+                sendApiTelemetry('refreshEnvironments');
             },
             get onDidChangeEnvironments() {
                 sendApiTelemetry('onDidChangeEnvironments');