fix(analytics): fix analytics hook for expired or logged out (#31)

https://coveord.atlassian.net/browse/CDX-84
coveo · Feb 23, 2021 · 1c9964e · 1c9964e
1 parent 7aec1dd
commit 1c9964e
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 10 deletions.
diff --git a/packages/cli/src/hooks/analytics/analytics.spec.ts b/packages/cli/src/hooks/analytics/analytics.spec.ts
@@ -5,7 +5,11 @@ jest.mock('@coveord/platform-client');
 import {mocked} from 'ts-jest/utils';
 import {CoveoAnalyticsClient, IRuntimeEnvironment} from 'coveo.analytics';
 import {Configuration, Config} from '../../lib/config/config';
-import {AuthenticatedClient} from '../../lib/platform/authenticatedClient';
+import {
+  AuthenticatedClient,
+  AuthenticationStatus,
+  getAuthenticationStatus,
+} from '../../lib/platform/authenticatedClient';
 import hook, {AnalyticsHook} from './analytics';
 import {IConfig} from '@oclif/config';
 import {PlatformClient} from '@coveord/platform-client';
@@ -14,6 +18,7 @@ const mockedAnalytics = mocked(CoveoAnalyticsClient);
 const mockedConfig = mocked(Config);
 const mockedPlatformClient = mocked(PlatformClient);
 const mockedAuthenticatedClient = mocked(AuthenticatedClient);
+const mockedAuthenticationStatus = mocked(getAuthenticationStatus);
 
 describe('analytics hook', () => {
   let sendCustomEvent: jest.Mock;
@@ -69,7 +74,7 @@ describe('analytics hook', () => {
   };
 
   const doMockAuthenticatedClient = () => {
-    mockedAuthenticatedClient.mockImplementationOnce(
+    mockedAuthenticatedClient.mockImplementation(
       () =>
         ({
           getClient: () =>
@@ -82,6 +87,9 @@ describe('analytics hook', () => {
           cfg: mockedConfig.getMockImplementation()!('./'),
         } as AuthenticatedClient)
     );
+    mockedAuthenticationStatus.mockImplementation(() =>
+      Promise.resolve(AuthenticationStatus.LOGGED_IN)
+    );
   };
 
   beforeEach(() => {
@@ -212,4 +220,19 @@ describe('analytics hook', () => {
     await hook(getAnalyticsHook({}));
     expect(sendCustomEvent).not.toHaveBeenCalled();
   });
+
+  it('should not throw an error when the user is not logged in', async () => {
+    mockedAuthenticationStatus.mockImplementationOnce(() =>
+      Promise.resolve(AuthenticationStatus.LOGGED_OUT)
+    );
+
+    await expect(hook(getAnalyticsHook({}))).resolves.not.toThrow();
+  });
+
+  it('should not throw an error when the user is expired', async () => {
+    mockedAuthenticationStatus.mockImplementationOnce(() =>
+      Promise.resolve(AuthenticationStatus.EXPIRED)
+    );
+    await expect(hook(getAnalyticsHook({}))).resolves.not.toThrow();
+  });
 });
diff --git a/packages/cli/src/hooks/analytics/analytics.ts b/packages/cli/src/hooks/analytics/analytics.ts
@@ -3,7 +3,11 @@ import {IConfig} from '@oclif/config';
 import {CoveoAnalyticsClient} from 'coveo.analytics';
 import {WebStorage} from 'coveo.analytics/dist/definitions/storage';
 import {Config} from '../../lib/config/config';
-import {AuthenticatedClient} from '../../lib/platform/authenticatedClient';
+import {
+  AuthenticatedClient,
+  AuthenticationStatus,
+  getAuthenticationStatus,
+} from '../../lib/platform/authenticatedClient';
 
 export interface AnalyticsHook {
   commandID: string;
@@ -15,6 +19,10 @@ export interface AnalyticsHook {
 const analyticsAPIKey = 'xx01ad67bb-f837-4a3e-8669-16397994a6f2';
 
 const hook = async function (opts: AnalyticsHook) {
+  if (!(await isLoggedIn())) {
+    return;
+  }
+
   const {eventType, eventValue} = identifier(opts);
   const {
     environment,
@@ -109,6 +117,11 @@ const storage = (cfg: Config): WebStorage => {
   };
 };
 
+const isLoggedIn = async () => {
+  const status = await getAuthenticationStatus();
+  return status === AuthenticationStatus.LOGGED_IN;
+};
+
 export type AnalyticsStatus = 'success' | 'failure';
 
 export const buildAnalyticsHook = (

diff --git a/packages/cli/src/lib/decorators/authenticationRequired.ts b/packages/cli/src/lib/decorators/authenticationRequired.ts
@@ -1,7 +1,10 @@
 /* eslint-disable @typescript-eslint/no-namespace */
 import Command from '@oclif/command';
 import {IConfig} from '@oclif/config';
-import {AuthenticatedClient} from '../platform/authenticatedClient';
+import {
+  AuthenticationStatus,
+  getAuthenticationStatus,
+} from '../platform/authenticatedClient';
 
 declare global {
   namespace NodeJS {
@@ -20,16 +23,13 @@ export default function AuthenticationRequired() {
   ) {
     const originalRunCommand = descriptor.value!;
     descriptor.value = async function () {
-      const authenticatedClient = new AuthenticatedClient();
+      const status = await getAuthenticationStatus();
 
-      const loggedIn = await authenticatedClient.isLoggedIn();
-
-      if (!loggedIn) {
+      if (status === AuthenticationStatus.LOGGED_OUT) {
         target.error('Not currently logged in. Run coveo auth:login first.');
       }
 
-      const isExpired = await authenticatedClient.isExpired();
-      if (isExpired) {
+      if (status === AuthenticationStatus.EXPIRED) {
         target.error(
           'Authentication token is expired. Run coveo auth:login first.'
         );

diff --git a/packages/cli/src/lib/platform/authenticatedClient.ts b/packages/cli/src/lib/platform/authenticatedClient.ts
@@ -61,3 +61,23 @@ export class AuthenticatedClient {
     }
   }
 }
+
+export enum AuthenticationStatus {
+  LOGGED_IN,
+  EXPIRED,
+  LOGGED_OUT,
+}
+
+export async function getAuthenticationStatus() {
+  const authenticatedClient = new AuthenticatedClient();
+
+  if (!(await authenticatedClient.isLoggedIn())) {
+    return AuthenticationStatus.LOGGED_OUT;
+  }
+
+  if (await authenticatedClient.isExpired()) {
+    return AuthenticationStatus.EXPIRED;
+  }
+
+  return AuthenticationStatus.LOGGED_IN;
+}