cordova/src/telemetry.js

Cordova command line interface tool

/**
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
*/

// For further details on telemetry, see:
// https://github.com/cordova/cordova-discuss/pull/43

const { EOL } = require('os');

// Google Analytics tracking code
const GA_TRACKING_CODE = 'UA-64283057-7';

const pkg = require('../package.json');
const Insight = require('insight');

/**
 * By redefining `get optOut` we trick Insight into tracking
 * even though the user might have opted out.
 */
class RelentlessInsight extends Insight {
    get optOut () { return false; }

    set optOut (value) { super.optOut = value; }

    get realOptOut () { return super.optOut; }
}

const insight = new RelentlessInsight({
    trackingCode: GA_TRACKING_CODE,
    pkg
});

/**
 * Returns true if the user opted in, and false otherwise
 */
function showPrompt () {
    insight._permissionTimeout = module.exports.timeoutInSecs || 30;

    const msg = 'May Cordova anonymously report usage statistics to improve the tool over time?';

    return insight.askPermission(msg).then(optIn => {
        if (optIn) {
            console.log(EOL + 'Thanks for opting into telemetry to help us improve cordova.');
            module.exports.track('telemetry', 'on', 'via-cli-prompt-choice', 'successful');
        } else {
            console.log(EOL + 'You have been opted out of telemetry. To change this, run: cordova telemetry on.');
            // Always track telemetry opt-outs! (whether opted-in or opted-out)
            module.exports.track('telemetry', 'off', 'via-cli-prompt-choice', 'successful');
        }

        return optIn;
    });
}

function track (...args) {
    // Remove empty, null or undefined strings from arguments
    const filteredArgs = args.filter(val => val && val.length !== 0);
    insight.track(...filteredArgs);
}

function turnOn () {
    insight.optOut = false;
}

function turnOff () {
    insight.optOut = true;
}

/**
 * Clears telemetry setting
 * Has the same effect as if user never answered the telemetry prompt
 * Useful for testing purposes
 */
function clear () {
    insight.optOut = undefined;
}

function isOptedIn () {
    return !insight.realOptOut;
}

/**
 * Has the user already answered the telemetry prompt? (thereby opting in or out?)
 */
function hasUserOptedInOrOut () {
    const insightOptOut = insight.realOptOut === undefined;
    return !(insightOptOut);
}

/**
 * Is the environment variable 'CI' specified ?
 */
function isCI (env) {
    return !!env.CI;
}

/**
 * Has the user ran a command of the form: `cordova run --no-telemetry` ?
 */
function isNoTelemetryFlag (args) {
    return args.indexOf('--no-telemetry') > -1;
}

// this is to help testing, so we don't have to wait for the full 30
module.exports = {
    track,
    turnOn,
    turnOff,
    clear,
    isOptedIn,
    hasUserOptedInOrOut,
    isCI,
    showPrompt,
    isNoTelemetryFlag,
    timeoutInSecs: 30
};