convex 1.34.0 → 1.35.0

package/src/cli/configure.test.ts

@@ -0,0 +1,138 @@
+import { describe, it, expect, vi, beforeEach } from "vitest";
+import { updateEnvAndConfigForDeploymentSelection } from "./configure.js";
+import { writeDeploymentEnvVar } from "./lib/deployment.js";
+import { finalizeConfiguration } from "./lib/init.js";
+
+vi.mock("./lib/deployment.js", async (importOriginal) => {
+  const actual = await importOriginal<typeof import("./lib/deployment.js")>();
+  return {
+    ...actual,
+    writeDeploymentEnvVar: vi.fn().mockResolvedValue({
+      wroteToGitIgnore: false,
+      changedDeploymentEnvVar: true,
+    }),
+  };
+});
+
+vi.mock("./lib/config.js", async (importOriginal) => {
+  const actual = await importOriginal<typeof import("./lib/config.js")>();
+  return {
+    ...actual,
+    readProjectConfig: vi.fn().mockResolvedValue({
+      configPath: "convex.json",
+      projectConfig: { functions: "convex" },
+    }),
+    writeProjectConfig: vi.fn().mockResolvedValue(undefined),
+    ensureConvexFunctionsDir: vi.fn().mockResolvedValue(undefined),
+  };
+});
+
+vi.mock("./lib/init.js", async (importOriginal) => {
+  const actual = await importOriginal<typeof import("./lib/init.js")>();
+  return {
+    ...actual,
+    finalizeConfiguration: vi.fn().mockResolvedValue(undefined),
+  };
+});
+
+const ctx = {} as any;
+
+describe("updateEnvAndConfigForDeploymentSelection", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it("prod deployments update CONVEX_URL and CONVEX_SITE_URL but not CONVEX_DEPLOYMENT", async () => {
+    await updateEnvAndConfigForDeploymentSelection(
+      ctx,
+      {
+        url: "https://happy-animal-123.convex.cloud",
+        siteUrl: "https://happy-animal-123.convex.site",
+        deploymentName: "happy-animal-123",
+        teamSlug: "my-team",
+        projectSlug: "my-project",
+        deploymentType: "prod",
+      },
+      null,
+    );
+
+    expect(writeDeploymentEnvVar).not.toHaveBeenCalled();
+    expect(finalizeConfiguration).toHaveBeenCalledWith(
+      ctx,
+      expect.objectContaining({
+        changedDeploymentEnvVar: false,
+        wroteToGitIgnore: false,
+        url: "https://happy-animal-123.convex.cloud",
+        siteUrl: "https://happy-animal-123.convex.site",
+      }),
+    );
+  });
+
+  it("dev deployments update CONVEX_DEPLOYMENT, CONVEX_URL, and CONVEX_SITE_URL", async () => {
+    await updateEnvAndConfigForDeploymentSelection(
+      ctx,
+      {
+        url: "https://joyful-capybara-456.convex.cloud",
+        siteUrl: "https://joyful-capybara-456.convex.site",
+        deploymentName: "joyful-capybara-456",
+        teamSlug: "my-team",
+        projectSlug: "my-project",
+        deploymentType: "dev",
+      },
+      null,
+    );
+
+    expect(writeDeploymentEnvVar).toHaveBeenCalledWith(
+      ctx,
+      "dev",
+      {
+        team: "my-team",
+        project: "my-project",
+        deploymentName: "joyful-capybara-456",
+      },
+      null,
+    );
+    expect(finalizeConfiguration).toHaveBeenCalledWith(
+      ctx,
+      expect.objectContaining({
+        changedDeploymentEnvVar: true,
+        url: "https://joyful-capybara-456.convex.cloud",
+        siteUrl: "https://joyful-capybara-456.convex.site",
+      }),
+    );
+  });
+
+  it("local deployments update CONVEX_DEPLOYMENT, CONVEX_URL, and CONVEX_SITE_URL", async () => {
+    await updateEnvAndConfigForDeploymentSelection(
+      ctx,
+      {
+        url: "https://swift-squirrel-789.convex.cloud",
+        siteUrl: "https://swift-squirrel-789.convex.site",
+        deploymentName: "swift-squirrel-789",
+        teamSlug: "my-team",
+        projectSlug: "my-project",
+        deploymentType: "local",
+      },
+      "existing-deployment-name",
+    );
+
+    expect(writeDeploymentEnvVar).toHaveBeenCalledWith(
+      ctx,
+      "local",
+      {
+        team: "my-team",
+        project: "my-project",
+        deploymentName: "swift-squirrel-789",
+      },
+      "existing-deployment-name",
+    );
+    expect(finalizeConfiguration).toHaveBeenCalledWith(
+      ctx,
+      expect.objectContaining({
+        changedDeploymentEnvVar: true,
+        url: "https://swift-squirrel-789.convex.cloud",
+        siteUrl: "https://swift-squirrel-789.convex.site",
+      }),
+    );
+  });
+});

package/src/cli/configure.ts

@@ -16,7 +16,7 @@ import {
   checkAccessToSelectedProject,
   DeploymentSelectionWithinProject,
 } from "./lib/api.js";
-import { readProjectConfig, writeProjectConfig } from "./lib/config.js";
+import { readProjectConfig, ensureConvexFunctionsDir } from "./lib/config.js";
 import {
   DeploymentDetails,
   eraseDeploymentEnvVar,
@@ -44,7 +44,7 @@ import {
   promptYesNo,
 } from "./lib/utils/prompts.js";
 import { readGlobalConfig } from "./lib/utils/globalConfig.js";
-import { maybeSetupAiFiles } from "./lib/ai/index.js";
+import { attemptSetupAiFiles } from "./lib/aiFiles/index.js";
 import {
   DeploymentSelection,
   deploymentNameFromSelection,
@@ -52,7 +52,7 @@ import {
 } from "./lib/deploymentSelection.js";
 import { ensureLoggedIn } from "./lib/login.js";
 import { handleAnonymousDeployment } from "./lib/localDeployment/anonymous.js";
-import { fetchDeploymentCanonicalSiteUrl } from "./lib/env.js";
+import { fetchDeploymentCanonicalUrls } from "./lib/deploy2.js";
 type DeploymentCredentials = {
   url: string;
   adminKey: string;
@@ -122,7 +122,7 @@ export async function deploymentCredentialsOrConfigure(
     chosenConfiguration,
     cmdOptions,
   );
-  const siteUrl = await fetchDeploymentCanonicalSiteUrl(ctx, {
+  const { convexSiteUrl: siteUrl } = await fetchDeploymentCanonicalUrls(ctx, {
     adminKey: selectedDeployment.adminKey,
     deploymentUrl: selectedDeployment.url,
   });
@@ -230,6 +230,7 @@ export async function _deploymentCredentialsOrConfigure(
       const isAgentMode = process.env.CONVEX_AGENT_MODE === "anonymous";
       if (
         !isAgentMode &&
+        process.stdin.isTTY &&
         hasAuth &&
         deploymentSelection.deploymentName !== null
       ) {
@@ -238,22 +239,17 @@ export async function _deploymentCredentialsOrConfigure(
           (await promptYesNo(ctx, {
             message: `${CONVEX_DEPLOYMENT_ENV_VAR_NAME} is configured with deployment ${deploymentSelection.deploymentName}, which is not linked with your account. Would you like to link it now?`,
           }));
-        if (!shouldConfigure) {
-          return await ctx.crash({
-            exitCode: 0,
-            errorType: "fatal",
-            printedMessage: `Run \`npx convex login --link-deployments\` first to link this deployment to your account, and then run \`npx convex dev\` again.`,
-          });
+        if (shouldConfigure) {
+          return await handleChooseProject(
+            ctx,
+            chosenConfiguration,
+            deploymentSelection.selectionWithinProject,
+            {
+              globallyForceCloud,
+            },
+            cmdOptions,
+          );
         }
-        return await handleChooseProject(
-          ctx,
-          chosenConfiguration,
-          deploymentSelection.selectionWithinProject,
-          {
-            globallyForceCloud,
-          },
-          cmdOptions,
-        );
       }
       const alreadyHasConfiguredAnonymousDeployment =
         deploymentSelection.deploymentName !== null &&
@@ -266,22 +262,23 @@ export async function _deploymentCredentialsOrConfigure(
         );
       }
 
-      const shouldPromptForLogin = isAgentMode
-        ? "no"
-        : alreadyHasConfiguredAnonymousDeployment
+      const shouldPromptForLogin =
+        isAgentMode || !process.stdin.isTTY
           ? "no"
-          : await promptOptions(ctx, {
-              message:
-                "Welcome to Convex! Would you like to login to your account?",
-              choices: [
-                {
-                  name: "Start without an account (run Convex locally)",
-                  value: "no",
-                },
-                { name: "Login or create an account", value: "yes" },
-              ],
-              default: "no",
-            });
+          : alreadyHasConfiguredAnonymousDeployment
+            ? "no"
+            : await promptOptions(ctx, {
+                message:
+                  "Welcome to Convex! Would you like to login to your account?",
+                choices: [
+                  {
+                    name: "Start without an account (run Convex locally)",
+                    value: "no",
+                  },
+                  { name: "Login or create an account", value: "yes" },
+                ],
+                default: "no",
+              });
       if (shouldPromptForLogin === "no") {
         const result = await handleAnonymousDeployment(ctx, {
           chosenConfiguration,
@@ -382,14 +379,20 @@ async function handleDeploymentWithinProject(
     selectedDeployment.deploymentFields !== null &&
     selectedDeployment.deploymentFields.deploymentType === "local"
   ) {
-    // Start running the local backend
-    await handleLocalDeployment(ctx, {
+    // Start running the local backend, which may bind to different ports
+    // than what was saved from a previous run.
+    const localDeployment = await handleLocalDeployment(ctx, {
       teamSlug: selectedDeployment.deploymentFields.teamSlug!,
       projectSlug: selectedDeployment.deploymentFields.projectSlug!,
       forceUpgrade: cmdOptions.localOptions.forceUpgrade,
       ports: cmdOptions.localOptions.ports,
       backendVersion: cmdOptions.localOptions.backendVersion,
     });
+    return {
+      url: localDeployment.deploymentUrl,
+      adminKey: localDeployment.adminKey,
+      deploymentFields: selectedDeployment.deploymentFields,
+    };
   }
   return {
     url: selectedDeployment.url,
@@ -619,11 +622,12 @@ async function selectNewProject(
   await doInitConvexFolder(ctx);
   const { configPath, projectConfig } = await readProjectConfig(ctx);
   const folder = functionsDir(configPath, projectConfig);
-  await maybeSetupAiFiles(
+  await attemptSetupAiFiles({
     ctx,
-    path.resolve(folder),
-    path.resolve(path.dirname(configPath)),
-  );
+    aiFilesConfig: projectConfig.aiFiles,
+    convexDir: path.resolve(folder),
+    projectDir: path.resolve(path.dirname(configPath)),
+  });
   return { teamSlug, projectSlug, devDeployment };
 }
 
@@ -679,11 +683,12 @@ async function selectExistingProject(
 
   const { configPath, projectConfig } = await readProjectConfig(ctx);
   const folder = functionsDir(configPath, projectConfig);
-  await maybeSetupAiFiles(
+  await attemptSetupAiFiles({
     ctx,
-    path.resolve(folder),
-    path.resolve(path.dirname(configPath)),
-  );
+    aiFilesConfig: projectConfig.aiFiles,
+    convexDir: path.resolve(folder),
+    projectDir: path.resolve(path.dirname(configPath)),
+  });
 
   return { teamSlug, projectSlug, devDeployment };
 }
@@ -781,17 +786,19 @@ export async function updateEnvAndConfigForDeploymentSelection(
   const { configPath, projectConfig } = await readProjectConfig(ctx);
 
   const { wroteToGitIgnore, changedDeploymentEnvVar } =
-    await writeDeploymentEnvVar(
-      ctx,
-      options.deploymentType,
-      {
-        team: options.teamSlug,
-        project: options.projectSlug,
-        deploymentName: options.deploymentName,
-      },
-      existingValue,
-    );
-  await writeProjectConfig(ctx, projectConfig);
+    options.deploymentType !== "prod"
+      ? await writeDeploymentEnvVar(
+          ctx,
+          options.deploymentType,
+          {
+            team: options.teamSlug,
+            project: options.projectSlug,
+            deploymentName: options.deploymentName,
+          },
+          existingValue,
+        )
+      : { wroteToGitIgnore: false, changedDeploymentEnvVar: false };
+  await ensureConvexFunctionsDir(ctx, projectConfig);
   await finalizeConfiguration(ctx, {
     deploymentType: options.deploymentType,
     deploymentName: options.deploymentName,

package/src/cli/deploy.ts

@@ -21,9 +21,12 @@ import { getTeamAndProjectFromPreviewAdminKey } from "./lib/deployment.js";
 import { runPush } from "./lib/components.js";
 import { promptYesNo } from "./lib/utils/prompts.js";
 import { deployToDeployment, runCommand } from "./lib/deploy2.js";
-import { getDeploymentSelection } from "./lib/deploymentSelection.js";
+import {
+  DeploymentSelection,
+  getDeploymentSelection,
+} from "./lib/deploymentSelection.js";
 import { deploymentNameAndTypeFromSelection } from "./lib/deploymentSelection.js";
-import { checkVersion } from "./lib/updates.js";
+import { checkVersionAndAiFilesStaleness } from "./lib/updates.js";
 import { readProjectConfig, getAuthKitConfig } from "./lib/config.js";
 import { ensureAuthKitProvisionedBeforeBuild } from "./lib/workos/workos.js";
 import { DASHBOARD_HOST } from "./lib/dashboard.js";
@@ -93,7 +96,10 @@ Same format as .env.local or .env files, and overrides them.`,
   .action(async (cmdOptions) => {
     const ctx = await oneoffContext(cmdOptions);
 
-    const deploymentSelection = await getDeploymentSelection(ctx, cmdOptions);
+    const deploymentSelection = await getDeploymentSelection(ctx, {
+      ...cmdOptions,
+      implicitProd: true,
+    });
     if (
       cmdOptions.checkBuildEnvironment === "enable" &&
       isNonProdBuildEnvironment() &&
@@ -171,7 +177,7 @@ Same format as .env.local or .env files, and overrides them.`,
         });
       }
 
-      await deployToExistingDeployment(ctx, {
+      await deployToExistingDeployment(ctx, deploymentSelection, {
         ...cmdOptions,
         skipWorkosCheck: cmdOptions.skipWorkosCheck ?? false,
         allowDeletingLargeIndexes:
@@ -309,6 +315,7 @@ async function deployToNewPreviewDeployment(
 
 async function deployToExistingDeployment(
   ctx: Context,
+  deploymentSelection: DeploymentSelection,
   options: {
     verbose?: boolean | undefined;
     dryRun?: boolean | undefined;
@@ -331,10 +338,6 @@ async function deployToExistingDeployment(
     allowDeletingLargeIndexes: boolean;
   },
 ) {
-  const deploymentSelection = await getDeploymentSelection(ctx, {
-    ...options,
-    implicitProd: true,
-  });
   const deploymentToActOn = await loadSelectedDeploymentCredentials(
     ctx,
     deploymentSelection,
@@ -383,7 +386,7 @@ async function deployToExistingDeployment(
     ...(isCloudDeployment
       ? [
           usageStateWarning(ctx, deploymentFields.deploymentName),
-          checkVersion(ctx),
+          checkVersionAndAiFilesStaleness(ctx),
         ]
       : []),
   ]);