feat(cli): unify Amplitude identify flow and enforce cli event source (#478)

Author: facundo-herodevs

src/commands/auth/login.ts

@@ -5,6 +5,7 @@ import { URL } from 'node:url';
 import { Command } from '@oclif/core';
 import { ensureUserSetup } from '../../api/user-setup.client.ts';
 import { OAUTH_CALLBACK_ERROR_CODES } from '../../config/constants.ts';
+import { refreshIdentityFromStoredToken } from '../../service/analytics.svc.ts';
 import { persistTokenResponse } from '../../service/auth.svc.ts';
 import { getClientId, getRealmUrl } from '../../service/auth-config.svc.ts';
 import { debugLogger, getErrorMessage } from '../../service/log.svc.ts';
@@ -55,6 +56,12 @@ export default class AuthLogin extends Command {
       this.error(`User setup failed. ${getErrorMessage(error)}`);
     }
 
+    try {
+      await refreshIdentityFromStoredToken();
+    } catch (error) {
+      this.warn(`Failed to refresh analytics identity: ${getErrorMessage(error)}`);
+    }
+
     this.log('\nLogin completed successfully.');
   }
 

src/commands/auth/logout.ts

@@ -1,4 +1,5 @@
 import { Command } from '@oclif/core';
+import { clearTrackedIdentity } from '../../service/analytics.svc.ts';
 import { logoutFromProvider } from '../../service/auth-refresh.svc.ts';
 import { clearStoredTokens, getStoredTokens } from '../../service/auth-token.svc.ts';
 
@@ -23,6 +24,7 @@ export default class AuthLogout extends Command {
       this.warn(`Failed to revoke tokens remotely: ${error instanceof Error ? error.message : error}`);
     }
 
+    clearTrackedIdentity();
     await clearStoredTokens();
     this.log('Local authentication tokens removed from your system.');
   }

src/commands/auth/provision-ci-token.ts

@@ -1,6 +1,7 @@
 import { Command } from '@oclif/core';
 import { provisionCIToken } from '../../api/ci-token.client.ts';
 import { ensureUserSetup } from '../../api/user-setup.client.ts';
+import { refreshIdentityFromStoredToken, track } from '../../service/analytics.svc.ts';
 import { requireAccessToken } from '../../service/auth.svc.ts';
 import { saveCIToken } from '../../service/ci-token.svc.ts';
 import { getErrorMessage } from '../../service/log.svc.ts';
@@ -17,10 +18,28 @@ export default class AuthProvisionCiToken extends Command {
       this.error(`Must be logged in to provision CI token. Run 'hd auth login' first. ${getErrorMessage(error)}`);
     }
 
+    try {
+      await refreshIdentityFromStoredToken();
+    } catch (error) {
+      this.warn(`Failed to refresh analytics identity: ${getErrorMessage(error)}`);
+    }
+
+    track('CLI CI Token Provision Started', (context) => ({
+      command: 'auth provision-ci-token',
+      app_used: context.app_used,
+      ci_provider: context.ci_provider,
+      cli_version: context.cli_version,
+      started_at: context.started_at,
+    }));
+
     let orgId: number;
     try {
       orgId = await ensureUserSetup();
     } catch (error) {
+      track('CLI CI Token Provision Failed', () => ({
+        command: 'auth provision-ci-token',
+        error: `user_setup_failed:${getErrorMessage(error)}`,
+      }));
       this.error(`User setup failed. ${getErrorMessage(error)}`);
     }
 
@@ -32,7 +51,14 @@ export default class AuthProvisionCiToken extends Command {
       this.log('');
       this.log('For CI/CD, set this environment variable:');
       this.log(`  HD_CI_CREDENTIAL=${refreshToken}`);
+      track('CLI CI Token Provision Succeeded', () => ({
+        command: 'auth provision-ci-token',
+      }));
     } catch (error) {
+      track('CLI CI Token Provision Failed', () => ({
+        command: 'auth provision-ci-token',
+        error: `provision_failed:${getErrorMessage(error)}`,
+      }));
       this.error(`CI token provisioning failed. ${getErrorMessage(error)}`);
     }
   }

src/hooks/finally/finally.ts

@@ -1,6 +1,7 @@
 import type { Hook } from '@oclif/core';
 import ora, { type Ora } from 'ora';
 import { track } from '../../service/analytics.svc.ts';
+import { debugLogger, getErrorMessage } from '../../service/log.svc.ts';
 
 const hook: Hook<'finally'> = async (opts) => {
   const isHelpOrVersionCmd = opts.argv.includes('--help') || opts.argv.includes('--version');
@@ -12,10 +13,14 @@ const hook: Hook<'finally'> = async (opts) => {
     spinner = ora().start('Cleaning up');
   }
 
-  await track('CLI Session Ended', (context) => ({
-    cli_version: context.cli_version,
-    ended_at: new Date(),
-  })).promise;
+  try {
+    await track('CLI Session Ended', (context) => ({
+      cli_version: context.cli_version,
+      ended_at: new Date(),
+    })).promise;
+  } catch (error) {
+    debugLogger('Failed to track CLI session end: %s', getErrorMessage(error));
+  }
 
   if (!isHelpOrVersionCmd && !hasError) {
     spinner?.stop();

src/hooks/init/01_initialize_amplitude.ts

@@ -1,18 +1,28 @@
 import { parseArgs } from 'node:util';
 import type { Hook } from '@oclif/core';
 import { initializeAnalytics, track } from '../../service/analytics.svc.ts';
+import { debugLogger, getErrorMessage } from '../../service/log.svc.ts';
 
 const hook: Hook.Init = async () => {
   const args = parseArgs({ allowPositionals: true, strict: false });
-  initializeAnalytics();
-  track('CLI Command Submitted', (context) => ({
-    command: args.positionals.join(' ').trim(),
-    command_flags: Object.entries(args.values).flat().join(' '),
-    app_used: context.app_used,
-    ci_provider: context.ci_provider,
-    cli_version: context.cli_version,
-    started_at: context.started_at,
-  }));
+  try {
+    await initializeAnalytics();
+  } catch (error) {
+    debugLogger('Failed to initialize analytics in init hook: %s', getErrorMessage(error));
+  }
+
+  try {
+    track('CLI Command Submitted', (context) => ({
+      command: args.positionals.join(' ').trim(),
+      command_flags: Object.entries(args.values).flat().join(' '),
+      app_used: context.app_used,
+      ci_provider: context.ci_provider,
+      cli_version: context.cli_version,
+      started_at: context.started_at,
+    }));
+  } catch (error) {
+    debugLogger('Failed to track command submission: %s', getErrorMessage(error));
+  }
 };
 
 export default hook;