Add Google Analytics tracking

Author: ivanbuhov

package.json

@@ -26,8 +26,9 @@
   "license": "SEE LICENSE IN LICENSE.txt",
   "dependencies": {
     "source-map": "^0.5.3",
-    "vscode-debugprotocol": "^1.7.0",
-    "vscode-debugadapter": "^1.7.0"
+    "universal-analytics": "^0.3.11",
+    "vscode-debugadapter": "^1.7.0",
+    "vscode-debugprotocol": "^1.7.0"
   },
   "devDependencies": {
     "mocha": "^2.4.5",
@@ -87,7 +88,7 @@
             "typescript"
           ]
         },
-        "program": "./out/webkit/webKitDebug.js",
+        "program": "./out/debug-adapter/webKitDebug.js",
         "runtime": "node",
         "initialConfigurations": [
           {

src/.vscode/launch.json

@@ -5,7 +5,7 @@
             "name": "launch as server",
             "type": "node",
             "request": "launch",
-            "program": "${workspaceRoot}/../out/webkit/webKitDebug.js",
+            "program": "${workspaceRoot}/../out/debug-adapter/webKitDebug.js",
 			"runtimeArgs": ["--nolazy"],
             "args": [ "--server=4712" ],
             "stopOnEntry": true,
@@ -20,7 +20,7 @@
             // Path to VSCode executable
             "runtimeExecutable": "${execPath}",
             "args": [
-                "--extensionDevelopmentPath=${workspaceRoot}"
+                "--extensionDevelopmentPath=${workspaceRoot}/.."
             ],
             "stopOnEntry": false,
 			"sourceMaps": true,

src/debug-adapter/webKitDebugAdapter.ts

@@ -14,6 +14,7 @@ import {formatConsoleMessage} from './consoleHelper';
 import * as ns from '../services/NsCliService';
 import {ILaunchRequestArgs, IAttachRequestArgs, IDebugAdapter, ISetBreakpointsArgs, ISetBreakpointsResponseBody, IBreakpoint,
     IStackTraceResponseBody, IScopesResponseBody, IVariablesResponseBody, ISourceResponseBody, IThreadsResponseBody, IEvaluateResponseBody} from './WebKitAdapterInterfaces';
+import {AnalyticsService} from '../services/analytics/AnalyticsService';
 
 
 interface IScopeVarHandle {
@@ -114,6 +115,7 @@ export class WebKitDebugAdapter implements IDebugAdapter {
     }
 
     private _attach(args: IAttachRequestArgs | ILaunchRequestArgs) {
+        AnalyticsService.getInstance().launchDebugger(args.request, args.platform, args.emulator);
         this.initDiagnosticLogging(args.request, args);
         this.appRoot = utils.getAppRoot(args);
         this.platform = args.platform;

src/main.ts

@@ -2,6 +2,7 @@ import * as vscode from 'vscode';
 import * as child from 'child_process';
 import * as ns from './services/NsCliService';
 import {ExtensionVersionInfo} from './services/ExtensionVersionInfo';
+import {AnalyticsService} from './services/analytics/AnalyticsService';
 
 function performVersionsCheck(context: vscode.ExtensionContext) {
     // Check the state of the existing NativeScript CLI
@@ -37,7 +38,7 @@ function performVersionsCheck(context: vscode.ExtensionContext) {
     }
 }
 
-// this method is called when your extension is activated
+// this method is called when the extension is activated
 export function activate(context: vscode.ExtensionContext) {
     performVersionsCheck(context);
 
@@ -64,6 +65,7 @@ export function activate(context: vscode.ExtensionContext) {
 
             // Execute run command
             let emulator: boolean = (target === 'emulator');
+            AnalyticsService.getInstance().runRunCommand(project.platform(), emulator);
             return project.run(emulator)
             .then(tnsProcess => {
                 tnsProcess.on('error', err => {

src/services/analytics/AnalyticsBaseInfo.ts

@@ -0,0 +1,14 @@
+export enum OperatingSystem {
+    Windows,
+    Linux,
+    OSX,
+    Other
+}
+
+export interface AnalyticsBaseInfo {
+    operatingSystem: OperatingSystem,
+    cliVersion: string,
+    extensionVersion: string,
+    userId: string,
+    hostname: string
+}

src/services/analytics/AnalyticsService.ts

@@ -0,0 +1,67 @@
+import * as os from 'os';
+import { Version } from '../../common/Version';
+import { GUAService } from './GUAService';
+import { AnalyticsBaseInfo, OperatingSystem } from './AnalyticsBaseInfo';
+import { ExtensionVersionInfo } from '../ExtensionVersionInfo';
+import * as ns from '../NsCliService';
+
+export class AnalyticsService {
+    private static _instance: AnalyticsService;
+
+    private _baseInfo: AnalyticsBaseInfo;
+    private _gua: GUAService;
+
+    public static getInstance(): AnalyticsService {
+        if (!this._instance) {
+            this._instance = new AnalyticsService();
+        }
+        return this._instance;
+    }
+
+    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() {
+        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; }
+        };
+
+        this._baseInfo = {
+            cliVersion: Version.stringify(ns.CliVersionInfo.getInstalledCliVersion()),
+            extensionVersion: Version.stringify(ExtensionVersionInfo.getExtensionVersion()),
+            operatingSystem: operatingSystem,
+            userId: AnalyticsService.generateMachineId(),
+            hostname: 'ns-vs-extension.org'
+        };
+
+        this._gua = new GUAService('UA-111455-29', this._baseInfo);
+    }
+
+    public launchDebugger(request: string, platform: string, emulator: boolean): Promise<any> {
+        try {
+            return this._gua.launchDebugger(request, platform, emulator);
+        } catch(e) {}
+    }
+
+    public runRunCommand(platform: string, emulator: boolean): Promise<any> {
+        try {
+            return this._gua.runRunCommand(platform, emulator);
+        } catch(e) {}
+    }
+}

src/services/analytics/GUAService.ts

@@ -0,0 +1,45 @@
+import * as ua from 'universal-analytics';
+import { AnalyticsBaseInfo, OperatingSystem } from './AnalyticsBaseInfo';
+
+/**
+ * Google Universal Analytics Service
+ */
+export class GUAService {
+    private _visitor: any;
+    private _getBasePayload: () => any;
+
+    constructor(trackingId: string, baseInfo: AnalyticsBaseInfo) {
+        this._visitor = ua(trackingId);
+        this._getBasePayload = () => {
+            return {
+                uid: baseInfo.userId,
+                dh: baseInfo.hostname,
+                cd5: baseInfo.cliVersion,
+                cd6: OperatingSystem[baseInfo.operatingSystem],
+                cd7: baseInfo.extensionVersion
+            };
+        };
+    }
+
+    public launchDebugger(request: string, platform: string, emulator: boolean): Promise<any> {
+        let payload = this._getBasePayload();
+        payload.ec = 'vscode-extension-debug'; // event category
+        payload.ea = `debug-${request}-on-${platform}-${emulator ? 'emulator' : 'device'}`; // event action
+        return this.sendEvent(payload);
+    }
+
+    public runRunCommand(platform: string, emulator: boolean): Promise<any> {
+        let payload = this._getBasePayload();
+        payload.ec = 'vscode-extension-command'; // event category
+        payload.ea = `command-run-on-${platform}-${emulator ? 'emulator' : 'device'}`; // event action
+        return this.sendEvent(payload);
+    }
+
+    private sendEvent(params): Promise<any> {
+        return new Promise<any>((res, rej) => {
+            this._visitor.event(params, err => {
+                return err ? rej(err) : res();
+            });
+        });
+    }
+}

src/typings.json

@@ -10,5 +10,7 @@
   "globalDevDependencies": {
     "mocha": "registry:dt/mocha#2.2.5+20160317120654"
   },
+  "dependencies": {
+    "universal-analytics": "registry:npm/universal-analytics#0.3.10+20160419033917"
   }
 }