Report telemetry data from the project generation wizard.

- Fixes #405
- Add boolean option to registerCommandWithTelemetry that delegates
  telemetry reporting to the command
- perform telemetry directly in the project generation wizard.

Signed-off-by: Roland Grunberg <rgrunber@redhat.com>

Author: rgrunber

USAGE_DATA.md

@@ -15,6 +15,9 @@ vscode-quarkus has opt-in telemetry collection, provided by [vscode-redhat-telem
     * "Quarkus: Debug current Quarkus project"
     * "Quarkus: Deploy current Quarkus project to OpenShift (odo)"
     * "Quarkus: Generate a Quarkus project"
+       * The project type (eg. Maven, Gradle, etc.)
+       * Whether sample code is to be included
+       * The list of Quarkus extensions selected
     * "Quarkus: Welcome"
     * "Quarkus: Build executable"
 

src/commands/registerCommands.ts

@@ -2,7 +2,7 @@ import { commands, ExtensionContext, window } from "vscode";
 import { VSCodeCommands } from "../definitions/constants";
 import { ProjectLabelInfo } from "../definitions/ProjectLabelInfo";
 import { requestStandardMode } from "../utils/requestStandardMode";
-import { sendCommandFailedTelemetry, sendCommandSucceededTelemetry } from "../utils/telemetryUtils";
+import { sendCommandFailedTelemetry, sendCommandSucceededTelemetry, sendTelemetry } from "../utils/telemetryUtils";
 import { WelcomeWebview } from "../webviews/WelcomeWebview";
 import { addExtensionsWizard } from "../wizards/addExtensions/addExtensionsWizard";
 import { buildBinary } from "../wizards/binary/buildBinary";
@@ -23,7 +23,7 @@ export function registerVSCodeCommands(context: ExtensionContext): void {
   /**
    * Command for creating a Quarkus project
    */
-  registerCommandWithTelemetry(context, VSCodeCommands.CREATE_PROJECT, generateProjectWizard);
+  registerCommandWithTelemetry(context, VSCodeCommands.CREATE_PROJECT, generateProjectWizard, true);
 
   /**
    * Command for adding Quarkus extensions to current Quarkus Maven project
@@ -63,12 +63,15 @@ export function registerVSCodeCommands(context: ExtensionContext): void {
  * @param context the extension context
  * @param commandName the name of the command to register
  * @param commandAction the async function to run when the command is called
+ * @param skipSuccess whether the success of the command should be reported
  */
-async function registerCommandWithTelemetry(context: ExtensionContext, commandName: string, commandAction: () => Promise<any>): Promise<void> {
+async function registerCommandWithTelemetry(context: ExtensionContext, commandName: string, commandAction: () => Promise<any>, skipSuccess?: boolean): Promise<void> {
   context.subscriptions.push(commands.registerCommand(commandName, async () => {
     try {
       await commandAction();
-      sendCommandSucceededTelemetry(commandName);
+      if (!skipSuccess) {
+        sendCommandSucceededTelemetry(commandName);
+      }
     } catch (e) {
       const msg = (e instanceof Error) ? e.message : e;
       window.showErrorMessage(msg);

src/utils/telemetryUtils.ts

@@ -1,7 +1,7 @@
 import { getRedHatService, TelemetryService } from "@redhat-developer/vscode-redhat-telemetry/lib";
 import { ExtensionContext } from "vscode";
 
-const CMD_SUCCEED_VALUE = "succeeded";
+export const CMD_SUCCEED_VALUE = "succeeded";
 const CMD_FAIL_VALUE = "failed";
 
 let telemetryService: TelemetryService;
@@ -43,7 +43,6 @@ export async function sendCommandFailedTelemetry(commandName: string, msg?: stri
  * Send a telemetry event related to a given vscode-quarkus command
  *
  * @param commandName the name of the command that was run
- * @param suffix the suffix to add to the command to get the event name
  * @throws if the telemetry service has not been initialized yet
  * @returns when the telemetry event has been sent
  */
@@ -59,3 +58,20 @@ async function sendCommandTelemetry(commandName: string, succeeded: boolean, msg
     }
   });
 }
+
+/**
+ * Send a telemetry event related to a given vscode-quarkus command
+ *
+ * @param commandName the name of the command that was run
+ * @throws if the telemetry service has not been initialized yet
+ * @returns when the telemetry event has been sent
+ */
+ export async function sendTelemetry(commandName: string, data: any): Promise<void> {
+  if (!isTelemetryInit) {
+    throw new Error('Telemetry has not been initialized yet');
+  }
+  await telemetryService.send({
+    name: commandName,
+    properties: data
+  });
+}

src/wizards/generateProject/generationWizard.ts

@@ -8,13 +8,14 @@ import * as fse from 'fs-extra';
 import * as path from 'path';
 import { commands, OpenDialogOptions, QuickPickItem, Uri, window, workspace } from 'vscode';
 import { ZipFile } from 'yauzl';
-import { BuildToolName, INPUT_TITLE } from '../../definitions/constants';
+import { BuildToolName, INPUT_TITLE, VSCodeCommands } from '../../definitions/constants';
 import { ProjectGenState } from '../../definitions/inputState';
 import { QExtension } from '../../definitions/QExtension';
 import { QuarkusContext } from '../../QuarkusContext';
 import { CodeQuarkusFunctionality, PlatformVersionPickItem, getCodeQuarkusApiFunctionality, getDefaultFunctionality, getCodeQuarkusApiPlatforms } from '../../utils/codeQuarkusApiUtils';
 import { MultiStepInput, QuickPickParameters } from '../../utils/multiStepUtils';
 import { downloadProject } from '../../utils/requestUtils';
+import { CMD_SUCCEED_VALUE, sendTelemetry } from '../../utils/telemetryUtils';
 import { ExtensionsPicker } from './ExtensionsPicker';
 import { validateArtifactId, validateGroupId, validatePackageName, validateResourceName, validateVersion } from './validateInput';
 
@@ -23,7 +24,7 @@ import { validateArtifactId, validateGroupId, validatePackageName, validateResou
  *
  * This first part uses the helper class `MultiStepInput` that wraps the API for the multi-step case.
  */
-export async function generateProjectWizard() {
+export async function generateProjectWizard(): Promise<any> {
 
   let apiCapabilities: CodeQuarkusFunctionality;
   try {
@@ -202,6 +203,12 @@ export async function generateProjectWizard() {
   state.targetDir = await getTargetDirectory(state.artifactId);
 
   const projectGenState: ProjectGenState = state as ProjectGenState;
+  await sendTelemetry(VSCodeCommands.CREATE_PROJECT, {
+    status: CMD_SUCCEED_VALUE,
+    buildTool: projectGenState.buildTool,
+    shouldGenerateCode: projectGenState.shouldGenerateCode,
+    extensions: projectGenState.extensions.map(e => `${e.groupId}:${e.artifactId}`).join(',')
+  });
   saveDefaults(projectGenState);
   deleteFolderIfExists(getNewProjectDirectory(projectGenState));
   await downloadAndSetupProject(projectGenState, apiCapabilities);