feat(analytics): add analytics hooks for success and failure (#18)

https://coveord.atlassian.net/browse/CDX-70

packages/cli/package.json

@@ -11,8 +11,9 @@
     "@openid/appauth": "^1.3.0",
     "@vue/cli": "^4.5.11",
     "abortcontroller-polyfill": "^1.7.1",
-    "create-react-app": "^4.0.1",
     "cli-ux": "^5.5.1",
+    "coveo.analytics": "^2.18.2",
+    "create-react-app": "^4.0.1",
     "exponential-backoff": "^3.1.0",
     "fs-extra": "^9.1.0",
     "isomorphic-fetch": "^3.0.0",
@@ -57,7 +58,8 @@
       }
     },
     "hooks": {
-      "init": "./lib/hooks/init/set-global-config"
+      "init": "./lib/hooks/init/set-global-config",
+      "analytics": "./lib/hooks/analytics/analytics"
     }
   },
   "repository": "coveo/cli",

packages/cli/src/commands/auth/login.spec.ts

@@ -2,6 +2,7 @@ jest.mock('../../lib/oauth/oauth');
 jest.mock('../../lib/oauth/storage');
 jest.mock('../../lib/config/config');
 jest.mock('keytar');
+jest.mock('../../hooks/analytics/analytics');
 import {test} from '@oclif/test';
 import {mocked} from 'ts-jest/utils';
 import {Config} from '../../lib/config/config';

packages/cli/src/commands/auth/login.ts

@@ -8,6 +8,10 @@ import {
   PlatformRegion,
 } from '../../lib/platform/environment';
 import {OrganizationModel} from '@coveord/platform-client';
+import {
+  buildAnalyticsFailureHook,
+  buildAnalyticsSuccessHook,
+} from '../../hooks/analytics/analytics';
 
 export default class Login extends Command {
   static description = 'Log into Coveo platform using OAuth2 flow';
@@ -64,6 +68,16 @@ export default class Login extends Command {
         );
       }
     }
+    this.config.runHook('analytics', buildAnalyticsSuccessHook(this, flags));
+  }
+
+  async catch(err?: Error) {
+    const {flags} = this.parse(Login);
+    await this.config.runHook(
+      'analytics',
+      buildAnalyticsFailureHook(this, flags, err)
+    );
+    throw err;
   }
 
   private async pickFirstAvailableOrganization() {

packages/cli/src/commands/config/get.ts

@@ -1,4 +1,8 @@
 import {Command} from '@oclif/command';
+import {
+  buildAnalyticsFailureHook,
+  buildAnalyticsSuccessHook,
+} from '../../hooks/analytics/analytics';
 import {Config} from '../../lib/config/config';
 
 export default class Get extends Command {
@@ -7,5 +11,14 @@ export default class Get extends Command {
   async run() {
     const cfg = await new Config(this.config.configDir, this.error).get();
     this.log(JSON.stringify(cfg, null, 4));
+    await this.config.runHook('analytics', buildAnalyticsSuccessHook(this, {}));
+  }
+
+  async catch(err?: Error) {
+    await this.config.runHook(
+      'analytics',
+      buildAnalyticsFailureHook(this, {}, err)
+    );
+    throw err;
   }
 }

packages/cli/src/commands/config/set.ts

@@ -1,4 +1,8 @@
 import {Command, flags} from '@oclif/command';
+import {
+  buildAnalyticsFailureHook,
+  buildAnalyticsSuccessHook,
+} from '../../hooks/analytics/analytics';
 import {Config} from '../../lib/config/config';
 import {
   PlatformEnvironment,
@@ -46,5 +50,18 @@ export default class Set extends Command {
     if (flags.region) {
       cfg.set('region', flags.region as PlatformRegion);
     }
+    await this.config.runHook(
+      'analytics',
+      buildAnalyticsSuccessHook(this, flags)
+    );
+  }
+
+  async catch(err?: Error) {
+    const {flags} = this.parse(Set);
+    await this.config.runHook(
+      'analytics',
+      buildAnalyticsFailureHook(this, flags, err)
+    );
+    throw err;
   }
 }

packages/cli/src/commands/org/list.ts

@@ -3,6 +3,10 @@ import AuthenticationRequired from '../../lib/decorators/authenticationRequired'
 import {AuthenticatedClient} from '../../lib/platform/authenticatedClient';
 import {OrganizationModel} from '@coveord/platform-client';
 import {cli} from 'cli-ux';
+import {
+  buildAnalyticsFailureHook,
+  buildAnalyticsSuccessHook,
+} from '../../hooks/analytics/analytics';
 
 export default class List extends Command {
   static description = 'List Coveo organizations.';
@@ -36,5 +40,19 @@ export default class List extends Command {
       },
       {...flags}
     );
+
+    await this.config.runHook(
+      'analytics',
+      buildAnalyticsSuccessHook(this, flags)
+    );
+  }
+
+  async catch(err?: Error) {
+    const {flags} = this.parse(List);
+    await this.config.runHook(
+      'analytics',
+      buildAnalyticsFailureHook(this, flags, err)
+    );
+    throw err;
   }
 }

packages/cli/src/commands/ui/create/react.spec.ts

@@ -1,7 +1,7 @@
 import {test} from '@oclif/test';
 import {EventEmitter} from 'events';
 import * as child_process from 'child_process';
-
+jest.mock('../../../hooks/analytics/analytics');
 jest.mock('child_process', () => ({
   spawn: jest.fn().mockImplementation(() => {
     const successExitCode = 0;

packages/cli/src/commands/ui/create/react.ts

@@ -1,15 +1,15 @@
 import {Command, flags} from '@oclif/command';
 import {resolve} from 'path';
+import {
+  buildAnalyticsFailureHook,
+  buildAnalyticsSuccessHook,
+} from '../../../hooks/analytics/analytics';
 import {spawnProcess} from '../../../lib/utils/process';
 
 export default class React extends Command {
   static description =
     'Create a search page in React powered by Coveo Headless';
 
-  static flags = {
-    help: flags.help({char: 'h'}),
-  };
-
   static examples = [
     '$ coveo ui:create:react myapp',
     '$ coveo ui:create:react --help',
@@ -20,8 +20,17 @@ export default class React extends Command {
   ];
 
   async run() {
-    const {args, flags} = this.parse(React);
+    const {args} = this.parse(React);
     await this.createProject(args.name);
+    await this.config.runHook('analytics', buildAnalyticsSuccessHook(this, {}));
+  }
+
+  async catch(err?: Error) {
+    await this.config.runHook(
+      'analytics',
+      buildAnalyticsFailureHook(this, {}, err)
+    );
+    throw err;
   }
 
   private createProject(name: string) {

packages/cli/src/commands/ui/create/vue.spec.ts

@@ -1,5 +1,5 @@
 import {expect, test} from '@oclif/test';
-
+jest.mock('../../../hooks/analytics/analytics');
 describe('ui:create:vue', () => {
   test
     .command(['ui:create:vue'])

packages/cli/src/commands/ui/create/vue.ts

@@ -1,5 +1,9 @@
 import {Command, flags} from '@oclif/command';
 import {dirname, resolve} from 'path';
+import {
+  buildAnalyticsFailureHook,
+  buildAnalyticsSuccessHook,
+} from '../../../hooks/analytics/analytics';
 import {spawnProcess} from '../../../lib/utils/process';
 
 export default class Vue extends Command {
@@ -41,6 +45,19 @@ export default class Vue extends Command {
     await this.installPlugin(args.name);
     await this.invokePlugin(args.name);
     this.startServer(args.name);
+    await this.config.runHook(
+      'analytics',
+      buildAnalyticsSuccessHook(this, flags)
+    );
+  }
+
+  async catch(err?: Error) {
+    const {flags} = this.parse(Vue);
+    await this.config.runHook(
+      'analytics',
+      buildAnalyticsFailureHook(this, flags, err)
+    );
+    throw err;
   }
 
   private installPlugin(applicationName: string) {