convex
Version:
Client for the Convex Cloud
332 lines (326 loc) • 14.3 kB
JavaScript
"use strict";
import { chalkStderr } from "chalk";
import { Command, Option } from "@commander-js/extra-typings";
import { oneoffContext } from "../bundler/context.js";
import { logFinishedStep, logMessage, showSpinner } from "../bundler/log.js";
import { loadSelectedDeploymentCredentials } from "./lib/api.js";
import { announceDeploymentTarget } from "./lib/announceDeploymentTarget.js";
import {
getDefaultDeployMessage,
gitBranchFromEnvironment,
isNonProdBuildEnvironment,
suggestedEnvVarNames
} from "./lib/envvars.js";
import {
CONVEX_DEPLOY_KEY_ENV_VAR_NAME,
CONVEX_SELF_HOSTED_URL_VAR_NAME,
CONVEX_DEPLOYMENT_ENV_VAR_NAME,
bigBrainAPI
} from "./lib/utils/utils.js";
import { runFunctionAndLog } from "./lib/run.js";
import { usageStateWarning } from "./lib/usage.js";
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 { deploymentNameAndTypeFromSelection } from "./lib/deploymentSelection.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";
import { extractDeploymentNameForWorkOS } from "./lib/extractDeploymentNameForWorkOS.js";
export const deploy = new Command("deploy").summary("Deploy to a production or preview deployment").description(
[
"Deploys code to a deployment.",
"This is typically used for deploying to a prod or preview deployment manually or from CI; to deploy to your dev deployment when developing, use `npx convex dev`.",
"",
"The target deployment is chosen like this:",
`\u2022 If the \`${CONVEX_DEPLOYMENT_ENV_VAR_NAME}\` environment variable is set (typical during local development), the target is the project\u2019s default production deployment.`,
`\u2022 If the \`${CONVEX_DEPLOY_KEY_ENV_VAR_NAME}\` environment variable is set (typical in CI), it is the deployment associated with that key.`,
` \u2022 When it\u2019s set to a preview deploy key, it will deploy to a preview deployment:`,
` \u2022 with the name of the current Git branch when running in CI (Vercel, Netlify, Cloudflare Pages, GitHub)`,
` \u2022 or with the name specified by the \`--preview-name\` or \`--preview-create\` flags`,
"",
"`npx convex deploy` will:",
" 1. Run a command if specified with `--cmd`, with the deployment URL available as an environment variable.",
" 2. Typecheck your Convex functions.",
" 3. Regenerate the generated code in the `convex/_generated` directory.",
" 4. Bundle your Convex functions and their dependencies.",
" 5. Push your functions, indexes, and schema to the deployment.",
" 6. When deploying to a preview deployment, it runs the function specified by `--preview-run`.",
"If any step fails, the next steps do not run."
].join("\n")
).allowExcessArguments(false).addDeployOptions().addOption(
new Option(
"--preview-run <functionName>",
"Function to run if deploying to a preview deployment. This is ignored if deploying to a production deployment."
)
).addOption(
new Option(
"--preview-name <name>",
"The name to associate with this preview deployment. Defaults to the current Git branch name in Vercel, Netlify, Cloudflare Pages and GitHub CI. Reuses the existing deployment if one exists."
).conflicts("preview-create")
).addOption(
new Option(
"--preview-create <name>",
"Like --preview-name, but deletes and recreates an existing preview deployment with the same name. This parameter can only be used with a preview deploy key (when used with another type of key, the command will return an error)."
).conflicts("preview-name")
).addOption(
new Option(
"--check-build-environment <mode>",
"Whether to check for a non-production build environment before deploying to a production Convex deployment."
).choices(["enable", "disable"]).default("enable").hideHelp()
).addOption(new Option("--admin-key <adminKey>").hideHelp()).addOption(new Option("--url <url>").hideHelp()).addOption(
new Option(
"--env-file <envFile>",
`Path to a custom file of environment variables, for choosing the deployment, e.g. ${CONVEX_DEPLOYMENT_ENV_VAR_NAME} or ${CONVEX_SELF_HOSTED_URL_VAR_NAME}. Same format as .env.local or .env files, and overrides them.`
)
).addOption(
new Option(
"--message <message>",
"Optional message to attach to this deployment in the audit log."
)
).addOption(
new Option(
"--skip-workos-check",
"Skip WorkOS AuthKit provisioning and credential checks during deploy."
).hideHelp()
).addOption(
new Option("--allow-deleting-large-indexes").hideHelp().conflicts("preview-create").conflicts("preview-name")
).showHelpAfterError().action(async (cmdOptions) => {
const ctx = await oneoffContext(cmdOptions);
const deploymentSelection = await getDeploymentSelection(ctx, {
...cmdOptions,
implicitProd: true
});
if (cmdOptions.checkBuildEnvironment === "enable" && isNonProdBuildEnvironment() && deploymentSelection.kind === "existingDeployment" && deploymentSelection.deploymentToActOn.source === "deployKey" && deploymentSelection.deploymentToActOn.deploymentFields?.deploymentType === "prod") {
await ctx.crash({
exitCode: 1,
errorType: "invalid filesystem data",
printedMessage: `Detected a non-production build environment and "${CONVEX_DEPLOY_KEY_ENV_VAR_NAME}" for a production Convex deployment.
This is probably unintentional.
`
});
}
if (deploymentSelection.kind === "anonymous") {
logMessage(
"You are currently developing anonymously with a locally running project.\nTo deploy your Convex app to the cloud, log in by running `npx convex login`.\nSee https://docs.convex.dev/production for more information on how Convex cloud works and instructions on how to set up hosting."
);
return await ctx.crash({
exitCode: 1,
errorType: "fatal",
printedMessage: null
});
}
if (deploymentSelection.kind === "preview") {
const previewName = cmdOptions.previewCreate ?? cmdOptions.previewName ?? gitBranchFromEnvironment();
const reuse = cmdOptions.previewCreate === void 0;
const teamAndProjectSlugs = await getTeamAndProjectFromPreviewAdminKey(
ctx,
deploymentSelection.previewDeployKey
);
await deployToNewPreviewDeployment(
ctx,
{
previewDeployKey: deploymentSelection.previewDeployKey,
projectSelection: {
kind: "teamAndProjectSlugs",
teamSlug: teamAndProjectSlugs.teamSlug,
projectSlug: teamAndProjectSlugs.projectSlug
}
},
{
...cmdOptions,
previewName: previewName ?? void 0,
reuse,
message: cmdOptions.message ?? getDefaultDeployMessage()
}
);
} else {
if (cmdOptions.previewCreate !== void 0) {
const source = deploymentSelection.kind === "deploymentWithinProject" && deploymentSelection.targetProject.kind === "deploymentName" ? `at ${chalkStderr.blue.underline(`${DASHBOARD_HOST}/dp/${deploymentSelection.targetProject.deploymentName}/settings#preview-deploy-keys`)}` : deploymentSelection.kind === "existingDeployment" && deploymentSelection.deploymentToActOn.deploymentFields !== null ? `at ${chalkStderr.blue.underline(`${DASHBOARD_HOST}/dp/${deploymentSelection.deploymentToActOn.deploymentFields.deploymentName}/settings#preview-deploy-keys`)}` : "on the dashboard";
await ctx.crash({
exitCode: 1,
errorType: "fatal",
printedMessage: `Preview deployments can only be created with preview deploy keys. Generate a preview deploy key ${source} and set the ${chalkStderr.bold(`CONVEX_DEPLOY_KEY`)} environment variable with it.`
});
}
await deployToExistingDeployment(ctx, deploymentSelection, {
...cmdOptions,
skipWorkosCheck: cmdOptions.skipWorkosCheck ?? false,
allowDeletingLargeIndexes: cmdOptions.allowDeletingLargeIndexes ?? false,
message: cmdOptions.message ?? getDefaultDeployMessage()
});
}
});
async function deployToNewPreviewDeployment(ctx, deploymentSelection, options) {
const previewName = options.previewName ?? null;
if (previewName === null) {
await ctx.crash({
exitCode: 1,
errorType: "fatal",
printedMessage: "`npx convex deploy` to a preview deployment could not determine the preview name. Provide one using `--preview-name`"
});
}
if (options.dryRun) {
logFinishedStep(
`Would have claimed preview deployment for "${previewName}"`
);
await runCommand(ctx, {
cmdUrlEnvVarName: options.cmdUrlEnvVarName,
cmd: options.cmd,
dryRun: !!options.dryRun,
url: "https://<PREVIEW DEPLOYMENT>.convex.cloud",
adminKey: "preview-deployment-admin-key"
});
logFinishedStep(
`Would have deployed Convex functions to preview deployment for "${previewName}"`
);
if (options.previewRun !== void 0) {
logMessage(`Would have run function "${options.previewRun}"`);
}
return;
}
const data = await bigBrainAPI({
ctx,
method: "POST",
path: "claim_preview_deployment",
data: {
projectSelection: deploymentSelection.projectSelection,
identifier: previewName,
reuse: options.reuse
}
});
const previewAdminKey = data.adminKey;
const previewUrl = data.instanceUrl;
const deploymentNameForWorkOS = extractDeploymentNameForWorkOS(previewUrl);
announceDeploymentTarget("Deploying code to deployment:", {
url: previewUrl,
deploymentFields: {
deploymentName: data.deploymentName,
deploymentType: "preview",
teamSlug: deploymentSelection.projectSelection.teamSlug,
projectSlug: deploymentSelection.projectSelection.projectSlug,
reference: data.reference,
// Preview deployments are never default
isDefault: false
}
});
const { projectConfig } = await readProjectConfig(ctx);
const authKitConfig = await getAuthKitConfig(ctx, projectConfig);
if (authKitConfig && deploymentNameForWorkOS && !options.skipWorkosCheck) {
await ensureAuthKitProvisionedBeforeBuild(
ctx,
deploymentNameForWorkOS,
{ deploymentUrl: previewUrl, adminKey: previewAdminKey },
"preview"
);
}
await runCommand(ctx, {
...options,
url: previewUrl,
adminKey: previewAdminKey
});
const pushOptions = {
deploymentName: null,
adminKey: previewAdminKey,
verbose: !!options.verbose,
dryRun: false,
typecheck: options.typecheck,
typecheckComponents: options.typecheckComponents,
debug: !!options.debug,
debugBundlePath: options.debugBundlePath,
debugNodeApis: false,
codegen: options.codegen === "enable",
url: previewUrl,
liveComponentSources: false,
pushAllModules: !!options.pushAllModules,
largeIndexDeletionCheck: "no verification",
// fine for preview deployments
message: options.message
};
showSpinner(`Deploying to ${previewUrl}...`);
await runPush(ctx, pushOptions);
logFinishedStep(`Deployed Convex functions to ${previewUrl}`);
if (options.previewRun !== void 0 && data.isNewDeployment) {
await runFunctionAndLog(ctx, {
deploymentUrl: previewUrl,
adminKey: previewAdminKey,
functionName: options.previewRun,
argsString: "{}",
componentPath: void 0,
callbacks: {
onSuccess: () => {
logFinishedStep(`Finished running function "${options.previewRun}"`);
}
}
});
}
}
async function deployToExistingDeployment(ctx, deploymentSelection, options) {
const deploymentToActOn = await loadSelectedDeploymentCredentials(
ctx,
deploymentSelection
);
announceDeploymentTarget("Deploying code to deployment:", deploymentToActOn);
const { deploymentFields } = deploymentToActOn;
const configuredDeployment = deploymentNameAndTypeFromSelection(deploymentSelection);
if (configuredDeployment !== null && configuredDeployment.name !== null) {
const shouldPushToProd = configuredDeployment.name === deploymentFields?.deploymentName || (options.yes ?? await askToConfirmPush(
ctx,
{
configuredName: configuredDeployment.name,
configuredType: configuredDeployment.type,
requestedName: deploymentFields?.deploymentName,
requestedType: deploymentFields?.deploymentType
},
deploymentToActOn.url
));
if (!shouldPushToProd) {
await ctx.crash({
exitCode: 1,
printedMessage: null,
errorType: "fatal"
});
}
}
const isCloudDeployment = deploymentFields !== null;
await Promise.all([
deployToDeployment(
ctx,
{
url: deploymentToActOn.url,
adminKey: deploymentToActOn.adminKey,
deploymentName: deploymentFields?.deploymentName ?? null,
...deploymentFields?.deploymentType !== void 0 ? { deploymentType: deploymentFields.deploymentType } : {}
},
{ ...options, skipWorkosCheck: options.skipWorkosCheck }
),
...isCloudDeployment ? [
usageStateWarning(ctx, deploymentFields.deploymentName),
checkVersionAndAiFilesStaleness(ctx)
] : []
]);
}
async function askToConfirmPush(ctx, deployment, prodUrl) {
logMessage(
`You're currently developing against your ${chalkStderr.bold(
deployment.configuredType ?? "dev"
)} deployment
${deployment.configuredName} (set in CONVEX_DEPLOYMENT)
Your ${chalkStderr.bold(deployment.requestedType)} deployment ${chalkStderr.bold(
deployment.requestedName
)} serves traffic at:
${(await suggestedEnvVarNames(ctx)).convexUrlEnvVar}=${chalkStderr.bold(prodUrl)}
Make sure that your published client is configured with this URL (for instructions see https://docs.convex.dev/hosting)
`
);
return promptYesNo(ctx, {
message: `Do you want to push your code to your ${deployment.requestedType} deployment ${deployment.requestedName} now?`,
default: true
});
}
//# sourceMappingURL=deploy.js.map