feat: add telemetry

lib/clients/metric-client/index.js

@@ -1,5 +1,8 @@
 const uuid = require('uuid/v4');
 const axios = require('axios');
+const AppConfig = require('@src/model/app-config');
+const { METRICS } = require('@src/utils/constants');
+const pck = require('../../../package.json');
 
 const MetricActionResult = {
     SUCCESS: 'Success',
@@ -57,37 +60,25 @@ class MetricAction {
 }
 
 class MetricClient {
-    /**
-     * A metric client options
-     * @typedef {Object} MetricClientOptions
-     * @property {string} version - The application version. Typically, version form package.json
-     * @property {string} machineId - The machine id
-     * @property {boolean} newUser - is new user
-     * @property {string} clientId - The client id. Typically, application name. For example, ask cli.
-     * @property {string} serverUrl - The server url where to send metrics data.
-     * @property {number} sendTimeout - The send timeout to send data to the metrics server.
-     */
-
     /**
      * @constructor
-     * @param {MetricClientOptions} options - The options for constructor
      */
-    constructor(options) {
-        const { version, machineId, newUser, clientId, serverUrl, sendTimeout, enabled } = options;
+    constructor() {
         this.httpClient = axios.create({
-            timeout: sendTimeout || 3000,
+            timeout: 3000,
             headers: { 'Content-Type': 'text/plain' }
         });
-        this.serverUrl = serverUrl;
+        this.serverUrl = METRICS.ENDPOINT;
         this.postRetries = 3;
-        this.enabled = enabled !== false;
+
+        this.enabled = this._isEnabled();
         this.data = {
-            version,
-            machineId,
+            version: pck.version,
+            machineId: this._getMachineId(),
             timeStarted: new Date(),
-            newUser,
+            newUser: false, // default to false since unused.
             timeUploaded: null,
-            clientId,
+            clientId: pck.name,
             actions: []
         };
     }
@@ -157,6 +148,25 @@ class MetricClient {
     _retry(retries, fn) {
         return fn().catch(err => (retries > 1 ? this._retry(retries - 1, fn) : Promise.reject(err)));
     }
+
+    _isEnabled() {
+        if (process.env.ASK_SHARE_USAGE === 'false') return false;
+        if (!AppConfig.configFileExists()) return false;
+
+        new AppConfig();
+        return AppConfig.getInstance().getShareUsage();
+    }
+
+    _getMachineId() {
+        if (!this.enabled) return;
+        const appConfig = AppConfig.getInstance();
+        if (!appConfig.getMachineId()) {
+            appConfig.setMachineId(uuid());
+            appConfig.write();
+        }
+
+        return appConfig.getMachineId();
+    }
 }
 
 module.exports = { MetricClient, MetricActionResult };

lib/commands/abstract-command.js

@@ -76,7 +76,7 @@ class AbstractCommand {
             Messenger.getInstance().doDebug = commandInstance.debug;
 
             // Start metric client
-            metricClient.startAction(commandInstance._name, 'command');
+            metricClient.startAction(commandInstance._name, '');
             const isCredentialHelperCmd = commandInstance._name === 'git-credentials-helper';
 
             // Check if a new CLI version is released

lib/commands/smapi/smapi-commander.js

@@ -3,9 +3,10 @@ const { ModelIntrospector } = require('ask-smapi-sdk');
 const { kebabCase } = require('@src/utils/string-utils');
 const { CliCustomizationProcessor } = require('@src/commands/smapi/cli-customization-processor');
 const optionModel = require('@src/commands/option-model.json');
-const { smapiCommandHandler } = require('@src/commands/smapi/smapi-command-handler');
+const handler = require('@src/commands/smapi/smapi-command-handler');
 const aliases = require('@src/commands/smapi/customizations/aliases.json');
 const { apiToCommanderMap } = require('@src/commands/smapi/customizations/parameters-map');
+const metricClient = require('@src/utils/metrics');
 
 const uploadCatalog = require('./appended-commands/upload-catalog');
 const exportPackage = require('./appended-commands/export-package');
@@ -99,13 +100,17 @@ const makeSmapiCommander = () => {
         defaultOptions.forEach(option => {
             commanderInstance.option(option.flags, option.description);
         });
-        commanderInstance.action((inputCmdObj) => smapiCommandHandler(
-            apiOperationName,
-            flatParamsMap,
-            commanderToApiCustomizationMap,
-            inputCmdObj,
-            modelIntrospector
-        ));
+        commanderInstance.action((inputCmdObj) => {
+            metricClient.startAction('smapi', inputCmdObj.name());
+            return handler.smapiCommandHandler(
+                apiOperationName,
+                flatParamsMap,
+                commanderToApiCustomizationMap,
+                inputCmdObj,
+                modelIntrospector
+            ).then(res => metricClient.sendData().then(() => res))
+                .catch(err => metricClient.sendData(err).then(() => Promise.reject(err)));
+        });
     });
 
     // register hand-written appended commands

lib/model/app-config.js

@@ -1,3 +1,4 @@
+const fs = require('fs-extra');
 const os = require('os');
 const path = require('path');
 
@@ -36,6 +37,10 @@ module.exports = class AppConfig extends ConfigFile {
         instance = null;
     }
 
+    static configFileExists() {
+        return fs.existsSync(defaultFilePath);
+    }
+
     // getter and setter
 
     getAwsProfile(profile) {
@@ -68,6 +73,21 @@ module.exports = class AppConfig extends ConfigFile {
         this.setProperty(['profiles', profile, 'vendor_id'], vendorId);
     }
 
+    setMachineId(machineId) {
+        this.setProperty(['machine_id'], machineId);
+    }
+
+    getMachineId() {
+        return this.getProperty(['machine_id']);
+    }
+
+    getShareUsage() {
+        const shareUsage = this.getProperty(['share_usage']);
+        if (shareUsage !== undefined) return shareUsage;
+
+        return true;
+    }
+
     /**
      * Returns all profile names and their associated aws profile names (if any) as list of objects.
      * return profilesList. Eg: [{ askProfile: 'askProfile1', awsProfile: 'awsProfile1'}, { askProfile: 'askProfile2', awsProfile: 'awsProfile2'}].

lib/utils/constants.js

@@ -2,8 +2,7 @@ module.exports.APPLICATION_NAME = 'ask-cli';
 module.exports.NPM_REGISTRY_URL_BASE = 'http://registry.npmjs.org';
 
 module.exports.METRICS = {
-    ENDPOINT: '', // TODO add the official endpoint when we have it
-    NEW_USER_LENGTH_DAYS: 3
+    ENDPOINT: 'https://client-telemetry.amazonalexa.com'
 };
 
 module.exports.DEPLOYER_TYPE = {

lib/utils/metrics.js

@@ -1,18 +1,6 @@
 const { MetricClient } = require('@src/clients/metric-client');
-// const MetricConfig = require('@src/model/metric-config');
-const { METRICS } = require('@src/utils/constants');
-const { name, version } = require('./../../package.json');
 
-// TODO enable when we have configure command prompting for telemetry
-// const metricConfig = new MetricConfig();
-
-const metricClient = new MetricClient({
-    version,
-    machineId: '', // metricConfig.machineId,
-    newUser: false, // metricConfig.isNewUser(),
-    clientId: name,
-    serverUrl: METRICS.ENDPOINT,
-    enabled: false // TODO make it dependent on configure command
-});
+// metric client singleton
+const metricClient = new MetricClient();
 
 module.exports = metricClient;

package.json

@@ -32,7 +32,8 @@
     "functional-test": "mocha -t 180000 test/functional/run-test.js",
     "lint": "eslint lib/builtins lib/clients lib/commands lib/controllers lib/model lib/view",
     "pre-release": "standard-version",
-    "prism": "prism"
+    "prism": "prism",
+    "postinstall": "node postinstall.js"
   },
   "dependencies": {
     "adm-zip": "^0.4.13",

postinstall.js

@@ -0,0 +1,9 @@
+console.log(`
+================================================================================
+ASK CLI collects telemetry to better understand customer needs. You can
+OPT OUT and disable telemetry by setting the 'share_usage' key to 'false' 
+in '~/.ask/cli_config'.
+
+Learn more: https://developer.amazon.com/docs/alexa/smapi/ask-cli-telemetry.html
+================================================================================ 
+`);

test/functional/run-test.js

@@ -1,5 +1,7 @@
 require('module-alias/register');
 
+process.env.ASK_SHARE_USAGE = false;
+
 [
     '@test/functional/commands/high-level-commands-test.js'
 ].forEach((testFile) => {

test/integration/run-test.js

@@ -1,5 +1,7 @@
 require('module-alias/register');
 
+process.env.ASK_SHARE_USAGE = false;
+
 [
     '@test/integration/commands/smapi-commands-test.js'
 ].forEach((testFile) => {