@yahoo/uds 1.5.0 → 1.7.0

package/cli/README.md

@@ -179,6 +179,22 @@ Commands are organized in a tree structure in `uds/cli/commands`. The root comma
 
 Adding nested commands, i.e. `uds expo dev` does work correctly when UDS is consumed from npm. As a workaround, please see code for expo/expo.ts for re-routing sub-commands from the root command file. To verify your CLI command works correctly you should run `npm pack` within the packages/uds directory. Once you have your generated tarball you should copy that tarball to a test application such as https://github.com/yahoo-uds/uds-nextjs-demo, then add `"@yahoo/uds": "file:./tarball-generated-from-npm-pack.tgz` to it's dependencies and run an install. Now you should be able to run `bun uds [your command name]` to test your functionality.
 
+### Testing the login flow
+
+To test the login flow, the CLI starts a web server and opens browser window to
+a login page in Configurator. In prod, it opens https://config.uds.build/login.
+In local dev, http://localhost:4001/login is opened.
+
+In the root of the UDS monorepo, run the following commands:
+
+```
+# Start configurator app web server:
+turbo --filter uds-configurator dev
+
+# Run the CLI login command:
+bun run --cwd packages/uds uds login
+```
+
 ### API Reference
 
 Bluebun comes with a number of built-in utilities that are exported from the main `bluebun` package. See [reference guide](https://github.com/jamonholmgren/bluebun/blob/main/docs/reference.md) for more.

package/cli/commands/codemod/codemod.ts

@@ -1,6 +1,7 @@
 import { type Props } from 'bluebun';
 import prompts from 'prompts';
 
+import { trackEvent } from '../../utils/analytics';
 import { getCommandHelp, getSubCommandsChoices } from '../../utils/getCommandHelp';
 import { getDirChoices } from '../../utils/getDirChoices';
 
@@ -13,6 +14,11 @@ export default {
     const isRootCommand = Boolean(!props?.first);
     const dirChoices = getDirChoices();
 
+    const runCodeMod = async (codemod: string, selectedDirs: string[]) => {
+      const mod = (await import(`./${codemod}`)).default;
+      return mod.run({ ...props, selectedDirs });
+    };
+
     if (isRootCommand) {
       // Prompt the user to setup the codemod runner
       const { selectedDirs, selectedCodemods, didConfirm } = await prompts([
@@ -49,10 +55,9 @@ export default {
 
       // Run each codemod and provide the selectedDirs
       return Promise.all(
-        selectedCodemods.map(async (selectedCodemod: string[]) => {
-          return await import(`./${selectedCodemod}`).then((codemod) =>
-            codemod.default.run({ ...props, selectedDirs }),
-          );
+        selectedCodemods.map(async (codemod: string) => {
+          await runCodeMod(codemod, selectedDirs);
+          return trackEvent('codemod', { codemod });
         }),
       );
     } else if (subCommandIsValid) {
@@ -71,11 +76,9 @@ export default {
         process.exit(1);
       }
 
-      // Run the codemod
-      return (await import(`./${props.first}`)).default.run({
-        ...props,
-        selectedDirs,
-      });
+      const codemod = props.first!;
+      await runCodeMod(codemod, selectedDirs);
+      return trackEvent('codemod', { codemod });
     } else {
       // Throw the help message
       await getCommandHelp({

package/cli/commands/login.ts

@@ -1,5 +1,6 @@
 import { magenta, print, red } from 'bluebun';
 
+import { trackEvent } from '../utils/analytics';
 import { login } from '../utils/auth';
 
 export default {
@@ -11,6 +12,7 @@ export default {
       const user = await login();
       if (user) {
         print(magenta(`🔒 Logged in as ${user.email}`));
+        return await trackEvent('login');
       }
     } catch (error) {
       if (error instanceof Error) {

package/cli/commands/logout.ts

@@ -1,5 +1,6 @@
 import { magenta, print, red } from 'bluebun';
 
+import { trackEvent } from '../utils/analytics';
 import { logout } from '../utils/auth';
 
 export default {
@@ -7,6 +8,8 @@ export default {
   description: '👤 Sign out of UDS CLI',
   run: async () => {
     try {
+      // Track logout event before logout is run. Otherwise, there's no user object to track.
+      await trackEvent('logout');
       await logout();
       print(magenta('👋 You have been logged out.'));
     } catch (error) {

package/cli/commands/purge.ts

@@ -1,5 +1,6 @@
 import { Props, spinStart, spinStop } from 'bluebun';
 
+import { trackEvent } from '../utils/analytics';
 import { purge, PurgeOptions } from '../utils/purgeCSS';
 
 interface PurgeProps extends Props {
@@ -15,6 +16,7 @@ export default {
     try {
       await purge(props.options);
       spinStop('✅', 'Purging css done!');
+      return await trackEvent('purge');
     } catch (error) {
       if (error instanceof Error) {
         spinStop('❌', error.message);

package/cli/commands/sync.ts

@@ -1,5 +1,6 @@
 import { magenta, print, Props } from 'bluebun';
 
+import { trackEvent } from '../utils/analytics';
 import { setupConfigWorker } from '../utils/setupConfigWorker';
 import { SyncOptions } from '../utils/types';
 
@@ -31,6 +32,7 @@ export default {
           }
         },
       });
+      return await trackEvent('sync', { id });
     } catch {
       console.error(
         '❌ An error occurred while syncing. Please reach out to #uds-ask channel for support.',

package/cli/commands/uds.ts

@@ -1,5 +1,6 @@
 import { print, type Props, red } from 'bluebun';
 
+import { trackEvent } from '../utils/analytics';
 import { getAuthenticatedUser } from '../utils/auth';
 import { getCommandHelp } from '../utils/getCommandHelp';
 
@@ -9,6 +10,7 @@ export default {
   run: async (props: Props) => {
     if (props.first) {
       print(red(`Unknown command: ${props.first}`));
+      await trackEvent('unknown_cmd', { cmd: props.first });
     }
     const user = await getAuthenticatedUser();
     const notes = user ? `🔒 Logged in as ${user.email}` : undefined;

package/cli/commands/version.ts

@@ -1,11 +1,13 @@
 import { print } from 'bluebun';
 
 import packageJson from '../../package.json';
+import { trackEvent } from '../utils/analytics';
 
 export default {
   name: 'version',
   description: `${packageJson.version}`,
   run: async () => {
     print(packageJson.version);
+    await trackEvent('version', { version: packageJson.version });
   },
 };

package/cli/tsconfig.json

@@ -18,14 +18,15 @@
     "strict": true,
     "types": ["bun-types"],
     "target": "esnext",
-    "lib": ["esnext"],
+    "lib": ["ESNext"],
     "module": "esnext",
     "moduleResolution": "bundler",
     "paths": {
       "@yahoo/uds/scripts/*": ["../scripts/*"],
       "@yahoo/uds/*": ["../src/*"],
       "@yahoo/uds/tailwind/tsMorph": ["../scripts/utils/tsMorph.ts"],
-      "root/*": ["../../*"],
-    },
-  },
+      "analytics/*": ["../../analytics/*"],
+      "root/*": ["../../*"]
+    }
+  }
 }

package/cli/utils/analytics.ts

@@ -0,0 +1,27 @@
+import { getFeatureFlags } from '@yahoo/uds/flags';
+import { GA_MEASUREMENT_IDS, GA_MEASUREMENT_SECRETS } from 'analytics/providers/google/consts';
+import { track } from 'analytics/providers/google/server';
+import { EventName } from 'analytics/types';
+
+import { getAuthenticatedUser } from '../utils/auth';
+
+export async function setup() {
+  const user = await getAuthenticatedUser();
+  if (user) {
+    await track.init({
+      appName: 'cli',
+      apiSecret: GA_MEASUREMENT_SECRETS.cli,
+      measurementId: GA_MEASUREMENT_IDS.cli,
+      // @ts-expect-error type is fine
+      user,
+    });
+  }
+}
+
+export const trackEvent = async (...args: Parameters<typeof track.event<EventName['cli']>>) => {
+  const { useCLIAuth } = getFeatureFlags();
+  if (useCLIAuth) {
+    await setup();
+    return track.event(...args);
+  }
+};

package/cli/utils/auth.ts

@@ -9,11 +9,11 @@ import {
   getAuth,
   GoogleAuthProvider,
   signInWithCredential,
-  User as FirebaseUser,
 } from 'firebase/auth';
 import { google, oauth2_v2 } from 'googleapis';
 import http from 'http';
 import open from 'open';
+import { type FirebaseUser } from 'root/database/firebase';
 
 import clientSecrets from './client_secrets.json';