feat: Add telemetry to track chectl command usage

.ci/obfuscate/gnirts.js

@@ -0,0 +1,29 @@
+'use strict'
+/*********************************************************************
+ * Copyright (c) 2020 Red Hat, Inc.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+
+const gnirts = require('gnirts');
+const fs = require('fs')
+
+const rootDir = process.cwd()
+
+const obfuscateJSFiles = () => {
+  const dirFilesToObfuscate = [ 'lib/hooks/analytics/analytics.js' ]
+
+  dirFilesToObfuscate.forEach((jsFilePath)=> {
+    if (fs.existsSync(`${rootDir}/${jsFilePath}`)) {
+      let js = fs.readFileSync(`${rootDir}/${jsFilePath}`, {encoding: 'utf8'});
+      js = gnirts.mangle(js);
+      fs.writeFileSync(`${rootDir}/${jsFilePath}`, js);
+    }
+  })
+}
+
+obfuscateJSFiles()

.travis.yml

@@ -28,6 +28,7 @@ before_deploy:
       export GITHUB_RELEASE_NAME=$CHECTL_VERSION
     fi;
     sed -i sed "s#version\":\ \"\(.*\)\",#version\":\ \"$CHECTL_VERSION\",#g" package.json
+    sed -i '.bak' "s|INSERT-KEY-HERE|${SEGMENT_KEY}|g"  src/hooks/analytics/analytics.ts
     git tag $TRAVIS_TAG
     TARGETS=linux-arm,linux-x64,linux-s390x,linux-ppc64le,darwin-x64,win32-x64,win32-x86
     npx oclif-dev pack --targets=$TARGETS

package.json

@@ -22,6 +22,7 @@
     "@types/request": "^2.48.5",
     "@types/websocket": "^1.0.1",
     "@types/ws": "^7.2.6",
+    "analytics-node": "^3.4.0-beta.3",
     "ansi-colors": "4.1.1",
     "axios": "^0.19.2",
     "cli-ux": "^5.4.5",
@@ -36,6 +37,7 @@
     "execa": "^4.0.3",
     "fancy-test": "^1.4.9",
     "fs-extra": "^9.0.1",
+    "gnirts": "^1.1.7",
     "inquirer": "^7.3.3",
     "js-yaml": "^3.14.0",
     "listr": "^0.14.3",
@@ -92,6 +94,9 @@
     "macos": {
       "identifier": "che-incubator.chectl"
     },
+    "hooks": {
+      "analytics": "./lib/hooks/analytics/analytics"
+    },
     "plugins": [
       "@oclif/plugin-autocomplete",
       "@oclif/plugin-help",
@@ -144,7 +149,8 @@
     "e2e-minikube-operator": "export PLATFORM=minikube && export INSTALLER=operator && yarn jest ./test/e2e/e2e.test.ts --testRegex='/test/(e2e)/.*.test.ts'",
     "e2e-minishift": "export PLATFORM=minishift && export INSTALLER=operator && yarn jest ./test/e2e/e2e.test.ts --testRegex='/test/(e2e)/.*.test.ts'",
     "e2e-openshift": "export PLATFORM=openshift && export INSTALLER=operator && yarn jest ./test/e2e/e2e.test.ts --testRegex='/test/(e2e)/.*.test.ts'",
-    "prepack": "rm -rf lib && rm -rf tsconfig.tsbuildinfo && tsc -b && oclif-dev manifest && oclif-dev readme",
+    "gnirts-ci": "node .ci/obfuscate/gnirts.js",
+    "prepack": "rm -rf lib && rm -rf tsconfig.tsbuildinfo && tsc -b && oclif-dev manifest && oclif-dev readme && yarn gnirts-ci",
     "pack-binaries": "oclif-dev pack",
     "postpack": "rm -f oclif.manifest.json",
     "format": "tsfmt -r --useTsfmt tsfmt.json",

src/commands/auth/delete.ts

@@ -39,6 +39,7 @@ export default class Delete extends Command {
 
   async run() {
     const { args, flags } = this.parse(Delete)
+    await this.config.runHook('analytics', { event: Delete.description, command: Delete.id, flags })
 
     let cheApiEndpoint = CheApiClient.normalizeCheApiEndpointUrl(args[CHE_API_ENDPOINT_KEY])
     const username: string | undefined = flags[USERNAME_KEY]

src/commands/auth/get.ts

@@ -17,6 +17,8 @@ export default class Get extends Command {
   static description = 'Display active login session'
 
   async run() {
+    await this.config.runHook('analytics', { event: Get.description, command: Get.id })
+
     const loginManager = await CheServerLoginManager.getInstance(this.config.configDir)
     const currentLogin = loginManager.getCurrentLoginInfo()
     if (currentLogin.username) {

src/commands/auth/list.ts

@@ -17,6 +17,8 @@ export default class List extends Command {
   static description = 'Show all existing login sessions'
 
   async run() {
+    await this.config.runHook('analytics', { event: List.description, command: List.id })
+
     const loginManager = await CheServerLoginManager.getInstance(this.config.configDir)
     const logins = loginManager.getAllLogins()
     const currentLogin = loginManager.getCurrentLoginInfo()

src/commands/auth/login.ts

@@ -69,6 +69,9 @@ export default class Login extends Command {
     const { args, flags } = this.parse(Login)
     const ctx = await initializeContext(flags)
 
+    // Not recommended to track user and password in telemetry
+    await this.config.runHook('analytics', { event: Login.description, command: Login.id })
+
     const loginManager = await CheServerLoginManager.getInstance(this.config.configDir)
 
     let cheApiClient: CheApiClient

src/commands/auth/logout.ts

@@ -17,6 +17,8 @@ export default class Logout extends Command {
   static description = 'Log out of the active login session'
 
   async run() {
+    await this.config.runHook('analytics', { event: Logout.description, command: Logout.id })
+
     const loginManager = await CheServerLoginManager.getInstance(this.config.configDir)
     const currentLogin = loginManager.getCurrentLoginInfo()
 
@@ -30,5 +32,4 @@ export default class Logout extends Command {
     loginManager.deleteLoginContext(cheApiEndpoint, username)
     cli.info(`Succesfully logged out ${username} on ${cheApiEndpoint}`)
   }
-
 }

src/commands/auth/use.ts

@@ -51,6 +51,8 @@ export default class Use extends Command {
   async run() {
     const { args, flags } = this.parse(Use)
 
+    await this.config.runHook('analytics', { event: Use.description, command: Use.id, flags })
+
     if (flags.interactive) {
       await this.interactiveSwitch()
       return

src/commands/cacert/export.ts

@@ -39,6 +39,8 @@ export default class Export extends Command {
     const kube = new KubeHelper(flags)
     const cheHelper = new CheHelper(flags)
 
+    await this.config.runHook('analytics', { event: Export.description, command: Export.id, flags })
+
     if (!await kube.hasReadPermissionsForNamespace(flags.chenamespace)) {
       throw new Error(`E_PERM_DENIED - Permission denied: no read access to '${flags.chenamespace}' namespace`)
     }

src/commands/dashboard/open.ts

@@ -27,6 +27,8 @@ export default class Open extends Command {
     const { flags } = this.parse(Open)
 
     try {
+      await this.config.runHook('analytics', { event: Open.description, command: Open.id, flags })
+
       const cheHelper = new CheHelper(flags)
       const cheURL = await cheHelper.cheURL(flags.chenamespace)
       const dashboardUrl = `${cheURL}/dashboard/`

src/commands/devfile/generate.ts

@@ -92,6 +92,8 @@ export default class Generate extends Command {
   async run() {
     const { flags } = this.parse(Generate)
     kube = new KubeHelper(flags)
+    await this.config.runHook('analytics', { event: Generate.description, command: Generate.id, flags })
+
     const notifier = require('node-notifier')
 
     let name = flags.name || 'chectl-generated'

src/commands/server/debug.ts

@@ -35,6 +35,7 @@ export default class Debug extends Command {
     const { flags } = this.parse(Debug)
     const ctx = await initializeContext(flags)
 
+    await this.config.runHook('analytics', { event: Debug.description, command: Debug.id, flags })
     const cheTasks = new CheTasks(flags)
     const apiTasks = new ApiTasks()
     const tasks = new Listr([], { renderer: flags['listr-renderer'] as any })

src/commands/server/delete.ts

@@ -54,6 +54,8 @@ export default class Delete extends Command {
       flags.yes = flags['skip-deletion-check']
     }
 
+    await this.config.runHook('analytics', { event: Delete.description, command: Delete.id, flags })
+
     const notifier = require('node-notifier')
     const apiTasks = new ApiTasks()
     const helmTasks = new HelmTasks(flags)

src/commands/server/deploy.ts

@@ -383,6 +383,7 @@ export default class Deploy extends Command {
     })
 
     await this.setPlaformDefaults(flags, ctx)
+    await this.config.runHook('analytics', { event: Deploy.description, command: Deploy.id, flags })
 
     if (flags.installer === 'olm' && flags['olm-suggested-namespace']) {
       flags.chenamespace = DEFAULT_OLM_SUGGESTED_NAMESPACE

src/commands/server/logs.ts

@@ -44,6 +44,7 @@ export default class Logs extends Command {
     const apiTasks = new ApiTasks()
     const tasks = new Listr([], { renderer: flags['listr-renderer'] as any })
 
+    await this.config.runHook('analytics', { event: Logs.description, command: Logs.id, flags })
     tasks.add(apiTasks.testApiTasks(flags, this))
     tasks.add(cheTasks.verifyCheNamespaceExistsTask(flags, this))
     tasks.add(cheTasks.serverLogsTasks(flags, false))

src/commands/server/status.ts

@@ -35,6 +35,7 @@ export default class Status extends Command {
 
     let openshiftOauth = 'No'
 
+    await this.config.runHook('analytics', { event: Status.description, command: Status.id, flags })
     const cr = await kube.getCheCluster(flags.chenamespace)
     if (ctx.isOpenShift && cr && cr.spec && cr.spec.auth && cr.spec.auth.openShiftoAuth) {
       openshiftOauth = 'Yes'

src/commands/server/stop.ts

@@ -43,6 +43,8 @@ export default class Stop extends Command {
     const cheTasks = new CheTasks(flags)
     const apiTasks = new ApiTasks()
 
+    await this.config.runHook('analytics', { event: Stop.description, command: Stop.id, flags })
+
     let tasks = new Listr(undefined,
       {
         renderer: flags['listr-renderer'] as any,

src/commands/server/update.ts

@@ -85,6 +85,7 @@ export default class Update extends Command {
       await this.setDefaultInstaller(flags)
       cli.info(`› Installer type is set to: '${flags.installer}'`)
     }
+    await this.config.runHook('analytics', { event: Update.description, command: Update.id, flags })
 
     const kubeHelper = new KubeHelper(flags)
     const installerTasks = new InstallerTasks()

src/commands/workspace/create.ts

@@ -53,6 +53,8 @@ export default class Create extends Command {
   async run() {
     const { flags } = this.parse(Create)
 
+    await this.config.runHook('analytics', { event: Create.description, command: Create.id, flags })
+
     const devfilePath = this.getDevfilePath(flags.devfile)
     const cheHelper = new CheHelper(flags)
 

src/commands/workspace/delete.ts

@@ -43,8 +43,9 @@ export default class Delete extends Command {
     const { flags } = this.parse(Delete)
     const { args } = this.parse(Delete)
 
-    const workspaceId = args.workspace
+    await this.config.runHook('analytics', { event: Delete.description, command: Delete.id, flags })
 
+    const workspaceId = args.workspace
     const { cheApiEndpoint, accessToken } = await getLoginData(this.config.configDir, flags[CHE_API_ENDPOINT_KEY], flags[ACCESS_TOKEN_KEY])
     const cheApiClient = CheApiClient.getInstance(cheApiEndpoint)
     await cheApiClient.deleteWorkspaceById(workspaceId, accessToken)

src/commands/workspace/inject.ts

@@ -60,6 +60,8 @@ export default class Inject extends Command {
   async run() {
     const { flags } = this.parse(Inject)
 
+    await this.config.runHook('analytics', { event: Inject.description, command: Inject.id, flags })
+
     const notifier = require('node-notifier')
     const cheHelper = new CheHelper(flags)
 

src/commands/workspace/list.ts

@@ -29,6 +29,8 @@ export default class List extends Command {
   async run() {
     const { flags } = this.parse(List)
 
+    await this.config.runHook('analytics', { event: List.description, command: List.id, flags })
+
     const { cheApiEndpoint, accessToken } = await getLoginData(this.config.configDir, flags[CHE_API_ENDPOINT_KEY], flags[ACCESS_TOKEN_KEY])
     const cheApiClient = CheApiClient.getInstance(cheApiEndpoint)
     const workspaces = await cheApiClient.getAllWorkspaces(accessToken)

src/commands/workspace/logs.ts

@@ -44,6 +44,7 @@ export default class Logs extends Command {
     const { flags } = this.parse(Logs)
     const logsDirectory = path.resolve(flags.directory ? flags.directory : path.resolve(os.tmpdir(), 'chectl-logs', Date.now().toString()))
 
+    await this.config.runHook('analytics', { event: Logs.description, command: Logs.id, flags })
     const cheHelper = new CheHelper(flags)
     const workspaceRun = await cheHelper.readWorkspacePodLog(flags.namespace, flags.workspace, logsDirectory)
 

src/commands/workspace/start.ts

@@ -45,6 +45,7 @@ export default class Start extends Command {
     const { flags } = this.parse(Start)
     const { args } = this.parse(Start)
 
+    await this.config.runHook('analytics', { event: Start.description, command: Start.id, flags })
     const workspaceId = args.workspace
     const cheHelper = new CheHelper(flags)
 

src/commands/workspace/stop.ts

@@ -39,8 +39,9 @@ export default class Stop extends Command {
     const { flags } = this.parse(Stop)
     const { args } = this.parse(Stop)
 
-    const workspaceId = args.workspace
+    await this.config.runHook('analytics', { event: Stop.description, command: Stop.id, flags })
 
+    const workspaceId = args.workspace
     const { cheApiEndpoint, accessToken } = await getLoginData(this.config.configDir, flags[CHE_API_ENDPOINT_KEY], flags[ACCESS_TOKEN_KEY])
     const cheApiClient = CheApiClient.getInstance(cheApiEndpoint)
     await cheApiClient.stopWorkspace(workspaceId, accessToken)

src/hooks/analytics/analytics.ts

@@ -0,0 +1,44 @@
+/*********************************************************************
+ * Copyright (c) 2020 Red Hat, Inc.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+
+import { cli } from 'cli-ux'
+import { IConfig } from '@oclif/config'
+import { existsSync, mkdirsSync } from 'fs-extra'
+
+import { SegmentAdapter } from './segment'
+
+export const hook = async (options: {event: string, flags: any, command: string, config: IConfig }) => {
+  let confirmed
+
+  const segment = new SegmentAdapter({
+    // tslint:disable-next-line:no-single-line-block-comment
+    segmentWriteKey: /* @mangle */'INSERT-KEY-HERE' /* @/mangle */,
+  })
+
+  // Check if exist config dir and if not procceed to create it
+  if (!existsSync(options.config.configDir)) {
+    mkdirsSync(options.config.configDir)
+  }
+
+  // In case if segment info doesn't exist ask user if allow chectl to collect data and store the confirmation in cache
+  if (!segment.checkIfSegmentConfigFileExist(options.config.configDir)) {
+    confirmed = await cli.confirm('Do you allow chectl to collect anonymous usage data? Please confirm - press y/n')
+    segment.storeSegmentConfig(options.config.configDir, confirmed)
+  }
+
+  try {
+    // If user allow to collect data, chectl start to send the data to segment
+    if (confirmed || segment.checkIfSegmentCollectIsAllowed(options.config.configDir)) {
+      segment.onTrack(options)
+    }
+  } catch {
+    return this
+  }
+}