Merge pull request #28 from stackb/telemetry

Add telemetry

Author: pcj

docs/subscribing.md

@@ -43,4 +43,13 @@ command from the palette or click the *Rocket* icon from the account view:
 
 ![get-started](https://user-images.githubusercontent.com/50580/95288941-d88f9500-0826-11eb-8d2e-b981ad2f2cab.gif)
 
-To view your account details or manage your subscription, proceed to <https://build.bzl.io/bzl/user>.
+To view your account details or manage your subscription, proceed to
+<https://build.bzl.io/bzl/user>.
+
+### Telemetry.
+
+This extension sends telemetry events to collect usage statistics on various
+features of the extension to help prioritize new features and/or diagnose
+problems.  No personal data is collected.  To opt out of telemetry, set the
+`telemetry.enableTelemetry` to `false` (this is the same flag for vscode
+telemetry itself).

package-lock.json

@@ -2,7 +2,7 @@
     "name": "bazel-stack-vscode",
     "displayName": "bazel-stack-vscode",
     "description": "Bazel Support for Visual Studio Code",
-    "version": "0.5.0",
+    "version": "0.5.1",
     "publisher": "StackBuild",
     "license": "Apache-2.0",
     "icon": "stackb-full.png",
@@ -1030,6 +1030,7 @@
         "tmp": "0.2.1",
         "uuid": "8.3.0",
         "vscode-common": "1.49.0",
+        "vscode-extension-telemetry": "^0.1.6",
         "vscode-languageclient": "6.1.3"
     },
     "devDependencies": {

package.json

@@ -1,6 +1,8 @@
 import * as grpc from '@grpc/grpc-js';
 import * as protobuf from 'protobufjs';
 import * as vscode from 'vscode';
+import { Telemetry } from '../constants';
+import { Container } from '../container';
 import { CancelResponse } from '../proto/build/stack/bezel/v1beta1/CancelResponse';
 import { EnvironmentVariable } from '../proto/build/stack/bezel/v1beta1/EnvironmentVariable';
 import { ExecRequest } from '../proto/build/stack/bezel/v1beta1/ExecRequest';
@@ -80,6 +82,9 @@ export class BzlServerCommandRunner implements vscode.Disposable, CommandTaskRun
         if (!client) {
             return Promise.reject('bzl client not available');
         }
+
+        Container.telemetry.sendTelemetryEvent(Telemetry.BzlRunTask);
+
         return vscode.window.withProgress<void>(
             {
                 location: vscode.ProgressLocation.Notification,

src/bzl/commandrunner.ts

@@ -4,7 +4,7 @@ import * as path from 'path';
 import { URL } from 'url';
 import * as vscode from 'vscode';
 import { markers, markerService, problemMatcher } from 'vscode-common';
-import { BuiltInCommands } from '../../constants';
+import { BuiltInCommands, Telemetry } from '../../constants';
 import { Container, MediaIconName } from '../../container';
 import { downloadAsset } from '../../download';
 import { FileKind } from '../../proto/build/stack/bezel/v1beta1/FileKind';
@@ -202,6 +202,8 @@ export class BuildEventProtocolView extends BzlClientTreeDataProvider<BazelBuild
     }
 
     async handleStartedEvent(e: BazelBuildEvent, started: BuildStarted) {
+        Container.telemetry.sendTelemetryEvent(Telemetry.BzlEventBuildStarted);
+
         this.clear();
         this.state.started = started;
         this.problemCollector.started = started;

src/bzl/view/events.ts

@@ -3,7 +3,7 @@ import * as fs from 'graceful-fs';
 import * as path from 'path';
 import * as vscode from 'vscode';
 import { utils } from 'vscode-common';
-import { BuiltInCommands } from '../../constants';
+import { BuiltInCommands, Telemetry } from '../../constants';
 import { Container, MediaIconName } from '../../container';
 import { ExternalWorkspace } from '../../proto/build/stack/bezel/v1beta1/ExternalWorkspace';
 import { LabelKind } from '../../proto/build/stack/bezel/v1beta1/LabelKind';
@@ -19,7 +19,7 @@ import {
   ContextValue,
   FileName,
   ruleClassIconUri,
-  ViewName,
+  ViewName
 } from '../constants';
 import { BzlClientTreeDataProvider } from './bzlclienttreedataprovider';
 
@@ -353,6 +353,9 @@ export class BzlPackageListView extends BzlClientTreeDataProvider<Node> {
     if (!this.currentWorkspace) {
       return undefined;
     }
+
+    Container.telemetry.sendTelemetryEvent(Telemetry.BzlPackageList);
+
     const pkgs = await this.client?.listPackages(
       this.currentWorkspace,
       this.currentExternalWorkspace

src/bzl/view/packages.ts

@@ -1,7 +1,7 @@
 import * as findUp from 'find-up';
 import * as path from 'path';
 import * as vscode from 'vscode';
-import { BuiltInCommands } from '../../constants';
+import { BuiltInCommands, Telemetry } from '../../constants';
 import { Container, MediaIconName } from '../../container';
 import { Workspace } from '../../proto/build/stack/bezel/v1beta1/Workspace';
 import { BzlClient } from '../bzlclient';
@@ -78,6 +78,8 @@ export class BzlRepositoryListView extends BzlClientTreeDataProvider<RepositoryI
             }
         }
 
+        Container.telemetry.sendTelemetryEvent(Telemetry.BzlRepositoryList);
+
         const workspaces = await client?.listWorkspaces(this.wasManuallyRefreshed);
         return this.createWorkspaceMetadataItems(workspaces, currentCwd!);
     }