feat: add telemetry for install/uninstall packages (#302)

Author: karthiknadig

src/api.ts

@@ -596,7 +596,7 @@ export interface PackageManager {
     /**
      * Installs/Uninstall packages in the specified Python environment.
      * @param environment - The Python environment in which to install packages.
-     * @param packages - The packages to install.
+     * @param options - Options for managing packages.
      * @returns A promise that resolves when the installation is complete.
      */
     manage(environment: PythonEnvironment, options: PackageManagementOptions): Promise<void>;

src/common/telemetry/constants.ts

@@ -7,6 +7,8 @@ export enum EventNames {
 
     VENV_USING_UV = 'VENV.USING_UV',
     VENV_CREATION = 'VENV.CREATION',
+
+    PACKAGE_MANAGEMENT = 'PACKAGE_MANAGEMENT',
 }
 
 // Map all events to their properties
@@ -45,14 +47,23 @@ export interface IEventNamePropertyMapping {
     /* __GDPR__
         "venv.using_uv": {"owner": "karthiknadig" }
     */
-    [EventNames.VENV_USING_UV]: never | undefined;
-
-    /* __GDPR__
+    [EventNames.VENV_USING_UV]: never | undefined /* __GDPR__
         "venv.creation": {
             "creationType": { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "karthiknadig" }
         }
-    */
+    */;
     [EventNames.VENV_CREATION]: {
         creationType: 'quick' | 'custom';
     };
+
+    /* __GDPR__
+        "package.install": {
+            "managerId": { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "karthiknadig" },
+            "result": { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "karthiknadig" }
+        }
+    */
+    [EventNames.PACKAGE_MANAGEMENT]: {
+        managerId: string;
+        result: 'success' | 'error' | 'cancelled';
+    };
 }

src/extension.ts

@@ -1,7 +1,7 @@
 import { commands, ExtensionContext, LogOutputChannel, Terminal, Uri } from 'vscode';
 
 import { PythonEnvironmentManagers } from './features/envManagers';
-import { registerLogger, traceInfo } from './common/logging';
+import { registerLogger, traceError, traceInfo } from './common/logging';
 import { EnvManagerView } from './features/views/envManagersView';
 import {
     addPythonProject,
@@ -138,7 +138,11 @@ export async function activate(context: ExtensionContext): Promise<PythonEnviron
                 envManagers,
                 projectManager,
             );
-            packageManager.manage(environment, { install: [] });
+            try {
+                packageManager.manage(environment, { install: [] });
+            } catch (err) {
+                traceError('Error when running command python-envs.packages', err);
+            }
         }),
         commands.registerCommand('python-envs.uninstallPackage', async (context: unknown) => {
             await handlePackageUninstall(context, envManagers);

src/internal.api.ts

@@ -1,4 +1,4 @@
-import { Disposable, Event, LogOutputChannel, MarkdownString, Uri } from 'vscode';
+import { CancellationError, Disposable, Event, LogOutputChannel, MarkdownString, Uri } from 'vscode';
 import {
     PythonEnvironment,
     EnvironmentManager,
@@ -28,6 +28,8 @@ import {
     CreateEnvironmentOptions,
 } from './api';
 import { CreateEnvironmentNotSupported, RemoveEnvironmentNotSupported } from './common/errors/NotSupportedError';
+import { sendTelemetryEvent } from './common/telemetry/sender';
+import { EventNames } from './common/telemetry/constants';
 
 export type EnvironmentManagerScope = undefined | string | Uri | PythonEnvironment;
 export type PackageManagerScope = undefined | string | Uri | PythonEnvironment | Package;
@@ -241,8 +243,21 @@ export class InternalPackageManager implements PackageManager {
         return this.manager.log;
     }
 
-    manage(environment: PythonEnvironment, options: PackageManagementOptions): Promise<void> {
-        return this.manager.manage(environment, options);
+    async manage(environment: PythonEnvironment, options: PackageManagementOptions): Promise<void> {
+        try {
+            await this.manager.manage(environment, options);
+            sendTelemetryEvent(EventNames.PACKAGE_MANAGEMENT, undefined, { managerId: this.id, result: 'success' });
+        } catch (error) {
+            if (error instanceof CancellationError) {
+                sendTelemetryEvent(EventNames.PACKAGE_MANAGEMENT, undefined, {
+                    managerId: this.id,
+                    result: 'cancelled',
+                });
+                throw error;
+            }
+            sendTelemetryEvent(EventNames.PACKAGE_MANAGEMENT, undefined, { managerId: this.id, result: 'error' });
+            throw error;
+        }
     }
 
     refresh(environment: PythonEnvironment): Promise<void> {

src/managers/builtin/pipManager.ts

@@ -1,4 +1,13 @@
-import { Event, EventEmitter, LogOutputChannel, MarkdownString, ProgressLocation, ThemeIcon, window } from 'vscode';
+import {
+    CancellationError,
+    Event,
+    EventEmitter,
+    LogOutputChannel,
+    MarkdownString,
+    ProgressLocation,
+    ThemeIcon,
+    window,
+} from 'vscode';
 import {
     DidChangePackagesEventArgs,
     IconPath,
@@ -82,13 +91,17 @@ export class PipPackageManager implements PackageManager, Disposable {
                     this.packages.set(environment.envId.id, after);
                     this._onDidChangePackages.fire({ environment, manager: this, changes });
                 } catch (e) {
+                    if (e instanceof CancellationError) {
+                        throw e;
+                    }
                     this.log.error('Error managing packages', e);
                     setImmediate(async () => {
                         const result = await window.showErrorMessage('Error managing packages', 'View Output');
                         if (result === 'View Output') {
                             this.log.show();
                         }
                     });
+                    throw e;
                 }
             },
         );

src/managers/conda/condaPackageManager.ts

@@ -85,7 +85,7 @@ export class CondaPackageManager implements PackageManager, Disposable {
                     this._onDidChangePackages.fire({ environment: environment, manager: this, changes });
                 } catch (e) {
                     if (e instanceof CancellationError) {
-                        return;
+                        throw e;
                     }
 
                     this.log.error('Error installing packages', e);