analyticsService.ts

import * as os from 'os';
import { Version } from '../common/version';
import { GUAService } from './guaService';
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_KEY = "nativescript.hasAnalyticsPromptShown";
    private static CLIENT_ID_KEY = "nativescript.analyticsClientId";
    private static ANALYTICS_PROMPT_MESSAGE = `Help us improve the NativeScript extension by allowing Progress to collect anonymous usage data.
                                               For more information about the gathered information and how it is used, read our [privacy statement](https://www.progress.com/legal/privacy-policy).
                                               You can [disable the analytics and data collection](https://github.com/NativeScript/nativescript-vscode-extension/blob/master/README.md#how-to-disable-the-analytics) at any given time.
                                               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;

    constructor(globalState: vscode.Memento) {
        this._globalState = globalState;

        vscode.workspace.onDidChangeConfiguration(() => this.updateAnalyticsEnabled());

        this._baseInfo = {
            cliVersion: Services.cli().version.toString(),
            extensionVersion: utils.getInstalledExtensionVersion().toString(),
            operatingSystem: AnalyticsService.getOperatingSystem(),
            clientId: this.getOrGenerateClientId()
        };
    }

    public launchDebugger(request: string, platform: string): Promise<any> {
        if(this._analyticsEnabled) {
            try {
                return this._gua.launchDebugger(request, platform);
            } catch(e) {}
        }

        return Promise.resolve();
    }

    public runRunCommand(platform: string): Promise<any> {
        if(this._analyticsEnabled) {
            try {
                return this._gua.runRunCommand(platform);
            } catch(e) { }
        }

        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;
        };
    }

    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;
        }

        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_ACCEPT_ACTION ? true : false;

        this._globalState.update(AnalyticsService.HAS_ANALYTICS_PROMPT_SHOWN_KEY, true);

        Services.workspaceConfigService.isAnalyticsEnabled = shouldEnableAnalytics;
        this.updateAnalyticsEnabled();
    }

    private updateAnalyticsEnabled() {
        this._analyticsEnabled = Services.workspaceConfigService.isAnalyticsEnabled;

        if(this._analyticsEnabled && !this._gua) {
            this._gua = new GUAService('UA-111455-29', this._baseInfo);
        }
    }
}