Adding profile support to the v3 CLI (#953)

ericallam · web-flow · commit e55ca0279b28 · 2024-03-18T17:35:29.000Z
diff --git a/packages/cli-v3/src/cli/common.ts b/packages/cli-v3/src/cli/common.ts
@@ -10,12 +10,14 @@ export const CommonCommandOptions = z.object({
   apiUrl: z.string().optional(),
   logLevel: z.enum(["debug", "info", "log", "warn", "error", "none"]).default("log"),
   skipTelemetry: z.boolean().default(false),
+  profile: z.string().default("default"),
 });
 
 export type CommonCommandOptions = z.infer<typeof CommonCommandOptions>;
 
 export function commonOptions(command: Command) {
   return command
+    .option("--profile <profile>", "The login profile to use", "default")
     .option("-a, --api-url <value>", "Override the API URL", "https://api.trigger.dev")
     .option(
       "-l, --log-level <level>",
@@ -25,9 +27,9 @@ export function commonOptions(command: Command) {
     .option("--skip-telemetry", "Opt-out of sending telemetry");
 }
 
-export class SkipLoggingError extends Error {}
-export class SkipCommandError extends Error {}
-export class OutroCommandError extends SkipCommandError {}
+export class SkipLoggingError extends Error { }
+export class SkipCommandError extends Error { }
+export class OutroCommandError extends SkipCommandError { }
 
 export async function handleTelemetry(action: () => Promise<void>) {
   try {
diff --git a/packages/cli-v3/src/cli/index.ts b/packages/cli-v3/src/cli/index.ts
@@ -3,12 +3,10 @@ import { configureDeployCommand } from "../commands/deploy.js";
 import { configureDevCommand } from "../commands/dev.js";
 import { configureInitCommand } from "../commands/init.js";
 import { configureLoginCommand } from "../commands/login.js";
-import { logoutCommand } from "../commands/logout.js";
-import { updateCommand } from "../commands/update.js";
+import { configureLogoutCommand } from "../commands/logout.js";
 import { configureWhoamiCommand } from "../commands/whoami.js";
 import { COMMAND_NAME } from "../consts.js";
 import { getVersion } from "../utilities/getVersion.js";
-import { printInitialBanner } from "../utilities/initialBanner.js";
 
 export const program = new Command();
 
@@ -19,35 +17,7 @@ program
 
 configureLoginCommand(program);
 configureInitCommand(program);
-
-program
-  .command("logout")
-  .description("Logout of Trigger.dev")
-  .version(getVersion(), "-v, --version", "Display the version number")
-  .action(async (options) => {
-    try {
-      await printInitialBanner(false);
-      await logoutCommand(options);
-      //todo login command
-    } catch (e) {
-      //todo error reporting
-      throw e;
-    }
-  });
-
 configureDevCommand(program);
 configureDeployCommand(program);
-
-program
-  .command("update")
-  .description(
-    "Updates all @trigger.dev/* packages to their latest compatible versions or the specified version"
-  )
-  .argument("[path]", "The path to the directory that contains the package.json file", ".")
-  .option("-t, --to <version tag>", "The version to update to (ex: 2.1.4)", "latest")
-  .action(async (path, options) => {
-    await printInitialBanner(false);
-    await updateCommand(path, options);
-  });
-
 configureWhoamiCommand(program);
+configureLogoutCommand(program);
diff --git a/packages/cli-v3/src/commands/deploy.ts b/packages/cli-v3/src/commands/deploy.ts
@@ -134,7 +134,7 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
 
   intro("Deploying project");
 
-  const authorization = await login({ embedded: true, defaultApiUrl: options.apiUrl });
+  const authorization = await login({ embedded: true, defaultApiUrl: options.apiUrl, profile: options.profile });
 
   if (!authorization.ok) {
     if (authorization.error === "fetch failed") {
diff --git a/packages/cli-v3/src/commands/dev.tsx b/packages/cli-v3/src/commands/dev.tsx
@@ -24,7 +24,7 @@ import { ClientOptions, WebSocket as wsWebSocket } from "ws";
 import { z } from "zod";
 import * as packageJson from "../../package.json";
 import { CliApiClient } from "../apiClient";
-import { CommonCommandOptions } from "../cli/common.js";
+import { CommonCommandOptions, commonOptions, wrapCommandAction } from "../cli/common.js";
 import { readConfig } from "../utilities/configFiles";
 import { printStandloneInitialBanner } from "../utilities/initialBanner.js";
 import { detectPackageNameFromImportPath } from "../utilities/installPackages";
@@ -47,46 +47,31 @@ const DevCommandOptions = CommonCommandOptions.extend({
 type DevCommandOptions = z.infer<typeof DevCommandOptions>;
 
 export function configureDevCommand(program: Command) {
-  program
-    .command("dev")
-    .description("Run your Trigger.dev tasks locally")
-    .argument("[path]", "The path to the project", ".")
-    .option(
-      "-l, --log-level <level>",
-      "The log level to use (debug, info, log, warn, error, none)",
-      "log"
-    )
-    .option(
-      "-c, --config <config file>",
-      "The name of the config file, found at [path]",
-      "trigger.config.mjs"
-    )
-    .option(
-      "-p, --project-ref <project ref>",
-      "The project ref. Required if there is no config file."
-    )
-    .option("--debugger", "Enable the debugger")
-    .option("--debug-otel", "Enable OpenTelemetry debugging")
-    .action(async (path, options) => {
-      try {
-        await devCommand(path, options);
-      } catch (e) {
-        //todo error reporting
-        throw e;
-      }
+  return commonOptions(
+    program
+      .command("dev")
+      .description("Run your Trigger.dev tasks locally")
+      .argument("[path]", "The path to the project", ".")
+      .option(
+        "-c, --config <config file>",
+        "The name of the config file, found at [path]",
+        "trigger.config.mjs"
+      )
+      .option(
+        "-p, --project-ref <project ref>",
+        "The project ref. Required if there is no config file."
+      )
+      .option("--debugger", "Enable the debugger")
+      .option("--debug-otel", "Enable OpenTelemetry debugging")
+  ).action(async (path, options) => {
+    wrapCommandAction("dev", DevCommandOptions, options, async (opts) => {
+      await devCommand(path, opts);
     });
+  });
 }
 
-export async function devCommand(dir: string, anyOptions: unknown) {
-  const options = DevCommandOptions.safeParse(anyOptions);
-
-  if (!options.success) {
-    console.log(fromZodError(options.error).toString());
-
-    process.exit(1);
-  }
-
-  const authorization = await isLoggedIn();
+export async function devCommand(dir: string, options: DevCommandOptions) {
+  const authorization = await isLoggedIn(options.profile);
 
   if (!authorization.ok) {
     if (authorization.error === "fetch failed") {
@@ -101,7 +86,7 @@ export async function devCommand(dir: string, anyOptions: unknown) {
   let watcher;
 
   try {
-    const devInstance = await startDev(dir, options.data, authorization.auth);
+    const devInstance = await startDev(dir, options, authorization.auth);
     watcher = devInstance.watcher;
     const { waitUntilExit } = devInstance.devReactElement;
     await waitUntilExit();
diff --git a/packages/cli-v3/src/commands/init.ts b/packages/cli-v3/src/commands/init.ts
@@ -80,7 +80,7 @@ async function _initCommand(dir: string, options: InitCommandOptions) {
 
   intro("Initializing project");
 
-  const authorization = await login({ embedded: true, defaultApiUrl: options.apiUrl });
+  const authorization = await login({ embedded: true, defaultApiUrl: options.apiUrl, profile: options.profile });
 
   if (!authorization.ok) {
     if (authorization.error === "fetch failed") {
@@ -96,6 +96,7 @@ async function _initCommand(dir: string, options: InitCommandOptions) {
     "cli.userId": authorization.userId,
     "cli.email": authorization.email,
     "cli.config.apiUrl": authorization.auth.apiUrl,
+    "cli.config.profile": authorization.profile,
   });
 
   if (!options.overrideConfig) {
diff --git a/packages/cli-v3/src/commands/login.ts b/packages/cli-v3/src/commands/login.ts
@@ -14,11 +14,12 @@ import {
   wrapCommandAction,
 } from "../cli/common.js";
 import { chalkLink } from "../utilities/colors.js";
-import { readAuthConfigFile, writeAuthConfigFile } from "../utilities/configFiles.js";
+import { readAuthConfigProfile, writeAuthConfigProfile } from "../utilities/configFiles.js";
 import { getVersion } from "../utilities/getVersion.js";
 import { printInitialBanner } from "../utilities/initialBanner.js";
 import { LoginResult } from "../utilities/session.js";
 import { whoAmI } from "./whoami.js";
+import { logger } from "../utilities/logger.js";
 
 export const LoginCommandOptions = CommonCommandOptions.extend({
   apiUrl: z.string(),
@@ -48,12 +49,13 @@ export async function loginCommand(options: unknown) {
 }
 
 async function _loginCommand(options: LoginCommandOptions) {
-  return login({ defaultApiUrl: options.apiUrl, embedded: false });
+  return login({ defaultApiUrl: options.apiUrl, embedded: false, profile: options.profile });
 }
 
 export type LoginOptions = {
   defaultApiUrl?: string;
   embedded?: boolean;
+  profile?: string;
 };
 
 export async function login(options?: LoginOptions): Promise<LoginResult> {
@@ -63,16 +65,17 @@ export async function login(options?: LoginOptions): Promise<LoginResult> {
 
       span.setAttributes({
         "cli.config.apiUrl": opts.defaultApiUrl,
+        "cli.options.profile": opts.profile,
       });
 
       if (!opts.embedded) {
         intro("Logging in to Trigger.dev");
       }
 
-      const authConfig = readAuthConfigFile();
+      const authConfig = readAuthConfigProfile(options?.profile);
 
       if (authConfig && authConfig.accessToken) {
-        const whoAmIResult = await whoAmI(undefined, opts.embedded);
+        const whoAmIResult = await whoAmI({ profile: options?.profile ?? "default", skipTelemetry: !span.isRecording(), logLevel: logger.loggerLevel }, opts.embedded);
 
         if (!whoAmIResult.success) {
           throw new Error(whoAmIResult.error);
@@ -106,6 +109,7 @@ export async function login(options?: LoginOptions): Promise<LoginResult> {
 
               return {
                 ok: true as const,
+                profile: options?.profile ?? "default",
                 userId: whoAmIResult.data.userId,
                 email: whoAmIResult.data.email,
                 dashboardUrl: whoAmIResult.data.dashboardUrl,
@@ -126,6 +130,7 @@ export async function login(options?: LoginOptions): Promise<LoginResult> {
 
             return {
               ok: true as const,
+              profile: options?.profile ?? "default",
               userId: whoAmIResult.data.userId,
               email: whoAmIResult.data.email,
               dashboardUrl: whoAmIResult.data.dashboardUrl,
@@ -170,9 +175,9 @@ export async function login(options?: LoginOptions): Promise<LoginResult> {
 
         getPersonalAccessTokenSpinner.stop(`Logged in with token ${indexResult.obfuscatedToken}`);
 
-        writeAuthConfigFile({ accessToken: indexResult.token, apiUrl: opts.defaultApiUrl });
+        writeAuthConfigProfile({ accessToken: indexResult.token, apiUrl: opts.defaultApiUrl }, options?.profile);
 
-        const whoAmIResult = await whoAmI(undefined, opts.embedded);
+        const whoAmIResult = await whoAmI({ profile: options?.profile ?? "default", skipTelemetry: !span.isRecording(), logLevel: logger.loggerLevel }, opts.embedded);
 
         if (!whoAmIResult.success) {
           throw new Error(whoAmIResult.error);
@@ -188,6 +193,7 @@ export async function login(options?: LoginOptions): Promise<LoginResult> {
 
         return {
           ok: true as const,
+          profile: options?.profile ?? "default",
           userId: whoAmIResult.data.userId,
           email: whoAmIResult.data.email,
           dashboardUrl: whoAmIResult.data.dashboardUrl,
diff --git a/packages/cli-v3/src/commands/logout.ts b/packages/cli-v3/src/commands/logout.ts
@@ -1,15 +1,41 @@
-import { readAuthConfigFile, writeAuthConfigFile } from "../utilities/configFiles.js";
+import { Command } from "commander";
+import { readAuthConfigProfile, writeAuthConfigProfile } from "../utilities/configFiles.js";
 import { logger } from "../utilities/logger.js";
+import { CommonCommandOptions, commonOptions, handleTelemetry, wrapCommandAction } from "../cli/common.js";
+import { printInitialBanner } from "../utilities/initialBanner.js";
+import { z } from "zod";
 
-export async function logoutCommand(options: any) {
-  const config = readAuthConfigFile();
+const LogoutCommandOptions = CommonCommandOptions;
+
+type LogoutCommandOptions = z.infer<typeof LogoutCommandOptions>;
+
+export function configureLogoutCommand(program: Command) {
+  return commonOptions(program
+    .command("logout")
+    .description("Logout of Trigger.dev"))
+    .action(async (options) => {
+      await handleTelemetry(async () => {
+        await printInitialBanner(false);
+        await logoutCommand(options);
+      });
+    });
+}
+
+export async function logoutCommand(options: unknown) {
+  return await wrapCommandAction("logoutCommand", LogoutCommandOptions, options, async (opts) => {
+    return await logout(opts);
+  });
+}
+
+export async function logout(options: LogoutCommandOptions) {
+  const config = readAuthConfigProfile(options.profile);
 
   if (!config?.accessToken) {
-    logger.info("You are already logged out");
+    logger.info(`You are already logged out [${options.profile ?? "default"}]`);
     return;
   }
 
-  writeAuthConfigFile({ ...config, accessToken: undefined, apiUrl: undefined });
+  writeAuthConfigProfile({ ...config, accessToken: undefined, apiUrl: undefined }, options.profile);
 
-  logger.info("Logged out");
+  logger.info(`Logged out of Trigger.dev [${options.profile ?? "default"}]`);
 }
diff --git a/packages/cli-v3/src/commands/whoami.ts b/packages/cli-v3/src/commands/whoami.ts
diff --git a/packages/cli-v3/src/utilities/configFiles.ts b/packages/cli-v3/src/utilities/configFiles.ts
diff --git a/packages/cli-v3/src/utilities/session.ts b/packages/cli-v3/src/utilities/session.ts
