neon 8.11.0 → 8.11.2

package/dist/commands/branches.js

@@ -1,460 +1 @@
-import { t as __exportAll } from "../_chunks/rolldown-runtime-8H4AJuhK.js";
-import { log } from "../log.js";
-import { retryOnLock } from "../api.js";
-import { contextBranch, readContextFile } from "../context.js";
-import { branchCreateRequest } from "../parameters.gen.js";
-import { writer } from "../writer.js";
-import { EndpointType } from "../utils/api_enums.js";
-import { looksLikeBranchId, looksLikeLSN, looksLikeTimestamp, toIso } from "../utils/formats.js";
-import { branchIdFromProps, fillSingleProject, resolveBranchFromProps } from "../utils/enrichers.js";
-import { getComputeUnits } from "../utils/compute_units.js";
-import { psql } from "../utils/psql.js";
-import { parsePointInTime } from "../utils/point_in_time.js";
-import { parseSchemaDiffParams, schemaDiff } from "./schema_diff.js";
-import chalk from "chalk";
-//#region src/commands/branches.ts
-var branches_exports = /* @__PURE__ */ __exportAll({
-	BRANCH_FIELDS: () => BRANCH_FIELDS,
-	aliases: () => aliases,
-	builder: () => builder,
-	command: () => command,
-	describe: () => describe,
-	handler: () => handler
-});
-const BRANCH_FIELDS = [
-	"name",
-	"id",
-	"current_state",
-	"expires_at",
-	"created_at"
-];
-const BRANCH_FIELDS_RESET = [...BRANCH_FIELDS, "last_reset_at"];
-const BRANCH_DETAIL_FIELDS = [
-	"name",
-	"id",
-	"parent_id",
-	"current_state",
-	"expires_at",
-	"created_at",
-	"created_by",
-	"last_reset_at",
-	"logical_size"
-];
-/**
-* The branch `.neon` pins, by name (preferred) or id, when `.neon` links this same project;
-* a `--project-id` pointing elsewhere makes its branch not current.
-*/
-const currentBranchOf = (props) => {
-	const context = readContextFile(props.contextFile);
-	return context.projectId === props.projectId ? contextBranch(context) : void 0;
-};
-const branchNameCell = (br, labels) => {
-	const tags = [];
-	if (br.default) tags.push(chalk.cyan("[default]"));
-	if (br.protected) tags.push(chalk.yellow("[protected]"));
-	if (labels.annotations?.[br.id]?.value.anonymized) tags.push(chalk.dim("[anon]"));
-	if (labels.current !== void 0 && (br.id === labels.current || br.name === labels.current)) tags.push(chalk.green("[current]"));
-	tags.push(br.name);
-	return tags.join(" ");
-};
-const stateCell = (state) => {
-	if (!state) return "";
-	if (state === "ready") return chalk.green(state);
-	if (state === "init" || state === "resetting") return chalk.yellow(state);
-	return chalk.dim(state);
-};
-const formatBytes = (bytes) => {
-	const units = [
-		"bytes",
-		"KiB",
-		"MiB",
-		"GiB",
-		"TiB"
-	];
-	let value = bytes;
-	let unit = 0;
-	while (value >= 1024 && unit < units.length - 1) {
-		value /= 1024;
-		unit++;
-	}
-	return unit === 0 ? `${bytes} bytes` : `${value.toFixed(1)} ${units[unit]}`;
-};
-const branchColumns = (labels) => ({
-	name: (br) => branchNameCell(br, labels),
-	current_state: (br) => stateCell(br.current_state),
-	expires_at: (br) => br.expires_at || "never",
-	created_by: (br) => br.created_by?.name ?? "",
-	logical_size: (br) => br.logical_size === void 0 ? "" : formatBytes(br.logical_size)
-});
-const command = "branches";
-const describe = "Manage branches";
-const aliases = ["branch"];
-const builder = (argv) => argv.usage("$0 branches <sub-command> [options]").options({ "project-id": {
-	describe: "Project ID",
-	type: "string"
-} }).middleware(fillSingleProject).middleware((args) => {
-	args.branchId ??= args.id;
-}).command("list", "List branches", (yargs) => yargs, (args) => list(args)).command("create", "Create a branch", (yargs) => yargs.options({
-	secrets: {
-		describe: "Include connection credentials in command output. Use --no-secrets to omit them",
-		type: "boolean",
-		default: true
-	},
-	name: branchCreateRequest["branch.name"],
-	parent: {
-		describe: "Parent branch name or id or timestamp or LSN. Defaults to the default branch",
-		type: "string"
-	},
-	compute: {
-		describe: "Create a branch with or without a compute. By default branch is created with a read-write compute. To create a branch without compute use --no-compute",
-		type: "boolean",
-		default: true
-	},
-	type: {
-		describe: "Type of compute to add",
-		type: "string",
-		implies: "compute",
-		default: EndpointType.ReadWrite,
-		choices: Object.values(EndpointType)
-	},
-	"suspend-timeout": {
-		describe: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the global default.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe maximum value is `604800` seconds (1 week).",
-		type: "number",
-		implies: "compute",
-		default: 0
-	},
-	cu: {
-		describe: "The number of Compute Units. Could be a fixed size (e.g. \"2\") or a range delimited by a dash (e.g. \"0.5-3\").",
-		type: "string",
-		implies: "compute"
-	},
-	psql: {
-		type: "boolean",
-		describe: "Connect to a new branch via psql",
-		default: false
-	},
-	fallback: {
-		type: "boolean",
-		describe: "Force the embedded TypeScript psql fallback (for testing)",
-		default: false,
-		hidden: true
-	},
-	annotation: {
-		type: "string",
-		hidden: true,
-		default: "{}"
-	},
-	"schema-only": {
-		describe: "Create a schema-only branch. Requires exactly one read-write compute.",
-		type: "boolean",
-		default: false
-	},
-	"expires-at": {
-		describe: "Set an expiration date for the branch. Accepts a date string (e.g., 2024-12-31T23:59:59Z).",
-		type: "string",
-		requiresArg: true
-	},
-	protected: {
-		describe: branchCreateRequest["branch.protected"].description,
-		type: "boolean"
-	}
-}), (args) => create(args)).command("reset <id|name>", "Reset a branch", (yargs) => yargs.options({
-	parent: {
-		describe: "Reset to a parent branch",
-		type: "boolean",
-		default: false
-	},
-	"preserve-under-name": { describe: "Name under which to preserve the old branch" }
-}), (args) => reset(args)).command("restore <target-id|name> <source>[@(timestamp|lsn)]", "Restores a branch to a specific point in time\n<source> can be: ^self, ^parent, or <source-branch-id|name>", (yargs) => yargs.middleware((args) => {
-	args.id = args.targetId;
-	args.pointInTime = args["source@(timestamp"];
-	args.branchId = args.id;
-}).usage("$0 branches restore <target-id|name> <source>[@(timestamp|lsn)]").options({ "preserve-under-name": { describe: "Name under which to preserve the old branch" } }).example([
-	["$0 branches restore main br-source-branch-123456", "Restores main to the head of the branch with id br-source-branch-123456"],
-	["$0 branches restore main source@2021-01-01T00:00:00Z", "Restores main to the timestamp 2021-01-01T00:00:00Z of the source branch"],
-	["$0 branches restore my-branch ^self@0/123456", "Restores my-branch to the LSN 0/123456 from its own history"],
-	["$0 branches restore my-branch ^parent", "Restore my-branch to the head of its parent branch"]
-]), (args) => restore(args)).command("rename <id|name> <new-name>", "Rename a branch", (yargs) => yargs, (args) => rename(args)).command("set-default <id|name>", "Set a branch as default", (yargs) => yargs, (args) => setDefault(args)).command({
-	command: "set-expiration <id|name>",
-	describe: "Set an expiration date for the branch",
-	builder: (yargs) => yargs.options({ "expires-at": {
-		describe: "Set a expiration date for the branch. If omitted, expiration will be removed. Format [RFC3339]: 2024-12-31T23:59:59Z",
-		type: "string",
-		requiresArg: false
-	} }),
-	handler: (args) => setExpiration(args)
-}).command("add-compute <id|name>", "Add a compute to a branch", (yargs) => yargs.options({
-	type: {
-		type: "string",
-		choices: Object.values(EndpointType),
-		describe: "Type of compute to add",
-		default: EndpointType.ReadOnly
-	},
-	cu: {
-		describe: "The number of Compute Units. Could be a fixed size (e.g. \"2\") or a range delimited by a dash (e.g. \"0.5-3\").",
-		type: "string"
-	},
-	name: {
-		type: "string",
-		describe: "Optional name of the compute"
-	}
-}), (args) => addCompute(args)).command("delete <id|name>", "Delete a branch", (yargs) => yargs, (args) => deleteBranch(args)).command("get <id|name>", "Get a branch", (yargs) => yargs, (args) => get(args)).command({
-	command: "schema-diff [base-branch] [compare-source[@(timestamp|lsn)]]",
-	aliases: ["sd"],
-	describe: "Compare the latest schemas of any two branches, or compare a branch to its own or another branch's history.",
-	builder: (yargs) => {
-		return yargs.middleware((args) => args.compareSource = args["compare-source@(timestamp"]).middleware(parseSchemaDiffParams).options({ database: {
-			alias: "db",
-			type: "string",
-			description: "Name of the database for which the schema comparison is performed"
-		} }).example([
-			["$0 branches schema-diff main br-compare-branch-123456", "Compares the main branch to the head of the branch with ID br-compare-branch-123456"],
-			["$0 branches schema-diff main compare@2024-06-01T00:00:00Z", "Compares the main branch to the state of the compare branch at timestamp 2024-06-01T00:00:00.000Z"],
-			["$0 branches schema-diff my-branch ^self@0/123456", "Compares my-branch to LSN 0/123456 from its own history"],
-			["$0 branches schema-diff my-branch ^parent", "Compares my-branch to the head of its parent branch"],
-			["$0 branches schema-diff", "If a branch is specified in 'set-context', compares this branch to its parent. Otherwise, compares the default branch to its parent."]
-		]);
-	},
-	handler: (args) => schemaDiff(args)
-});
-const handler = (args) => {
-	return args;
-};
-const list = async (props) => {
-	const { data: { branches, annotations } } = await props.apiClient.listProjectBranches({ projectId: props.projectId });
-	writer(props).end(branches, {
-		fields: BRANCH_FIELDS,
-		renderColumns: branchColumns({
-			annotations,
-			current: currentBranchOf(props)
-		})
-	});
-};
-const parseAnnotation = (value) => {
-	try {
-		return JSON.parse(value);
-	} catch (err) {
-		const message = err instanceof Error ? err.message : String(err);
-		throw new Error(`Failed to parse --annotation JSON: ${message}`);
-	}
-};
-const create = async (props) => {
-	const branches = await props.apiClient.listProjectBranches({ projectId: props.projectId }).then(({ data }) => data.branches);
-	const parentProps = (() => {
-		if (!props.parent) {
-			const branch = branches.find((b) => b.default);
-			if (!branch) throw new Error("No default branch found");
-			return { parent_id: branch.id };
-		}
-		if (looksLikeLSN(props.parent)) return { parent_lsn: props.parent };
-		if (looksLikeTimestamp(props.parent)) return { parent_timestamp: props.parent };
-		if (looksLikeBranchId(props.parent)) return { parent_id: props.parent };
-		const branch = branches.find((b) => b.name === props.parent);
-		if (!branch) throw new Error(`Branch ${props.parent} not found`);
-		return { parent_id: branch.id };
-	})();
-	const annotationValue = props.annotation ? parseAnnotation(props.annotation) : void 0;
-	if (props.schemaOnly) {
-		if (!props.compute) throw new Error("Schema-only branches require a compute endpoint");
-		if (props.type !== EndpointType.ReadWrite) throw new Error("Schema-only branches require a read-write compute endpoint");
-	}
-	const { data } = await retryOnLock(() => props.apiClient.createProjectBranch(props.projectId, {
-		branch: {
-			name: props.name,
-			...parentProps,
-			...props.schemaOnly ? { init_source: "schema-only" } : {},
-			...props["expires-at"] ? { expires_at: toIso(props["expires-at"], "--expires-at") } : {},
-			...props.protected !== void 0 ? { protected: props.protected } : {}
-		},
-		endpoints: props.compute ? [{
-			type: props.type,
-			suspend_timeout_seconds: props.suspendTimeout === 0 ? void 0 : props.suspendTimeout,
-			...props.cu ? getComputeUnits(props.cu) : void 0
-		}] : [],
-		annotation_value: annotationValue
-	}));
-	if (branches.find((b) => b.id === data.branch.parent_id)?.protected) log.warning("The parent branch is protected; a unique role password has been generated for the new branch.");
-	const out = writer(props);
-	const endpoints = data.endpoints ?? [];
-	const connectionUris = data.connection_uris ?? [];
-	const writeEndpoints = endpoints.length > 0;
-	const writeUris = props.secrets && connectionUris.length > 0;
-	if (!props.secrets && (props.output === "json" || props.output === "yaml") && !writeEndpoints) out.write({ branch: data.branch }, {
-		fields: ["branch"],
-		title: "branch"
-	});
-	else {
-		out.write(data.branch, {
-			fields: BRANCH_FIELDS,
-			title: "branch",
-			humanTitle: "Branch",
-			emptyMessage: "No branches have been found.",
-			renderColumns: branchColumns({ current: currentBranchOf(props) })
-		});
-		if (writeEndpoints) out.write(endpoints, {
-			fields: ["id", "created_at"],
-			title: "endpoints",
-			humanTitle: "Compute",
-			emptyMessage: "No endpoints have been found."
-		});
-		if (writeUris) out.write(connectionUris, {
-			fields: ["connection_uri"],
-			title: "connection_uris",
-			humanTitle: "Connection string",
-			emptyMessage: "No connection uris have been found"
-		});
-	}
-	out.end();
-	if (props.psql) {
-		if (!data.connection_uris?.length) throw new Error(`Branch ${data.branch.id} doesn't have a connection uri`);
-		const connection_uri = data.connection_uris[0].connection_uri;
-		const psqlArgs = props["--"];
-		await psql(connection_uri, psqlArgs, { mode: props.fallback ? "ts" : "auto" });
-	}
-};
-const rename = async (props) => {
-	const { branchId, listing } = await resolveBranchFromProps(props);
-	const { data } = await retryOnLock(() => props.apiClient.updateProjectBranch(props.projectId, branchId, { branch: { name: props.newName } }));
-	writer(props).end(data.branch, {
-		fields: BRANCH_FIELDS,
-		renderColumns: branchColumns({
-			annotations: listing?.annotations,
-			current: currentBranchOf(props)
-		})
-	});
-};
-const setDefault = async (props) => {
-	const { branchId, listing } = await resolveBranchFromProps(props);
-	const { data } = await retryOnLock(() => props.apiClient.setDefaultProjectBranch(props.projectId, branchId));
-	writer(props).end(data.branch, {
-		fields: BRANCH_FIELDS,
-		renderColumns: branchColumns({
-			annotations: listing?.annotations,
-			current: currentBranchOf(props)
-		})
-	});
-};
-const deleteBranch = async (props) => {
-	const { branchId, listing } = await resolveBranchFromProps(props);
-	const { data } = await retryOnLock(() => props.apiClient.deleteProjectBranch(props.projectId, branchId));
-	if (data) writer(props).end(data.branch, {
-		fields: BRANCH_FIELDS,
-		renderColumns: branchColumns({
-			annotations: listing?.annotations,
-			current: currentBranchOf(props)
-		})
-	});
-};
-const get = async (props) => {
-	const resolved = await resolveBranchFromProps(props);
-	let branch = resolved.branch;
-	let annotations = resolved.listing?.annotations;
-	if (!branch) {
-		const { data } = await props.apiClient.getProjectBranch(props.projectId, resolved.branchId);
-		branch = data.branch;
-		annotations = data.annotation ? { [data.branch.id]: data.annotation } : void 0;
-	}
-	writer(props).end(branch, {
-		fields: BRANCH_DETAIL_FIELDS,
-		renderColumns: branchColumns({
-			annotations,
-			current: currentBranchOf(props)
-		})
-	});
-};
-const addCompute = async (props) => {
-	const branchId = await branchIdFromProps(props);
-	const computeName = props.name ? { name: props.name } : null;
-	const { data } = await retryOnLock(() => props.apiClient.createProjectEndpoint(props.projectId, { endpoint: {
-		branch_id: branchId,
-		type: props.type,
-		...props.cu ? getComputeUnits(props.cu) : void 0,
-		...computeName
-	} }));
-	writer(props).end(data.endpoint, { fields: ["id", "host"] });
-};
-const reset = async (props) => {
-	if (!props.parent) throw new Error("Only resetting to parent is supported for now");
-	const { branchId, branch, listing } = await resolveBranchFromProps(props);
-	const parent_id = branch?.parent_id ?? (await props.apiClient.getProjectBranch(props.projectId, branchId)).data.branch.parent_id;
-	if (!parent_id) throw new Error("Branch has no parent");
-	const { data } = await retryOnLock(() => props.apiClient.restoreProjectBranch(props.projectId, branchId, {
-		source_branch_id: parent_id,
-		preserve_under_name: props.preserveUnderName || void 0
-	}));
-	writer(props).end(data.branch, {
-		fields: BRANCH_FIELDS_RESET,
-		renderColumns: branchColumns({
-			annotations: listing?.annotations,
-			current: currentBranchOf(props)
-		})
-	});
-};
-const restore = async (props) => {
-	const { branchId: targetBranchId, branch: targetBranch, listing } = await resolveBranchFromProps({
-		apiClient: props.apiClient,
-		projectId: props.projectId,
-		id: props.id
-	});
-	const pointInTime = await parsePointInTime({
-		pointInTime: props.pointInTime,
-		targetBranchId,
-		projectId: props.projectId,
-		api: props.apiClient,
-		branches: listing?.branches,
-		targetBranch
-	});
-	if (props.output === "table") {
-		const nameOf = (id) => listing?.branches.find((b) => b.id === id)?.name ?? id;
-		const point = pointInTime.tag === "lsn" ? `LSN ${pointInTime.lsn} of` : pointInTime.tag === "timestamp" ? `timestamp ${pointInTime.timestamp} of` : "the head of";
-		log.info(`Restoring ${nameOf(targetBranchId)} to ${point} ${nameOf(pointInTime.branchId)}`);
-	} else log.info(`Restoring branch ${targetBranchId} to the branch ${pointInTime.branchId} ${pointInTime.tag === "lsn" && "LSN " + pointInTime.lsn || pointInTime.tag === "timestamp" && "timestamp " + pointInTime.timestamp || "head"}`);
-	const { data } = await retryOnLock(() => props.apiClient.restoreProjectBranch(props.projectId, targetBranchId, {
-		source_branch_id: pointInTime.branchId,
-		preserve_under_name: props.preserveUnderName || void 0,
-		...pointInTime.tag === "lsn" && { source_lsn: pointInTime.lsn },
-		...pointInTime.tag === "timestamp" && { source_timestamp: pointInTime.timestamp }
-	}));
-	const labels = {
-		annotations: listing?.annotations,
-		current: currentBranchOf(props)
-	};
-	const writeInst = writer(props).write(data.branch, {
-		title: "Restored branch",
-		fields: [
-			"id",
-			"name",
-			"last_reset_at"
-		],
-		emptyMessage: "No branches have been restored.",
-		renderColumns: branchColumns(labels)
-	});
-	const parentId = data.branch.parent_id;
-	if (props.preserveUnderName && parentId) {
-		const { data } = await props.apiClient.getProjectBranch(props.projectId, parentId);
-		writeInst.write(data.branch, {
-			title: "Backup branch",
-			fields: ["id", "name"],
-			emptyMessage: "Backup branch has not been found.",
-			renderColumns: branchColumns(labels)
-		});
-	}
-	writeInst.end();
-};
-const setExpiration = async (props) => {
-	const { branchId, listing } = await resolveBranchFromProps({
-		...props,
-		id: props.branchId
-	});
-	const expiresAt = typeof props.expiresAt === "string" ? toIso(props.expiresAt, "--expires-at") : null;
-	const { data } = await retryOnLock(() => props.apiClient.updateProjectBranch(props.projectId, branchId, { branch: { expires_at: expiresAt } }));
-	writer(props).end(data.branch, {
-		fields: BRANCH_FIELDS,
-		renderColumns: branchColumns({
-			annotations: listing?.annotations,
-			current: currentBranchOf(props)
-		})
-	});
-};
-//#endregion
-export { BRANCH_FIELDS, aliases, builder, command, describe, handler, branches_exports as t };
+export { t as BRANCH_FIELDS, n as aliases, i as builder, a as command, o as describe, s as handler } from "../_chunks/branches-BNa1xX1L.js";