Disable Analytics by default

Prompt user to enable the analytics on extension first start(only once).

Author: ivanovit

package.json

@@ -67,7 +67,7 @@
  "properties": {
  "nativescript.analytics.enabled": {
  "type": "boolean",
- "default": true,
+ "default": false,
  "description": "Enables the extension tracking."
  },
  "nativescript.tnsPath": {

src/analytics/analyticsService.ts

@@ -5,12 +5,19 @@ import { TelerikAnalyticsService } from './telerikAnalyticsService';
 import { AnalyticsBaseInfo, OperatingSystem } from './analyticsBaseInfo';
 import { Services } from '../services/extensionHostServices';
 import * as utils from '../common/utilities';
+import * as vscode from 'vscode';
 
 export class AnalyticsService {
+ private static HAS_ANALYTICS_PROMPT_SHOWN = "nativescript.hasAnalyticsPromptShown";
+ private static ANALYTICS_PROMPT_MESSAGE = "Help improve NativeScript Extension by allowing Progress to collect data usage.";
+ private static ANALYTICS_PROMPT_ACTION = "Track";
+
+ private _globalState: vscode.Memento;
  private _baseInfo: AnalyticsBaseInfo;
  private _gua: GUAService;
  private _ta: TelerikAnalyticsService;
  private _analyticsEnabled: boolean;
+ private disposables: vscode.Disposable[] = [];
 
  public static generateMachineId(): string {
  let machineId = '';
@@ -27,27 +34,20 @@ export class AnalyticsService {
  return machineId;
  }
 
- constructor() {
- this._analyticsEnabled = Services.workspaceConfigService().isAnalyticsEnabled;
- let operatingSystem = OperatingSystem.Other;
- switch(process.platform) {
- case 'win32': { operatingSystem = OperatingSystem.Windows; break; }
- case 'darwin': { operatingSystem = OperatingSystem.OSX; break; }
- case 'linux':
- case 'freebsd': { operatingSystem = OperatingSystem.Linux; break; }
- };
+ constructor(globalState: vscode.Memento) {
+ this._globalState = globalState;
+
+ //TODO: Dispose
+ vscode.workspace.onDidChangeConfiguration(() => this.updateAnalyticsEnabled());
 
  this._baseInfo = {
  cliVersion: Services.cli().version.toString(),
  extensionVersion: utils.getInstalledExtensionVersion().toString(),
- operatingSystem: operatingSystem,
+ operatingSystem: AnalyticsService.getOperatingSystem(),
  userId: AnalyticsService.generateMachineId()
  };
 
- if(this._analyticsEnabled) {
- this._gua = new GUAService('UA-111455-29', this._baseInfo);
- this._ta = new TelerikAnalyticsService('b8b2e51f188f43e9b0dfb899f7b71cc6', this._baseInfo);
- }
+ this.initializeAnalytics();
  }
 
  public launchDebugger(request: string, platform: string): Promise<any> {
@@ -73,4 +73,47 @@ export class AnalyticsService {
  }
  return Promise.resolve();
  }
+
+ private static getOperatingSystem() : OperatingSystem {
+ switch(process.platform) {
+ case 'win32':
+ return OperatingSystem.Windows;
+ case 'darwin':
+ return OperatingSystem.OSX;
+ case 'linux':
+ case 'freebsd':
+ return OperatingSystem.Linux;
+ default:
+ return OperatingSystem.Other;
+ };
+ }
+
+ private initializeAnalytics() : void {
+ const hasAnalyticsPromptShown = this._globalState.get(AnalyticsService.HAS_ANALYTICS_PROMPT_SHOWN);
+ if(hasAnalyticsPromptShown) {
+ vscode.window.showInformationMessage(AnalyticsService.ANALYTICS_PROMPT_MESSAGE, AnalyticsService.ANALYTICS_PROMPT_ACTION)
+ .then(result => this.onAnalyticsMessageConfirmation(result));
+
+ return;
+ }
+
+ this.updateAnalyticsEnabled();
+ }
+
+ private onAnalyticsMessageConfirmation(result: string) : void {
+ const shouldEnableAnalytics = result === AnalyticsService.ANALYTICS_PROMPT_ACTION ? true : false;
+
+ Services.workspaceConfigService().isAnalyticsEnabled = shouldEnableAnalytics;
+ this.updateAnalyticsEnabled();
+ this._globalState.update(AnalyticsService.HAS_ANALYTICS_PROMPT_SHOWN, true);
+ }
+
+ private updateAnalyticsEnabled() {
+ this._analyticsEnabled = Services.workspaceConfigService().isAnalyticsEnabled;
+
+ if(this._analyticsEnabled) {
+ this._gua = this._gua || new GUAService('UA-111455-29', this._baseInfo);
+ this._ta = this._ta || new TelerikAnalyticsService('b8b2e51f188f43e9b0dfb899f7b71cc6', this._baseInfo);
+ }
+ }
 }

src/common/workspaceConfigService.ts

@@ -5,6 +5,10 @@ export class WorkspaceConfigService {
  return vscode.workspace.getConfiguration('nativescript').get('analytics.enabled') as boolean;
  }
 
+ public set isAnalyticsEnabled(isAnalyticsEnabled: boolean) {
+ vscode.workspace.getConfiguration('nativescript').update('analytics.enabled', isAnalyticsEnabled);
+ }
+
  public get tnsPath(): string {
  return vscode.workspace.getConfiguration('nativescript').get('tnsPath') as string;
  }

src/services/extensionHostServices.ts

@@ -36,7 +36,7 @@ export class ExtensionHostServices extends BaseServices {
  }
 
  public analyticsService(): AnalyticsService {
- this._analyticsService = this._analyticsService || new AnalyticsService();
+ this._analyticsService = this._analyticsService || new AnalyticsService(this.globalState);
  return this._analyticsService;
  }
 }