Final fixes

Author: ivanovit

README.md

@@ -31,7 +31,7 @@ Your application will be launched and the VSCode debugger will attach. If you wa
 
 ### NativeScript commands
 
-Type `NativeScript` in the Command Palette and you will see all available commands. 
+Type `NativeScript` in the Command Palette and you will see all available commands.
 
 ![NativeScript Commands](https://raw.githubusercontent.com/NativeScript/nativescript-vscode-extension/master/images/screenshots/nativescript-commands.png)
 
@@ -50,7 +50,7 @@ If your version of NativeScript is incompatible with the extension you will see
     npm install
     npm run build # compiles TypeScript source files to JavaScript
     npm run package # produces nativescript-*.*.*.vsix in the root folder
-    ```    
+    ```
 
 3. To test the extension run the following commands in the root repository folder:
 
@@ -60,6 +60,17 @@ If your version of NativeScript is incompatible with the extension you will see
     npm run launch-as-server # launches the debug adapter in server mode
     # execute this in a separate terminal
     npm run test-mac # run tests on ios device
-    ```    
+    ```
 
 4. To install the extension drag and drop the `nativescript-*.*.*.vsix` package in the VS Code.
+
+### How to disable the analytics
+NativeScript Extension for Visual Studio Code collects usage data and sends it to Progress to help improve our products and services.
+
+If you don’t wish to send usage data to Progress, you can set the **nativescript.analytics.enabled** to **false**.
+
+From **File > Preferences > Settings** (macOS: **Code > Preferences > Settings**), add the following option to disable analytics:
+
+```
+"nativescript.analytics.enabled": false
+```

package.json

@@ -29,6 +29,7 @@
     "source-map": "0.6.1",
     "tree-kill": "^1.2.0",
     "universal-analytics": "0.4.13",
+    "uuid": "^3.2.1",
     "vscode-chrome-debug-core": "~3.9.0",
     "vscode-debugadapter": "1.26.0",
     "vscode-debugprotocol": "1.26.0",

src/analytics/analyticsBaseInfo.ts

@@ -9,5 +9,5 @@ export interface AnalyticsBaseInfo {
     operatingSystem: OperatingSystem,
     cliVersion: string,
     extensionVersion: string,
-    userId: string
+    clientId: string
 }

src/analytics/analyticsService.ts

@@ -5,47 +5,34 @@ import { AnalyticsBaseInfo, OperatingSystem } from './analyticsBaseInfo';
 import { Services } from '../services/extensionHostServices';
 import * as utils from '../common/utilities';
 import * as vscode from 'vscode';
+import * as uuid from "uuid";
 
 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 static HAS_ANALYTICS_PROMPT_SHOWN_KEY = "nativescript.hasAnalyticsPromptShown";
+    private static CLIENT_ID_KEY = "nativescript.analyticsClientId";
+    private static ANALYTICS_PROMPT_MESSAGE = "Help improve NativeScript Extension by allowing Progress to collect data usage. " +
+                                              "Read our [privacy statement](https://www.telerik.com/about/privacy-policy) and " +
+                                              "learn how to [disable analytics settings.](https://github.com/NativeScript/nativescript-vscode-extension/blob/master/README.md#how-to-disable-the-analytics). " +
+                                              "Do you want to enable analytics?";
+    private static ANALYTICS_PROMPT_ACCEPT_ACTION = "Yes";
+    private static ANALYTICS_PROMPT_DENY_ACTION = "No";
 
     private _globalState: vscode.Memento;
     private _baseInfo: AnalyticsBaseInfo;
     private _gua: GUAService;
     private _analyticsEnabled: boolean;
-    private disposables: vscode.Disposable[] = [];
-
-    public static generateMachineId(): string {
-        let machineId = '';
-        try {
-            let netInterfaces = os.networkInterfaces();
-            Object.keys(netInterfaces).forEach(interfName => {
-                netInterfaces[interfName].forEach(interf => {
-                    if (!interf.internal) {
-                        machineId += `${interf.mac}-`;
-                    }
-                });
-            });
-        } catch(e) {}
-        return machineId;
-    }
 
     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: AnalyticsService.getOperatingSystem(),
-            userId: AnalyticsService.generateMachineId()
+            clientId: this.getOrGenerateClientId()
         };
-
-        this.initializeAnalytics();
     }
 
     public launchDebugger(request: string, platform: string): Promise<any> {
@@ -82,10 +69,13 @@ export class AnalyticsService {
         };
     }
 
-    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)
+    public initialize() : void {
+        const hasAnalyticsPromptShown = this._globalState.get<boolean>(AnalyticsService.HAS_ANALYTICS_PROMPT_SHOWN_KEY);
+        if(!hasAnalyticsPromptShown) {
+            vscode.window.showInformationMessage(AnalyticsService.ANALYTICS_PROMPT_MESSAGE,
+                AnalyticsService.ANALYTICS_PROMPT_ACCEPT_ACTION,
+                AnalyticsService.ANALYTICS_PROMPT_DENY_ACTION
+            )
             .then(result => this.onAnalyticsMessageConfirmation(result));
 
             return;
@@ -94,19 +84,31 @@ export class AnalyticsService {
         this.updateAnalyticsEnabled();
     }
 
+    private getOrGenerateClientId(): string {
+        let clientId = this._globalState.get<string>(AnalyticsService.CLIENT_ID_KEY);
+
+        if(!clientId) {
+            clientId = uuid.v4();
+            this._globalState.update(AnalyticsService.CLIENT_ID_KEY, clientId);
+        }
+
+        return clientId;
+    }
+
     private onAnalyticsMessageConfirmation(result: string) : void {
-        const shouldEnableAnalytics = result === AnalyticsService.ANALYTICS_PROMPT_ACTION ? true : false;
+        const shouldEnableAnalytics = result === AnalyticsService.ANALYTICS_PROMPT_ACCEPT_ACTION ? true : false;
+
+        this._globalState.update(AnalyticsService.HAS_ANALYTICS_PROMPT_SHOWN_KEY, true);
 
         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);
+        if(this._analyticsEnabled && !this._gua) {
+            this._gua = new GUAService('UA-111455-29', this._baseInfo);
         }
     }
 }

src/analytics/guaService.ts

@@ -9,10 +9,10 @@ export class GUAService {
     private _getBasePayload: () => any;
 
     constructor(trackingId: string, baseInfo: AnalyticsBaseInfo) {
-        this._visitor = ua(trackingId, baseInfo.userId, { requestOptions: {}, strictCidFormat: false });
+        this._visitor = ua(trackingId, baseInfo.clientId, { requestOptions: {}, strictCidFormat: false });
         this._getBasePayload = () => {
             return {
-                uid: baseInfo.userId,
+                cid: baseInfo.clientId,
                 dh: 'ns-vs-extension.org',
                 cd5: baseInfo.cliVersion,
                 cd6: OperatingSystem[baseInfo.operatingSystem],

src/common/workspaceConfigService.ts

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

src/main.ts

@@ -10,6 +10,7 @@ export function activate(context: vscode.ExtensionContext) {
     Services.globalState = context.globalState;
     Services.cliPath = Services.workspaceConfigService().tnsPath || Services.cliPath;
     Services.extensionServer().start();
+    Services.analyticsService().initialize();
 
     // Check for newer extension version
     Services.extensionVersionService().isLatestInstalled.then(result => {

src/tsconfig.json

@@ -22,7 +22,6 @@
 
         "./debug-adapter/webKitDebug.ts",
         "./main.ts",
-        "./tests/adapter.test.ts",
-        "./analytics/eqatecMonitor.min.js"
+        "./tests/adapter.test.ts"
     ]
 }