Metrics events - add utils to support mixpanel integration and persisting user settings in shell.

commands/create-account.js

@@ -2,6 +2,7 @@
 const exitOnError = require('../utils/exit-on-error');
 const connect = require('../utils/connect');
 const { KeyPair, utils } = require('near-api-js');
+const eventtracking = require('../utils/eventtracking');
 
 module.exports = {
     command: 'create_account <accountId>',
@@ -31,6 +32,8 @@ module.exports = {
 };
 
 async function createAccount(options) {
+    await eventtracking.track(eventtracking.EVENT_ID_CREATE_ACCOUNT_START, {});
+    console.log("?")
     options.initialBalance = utils.format.parseNearAmount(options.initialBalance);
     // NOTE: initialBalance is passed as part of config here
     let near = await connect(options);
@@ -47,4 +50,5 @@ async function createAccount(options) {
         await near.connection.signer.keyStore.setKey(options.networkId, options.accountId, keyPair);
     }
     console.log(`Account ${options.accountId} for network "${options.networkId}" was created.`);
+    await eventtracking.track(eventtracking.EVENT_ID_CREATE_ACCOUNT_SUCCESS, {});
 }

commands/tx-status.js

@@ -2,6 +2,7 @@ const exitOnError = require('../utils/exit-on-error');
 const connect = require('../utils/connect');
 const inspectResponse = require('../utils/inspect-response');
 const bs58 = require('bs58');
+const eventtracking = require('../utils/eventtracking');
 
 module.exports = {
     command: 'tx-status <hash>',
@@ -13,6 +14,7 @@ module.exports = {
             required: true
         }),
     handler: exitOnError(async (argv) => {
+        await eventtracking.track(eventtracking.EVENT_ID_TX_STATUS_START, {});
         const near = await connect(argv);
 
         const hashParts = argv.hash.split(':');
@@ -33,5 +35,6 @@ module.exports = {
         const status = await near.connection.provider.txStatus(bs58.decode(hash), accountId);
         console.log(`Transaction ${accountId}:${hash}`);
         console.log(inspectResponse(status));
+        await eventtracking.track(eventtracking.EVENT_ID_TX_STATUS_SUCCESS, {});
     })
 };

index.js

@@ -14,6 +14,7 @@ const verify = require('./utils/verify-account');
 const capture = require('./utils/capture-login-success');
 
 const inspectResponse = require('./utils/inspect-response');
+const eventtracking = require('./utils/eventtracking');
 
 // TODO: Fix promisified wrappers to handle error properly
 
@@ -100,7 +101,6 @@ exports.login = async function(options) {
             input: process.stdin,
             output: process.stdout
         });
-
         const getAccountFromConsole = async () => {
             return await new Promise((resolve) => {
                 rl.question(
@@ -128,7 +128,6 @@ exports.login = async function(options) {
         }
         rl.close();
         capture.cancel();
-
         // verify the accountId if we captured it or ...
         try {
             await verify(accountId, keyPair, options);
@@ -139,6 +138,7 @@ exports.login = async function(options) {
 };
 
 exports.viewAccount = async function(options) {
+    await eventtracking.track(eventtracking.EVENT_ID_ACCOUNT_STATE_START, {});
     let near = await connect(options);
     let account = await near.account(options.accountId);
     let state = await account.state();
@@ -147,23 +147,28 @@ exports.viewAccount = async function(options) {
     }
     console.log(`Account ${options.accountId}`);
     console.log(inspectResponse(state));
+    await eventtracking.track(eventtracking.EVENT_ID_ACCOUNT_STATE_SUCCESS, {});
 };
 
 exports.deleteAccount = async function(options) {
+    await eventtracking.track(eventtracking.EVENT_ID_DELETE_ACCOUNT_START, {});
     console.log(
         `Deleting account. Account id: ${options.accountId}, node: ${options.nodeUrl}, helper: ${options.helperUrl}, beneficiary: ${options.beneficiaryId}`);
     const near = await connect(options);
     const account = await near.account(options.accountId);
     await account.deleteAccount(options.beneficiaryId);
     console.log(`Account ${options.accountId} for network "${options.networkId}" was deleted.`);
+    await eventtracking.track(eventtracking.EVENT_ID_DELETE_ACCOUNT_SUCCESS, {});
 };
 
 exports.keys = async function(options) {
+    await eventtracking.track(eventtracking.EVENT_ID_ACCOUNT_KEYS_START, {});
     let near = await connect(options);
     let account = await near.account(options.accountId);
     let accessKeys = await account.getAccessKeys();
     console.log(`Keys for account ${options.accountId}`);
     console.log(inspectResponse(accessKeys));
+    await eventtracking.track(eventtracking.EVENT_ID_ACCOUNT_KEYS_SUCCESS, {});
 };
 
 exports.sendMoney = async function(options) {

package.json

@@ -37,13 +37,15 @@
     "flagged-respawn": "^1.0.1",
     "is-ci": "^2.0.0",
     "jest-environment-node": "^25.1.0",
+    "mixpanel": "^0.11.0",
     "ncp": "^2.0.0",
     "near-api-js": "^0.23.1",
     "open": "^7.0.1",
     "rimraf": "^3.0.0",
     "stoppable": "^1.1.0",
     "tcp-port-used": "^1.0.1",
     "update-notifier": "^4.0.0",
+    "uuid": "^7.0.3",
     "v8flags": "^3.1.3",
     "yargs": "^15.0.1"
   },

test/index.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 OVERALL_RESULT=0
+mkdir ~/.near-config
+cp ./test/testsettings ~/.near-config/settings
 for test in ./test/test_*; do
     echo ""
     echo "Running $test"

test/testsettings

@@ -0,0 +1 @@
+{"trackingEnaled":false}

utils/eventtracking.js

@@ -0,0 +1,83 @@
+const MIXPANEL_TOKEN = '9aa8926fbcb03eb5d6ce787b5e8fa6eb';
+var mixpanel = require('mixpanel').init(MIXPANEL_TOKEN);
+
+const uuid = require('uuid');
+const chalk = require('chalk');  // colorize output
+const readline = require('readline');
+const settings = require('./settings');
+
+const TRACKING_ENABLED_KEY = 'trackingEnaled';
+const TRACKING_SESSION_ID_KEY = 'trackingSessionId';
+
+const track = async (eventType, eventProperties) => {
+    const shellSettings = settings.getShellSettings();
+    // if the appropriate option is not in settings, ask now and save settings.
+    if (!(TRACKING_ENABLED_KEY in shellSettings)) {
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+        const getEventTrackingConsent = async () => {
+            for (var attempts = 0; attempts < 10; attempts++) {
+                const answer = await new Promise((resolve) => {
+
+                    rl.question(
+                        chalk`We would like to collect data on near shell usage to improve developer experience. {bold.yellow Would you like to opt in (y/n)?}`,
+                        async (consentToEventTracking) => {
+                            if (consentToEventTracking == 'y' || consentToEventTracking == 'Y') { 
+                                resolve(true); 
+                            }
+                            else if (consentToEventTracking == 'n' || consentToEventTracking == 'N') {
+                                resolve(false);
+                            }
+                            resolve(undefined);
+                        });
+                });
+                if (answer !== undefined) {
+                    return answer;
+                }
+            }
+            return false; // If they can't figure it out in this many attempts, just opt out
+        };
+
+        shellSettings[TRACKING_ENABLED_KEY] = await getEventTrackingConsent();
+        shellSettings[TRACKING_SESSION_ID_KEY] = shellSettings[TRACKING_ENABLED_KEY] ? uuid.v4() : undefined;
+        rl.close();
+        settings.saveShellSettings(shellSettings);
+    }
+
+    if (!shellSettings[TRACKING_ENABLED_KEY]) {
+        return;
+    }
+
+    try {
+        const mixPanelProperties = {
+            distinct_id: shellSettings.trackingSessionId
+        };
+        Object.assign(mixPanelProperties, eventProperties);
+        mixpanel.track(eventType, mixPanelProperties);
+    }
+    catch (e) {
+        console.log('Warning: problem while sending developer event tracking data. This is not critical. Error: ', e);
+    }
+};
+
+module.exports = {
+    track,
+
+    // Event ids used in mixpanel. Note that we want to mention shell to make it very easy to tell that an event came from shell,
+    // since mixpanel might be used for other components as well.
+    EVENT_ID_ACCOUNT_STATE_START: 'shell_account_state_start',
+    EVENT_ID_ACCOUNT_STATE_SUCCESS: 'shell_account_state_success',
+    EVENT_ID_DELETE_ACCOUNT_START: 'shell_delete_account_start',
+    EVENT_ID_DELETE_ACCOUNT_SUCCESS: 'shell_delete_account_success',
+    EVENT_ID_ACCOUNT_KEYS_START: 'shell_account_keys_start',
+    EVENT_ID_ACCOUNT_KEYS_SUCCESS: 'shell_account_keys_success',
+    EVENT_ID_TX_STATUS_START: 'shell_tx_status_start',
+    EVENT_ID_TX_STATUS_SUCCESS: 'shell_tx_status_success',
+    EVENT_ID_LOGIN: 'shell_login',
+    EVENT_ID_DEPLOY: 'shell_deploy',
+    EVENT_ID_DEV_DEPLOY: 'shell_dev_deploy',
+    EVENT_ID_CREATE_ACCOUNT_START: 'shell_create_account_start',
+    EVENT_ID_CREATE_ACCOUNT_SUCCESS: 'shell_create_account_success'
+};

utils/settings.js

@@ -0,0 +1,42 @@
+const fs = require('fs');
+const homedir = require('os').homedir();
+const path = require('path');
+
+
+// Persistent shell settings
+
+const getShellSettings = () => {
+    const nearPath = path.join(homedir, '.near-config');
+    try {
+        if (!fs.existsSync(nearPath)) {
+            fs.mkdirSync(nearPath);
+        }
+        const shellSettingsPath = path.join(nearPath, 'settings');
+        if (!fs.existsSync(shellSettingsPath)) {
+            return {};
+        } else {
+            return JSON.parse(fs.readFileSync(shellSettingsPath, 'utf8'));
+        }
+    } catch (e) {
+        console.log(e);
+    }
+    return {};
+};
+
+const saveShellSettings = (settings) => {
+    const nearPath = path.join(homedir, '.near-config');
+    try {
+        if (!fs.existsSync(nearPath)) {
+            fs.mkdirSync(nearPath);
+        }
+        const shellSettingsPath = path.join(nearPath, 'settings');
+        fs.writeFileSync(shellSettingsPath, JSON.stringify(settings));
+    } catch (e) {
+        console.log(e);
+    }
+};
+
+module.exports = {
+    getShellSettings,
+    saveShellSettings
+};