Implement telemetry in cli

packages/cli/package.json

@@ -67,8 +67,10 @@
     "chalk": "^2.4.1",
     "cheerio": "^1.0.0-rc.2",
     "commander": "^2.15.1",
+    "env-paths": "^2.2.0",
     "ethereumjs-util": "^6.1.0",
     "find-up": "^3.0.0",
+    "firebase": "^6.6.0",
     "fs-extra": "^7.0.1",
     "inquirer": "^6.4.1",
     "is-url": "^1.2.4",
@@ -95,6 +97,7 @@
     "lodash.isstring": "^4.0.1",
     "lodash.isundefined": "^3.0.1",
     "lodash.map": "^4.6.0",
+    "lodash.mapvalues": "^4.6.0",
     "lodash.max": "^4.0.1",
     "lodash.maxby": "^4.6.0",
     "lodash.merge": "^4.6.1",
@@ -118,6 +121,7 @@
     "spinnies": "^0.3.0",
     "truffle-config": "1.1.16",
     "underscore": "^1.9.1",
+    "uuid": "^3.3.3",
     "web3": "1.2.1",
     "web3-utils": "1.2.0"
   },
@@ -151,6 +155,7 @@
     "sinon-chai": "^3.2.0",
     "truffle": "^5.0.5",
     "ts-node": "^7.0.1",
-    "typescript": "^3.2.2"
+    "typescript": "^3.2.2",
+    "yargs": "^7.1.0"
   }
 }

packages/cli/src/commands/accounts.ts

@@ -1,6 +1,7 @@
 import accounts from '../scripts/accounts';
 import { networksList, promptForNetwork, InquirerQuestions } from '../prompts/prompt';
 import ConfigManager from '../models/config/ConfigManager';
+import Telemetry from '../telemetry';
 
 const name = 'accounts';
 const signature: string = name;
@@ -17,6 +18,8 @@ const register: (program: any) => any = program =>
 async function action(options: any): Promise<void> {
   const networkOpts = await promptForNetwork(options, () => getCommandProps());
   const { network } = await ConfigManager.initNetworkConfiguration({ ...options, ...networkOpts });
+
+  await Telemetry.report('accounts', { network }, options.interactive);
   await accounts({ network });
 
   if (!options.dontExitProcess && process.env.NODE_ENV !== 'test') process.exit(0);

packages/cli/src/commands/add.ts

@@ -3,10 +3,10 @@ import add from '../scripts/add';
 import addAll from '../scripts/add-all';
 import ConfigManager from '../models/config/ConfigManager';
 import { compile } from '../models/compiler/Compiler';
-
 import { promptIfNeeded, contractsList, InquirerQuestions } from '../prompts/prompt';
 import { fromContractFullName } from '../utils/naming';
 import ProjectFile from '../models/files/ProjectFile';
+import Telemetry from '../telemetry';
 
 const name = 'add';
 const signature = `${name} [contractNames...]`;
@@ -38,6 +38,7 @@ async function action(contractNames: string[], options: any): Promise<void> {
         ? contractNames.map(splitContractName)
         : prompted.contractNames.map(contractName => ({ name: contractName }));
 
+    if (!options.skipTelemetry) await Telemetry.report('add', { contractsData }, interactive);
     add({ contractsData });
   }
   await push.runActionIfRequested(options);
@@ -47,6 +48,7 @@ async function runActionIfNeeded(contractName?: string, options?: any): Promise<
   const { interactive } = options;
   const { contract: contractAlias, package: packageName } = fromContractFullName(contractName);
   const projectFile = new ProjectFile();
+  options = { ...options, skipTelemetry: true };
 
   if (interactive) {
     if (!packageName && contractAlias && !projectFile.hasContract(contractAlias)) {

packages/cli/src/commands/balance.ts

@@ -2,6 +2,7 @@ import balance from '../scripts/balance';
 import { promptIfNeeded, networksList, InquirerQuestions } from '../prompts/prompt';
 import ConfigManager from '../models/config/ConfigManager';
 import Session from '../models/network/Session';
+import Telemetry from '../telemetry';
 
 const name = 'balance';
 const signature = `${name} [address]`;
@@ -28,14 +29,13 @@ async function action(accountAddress: string, options: any): Promise<void> {
   const defaults = { network: networkInSession };
   const promptedConfig = await promptIfNeeded({ args, opts, props, defaults }, interactive);
 
-  await ConfigManager.initNetworkConfiguration({
+  const { network } = await ConfigManager.initNetworkConfiguration({
     ...options,
     ...promptedConfig,
   });
-  await balance({
-    accountAddress: promptedConfig.accountAddress,
-    contractAddress,
-  });
+
+  await Telemetry.report('balance', { ...promptedConfig, contractAddress, network }, interactive);
+  await balance({ accountAddress: promptedConfig.accountAddress, contractAddress });
 
   if (!options.dontExitProcess && process.env.NODE_ENV !== 'test') process.exit(0);
 }

packages/cli/src/commands/bump.ts

@@ -1,5 +1,6 @@
 import push from './push';
 import bump from '../scripts/bump';
+import Telemetry from '../telemetry';
 
 const name = 'bump';
 const signature = `${name} <version>`;
@@ -14,6 +15,7 @@ const register: (program: any) => any = program =>
     .action(action);
 
 async function action(version: string, options: any): Promise<void> {
+  await Telemetry.report('bump', { version }, options.interactive);
   await bump({ version });
   await push.runActionIfRequested(options);
 }

packages/cli/src/commands/call.ts

@@ -14,6 +14,7 @@ import {
 import ConfigManager from '../models/config/ConfigManager';
 import { SendTxPropsParams, SendTxSelectionParams } from './interfaces';
 import promptForMethodParams from '../prompts/method-params';
+import Telemetry from '../telemetry';
 
 const name = 'call';
 const signature: string = name;
@@ -43,6 +44,7 @@ async function action(options: any): Promise<void> {
   const { contractFullName, proxyReference } = await promptForProxy(proxyAddress, network, options);
   const methodParams = await promptForMethodParams(contractFullName, options, {}, Mutability.Constant);
   const args = pickBy({ ...methodParams, proxyAddress: proxyReference });
+  await Telemetry.report('call', { ...args, network, txParams }, interactive);
   await call({ ...args, network, txParams });
 
   if (!options.dontExitProcess && process.env.NODE_ENV !== 'test') process.exit(0);

packages/cli/src/commands/check.ts

@@ -1,6 +1,7 @@
 import check from '../scripts/check';
 import { compile } from '../models/compiler/Compiler';
 import ConfigManager from '../models/config/ConfigManager';
+import Telemetry from '../telemetry';
 
 const name = 'check';
 const signature = `${name} [contract]`;
@@ -17,6 +18,7 @@ const register: (program: any) => any = program =>
 async function action(contractAlias: string, options: any): Promise<void> {
   ConfigManager.initStaticConfiguration();
   if (!options.skipCompile) await compile();
+  await Telemetry.report('check', { contractAlias }, options.interactive);
   check({ contractAlias });
 }
 

packages/cli/src/commands/compile.ts

@@ -1,5 +1,7 @@
 import { compile } from '../models/compiler/Compiler';
+import { CompileParams } from '../scripts/interfaces';
 import { ProjectCompilerOptions } from '../models/compiler/solidity/SolidityProjectCompiler';
+import Telemetry from '../telemetry';
 
 const name = 'compile';
 const signature = `${name}`;
@@ -25,14 +27,10 @@ const register: (program: any) => any = program =>
       '--evm-version [evm]',
       `choose target evm version (value is written to configuration file for future runs, defaults depends on compiler: byzantium prior to 0.5.5, petersburg from 0.5.5)`,
     )
+    .withNonInteractiveOption()
     .action(action);
 
-async function action(options: {
-  evmVersion: string;
-  solcVersion: string;
-  optimizer: string | boolean;
-  optimizerRuns: string;
-}): Promise<void> {
+async function action(options: CompileParams & { interactive: boolean }): Promise<void> {
   const { evmVersion, solcVersion: version, optimizer, optimizerRuns } = options;
 
   // Handle optimizer option:
@@ -59,6 +57,11 @@ async function action(options: {
     },
   };
 
+  await Telemetry.report(
+    'compile',
+    { evmVersion, solcVersion: version, optimizer, optimizerRuns },
+    options.interactive,
+  );
   await compile(compilerOptions);
 }
 

packages/cli/src/commands/create.ts

@@ -13,6 +13,7 @@ import ConfigManager from '../models/config/ConfigManager';
 import { promptIfNeeded, networksList, contractsList, methodsList, InquirerQuestions } from '../prompts/prompt';
 import promptForMethodParams from '../prompts/method-params';
 import { ProxyType } from '../scripts/interfaces';
+import Telemetry from '../telemetry';
 
 interface PropsParams {
   contractFullName?: string;
@@ -47,20 +48,20 @@ async function commandActions(contractFullName: string, options: any): Promise<v
   const { skipCompile } = options;
   if (!skipCompile) await compile();
 
-  const { network: promptedNewtork, contractFullName: promptedContractFullName } = await promptForCreate(
+  const { network: promptedNetwork, contractFullName: promptedContractFullName } = await promptForCreate(
     contractFullName,
     options,
   );
   const { network, txParams } = await ConfigManager.initNetworkConfiguration({
     ...options,
-    network: promptedNewtork,
+    network: promptedNetwork,
   });
 
   await link.runActionIfNeeded(promptedContractFullName, options);
   await add.runActionIfNeeded(promptedContractFullName, options);
   await push.runActionIfNeeded(promptedContractFullName, network, {
     ...options,
-    network: promptedNewtork,
+    network: promptedNetwork,
     force: true,
   });
 
@@ -90,6 +91,7 @@ async function action(contractFullName: string, options: any): Promise<void> {
 
   if (!(await hasToMigrateProject(network))) process.exit(0);
 
+  await Telemetry.report('create', { ...args, network, txParams }, options.interactive);
   await create({ ...args, network, txParams });
   Session.setDefaultNetworkIfNeeded(network);
 }

packages/cli/src/commands/create2.ts

@@ -9,6 +9,7 @@ import { parseMethodParams } from '../utils/input';
 import { fromContractFullName } from '../utils/naming';
 import { hasToMigrateProject } from '../prompts/migrations';
 import ConfigManager from '../models/config/ConfigManager';
+import Telemetry from '../telemetry';
 
 const name = 'create2';
 const signature = `${name} [alias]`;
@@ -54,6 +55,8 @@ async function action(contractFullName: string, options: any): Promise<void> {
     packageName,
   };
 
+  await Telemetry.report('create2', { ...opts, network, txParams }, options.interactive);
+
   if (options.query && options.signature) await runSignatureQuery(opts, network, txParams);
   else if (options.query) await runQuery(opts, network, txParams);
   else await runCreate(opts, network, txParams);

packages/cli/src/commands/freeze.ts

@@ -1,5 +1,6 @@
 import freeze from '../scripts/freeze';
 import ConfigManager from '../models/config/ConfigManager';
+import Telemetry from '../telemetry';
 
 const name = 'freeze';
 const signature: string = name;
@@ -15,6 +16,7 @@ const register: (program: any) => any = program =>
 
 async function action(options: any): Promise<void> {
   const { network, txParams } = await ConfigManager.initNetworkConfiguration(options);
+  await Telemetry.report('freeze', { network, txParams }, options.interactive);
   await freeze({ network, txParams });
   if (!options.dontExitProcess && process.env.NODE_ENV !== 'test') process.exit(0);
 }

packages/cli/src/commands/init.ts

@@ -5,6 +5,7 @@ import { promptIfNeeded, InquirerQuestions } from '../prompts/prompt';
 import { FileSystem } from '@openzeppelin/upgrades';
 import ProjectFile from '../models/files/ProjectFile';
 import { notEmpty } from '../prompts/validators';
+import Telemetry from '../telemetry';
 
 const name = 'init';
 const signature = `${name} [project-name] [version]`;
@@ -33,8 +34,10 @@ async function action(projectName: string, version: string, options: any): Promi
 
   const dependencies = link ? link.split(',') : [];
   const flags = { dependencies, installDependencies, force, publish };
+  const initArguments = { ...prompted, ...flags };
 
-  await init({ ...prompted, ...flags });
+  await Telemetry.report('init', initArguments, interactive);
+  await init(initArguments);
   await push.runActionIfRequested(options);
 }
 

packages/cli/src/commands/link.ts

@@ -4,6 +4,7 @@ import Dependency from '../models/dependency/Dependency';
 import ProjectFile from '../models/files/ProjectFile';
 import { promptIfNeeded, InquirerQuestions } from '../prompts/prompt';
 import { fromContractFullName } from '../utils/naming';
+import Telemetry from '../telemetry';
 
 const name = 'link';
 const signature = `${name} [dependencies...]`;
@@ -28,8 +29,10 @@ async function action(dependencies: string[], options: any): Promise<void> {
     dependencies: [await Dependency.fetchVersionFromNpm('@openzeppelin/contracts-ethereum-package')],
   };
   const prompted = await promptIfNeeded({ args, props, defaults }, interactive);
+  const linkArguments = { ...prompted, installDependencies };
 
-  await link({ ...prompted, installDependencies });
+  if (!options.skipTelemetry) await Telemetry.report('push', linkArguments, interactive);
+  await link(linkArguments);
   await push.runActionIfRequested(options);
 }
 
@@ -38,7 +41,7 @@ async function runActionIfNeeded(contractFullName: string, options: any): Promis
   const projectFile = new ProjectFile();
   const { contract: contractAlias, package: packageName } = fromContractFullName(contractFullName);
   if (interactive && packageName && !projectFile.hasDependency(packageName)) {
-    await action([packageName], { ...options, forceInstall: true });
+    await action([packageName], { ...options, forceInstall: true, skipTelemetry: true });
   }
 }
 

packages/cli/src/commands/publish.ts

@@ -3,6 +3,7 @@ import ConfigManager from '../models/config/ConfigManager';
 import { hasToMigrateProject } from '../prompts/migrations';
 import { promptIfNeeded, networksList, InquirerQuestions } from '../prompts/prompt';
 import Session from '../models/network/Session';
+import Telemetry from '../telemetry';
 
 const name = 'publish';
 const signature = `${name}`;
@@ -28,6 +29,7 @@ async function action(options: any): Promise<void> {
   const { network, txParams } = await ConfigManager.initNetworkConfiguration(promptedOpts);
   if (!(await hasToMigrateProject(network))) process.exit(0);
 
+  await Telemetry.report('publish', { network, txParams }, interactive);
   await publish({ network, txParams });
   if (!options.dontExitProcess && process.env.NODE_ENV !== 'test') process.exit(0);
 }

packages/cli/src/commands/push.ts

@@ -12,6 +12,7 @@ import ProjectFile from '../models/files/ProjectFile';
 import ConfigManager from '../models/config/ConfigManager';
 import { promptIfNeeded, networksList, InquirerQuestions } from '../prompts/prompt';
 import NetworkFile from '../models/files/NetworkFile';
+import Telemetry from '../telemetry';
 
 const name = 'push';
 const signature: string = name;
@@ -69,15 +70,18 @@ async function action(options: any): Promise<void> {
   });
   const promptDeployDependencies = await promptForDeployDependencies(deployDependencies, network, interactive);
 
-  await push({
+  const pushArguments = {
     deployProxyAdmin,
     deployProxyFactory,
     force,
     reupload,
     network,
     txParams,
     ...promptDeployDependencies,
-  });
+  };
+
+  if (!options.skipTelemetry) await Telemetry.report('push', pushArguments, interactive);
+  await push(pushArguments);
   if (!options.dontExitProcess && process.env.NODE_ENV !== 'test') process.exit(0);
 }
 
@@ -101,7 +105,7 @@ async function runActionIfNeeded(contractName: string, network: string, options:
       (!packageName && !networkFile.hasContract(contractAlias)) ||
       (packageName && !networkFile.hasDependency(packageName))
     ) {
-      await action({ ...options, dontExitProcess: true });
+      await action({ ...options, dontExitProcess: true, skipTelemetry: true });
     }
   }
 }

packages/cli/src/commands/remove.ts

@@ -1,6 +1,7 @@
 import remove from '../scripts/remove';
 import push from './push';
 import { promptIfNeeded, contractsList, InquirerQuestions } from '../prompts/prompt';
+import Telemetry from '../telemetry';
 
 const name = 'remove';
 const signature = `${name} [contracts...]`;
@@ -23,6 +24,7 @@ async function action(contracts: string[], options: any): Promise<void> {
   const props = getCommandProps();
   const prompted = await promptIfNeeded({ args, props }, interactive);
 
+  await Telemetry.report('remove', prompted, interactive);
   remove(prompted);
   await push.runActionIfRequested(options);
 }