Add powershell version telemetry

package.json

@@ -40,6 +40,7 @@
     "onView:PowerShellCommands"
   ],
   "dependencies": {
+    "vscode-extension-telemetry": "~0.1.1",
     "vscode-languageclient": "~5.2.1"
   },
   "devDependencies": {

src/main.ts

@@ -6,6 +6,7 @@
 
 import path = require("path");
 import vscode = require("vscode");
+import TelemetryReporter from "vscode-extension-telemetry";
 import { DocumentSelector } from "vscode-languageclient";
 import { IFeature } from "./feature";
 import { CodeActionsFeature } from "./features/CodeActions";
@@ -35,24 +36,39 @@ import Settings = require("./settings");
 import { PowerShellLanguageId } from "./utils";
 import utils = require("./utils");
 
+// The most reliable way to get the name and version of the current extension.
+// tslint:disable-next-line: no-var-requires
+const PackageJSON: any = require("../../package.json");
+
 // NOTE: We will need to find a better way to deal with the required
 //       PS Editor Services version...
 const requiredEditorServicesVersion = "2.0.0";
 
+// the application insights key (also known as instrumentation key) used for telemetry.
+const AI_KEY: string = "AIF-d9b70cd4-b9f9-4d70-929b-a071c400b217";
+
 let logger: Logger;
 let sessionManager: SessionManager;
 let extensionFeatures: IFeature[] = [];
+let telemetryReporter: TelemetryReporter;
 
 const documentSelector: DocumentSelector = [
     { language: "powershell", scheme: "file" },
     { language: "powershell", scheme: "untitled" },
 ];
 
 export function activate(context: vscode.ExtensionContext): void {
+    // create telemetry reporter on extension activation
+    telemetryReporter = new TelemetryReporter(PackageJSON.name, PackageJSON.version, AI_KEY);
 
-    const version = getCurrentVersion(context);
+    // If both extensions are enabled, this will cause unexpected behavior since both register the same commands
+    if (PackageJSON.name.toLowerCase() === "powerShell-preview"
+        && vscode.extensions.getExtension("ms-vscode.powershell")) {
+        vscode.window.showWarningMessage(
+            "'PowerShell' and 'PowerShell Preview' are both enabled. Please disable one for best performance.");
+    }
 
-    checkForUpdatedVersion(context, version);
+    checkForUpdatedVersion(context, PackageJSON.version);
 
     vscode.languages.setLanguageConfiguration(
         PowerShellLanguageId,
@@ -119,7 +135,8 @@ export function activate(context: vscode.ExtensionContext): void {
             requiredEditorServicesVersion,
             logger,
             documentSelector,
-            version);
+            PackageJSON.version,
+            telemetryReporter);
 
     // Create features
     extensionFeatures = [
@@ -153,36 +170,6 @@ export function activate(context: vscode.ExtensionContext): void {
     }
 }
 
-// Until VSCode offers an easier way to grab the extension name,
-// we have this function as a workaround to grab the version
-function getCurrentVersion(context: vscode.ExtensionContext) {
-    // sometimes storagePath is null. This happens when an Untitled workspace is opened
-    let pathToCheck: string;
-    if (context.storagePath) {
-        pathToCheck = context.storagePath;
-    } else if (context.extensionPath) {
-        pathToCheck = context.extensionPath;
-    } else {
-        pathToCheck = __dirname;
-    }
-
-    const extensionName = pathToCheck.toLowerCase().includes("ms-vscode.powershell-preview") ?
-        "ms-vscode.PowerShell-Preview" : "ms-vscode.PowerShell";
-
-    // If both extensions are enabled, this will cause unexpected behavior since both register the same commands
-    if (extensionName === "ms-vscode.PowerShell-Preview"
-        && vscode.extensions.getExtension("ms-vscode.PowerShell")) {
-        vscode.window.showWarningMessage(
-            "'PowerShell' and 'PowerShell Preview' are both enabled. Please disable one for best performance.");
-    }
-
-    return vscode
-        .extensions
-        .getExtension(extensionName)
-        .packageJSON
-        .version;
-}
-
 function checkForUpdatedVersion(context: vscode.ExtensionContext, version: string) {
 
     const showReleaseNotes = "Show Release Notes";
@@ -223,4 +210,7 @@ export function deactivate(): void {
 
     // Dispose of the logger
     logger.dispose();
+
+    // Dispose of telemetry reporter
+    telemetryReporter.dispose();
 }

src/session.ts

@@ -10,6 +10,7 @@ import os = require("os");
 import path = require("path");
 import { StringDecoder } from "string_decoder";
 import vscode = require("vscode");
+import TelemetryReporter from "vscode-extension-telemetry";
 import { Message } from "vscode-jsonrpc";
 import { IFeature } from "./feature";
 import { Logger } from "./logging";
@@ -55,6 +56,7 @@ export class SessionManager implements Middleware {
     private sessionSettings: Settings.ISettings = undefined;
     private sessionDetails: utils.IEditorServicesSessionDetails;
     private bundledModulesPath: string;
+    private telemetryReporter: TelemetryReporter;
 
     // When in development mode, VS Code's session ID is a fake
     // value of "someValue.machineId".  Use that to detect dev
@@ -66,10 +68,12 @@ export class SessionManager implements Middleware {
         private requiredEditorServicesVersion: string,
         private log: Logger,
         private documentSelector: DocumentSelector,
-        private version: string) {
+        private version: string,
+        private reporter: TelemetryReporter) {
 
         this.platformDetails = getPlatformDetails();
         this.HostVersion = version;
+        this.telemetryReporter = reporter;
 
         const osBitness = this.platformDetails.isOS64Bit ? "64-bit" : "32-bit";
         const procBitness = this.platformDetails.isProcess64Bit ? "64-bit" : "32-bit";
@@ -108,6 +112,11 @@ export class SessionManager implements Middleware {
         this.createStatusBarItem();
 
         this.powerShellExePath = this.getPowerShellExePath();
+        cp.exec(`${this.powerShellExePath} -v`, (error: cp.ExecException, stdout: string, stderr: string) => {
+            if (!error && !stderr) {
+                this.telemetryReporter.sendTelemetryEvent("powershellVersionCheck", { powershellVersion: stdout });
+            }
+        });
 
         // Check for OpenSSL dependency on macOS when running PowerShell Core alpha. Look for the default
         // Homebrew installation path and if that fails check the system-wide library path.