neon 8.11.0 → 8.11.2

package/dist/commands/checkout.js

@@ -1,348 +1 @@
-import { t as __exportAll } from "../_chunks/rolldown-runtime-8H4AJuhK.js";
-import { isCi } from "../env.js";
-import { log } from "../log.js";
-import { isNeonApiError } from "../api.js";
-import { applyContext, contextBranch, readContextFile } from "../context.js";
-import { isClaimableEnvTarget } from "../claimable/state.js";
-import { getCliName } from "../utils/cli_name.js";
-import { loadEnvFileIntoProcess } from "../env_file.js";
-import { createBranch, pickBranchInteractively } from "../utils/branch_picker.js";
-import { looksLikeBranchId } from "../utils/formats.js";
-import { fillSingleProject, listAllProjectBranches } from "../utils/enrichers.js";
-import { buildCheckoutEvent, readGitContext } from "../utils/git.js";
-import { buildHookBranch, loadHookConfig, resolveHookEnv, runCheckoutAfterHook, runCheckoutBeforeHook, runCreateAfterHook, runCreateBeforeHook } from "../utils/hooks.js";
-import { autoPullEnvAfterPin } from "./env.js";
-import { applyPolicyOnCreate, createBranchFromPolicyOnCheckout, envFlag } from "./config.js";
-import { handler as handler$1 } from "./link.js";
-import chalk from "chalk";
-import prompts from "prompts";
-//#region src/commands/checkout.ts
-var checkout_exports = /* @__PURE__ */ __exportAll({
-	builder: () => builder,
-	command: () => command,
-	describe: () => describe,
-	formatCheckoutPolicyFailure: () => formatCheckoutPolicyFailure,
-	handler: () => handler
-});
-const command = "checkout [id|name]";
-const describe = "Pin a branch in the local context (.neon) so subsequent commands target it";
-const formatCheckoutPolicyFailure = (opts) => {
-	const cli = getCliName();
-	const envArg = opts.env ? ` --env ${opts.env}` : "";
-	return [
-		`Branch ${opts.branchName} (${opts.branchId}) was created and checked out, but applying neon.ts to it failed: ${opts.failure}`,
-		`The branch is usable but does not match the policy, and \`${cli} checkout\` never reconciles a branch that already exists.`,
-		`Fix the cause above, then run \`${cli} deploy --update-existing${envArg}\` to apply the policy to it — or, if your policy only configures new branches (keyed on \`!branch.exists\`), delete the branch and check it out again: \`${cli} branches delete ${opts.branchName}\` then \`${cli} checkout ${opts.branchName} --create${envArg}\`.`
-	].join("\n");
-};
-const builder = (argv) => argv.usage("$0 checkout [id|name] [options]").positional("id", {
-	describe: "Branch name or id to check out. Omit to pick interactively from the list of branches.",
-	type: "string"
-}).options({
-	"project-id": {
-		describe: "Project ID",
-		type: "string"
-	},
-	"env-pull": {
-		describe: "Pull the branch's Neon env vars (DATABASE_URL, …) into a local .env after checkout. On by default; use --no-env-pull to skip (e.g. when injecting env at runtime with `neon-env run` / `neon dev`).",
-		type: "boolean",
-		default: true
-	},
-	create: {
-		describe: "Create the named branch if it does not exist, then check it out",
-		type: "boolean",
-		default: false
-	},
-	...envFlag,
-	env: {
-		...envFlag.env,
-		describe: envFlag.env.describe + " Used when this checkout creates a branch from neon.ts; ignored for an existing branch."
-	}
-}).example([
-	["$0 checkout", "Pick a branch interactively from the project in the closest .neon file"],
-	["$0 checkout main", "Pin the branch named \"main\" in the closest .neon file"],
-	["$0 checkout dev --create", "Create and pin a missing branch named dev"],
-	["$0 checkout feat --create --env .env.local", "Create feat from neon.ts, loading Function env from .env.local first"],
-	["$0 checkout br-cool-snow-12345678 --project-id project-id-123", "Pin a branch by id for an explicit project"]
-]);
-const handler = async (props) => {
-	const previousBranch = contextBranch(readContextFile(props.contextFile));
-	if (previousBranch) log.info("%s Currently on branch %s", chalk.dim("→"), chalk.cyan.bold(previousBranch));
-	if (props.create && !props.id?.trim()) throw new Error(`No branch specified. Pass a branch name with --create (e.g. \`${getCliName()} checkout dev --create\`).`);
-	const projectId = await resolveProjectId(props);
-	if (props.create && props.env) try {
-		loadEnvFileIntoProcess(props.env);
-	} catch (err) {
-		log.debug("checkout: could not preload --env for hook discovery (continuing): %s", err instanceof Error ? err.message : String(err));
-	}
-	const cwd = process.cwd();
-	const git = readGitContext(cwd);
-	const event = buildCheckoutEvent(git, props.id);
-	const config = await loadHookConfig(cwd, props.contextFile);
-	const hooks = config?.experimental?.hooks;
-	if (props.id) {
-		const renamed = await runCheckoutBeforeHook({
-			hooks,
-			event,
-			git,
-			cwd
-		});
-		if (renamed && renamed !== props.id) {
-			log.info("%s checkout.before hook mapped %s → %s", chalk.dim("→"), chalk.cyan(props.id), chalk.cyan.bold(renamed));
-			props.id = renamed;
-		}
-	}
-	const orgRead = isClaimableEnvTarget({
-		apiHost: props.apiHost,
-		contextFile: props.contextFile,
-		configDir: props.configDir ?? ""
-	}) ? void 0 : resolveOrgId(props, projectId);
-	orgRead?.catch(() => void 0);
-	const { branchId, branchName, created, policyApplied, policyFailure } = await resolveBranchId(props, projectId, {
-		hooks,
-		git,
-		event,
-		cwd
-	});
-	const orgId = await (orgRead ?? resolveOrgId(props, projectId));
-	applyContext(props.contextFile, {
-		projectId,
-		...orgId ? { orgId } : {},
-		branch: branchName
-	});
-	log.info("Checked out branch %s on project %s%s. Updated %s.", branchId, projectId, orgId ? ` (org ${orgId})` : "", props.contextFile);
-	const failure = created && !policyApplied ? await applyPolicyOrDescribeFailure({
-		projectId,
-		branchId,
-		branchName,
-		contextFile: props.contextFile,
-		...props.apiKey ? { apiKey: props.apiKey } : {},
-		...props.apiHost ? { apiHost: props.apiHost } : {},
-		...props.color !== void 0 ? { color: props.color } : {},
-		...props.env ? { env: props.env } : {}
-	}) : policyFailure;
-	await autoPullEnvAfterPin({
-		...props,
-		projectId,
-		branch: branchId,
-		envPull: props.envPull
-	}, {
-		branchId,
-		branchName,
-		usedDefault: false
-	});
-	const needsCreateAfter = created && hooks?.create?.after;
-	if (config && (hooks?.checkout?.after || needsCreateAfter)) {
-		const env = await resolveHookEnv(config, {
-			projectId,
-			branch: branchId,
-			...props.apiKey ? { apiKey: props.apiKey } : {},
-			...props.apiHost ? { apiHost: props.apiHost } : {}
-		});
-		if (env) {
-			const branch = await buildHookBranch({
-				apiClient: props.apiClient,
-				projectId,
-				branchId,
-				created
-			});
-			if (hooks?.checkout?.after) await runCheckoutAfterHook({
-				hooks,
-				branch,
-				env,
-				git,
-				event,
-				cwd
-			});
-			if (needsCreateAfter) await runCreateAfterHook({
-				hooks,
-				branch,
-				env,
-				git,
-				event,
-				cwd
-			});
-		}
-	}
-	if (failure) throw new Error(formatCheckoutPolicyFailure({
-		branchName,
-		branchId,
-		failure,
-		...props.env ? { env: props.env } : {}
-	}));
-};
-/**
-* Apply the policy to a branch `checkout` just created bare, returning the failure message
-* instead of throwing it. The branch and the context pin already stand at this point, so a
-* failed apply must not abort the rest of the checkout — the handler reports it at the end.
-*/
-const applyPolicyOrDescribeFailure = async (props) => {
-	try {
-		await applyPolicyOnCreate(props);
-		return;
-	} catch (err) {
-		return err instanceof Error ? err.message : String(err);
-	}
-};
-const resolveBranchId = async (props, projectId, hookCtx) => {
-	const branches = await listAllProjectBranches(props.apiClient, projectId);
-	if (!props.id) {
-		const picked = await pickBranchInteractively(branches, {
-			message: "Which branch would you like to check out?",
-			nonInteractiveMessage: `No branch specified. Pass a branch name or id (e.g. \`${getCliName()} checkout main\`), or run interactively to pick one from a list.`
-		});
-		if (picked.kind === "existing") {
-			const existing = branches.find((b) => b.id === picked.branchId);
-			return {
-				branchId: picked.branchId,
-				branchName: existing?.name ?? picked.branchId,
-				created: false,
-				policyApplied: false
-			};
-		}
-		return createCheckoutBranch(props, projectId, picked.name, branches, hookCtx);
-	}
-	const ref = props.id;
-	if (looksLikeBranchId(ref)) {
-		const byId = branches.find((b) => b.id === ref);
-		if (byId) return {
-			branchId: byId.id,
-			branchName: byId.name ?? byId.id,
-			created: false,
-			policyApplied: false
-		};
-		throw new Error(notFoundMessage(ref, branches));
-	}
-	const byName = branches.find((b) => b.name === ref);
-	if (byName) return {
-		branchId: byName.id,
-		branchName: byName.name ?? byName.id,
-		created: false,
-		policyApplied: false
-	};
-	if (props.create) return createCheckoutBranch(props, projectId, ref, branches, hookCtx);
-	const missingName = notFoundMessage(ref, branches, { suggestCreate: true });
-	if (isCi() || !process.stdout.isTTY) throw new Error(missingName);
-	log.info(missingName);
-	const { create } = await prompts({
-		type: "confirm",
-		name: "create",
-		message: `Branch "${ref}" does not exist. Create it now?`,
-		initial: true
-	});
-	if (!create) throw new Error(`Aborted: branch "${ref}" was not found and not created.`);
-	return createCheckoutBranch(props, projectId, ref, branches, hookCtx);
-};
-/**
-* Create the branch to check out. When a `neon.ts` exists, route through the policy-driven
-* create so the new branch comes up branched from the policy's `parent` and configured with
-* its declared TTL / compute / services (evaluated as a *new* branch). Otherwise fall back to
-* a bare branch off the default — the handler then applies the policy (a no-op with no
-* `neon.ts`).
-*/
-const createCheckoutBranch = async (props, projectId, name, branches, hookCtx) => {
-	await runCreateBeforeHook({
-		hooks: hookCtx.hooks,
-		branchName: name,
-		git: hookCtx.git,
-		event: hookCtx.event,
-		cwd: hookCtx.cwd
-	});
-	const fromPolicy = await createBranchFromPolicyOnCheckout({
-		projectId,
-		branchName: name,
-		contextFile: props.contextFile,
-		...props.apiKey ? { apiKey: props.apiKey } : {},
-		...props.apiHost ? { apiHost: props.apiHost } : {},
-		...props.color !== void 0 ? { color: props.color } : {},
-		...props.env ? { env: props.env } : {}
-	});
-	if (fromPolicy) return {
-		branchId: fromPolicy.branchId,
-		branchName: name,
-		created: true,
-		policyApplied: true,
-		...fromPolicy.policyFailure ? { policyFailure: fromPolicy.policyFailure } : {}
-	};
-	return {
-		branchId: await createBranch(props.apiClient, projectId, name, branches),
-		branchName: name,
-		created: true,
-		policyApplied: false
-	};
-};
-const notFoundMessage = (ref, branches, opts) => `Branch ${ref} not found.${opts?.suggestCreate ? " Pass --create to create it." : ""}\nAvailable branches: ${branches.map((b) => b.name).join(", ")}`;
-/**
-* Resolve the org id to heal into the context file.
-*
-* Prefer an org id we already know (from `--org-id`, the `.neon` file, or a
-* freshly-run `link`). Otherwise look it up from the project itself so the
-* `.neon` file ends up with an accurate `orgId` even when it was previously
-* missing. Projects on a personal account have no org; in that case (or if the
-* lookup fails for a non-auth reason) we return `undefined` and simply omit the
-* field rather than failing the checkout.
-*/
-const resolveOrgId = async (props, projectId) => {
-	if (props.orgId) return props.orgId;
-	try {
-		const { data } = await props.apiClient.getProject(projectId);
-		return data.project.org_id ?? void 0;
-	} catch (err) {
-		if (isNeonApiError(err) && err.status === 401) throw err;
-		log.debug("checkout: could not resolve org id for project %s: %s", projectId, err instanceof Error ? err.message : String(err));
-		return;
-	}
-};
-/**
-* Resolve the project id `checkout` should target.
-*
-* `props.projectId` is already populated from the `--project-id` flag or the
-* closest `.neon` file (via the global `enrichFromContext` middleware). When
-* it's still missing we try to auto-detect a single project (same behaviour as
-* `branches` / `connection-string`). If that fails we surface a telling error
-* and, in an interactive terminal, offer to run `neonctl link` in the current
-* folder so the user can pick a project/branch without having to re-run the
-* command by hand.
-*/
-const resolveProjectId = async (props) => {
-	if (props.projectId) return props.projectId;
-	const autoDetected = await tryAutoDetectProject(props);
-	if (autoDetected) return autoDetected;
-	const missingProjectMessage = `Could not determine which Neon project to check out a branch from. Provide one via the --project-id flag or a .neon file (created by \`${getCliName()} link\` / \`${getCliName()} set-context\`).`;
-	if (isCi() || !process.stdout.isTTY) throw new Error(missingProjectMessage);
-	log.info(missingProjectMessage);
-	const { runLink } = await prompts({
-		type: "confirm",
-		name: "runLink",
-		message: `Run \`${getCliName()} link\` in the current folder to pick a project now?`,
-		initial: true
-	});
-	if (!runLink) throw new Error("Aborted: no project selected. Re-run with --project-id or link a project first.");
-	await handler$1({
-		...props,
-		yes: false,
-		clear: false,
-		checks: true
-	});
-	const linked = readContextFile(props.contextFile);
-	if (!linked.projectId) throw new Error(`Linking did not produce a project id. Re-run \`${getCliName()} checkout\` once the directory is linked.`);
-	if (linked.orgId) props.orgId = linked.orgId;
-	return linked.projectId;
-};
-/**
-* Best-effort single-project auto-detection. Returns the project id when the
-* API key maps to exactly one project, or `undefined` when the project can't be
-* determined unambiguously (zero or multiple projects) so the caller can fall
-* back to the interactive `link` flow.
-*/
-const tryAutoDetectProject = async (props) => {
-	try {
-		return (await fillSingleProject(props)).projectId;
-	} catch (err) {
-		if (isNeonApiError(err)) throw err;
-		log.debug("checkout: could not auto-detect a single project: %s", err instanceof Error ? err.message : String(err));
-		return;
-	}
-};
-//#endregion
-export { builder, command, describe, formatCheckoutPolicyFailure, handler, checkout_exports as t };
+export { t as builder, r as command, i as describe, a as formatCheckoutPolicyFailure, o as handler } from "../_chunks/checkout-CXIOydqZ.js";