Add telemetry for pipenv interpreter discovery (#11507)

* Add pipenv discovery telemetry

(update when getInterpreters signature change gets merged)

* Update after master merge + add unit test

Author: kimadeline

news/3 Code Health/11128.md

@@ -0,0 +1 @@
+Add telemetry for pipenv interpreter discovery.

src/client/interpreter/locators/services/pipEnvService.ts

@@ -9,8 +9,17 @@ import { traceError, traceWarning } from '../../../common/logger';
 import { IFileSystem, IPlatformService } from '../../../common/platform/types';
 import { IProcessServiceFactory } from '../../../common/process/types';
 import { IConfigurationService, ICurrentProcess } from '../../../common/types';
+import { StopWatch } from '../../../common/utils/stopWatch';
 import { IServiceContainer } from '../../../ioc/types';
-import { IInterpreterHelper, InterpreterType, IPipEnvService, PythonInterpreter } from '../../contracts';
+import { sendTelemetryEvent } from '../../../telemetry';
+import { EventName } from '../../../telemetry/constants';
+import {
+    GetInterpreterLocatorOptions,
+    IInterpreterHelper,
+    InterpreterType,
+    IPipEnvService,
+    PythonInterpreter
+} from '../../contracts';
 import { IPipEnvServiceHelper } from '../types';
 import { CacheableLocatorService } from './cacheableLocatorService';
 
@@ -49,6 +58,18 @@ export class PipEnvService extends CacheableLocatorService implements IPipEnvSer
         return this.configService.getSettings().pipenvPath;
     }
 
+    public async getInterpreters(resource?: Uri, options?: GetInterpreterLocatorOptions): Promise<PythonInterpreter[]> {
+        const stopwatch = new StopWatch();
+        const startDiscoveryTime = stopwatch.elapsedTime;
+
+        const interpreters = await super.getInterpreters(resource, options);
+
+        const discoveryDuration = stopwatch.elapsedTime - startDiscoveryTime;
+        sendTelemetryEvent(EventName.PIPENV_INTERPRETER_DISCOVERY, discoveryDuration);
+
+        return interpreters;
+    }
+
     protected getInterpretersImplementation(resource?: Uri): Promise<PythonInterpreter[]> {
         const pipenvCwd = this.getPipenvWorkingDirectory(resource);
         if (!pipenvCwd) {

src/client/telemetry/constants.ts

@@ -28,6 +28,7 @@ export enum EventName {
     PYTHON_INTERPRETER_ACTIVATION_ENVIRONMENT_VARIABLES = 'PYTHON_INTERPRETER_ACTIVATION_ENVIRONMENT_VARIABLES',
     PYTHON_INTERPRETER_ACTIVATION_FOR_RUNNING_CODE = 'PYTHON_INTERPRETER_ACTIVATION_FOR_RUNNING_CODE',
     PYTHON_INTERPRETER_ACTIVATION_FOR_TERMINAL = 'PYTHON_INTERPRETER_ACTIVATION_FOR_TERMINAL',
+    PIPENV_INTERPRETER_DISCOVERY = 'PIPENV_INTERPRETER_DISCOVERY',
     TERMINAL_SHELL_IDENTIFICATION = 'TERMINAL_SHELL_IDENTIFICATION',
     PYTHON_INTERPRETER_ACTIVATE_ENVIRONMENT_PROMPT = 'PYTHON_INTERPRETER_ACTIVATE_ENVIRONMENT_PROMPT',
     PYTHON_NOT_INSTALLED_PROMPT = 'PYTHON_NOT_INSTALLED_PROMPT',

src/client/telemetry/index.ts

@@ -1042,6 +1042,10 @@ export interface IEventNamePropertyMapping {
          */
         interpreters?: number;
     };
+    /**
+     * Telemetry event sent when pipenv interpreter discovery is executed.
+     */
+    [EventName.PIPENV_INTERPRETER_DISCOVERY]: never | undefined;
     /**
      * Telemetry event sent with details when user clicks the prompt with the following message
      * `Prompt message` :- 'We noticed you're using a conda environment. If you are experiencing issues with this environment in the integrated terminal, we suggest the "terminal.integrated.inheritEnv" setting to be changed to false. Would you like to update this setting?'

src/test/interpreters/pipEnvService.unit.test.ts

@@ -9,6 +9,7 @@ import * as assert from 'assert';
 import { expect } from 'chai';
 import * as path from 'path';
 import { SemVer } from 'semver';
+import * as sinon from 'sinon';
 import { anything, instance, mock, when } from 'ts-mockito';
 import * as TypeMoq from 'typemoq';
 import { Uri, WorkspaceFolder } from 'vscode';
@@ -29,6 +30,8 @@ import { PipEnvService } from '../../client/interpreter/locators/services/pipEnv
 import { PipEnvServiceHelper } from '../../client/interpreter/locators/services/pipEnvServiceHelper';
 import { IPipEnvServiceHelper } from '../../client/interpreter/locators/types';
 import { IServiceContainer } from '../../client/ioc/types';
+import * as Telemetry from '../../client/telemetry';
+import { EventName } from '../../client/telemetry/constants';
 
 enum OS {
     Mac,
@@ -271,6 +274,15 @@ suite('Interpreters - PipEnv', () => {
                 const pipenvExe = pipEnvService.executable;
                 assert.equal(pipenvExe, 'spam-spam-pipenv-spam-spam', 'Failed to identify pipenv.exe');
             });
+
+            test('Should send telemetry event when calling getInterpreters', async () => {
+                const sendTelemetryStub = sinon.stub(Telemetry, 'sendTelemetryEvent');
+
+                await pipEnvService.getInterpreters(resource);
+
+                sinon.assert.calledWith(sendTelemetryStub, EventName.PIPENV_INTERPRETER_DISCOVERY);
+                sinon.restore();
+            });
         });
     });
 });