@prisma/cli 3.0.0-alpha.8 → 3.0.0-beta.0

package/dist/controllers/app-env.js

@@ -18,9 +18,9 @@ async function runEnvAdd(context, rawAssignment, flags) {
 		requireExplicit: true,
 		command: "add"
 	});
-	if (!scope) throw usageError(`prisma-cli project env add requires --role`, "Writing without an explicit scope is rejected.", "Pass --role production or --role preview.", [`prisma-cli project env add ${key}=${value} --role production`], "app");
+	if (!scope) throw usageError(`prisma-cli project env add requires --role or --branch`, "Writing without an explicit scope is rejected.", "Pass --role production, --role preview, or --branch <git-name>.", [`prisma-cli project env add ${key}=${value} --role production`], "app");
 	const { client, projectId } = await requireClientAndProject(context, flags.projectRef);
-	const resolved = resolveScopeToApi(scope);
+	const resolved = await resolveScopeToApi(client, projectId, scope, { createBranchIfMissing: true });
 	if (await findVariableByNaturalKey(client, projectId, key, resolved)) throw new CliError({
 		code: "ENV_VARIABLE_ALREADY_EXISTS",
 		domain: "app",
@@ -28,11 +28,26 @@ async function runEnvAdd(context, rawAssignment, flags) {
 		why: "A variable with this key already exists in the targeted scope.",
 		fix: "Use `prisma-cli project env update` to change an existing variable's value.",
 		exitCode: 1,
-		nextSteps: [`prisma-cli project env update ${key}=<new-value> --role ${scope.role}`]
+		nextSteps: [`prisma-cli project env update ${key}=<new-value> ${formatScopeFlag(scope)}`]
 	});
+	const warnings = scope.kind === "branch" && !await findVariableByNaturalKey(client, projectId, key, {
+		scope: {
+			kind: "role",
+			role: "preview"
+		},
+		descriptor: {
+			kind: "role",
+			role: "preview"
+		},
+		apiTarget: {
+			class: "preview",
+			branchId: null
+		}
+	}) ? [`Variable "${key}" does not exist in preview. It will only exist on ${formatScopeLabel(scope)}.`] : [];
 	const { data, error, response } = await client.POST("/v1/environment-variables", { body: {
 		projectId,
 		class: resolved.apiTarget.class,
+		...resolved.apiTarget.branchId !== null ? { branchId: resolved.apiTarget.branchId } : {},
 		key,
 		value
 	} });
@@ -44,7 +59,7 @@ async function runEnvAdd(context, rawAssignment, flags) {
 			scope: resolved.descriptor,
 			variable: toMetadata(data.data, resolved.descriptor)
 		},
-		warnings: [],
+		warnings,
 		nextSteps: []
 	};
 }
@@ -54,9 +69,9 @@ async function runEnvUpdate(context, rawAssignment, flags) {
 		requireExplicit: true,
 		command: "update"
 	});
-	if (!scope) throw usageError(`prisma-cli project env update requires --role`, "Writing without an explicit scope is rejected.", "Pass --role production or --role preview.", [`prisma-cli project env update ${key}=${value} --role production`], "app");
+	if (!scope) throw usageError(`prisma-cli project env update requires --role or --branch`, "Writing without an explicit scope is rejected.", "Pass --role production, --role preview, or --branch <git-name>.", [`prisma-cli project env update ${key}=${value} --role production`], "app");
 	const { client, projectId } = await requireClientAndProject(context, flags.projectRef);
-	const resolved = resolveScopeToApi(scope);
+	const resolved = await resolveScopeToApi(client, projectId, scope, { createBranchIfMissing: false });
 	const existing = await findVariableByNaturalKey(client, projectId, key, resolved);
 	if (!existing) throw new CliError({
 		code: "ENV_VARIABLE_NOT_FOUND",
@@ -65,7 +80,7 @@ async function runEnvUpdate(context, rawAssignment, flags) {
 		why: "No variable with this key exists in the targeted scope.",
 		fix: "Use `prisma-cli project env add` to create a new variable.",
 		exitCode: 1,
-		nextSteps: [`prisma-cli project env add ${key}=<value> --role ${scope.role}`]
+		nextSteps: [`prisma-cli project env add ${key}=<value> ${formatScopeFlag(scope)}`]
 	});
 	const { data, error, response } = await client.PATCH("/v1/environment-variables/{envVarId}", {
 		params: { path: { envVarId: existing.id } },
@@ -89,7 +104,7 @@ async function runEnvList(context, flags) {
 		command: "list"
 	}) ?? defaultRoleScope();
 	const { client, projectId } = await requireClientAndProject(context, flags.projectRef);
-	const resolved = resolveScopeToApi(scope);
+	const resolved = await resolveScopeToApi(client, projectId, scope, { createBranchIfMissing: false });
 	const variables = await listVariables(client, projectId, resolved);
 	return {
 		command: "project.env.list",
@@ -99,18 +114,18 @@ async function runEnvList(context, flags) {
 			variables: variables.map((row) => toMetadata(row, resolved.descriptor))
 		},
 		warnings: [],
-		nextSteps: variables.length === 0 ? [`prisma-cli project env add KEY=value --role ${scope.role}`] : []
+		nextSteps: variables.length === 0 ? [`prisma-cli project env add KEY=value ${formatScopeFlag(scope)}`] : []
 	};
 }
-async function runEnvRm(context, key, flags) {
-	if (!key) throw usageError("prisma-cli project env rm requires KEY", "No KEY positional argument was supplied.", "Pass the variable name to remove, e.g. STRIPE_KEY.", ["prisma-cli project env rm STRIPE_KEY --role production"], "app");
+async function runEnvRemove(context, key, flags) {
+	if (!key) throw usageError("prisma-cli project env remove requires KEY", "No KEY positional argument was supplied.", "Pass the variable name to remove, e.g. STRIPE_KEY.", ["prisma-cli project env remove STRIPE_KEY --role production"], "app");
 	const scope = resolveEnvScope(flags, {
 		requireExplicit: true,
-		command: "rm"
+		command: "remove"
 	});
-	if (!scope) throw usageError("prisma-cli project env rm requires --role", "Writing without an explicit scope is rejected.", "Pass --role production or --role preview.", [`prisma-cli project env rm ${key} --role production`], "app");
+	if (!scope) throw usageError("prisma-cli project env remove requires --role or --branch", "Writing without an explicit scope is rejected.", "Pass --role production, --role preview, or --branch <git-name>.", [`prisma-cli project env remove ${key} --role production`], "app");
 	const { client, projectId } = await requireClientAndProject(context, flags.projectRef);
-	const resolved = resolveScopeToApi(scope);
+	const resolved = await resolveScopeToApi(client, projectId, scope, { createBranchIfMissing: false });
 	const existing = await findVariableByNaturalKey(client, projectId, key, resolved);
 	if (!existing) throw new CliError({
 		code: "ENV_VARIABLE_NOT_FOUND",
@@ -119,12 +134,12 @@ async function runEnvRm(context, key, flags) {
 		why: "No variable with this key exists in the targeted scope, so there is nothing to remove.",
 		fix: "Run prisma-cli project env list with the same scope to see the available variables.",
 		exitCode: 1,
-		nextSteps: [`prisma-cli project env list --role ${scope.role}`]
+		nextSteps: [`prisma-cli project env list ${formatScopeFlag(scope)}`]
 	});
 	const { error, response } = await client.DELETE("/v1/environment-variables/{envVarId}", { params: { path: { envVarId: existing.id } } });
 	if (error) throw apiCallError(`Failed to remove ${key}`, response, error);
 	return {
-		command: "project.env.rm",
+		command: "project.env.remove",
 		result: {
 			projectId,
 			scope: resolved.descriptor,
@@ -151,8 +166,8 @@ async function requireClientAndProject(context, explicitProject) {
 		})).project.id
 	};
 }
-function resolveScopeToApi(scope) {
-	return {
+async function resolveScopeToApi(client, projectId, scope, options) {
+	if (scope.kind === "role") return {
 		scope,
 		descriptor: {
 			kind: "role",
@@ -163,6 +178,96 @@ function resolveScopeToApi(scope) {
 			branchId: null
 		}
 	};
+	const branch = options.createBranchIfMissing ? await resolveOrCreateBranch(client, projectId, scope.branchName) : await resolveExistingBranch(client, projectId, scope.branchName);
+	if (branch.isDefault) throw new CliError({
+		code: "ENV_BRANCH_SCOPE_IS_PRODUCTION",
+		domain: "app",
+		summary: `Branch "${scope.branchName}" is the default branch`,
+		why: "Production variables are project-level only; branch overrides apply to preview branches.",
+		fix: "Use --role production for the default branch.",
+		exitCode: 1,
+		nextSteps: ["prisma-cli project env list --role production"]
+	});
+	return {
+		scope,
+		descriptor: {
+			kind: "branch",
+			branchName: branch.gitName,
+			branchId: branch.id
+		},
+		apiTarget: {
+			class: "preview",
+			branchId: branch.id
+		}
+	};
+}
+function formatScopeFlag(scope) {
+	if (scope.kind === "role") return `--role ${scope.role}`;
+	return `--branch ${scope.branchName}`;
+}
+async function listBranchesByName(client, projectId, branchName) {
+	const { data, error, response } = await client.GET("/v1/projects/{projectId}/branches", { params: {
+		path: { projectId },
+		query: { gitName: branchName }
+	} });
+	if (error || !data) throw apiCallError(`Failed to resolve branch "${branchName}"`, response, error);
+	return data.data;
+}
+async function resolveExistingBranch(client, projectId, branchName) {
+	const branch = (await listBranchesByName(client, projectId, branchName))[0];
+	if (!branch) throw new CliError({
+		code: "ENV_BRANCH_NOT_FOUND",
+		domain: "app",
+		summary: `Branch "${branchName}" not found`,
+		why: "Branch update, list, and remove commands only target existing preview branches.",
+		fix: "Create the branch by deploying it, or use `project env add --branch` to create its first override.",
+		exitCode: 1,
+		nextSteps: [`prisma-cli project env add KEY=value --branch ${branchName}`]
+	});
+	return branch;
+}
+async function resolveOrCreateBranch(client, projectId, branchName) {
+	const existing = (await listBranchesByName(client, projectId, branchName))[0];
+	if (existing) return existing;
+	if (!await projectHasDefaultBranch(client, projectId)) throw new CliError({
+		code: "ENV_BRANCH_CREATE_REQUIRES_DEFAULT_BRANCH",
+		domain: "app",
+		summary: `Cannot create branch "${branchName}" from project env`,
+		why: "Creating the first branch would make it the project default, but branch overrides are preview-only.",
+		fix: "Create or deploy the default branch first, then add the branch override.",
+		exitCode: 1,
+		nextSteps: ["prisma-cli app deploy --branch main"]
+	});
+	const { data, error, response } = await client.POST("/v1/projects/{projectId}/branches", {
+		params: { path: { projectId } },
+		body: {
+			gitName: branchName,
+			isDefault: false
+		}
+	});
+	if (error || !data) {
+		if (response?.status === 409) {
+			const raced = (await listBranchesByName(client, projectId, branchName))[0];
+			if (raced) return raced;
+		}
+		throw apiCallError(`Failed to create branch "${branchName}"`, response, error);
+	}
+	return data.data;
+}
+async function projectHasDefaultBranch(client, projectId) {
+	let cursor;
+	while (true) {
+		const query = {};
+		if (cursor !== void 0) query.cursor = cursor;
+		const result = await client.GET("/v1/projects/{projectId}/branches", { params: {
+			path: { projectId },
+			query
+		} });
+		if (result.error || !result.data) throw apiCallError("Failed to check project default branch", result.response, result.error);
+		if (result.data.data.some((branch) => branch.isDefault)) return true;
+		if (!result.data.pagination.hasMore || !result.data.pagination.nextCursor) return false;
+		cursor = result.data.pagination.nextCursor;
+	}
 }
 async function findVariableByNaturalKey(client, projectId, key, resolved) {
 	const { data, error, response } = await client.GET("/v1/environment-variables", { params: { query: {
@@ -171,7 +276,7 @@ async function findVariableByNaturalKey(client, projectId, key, resolved) {
 		key
 	} } });
 	if (error || !data) throw apiCallError(`Failed to look up ${key}`, response, error);
-	return data.data.filter((row) => rowMatchesScope(row, resolved))[0] ?? null;
+	return data.data.filter((row) => rowMatchesExactScope(row, resolved))[0] ?? null;
 }
 async function listVariables(client, projectId, resolved) {
 	const collected = [];
@@ -189,20 +294,41 @@ async function listVariables(client, projectId, resolved) {
 		if (!result.data.pagination.hasMore || !result.data.pagination.nextCursor) break;
 		cursor = result.data.pagination.nextCursor;
 	}
-	return collected;
+	return materializeEffectiveRows(collected, resolved);
 }
 function rowMatchesScope(row, resolved) {
-	return row.branchId === null && row.class === resolved.apiTarget.class;
+	if (row.class !== resolved.apiTarget.class) return false;
+	if (resolved.apiTarget.branchId === null) return row.branchId === null;
+	return row.branchId === null || row.branchId === resolved.apiTarget.branchId;
 }
-function toMetadata(row, scope) {
+function rowMatchesExactScope(row, resolved) {
+	return row.class === resolved.apiTarget.class && row.branchId === resolved.apiTarget.branchId;
+}
+function materializeEffectiveRows(rows, resolved) {
+	if (resolved.apiTarget.branchId === null) return rows;
+	const byKey = /* @__PURE__ */ new Map();
+	for (const row of rows) if (row.branchId === null && !byKey.has(row.key)) byKey.set(row.key, row);
+	for (const row of rows) if (row.branchId === resolved.apiTarget.branchId) byKey.set(row.key, row);
+	return [...byKey.values()].sort((left, right) => left.key.localeCompare(right.key));
+}
+function toMetadata(row, requestedScope) {
+	const rowScope = row.branchId === null ? {
+		kind: "role",
+		role: row.class
+	} : requestedScope;
 	return {
 		id: row.id,
 		key: row.key,
-		scope,
+		scope: rowScope,
+		source: formatDescriptorLabel(rowScope),
 		isManagedBySystem: row.isManagedBySystem,
 		updatedAt: row.updatedAt
 	};
 }
+function formatDescriptorLabel(scope) {
+	if (scope.kind === "role") return scope.role ?? "unknown";
+	return `branch:${scope.branchName ?? scope.branchId ?? "unknown"}`;
+}
 function apiCallError(summary, response, error) {
 	const status = response?.status ?? 0;
 	const apiCode = error?.error?.code;
@@ -220,4 +346,4 @@ function apiCallError(summary, response, error) {
 	});
 }
 //#endregion
-export { runEnvAdd, runEnvList, runEnvRm, runEnvUpdate };
+export { runEnvAdd, runEnvList, runEnvRemove, runEnvUpdate };