npx convex login status and npx convex deployments (#40220)

Would be useful for some support requests.

GitOrigin-RevId: b0230f557680b1aed4a9d5d824964e66925ae8cc

Author: thomasballinger

src/cli/deployments.ts

@@ -1,16 +1,20 @@
 import { Command } from "@commander-js/extra-typings";
-import { readProjectConfig } from "./lib/config.js";
-import chalk from "chalk";
-import { bigBrainAPI } from "./lib/utils/utils.js";
-import { oneoffContext } from "../bundler/context.js";
-import { logError, logMessage, logOutput } from "../bundler/log.js";
-
-type Deployment = {
-  id: number;
-  name: string;
-  create_time: number;
-  deployment_type: "dev" | "prod";
-};
+import { oneoffContext, Context } from "../bundler/context.js";
+import { logMessage } from "../bundler/log.js";
+import {
+  getDeploymentSelection,
+  DeploymentSelection,
+} from "./lib/deploymentSelection.js";
+import { fetchTeamAndProject } from "./lib/api.js";
+
+// This is a debugging command: it's output is not stable, don't write scripts
+// that depend on its output.
+
+// TODO: for the deployments command to list all deployments in a project
+// we need a stable endpoint for listing projects (check) and a way to
+// get a project ID in all cases to use it. We have an endpoint that lists
+// deployments by team/project slug today but it's not in use and we'll
+// be able to deprecate it if we avoid using it.
 
 export const deployments = new Command("deployments")
   .description("List deployments associated with a project")
@@ -21,18 +25,78 @@ export const deployments = new Command("deployments")
       adminKey: undefined,
       envFile: undefined,
     });
-    const { projectConfig: config } = await readProjectConfig(ctx);
-
-    const url = `teams/${config.team}/projects/${config.project}/deployments`;
-
-    logMessage(`Deployments for project ${config.team}/${config.project}`);
-    const deployments = (await bigBrainAPI({
-      ctx,
-      method: "GET",
-      url,
-    })) as Deployment[];
-    logOutput(deployments);
-    if (deployments.length === 0) {
-      logError(chalk.yellow(`No deployments exist for project`));
-    }
+
+    const deploymentSelection = await getDeploymentSelection(ctx, {
+      url: undefined,
+      adminKey: undefined,
+      envFile: undefined,
+    });
+
+    await displayCurrentDeploymentInfo(ctx, deploymentSelection);
   });
+
+async function displayCurrentDeploymentInfo(
+  ctx: Context,
+  selection: DeploymentSelection,
+) {
+  logMessage("Currently configured deployment:");
+
+  switch (selection.kind) {
+    case "existingDeployment": {
+      const { deploymentToActOn } = selection;
+      logMessage(`  URL: ${deploymentToActOn.url}`);
+
+      if (deploymentToActOn.deploymentFields) {
+        const fields = deploymentToActOn.deploymentFields;
+        logMessage(
+          `  Deployment: ${fields.deploymentName} (${fields.deploymentType})`,
+        );
+        logMessage(`  Team: ${fields.teamSlug}`);
+        logMessage(`  Project: ${fields.projectSlug}`);
+      } else {
+        logMessage(`  Type: ${deploymentToActOn.source}`);
+      }
+      break;
+    }
+    case "deploymentWithinProject": {
+      const { targetProject } = selection;
+      if (targetProject.kind === "teamAndProjectSlugs") {
+        logMessage(`  Team: ${targetProject.teamSlug}`);
+        logMessage(`  Project: ${targetProject.projectSlug}`);
+      } else if (targetProject.kind === "deploymentName") {
+        const slugs = await fetchTeamAndProject(
+          ctx,
+          targetProject.deploymentName,
+        );
+        logMessage(`  Team: ${slugs.team}`);
+        logMessage(`  Project: ${slugs.project}`);
+        logMessage(`  Deployment: ${targetProject.deploymentName}`);
+        if (targetProject.deploymentType) {
+          logMessage(`  Type: ${targetProject.deploymentType}`);
+        }
+      } else {
+        logMessage(`  Project deploy key configured`);
+      }
+      break;
+    }
+    case "preview": {
+      logMessage(`  Preview deployment (deploy key configured)`);
+      break;
+    }
+    case "anonymous": {
+      if (selection.deploymentName) {
+        logMessage(`  Anonymous deployment: ${selection.deploymentName}`);
+      } else {
+        logMessage(`  Anonymous development (no deployment selected)`);
+      }
+      break;
+    }
+    case "chooseProject": {
+      logMessage(`  No project configured - will prompt interactively`);
+      break;
+    }
+    default: {
+      logMessage(`  Unknown deployment configuration`);
+    }
+  }
+}

src/cli/lib/api.ts

@@ -182,7 +182,7 @@ async function hasAccessToProject(
   try {
     await bigBrainAPIMaybeThrows({
       ctx,
-      url: `/api/teams/${selector.teamSlug}/projects/${selector.projectSlug}/deployments`,
+      url: `teams/${selector.teamSlug}/projects/${selector.projectSlug}/deployments`,
       method: "GET",
     });
     return true;
@@ -256,7 +256,7 @@ async function getTeamAndProjectSlugForDeployment(
   try {
     const body = await bigBrainAPIMaybeThrows({
       ctx,
-      url: `/api/deployment/${selector.deploymentName}/team_and_project`,
+      url: `deployment/${selector.deploymentName}/team_and_project`,
       method: "GET",
     });
     return { teamSlug: body.team, projectSlug: body.project };

src/cli/lib/localDeployment/bigBrain.ts

@@ -14,7 +14,7 @@ export async function bigBrainStart(
   return bigBrainAPI({
     ctx,
     method: "POST",
-    url: "/api/local_deployment/start",
+    url: "local_deployment/start",
     data,
   });
 }
@@ -29,7 +29,7 @@ export async function bigBrainPause(
   return bigBrainAPI({
     ctx,
     method: "POST",
-    url: "/api/local_deployment/pause",
+    url: "local_deployment/pause",
     data,
   });
 }
@@ -43,7 +43,7 @@ export async function bigBrainRecordActivity(
   return bigBrainAPI({
     ctx,
     method: "POST",
-    url: "/api/local_deployment/record_activity",
+    url: "local_deployment/record_activity",
     data,
   });
 }
@@ -54,7 +54,7 @@ export async function bigBrainEnableFeatureMetadata(
   return bigBrainAPI({
     ctx,
     method: "POST",
-    url: "/api/local_deployment/enable_feature_metadata",
+    url: "local_deployment/enable_feature_metadata",
     data: {},
   });
 }
@@ -69,7 +69,7 @@ export async function bigBrainGenerateAdminKeyForAnonymousDeployment(
   return bigBrainAPI({
     ctx,
     method: "POST",
-    url: "/api/local_deployment/generate_admin_key",
+    url: "local_deployment/generate_admin_key",
     data,
   });
 }
@@ -94,7 +94,7 @@ export async function projectHasExistingCloudDev(
   >({
     ctx,
     method: "POST",
-    url: "/api/deployment/existing_dev",
+    url: "deployment/existing_dev",
     data: { projectSlug, teamSlug },
   });
   if (response.kind === "Exists") {

src/cli/lib/localDeployment/dashboard.ts

@@ -87,7 +87,7 @@ async function reportSelfHostedEvent(
     await bigBrainAPIMaybeThrows({
       ctx,
       method: "POST",
-      url: "/api/self_hosted_event",
+      url: "self_hosted_event",
       data: {
         selfHostedUuid: anonymousId,
         eventName,

src/cli/lib/login.ts

@@ -487,6 +487,17 @@ async function optins(ctx: Context, acceptOptIns: boolean): Promise<boolean> {
   return true;
 }
 
+export async function getTeamsForUser(ctx: Context) {
+  const teams = await bigBrainAPI<{ id: number; name: string; slug: string }[]>(
+    {
+      ctx,
+      method: "GET",
+      url: "teams",
+    },
+  );
+  return teams;
+}
+
 export async function ensureLoggedIn(
   ctx: Context,
   options?: {

src/cli/login.ts

@@ -1,7 +1,11 @@
 import { Command, Option } from "@commander-js/extra-typings";
 import { Context, oneoffContext } from "../bundler/context.js";
 import { logFailure, logFinishedStep, logMessage } from "../bundler/log.js";
-import { checkAuthorization, performLogin } from "./lib/login.js";
+import {
+  checkAuthorization,
+  performLogin,
+  getTeamsForUser,
+} from "./lib/login.js";
 import { loadUuidForAnonymousUser } from "./lib/localDeployment/filePaths.js";
 import {
   handleLinkToProject,
@@ -23,6 +27,47 @@ import {
   shouldAllowAnonymousDevelopment,
 } from "./lib/deploymentSelection.js";
 import { removeAnonymousPrefix } from "./lib/deployment.js";
+import {
+  readGlobalConfig,
+  globalConfigPath,
+} from "./lib/utils/globalConfig.js";
+
+const loginStatus = new Command("status")
+  .description("Check login status and list accessible teams")
+  .allowExcessArguments(false)
+  .action(async () => {
+    const ctx = await oneoffContext({
+      url: undefined,
+      adminKey: undefined,
+      envFile: undefined,
+    });
+
+    const globalConfig = readGlobalConfig(ctx);
+    const hasToken = globalConfig?.accessToken !== null;
+
+    if (hasToken) {
+      logMessage(`Convex account token found in: ${globalConfigPath()}`);
+    } else {
+      logMessage("No token found locally");
+      return;
+    }
+
+    const isLoggedIn = await checkAuthorization(ctx, false);
+
+    if (!isLoggedIn) {
+      logMessage("Status: Not logged in");
+      return;
+    }
+
+    logMessage("Status: Logged in");
+    const teams = await getTeamsForUser(ctx);
+    logMessage(
+      `Teams: ${teams.length} team${teams.length === 1 ? "" : "s"} accessible`,
+    );
+    for (const team of teams) {
+      logMessage(`  - ${team.name} (${team.slug})`);
+    }
+  });
 
 export const login = new Command("login")
   .description("Login to Convex")
@@ -62,6 +107,8 @@ export const login = new Command("login")
   .addOption(new Option("--dump-access-token").hideHelp())
   // Hidden option for tests to check if the user is logged in.
   .addOption(new Option("--check-login").hideHelp())
+  .addCommand(loginStatus)
+  .addHelpCommand(false)
   .action(async (options, cmd: Command) => {
     const ctx = await oneoffContext({
       url: undefined,
@@ -274,7 +321,7 @@ async function getProjectsRemaining(ctx: Context, teamSlug: string) {
   const response = await bigBrainAPI<{ projectsRemaining: number }>({
     ctx,
     method: "GET",
-    url: `/api/teams/${teamSlug}/projects_remaining`,
+    url: `teams/${teamSlug}/projects_remaining`,
   });
 
   return response.projectsRemaining;