Convert telemetry to a class

Created the TelemetryListener and stuffed most of the functions in
telemetry.ts into this class. Tests had to change a significant amount.

Also addressed other comments from code review.

Author: aeisenberg

.github/TELEMETRY.md

@@ -1,8 +1,8 @@
-# Telemetry in the CodeQL for VS Code
+# Telemetry in the CodeQL extension for VS Code
 
 ## Why do you collect data?
 
-GitHub collects usage data and metrics to help us improve Salesforce Extensions for VS Code.
+GitHub collects usage data and metrics to help us improve CodeQL for VS Code.
 
 ## What data is collected
 
@@ -16,6 +16,6 @@ GitHub collects anonymous information related to the usage of the extensions. Th
 
 ## How do I disable telemetry reporting?
 
-You can disable telemetry reporting by setting `codeQL.telemetry.enableTelemetry` to `false` in your settings.
+You can disable telemetry reporting by setting `codeQL.telemetry.enableTelemetry` to `false` in [your settings](https://code.visualstudio.com/docs/getstarted/settings#_settings-editor).
 
-Additionally, telemetry will be disabled if the global `telemetry.enableTelemetry` is set to `false`. For more information see [Microsoft’s documentation](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting).
+Additionally, telemetry will be disabled if the global `telemetry.enableTelemetry` setting is set to `false`. For more information on global telemetry collection, see [Microsoft’s documentation](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting).

extensions/ql-vscode/gulpfile.ts/index.ts

@@ -7,11 +7,9 @@ import { packageExtension } from './package';
 import { injectAppInsightsKey } from './appInsights';
 
 export const buildWithoutPackage =
-  gulp.series(
-    gulp.parallel(
-      compileTypeScript, compileTextMateGrammar, compileView, copyTestData, copyViewCss
-    ),
-    injectAppInsightsKey
+  gulp.parallel(
+    compileTypeScript, compileTextMateGrammar, compileView, copyTestData, copyViewCss
   );
+
 export { compileTextMateGrammar, watchTypeScript, compileTypeScript, injectAppInsightsKey };
-exports.default = gulp.series(buildWithoutPackage, packageExtension);
+exports.default = gulp.series(buildWithoutPackage, injectAppInsightsKey, packageExtension);

extensions/ql-vscode/package.json

@@ -179,7 +179,7 @@
           "type": "boolean",
           "default": false,
           "scope": "application",
-          "markdownDescription": "Specifies whether to enable Code QL telemetry. This setting AND the global `#telemetry.enableTelemetry#` setting must be checked for telemetry to be sent. For more information, see [TELEMETRY.md](https://github.com/github/vscode-codeql/blob/93831e28597bb08567db9844737efd9ff188fc3a/.github/TELEMETRY.md)"
+          "markdownDescription": "Specifies whether to send CodeQL usage telemetry. This setting AND the global `#telemetry.enableTelemetry#` setting must be checked for telemetry to be sent to GitHub. For more information, see [TELEMETRY.md](https://github.com/github/vscode-codeql/blob/main/.github/TELEMETRY.md)"
         },
         "codeQL.telemetry.logTelemetry": {
           "type": "boolean",

extensions/ql-vscode/src/commandRunner.ts

@@ -8,7 +8,7 @@ import {
 } from 'vscode';
 import { showAndLogErrorMessage, showAndLogWarningMessage } from './helpers';
 import { logger } from './logging';
-import { sendCommandUsage } from './telemetry';
+import { telemetryListener } from './telemetry';
 
 export class UserCancellationException extends Error {
   /**
@@ -134,7 +134,7 @@ export function commandRunner(
       }
     } finally {
       const executionTime = Date.now() - startTIme;
-      sendCommandUsage(commandId, executionTime, error);
+      telemetryListener.sendCommandUsage(commandId, executionTime, error);
     }
   });
 }
@@ -177,7 +177,7 @@ export function commandRunnerWithProgress<R>(
       }
     } finally {
       const executionTime = Date.now() - startTIme;
-      sendCommandUsage(commandId, executionTime, error);
+      telemetryListener.sendCommandUsage(commandId, executionTime, error);
     }
   });
 }

extensions/ql-vscode/src/config.ts

@@ -4,7 +4,7 @@ import { DistributionManager } from './distribution';
 import { logger } from './logging';
 
 /** Helper class to look up a labelled (and possibly nested) setting. */
-class Setting {
+export class Setting {
   name: string;
   parent?: Setting;
 
@@ -39,8 +39,16 @@ class Setting {
 
 const ROOT_SETTING = new Setting('codeQL');
 
-// Distribution configuration
+// Global configuration
+const TELEMETRY_SETTING = new Setting('telemetry', ROOT_SETTING);
+const GLOBAL_TELEMETRY_SETTING = new Setting('telemetry');
+
+export const LOG_TELEMETRY = new Setting('logTelemetry', TELEMETRY_SETTING);
+export const ENABLE_TELEMETRY = new Setting('enableTelemetry', TELEMETRY_SETTING);
 
+export const GLOBAL_ENABLE_TELEMETRY = new Setting('enableTelemetry', GLOBAL_TELEMETRY_SETTING);
+
+// Distribution configuration
 const DISTRIBUTION_SETTING = new Setting('cli', ROOT_SETTING);
 const CUSTOM_CODEQL_PATH_SETTING = new Setting('executablePath', DISTRIBUTION_SETTING);
 const INCLUDE_PRERELEASE_SETTING = new Setting('includePrerelease', DISTRIBUTION_SETTING);
@@ -70,8 +78,6 @@ const DEBUG_SETTING = new Setting('debug', RUNNING_QUERIES_SETTING);
 const RUNNING_TESTS_SETTING = new Setting('runningTests', ROOT_SETTING);
 const RESULTS_DISPLAY_SETTING = new Setting('resultsDisplay', ROOT_SETTING);
 
-export const LOG_TELEMETRY = new Setting('telemetry.logTelemetry', ROOT_SETTING);
-export const ENABLE_TELEMETRY = new Setting('telemetry.enableTelemetry', ROOT_SETTING);
 export const NUMBER_OF_TEST_THREADS_SETTING = new Setting('numberOfThreads', RUNNING_TESTS_SETTING);
 export const MAX_QUERIES = new Setting('maxQueries', RUNNING_QUERIES_SETTING);
 export const AUTOSAVE_SETTING = new Setting('autoSave', RUNNING_QUERIES_SETTING);
@@ -105,7 +111,7 @@ export interface CliConfig {
 }
 
 
-abstract class ConfigListener extends DisposableObject {
+export abstract class ConfigListener extends DisposableObject {
   protected readonly _onDidChangeConfiguration = this.push(new EventEmitter<void>());
 
   constructor() {

extensions/ql-vscode/src/helpers.ts

@@ -71,11 +71,15 @@ async function internalShowAndLog(message: string, items: string[], outputLogger
 
 /**
  * Opens a modal dialog for the user to make a yes/no choice.
+ *
  * @param message The message to show.
+ * @param modal If true (the default), show a modal dialog box, otherwise dialog is non-modal and can
+ *        be closed even if the user does not make a choice.
  *
  * @return `true` if the user clicks 'Yes', `false` if the user clicks 'No' or cancels the dialog.
+ *        Return `undefined` if the user avoids a choice on a non-modal dialog.
  */
-export async function showBinaryChoiceDialog(message: string, { modal = true } = {}): Promise<boolean | undefined> {
+export async function showBinaryChoiceDialog(message: string, modal = true): Promise<boolean | undefined> {
   const yesItem = { title: 'Yes', isCloseAffordance: false };
   const noItem = { title: 'No', isCloseAffordance: true };
   const chosenItem = await Window.showInformationMessage(message, { modal }, yesItem, noItem);