Add telemetry event when creating environment using button (#21172)

A temporary command to understand the usage of the create environment button. Fixes #21168
microsoft · May 3, 2023 · 7dfa631 · 7dfa631
1 parent f5eded2
commit 7dfa631
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 3 deletions.
diff --git a/package.json b/package.json
@@ -277,6 +277,11 @@
                 "command": "python.createEnvironment",
                 "title": "%python.command.python.createEnvironment.title%"
             },
+            {
+                "category": "Python",
+                "command": "python.createEnvironment-button",
+                "title": "%python.command.python.createEnvironment.title%"
+            },
             {
                 "category": "Python",
                 "command": "python.enableLinting",
@@ -1700,12 +1705,12 @@
             "editor/content": [
                 {
                     "group": "Python",
-                    "command": "python.createEnvironment",
+                    "command": "python.createEnvironment-button",
                     "when": "resourceLangId == pip-requirements && !virtualWorkspace && shellExecutionSupported && !inDiffEditor"
                 },
                 {
                     "group": "Python",
-                    "command": "python.createEnvironment",
+                    "command": "python.createEnvironment-button",
                     "when": "resourceFilename == pyproject.toml && pipInstallableToml && !virtualWorkspace && shellExecutionSupported  && !inDiffEditor"
                 }
             ],

diff --git a/src/client/common/constants.ts b/src/client/common/constants.ts
@@ -37,6 +37,7 @@ export namespace Commands {
     export const CreateNewFile = 'python.createNewFile';
     export const ClearWorkspaceInterpreter = 'python.clearWorkspaceInterpreter';
     export const Create_Environment = 'python.createEnvironment';
+    export const Create_Environment_Button = 'python.createEnvironment-button';
     export const Create_Terminal = 'python.createTerminal';
     export const Debug_In_Terminal = 'python.debugInTerminal';
     export const Enable_Linter = 'python.enableLinting';

diff --git a/src/client/pythonEnvironments/creation/createEnvApi.ts b/src/client/pythonEnvironments/creation/createEnvApi.ts
@@ -4,7 +4,7 @@
 import { ConfigurationTarget, Disposable } from 'vscode';
 import { Commands } from '../../common/constants';
 import { IDisposableRegistry, IInterpreterPathService, IPathUtils } from '../../common/types';
-import { registerCommand } from '../../common/vscodeApis/commandApis';
+import { executeCommand, registerCommand } from '../../common/vscodeApis/commandApis';
 import { IInterpreterQuickPick } from '../../interpreter/configuration/types';
 import { getCreationEvents, handleCreateEnvironmentCommand } from './createEnvironment';
 import { condaCreationProvider } from './provider/condaCreationProvider';
@@ -18,6 +18,8 @@ import {
     ProposedCreateEnvironmentAPI,
     EnvironmentDidCreateEvent,
 } from './proposed.createEnvApis';
+import { sendTelemetryEvent } from '../../telemetry';
+import { EventName } from '../../telemetry/constants';
 
 class CreateEnvironmentProviders {
     private _createEnvProviders: CreateEnvironmentProvider[] = [];
@@ -67,6 +69,13 @@ export function registerCreateEnvironmentFeatures(
                 return handleCreateEnvironmentCommand(providers, options);
             },
         ),
+        registerCommand(
+            Commands.Create_Environment_Button,
+            async (): Promise<void> => {
+                sendTelemetryEvent(EventName.ENVIRONMENT_BUTTON, undefined, undefined);
+                await executeCommand(Commands.Create_Environment);
+            },
+        ),
         registerCreateEnvironmentProvider(new VenvCreationProvider(interpreterQuickPick)),
         registerCreateEnvironmentProvider(condaCreationProvider()),
         onCreateEnvironmentExited(async (e: EnvironmentDidCreateEvent) => {

diff --git a/src/client/telemetry/constants.ts b/src/client/telemetry/constants.ts
@@ -111,6 +111,7 @@ export enum EventName {
     ENVIRONMENT_INSTALLING_PACKAGES = 'ENVIRONMENT.INSTALLING_PACKAGES',
     ENVIRONMENT_INSTALLED_PACKAGES = 'ENVIRONMENT.INSTALLED_PACKAGES',
     ENVIRONMENT_INSTALLING_PACKAGES_FAILED = 'ENVIRONMENT.INSTALLING_PACKAGES_FAILED',
+    ENVIRONMENT_BUTTON = 'ENVIRONMENT.BUTTON',
 
     TOOLS_EXTENSIONS_ALREADY_INSTALLED = 'TOOLS_EXTENSIONS.ALREADY_INSTALLED',
     TOOLS_EXTENSIONS_PROMPT_SHOWN = 'TOOLS_EXTENSIONS.PROMPT_SHOWN',

diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts
@@ -2098,6 +2098,13 @@ export interface IEventNamePropertyMapping {
         environmentType: 'venv' | 'conda' | 'microvenv';
         using: 'pipUpgrade' | 'requirements.txt' | 'pyproject.toml' | 'environment.yml' | 'pipDownload' | 'pipInstall';
     };
+    /**
+     * Telemetry event sent if create environment button was used to trigger the command.
+     */
+    /* __GDPR__
+       "environment.button" : {"owner": "karthiknadig" }
+     */
+    [EventName.ENVIRONMENT_BUTTON]: never | undefined;
     /**
      * Telemetry event sent when a linter or formatter extension is already installed.
      */