@prisma/cli 3.0.0-beta.2 → 3.0.0-beta.4

package/dist/controllers/app-env.js

@@ -1,16 +1,11 @@
 import { CliError, authRequiredError, usageError, workspaceRequiredError } from "../shell/errors.js";
 import { requireComputeAuth } from "../lib/auth/guard.js";
 import { resolveProjectTarget } from "../lib/project/resolution.js";
+import { readLocalGitBranch } from "../lib/git/local-branch.js";
 import { requireAuthenticatedAuthState } from "./auth.js";
 import { listRealWorkspaceProjects } from "./project.js";
 import { formatScopeLabel, parseKeyValuePositional, resolveEnvScope } from "../lib/app/env-config.js";
 //#region src/controllers/app-env.ts
-function defaultRoleScope() {
-	return {
-		kind: "role",
-		role: "production"
-	};
-}
 async function runEnvAdd(context, rawAssignment, flags) {
 	const { key, value } = parseKeyValuePositional(rawAssignment, "add", context.runtime.env);
 	const scope = resolveEnvScope(flags, {
@@ -19,8 +14,11 @@ async function runEnvAdd(context, rawAssignment, flags) {
 	});
 	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, "project env add");
-	const resolved = await resolveScopeToApi(client, projectId, scope, { createBranchIfMissing: true });
-	if (await findVariableByNaturalKey(client, projectId, key, resolved)) throw new CliError({
+	const resolved = await resolveScopeToApi(client, projectId, scope, {
+		createBranchIfMissing: true,
+		signal: context.runtime.signal
+	});
+	if (await findVariableByNaturalKey(client, projectId, key, resolved, context.runtime.signal)) throw new CliError({
 		code: "ENV_VARIABLE_ALREADY_EXISTS",
 		domain: "app",
 		summary: `Variable "${key}" already exists in ${formatScopeLabel(scope)}`,
@@ -42,14 +40,17 @@ async function runEnvAdd(context, rawAssignment, flags) {
 			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
-	} });
+	}, context.runtime.signal) ? [`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
+		},
+		signal: context.runtime.signal
+	});
 	if (error || !data) throw apiCallError(`Failed to add ${key}`, response, error);
 	return {
 		command: "project.env.add",
@@ -70,8 +71,11 @@ async function runEnvUpdate(context, rawAssignment, flags) {
 	});
 	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, "project env update");
-	const resolved = await resolveScopeToApi(client, projectId, scope, { createBranchIfMissing: false });
-	const existing = await findVariableByNaturalKey(client, projectId, key, resolved);
+	const resolved = await resolveScopeToApi(client, projectId, scope, {
+		createBranchIfMissing: false,
+		signal: context.runtime.signal
+	});
+	const existing = await findVariableByNaturalKey(client, projectId, key, resolved, context.runtime.signal);
 	if (!existing) throw new CliError({
 		code: "ENV_VARIABLE_NOT_FOUND",
 		domain: "app",
@@ -83,7 +87,8 @@ async function runEnvUpdate(context, rawAssignment, flags) {
 	});
 	const { data, error, response } = await client.PATCH("/v1/environment-variables/{envVarId}", {
 		params: { path: { envVarId: existing.id } },
-		body: { value }
+		body: { value },
+		signal: context.runtime.signal
 	});
 	if (error || !data) throw apiCallError(`Failed to update value for ${key}`, response, error);
 	return {
@@ -98,22 +103,30 @@ async function runEnvUpdate(context, rawAssignment, flags) {
 	};
 }
 async function runEnvList(context, flags) {
-	const scope = resolveEnvScope(flags, {
+	const explicit = resolveEnvScope(flags, {
 		requireExplicit: false,
 		command: "list"
-	}) ?? defaultRoleScope();
+	});
 	const { client, projectId } = await requireClientAndProject(context, flags.projectRef, "project env list");
-	const resolved = await resolveScopeToApi(client, projectId, scope, { createBranchIfMissing: false });
-	const variables = await listVariables(client, projectId, resolved);
+	const resolved = await resolveListScopeToApi(client, projectId, explicit, {
+		cwd: context.runtime.cwd,
+		signal: context.runtime.signal
+	});
+	const variables = resolved.kind === "scoped" ? await listVariables(client, projectId, {
+		scope: resolved.addScope,
+		descriptor: resolved.descriptor,
+		apiTarget: resolved.apiTarget
+	}, context.runtime.signal) : await listOverviewVariables(client, projectId, context.runtime.signal);
 	return {
 		command: "project.env.list",
 		result: {
 			projectId,
 			scope: resolved.descriptor,
+			target: resolved.target,
 			variables: variables.map((row) => toMetadata(row, resolved.descriptor))
 		},
 		warnings: [],
-		nextSteps: variables.length === 0 ? [`prisma-cli project env add KEY=value ${formatScopeFlag(scope)}`] : []
+		nextSteps: variables.length === 0 ? [`prisma-cli project env add KEY=value ${formatScopeFlag(resolved.addScope)}`] : []
 	};
 }
 async function runEnvRemove(context, key, flags) {
@@ -124,8 +137,11 @@ async function runEnvRemove(context, key, flags) {
 	});
 	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, "project env remove");
-	const resolved = await resolveScopeToApi(client, projectId, scope, { createBranchIfMissing: false });
-	const existing = await findVariableByNaturalKey(client, projectId, key, resolved);
+	const resolved = await resolveScopeToApi(client, projectId, scope, {
+		createBranchIfMissing: false,
+		signal: context.runtime.signal
+	});
+	const existing = await findVariableByNaturalKey(client, projectId, key, resolved, context.runtime.signal);
 	if (!existing) throw new CliError({
 		code: "ENV_VARIABLE_NOT_FOUND",
 		domain: "app",
@@ -135,7 +151,10 @@ async function runEnvRemove(context, key, flags) {
 		exitCode: 1,
 		nextSteps: [`prisma-cli project env list ${formatScopeFlag(scope)}`]
 	});
-	const { error, response } = await client.DELETE("/v1/environment-variables/{envVarId}", { params: { path: { envVarId: existing.id } } });
+	const { error, response } = await client.DELETE("/v1/environment-variables/{envVarId}", {
+		params: { path: { envVarId: existing.id } },
+		signal: context.runtime.signal
+	});
 	if (error) throw apiCallError(`Failed to remove ${key}`, response, error);
 	return {
 		command: "project.env.remove",
@@ -150,7 +169,7 @@ async function runEnvRemove(context, key, flags) {
 }
 async function requireClientAndProject(context, explicitProject, commandName) {
 	const authState = await requireAuthenticatedAuthState(context);
-	const client = await requireComputeAuth(context.runtime.env);
+	const client = await requireComputeAuth(context.runtime.env, context.runtime.signal);
 	if (!client) throw authRequiredError(["prisma-cli auth login"]);
 	if (!authState.workspace) throw workspaceRequiredError();
 	return {
@@ -159,7 +178,7 @@ async function requireClientAndProject(context, explicitProject, commandName) {
 			context,
 			workspace: authState.workspace,
 			explicitProject,
-			listProjects: () => listRealWorkspaceProjects(client, authState.workspace),
+			listProjects: () => listRealWorkspaceProjects(client, authState.workspace, context.runtime.signal),
 			commandName
 		})).project.id
 	};
@@ -176,13 +195,13 @@ async function resolveScopeToApi(client, projectId, scope, options) {
 			branchId: null
 		}
 	};
-	const branch = options.createBranchIfMissing ? await resolveOrCreateBranch(client, projectId, scope.branchName) : await resolveExistingBranch(client, projectId, scope.branchName);
-	if (branch.isDefault) throw new CliError({
+	const branch = options.createBranchIfMissing ? await resolveOrCreateBranch(client, projectId, scope.branchName, options.signal) : await resolveExistingBranch(client, projectId, scope.branchName, options.signal);
+	if (branch.role === "production") throw new CliError({
 		code: "ENV_BRANCH_SCOPE_IS_PRODUCTION",
 		domain: "app",
-		summary: `Branch "${scope.branchName}" is the default branch`,
+		summary: `Branch "${scope.branchName}" is the production branch`,
 		why: "Production variables are project-level only; branch overrides apply to preview branches.",
-		fix: "Use --role production for the default branch.",
+		fix: "Use --role production for the production branch.",
 		exitCode: 1,
 		nextSteps: ["prisma-cli project env list --role production"]
 	});
@@ -199,20 +218,140 @@ async function resolveScopeToApi(client, projectId, scope, options) {
 		}
 	};
 }
+async function resolveListScopeToApi(client, projectId, explicit, options) {
+	if (explicit) {
+		const resolved = await resolveScopeToApi(client, projectId, explicit, {
+			createBranchIfMissing: false,
+			signal: options.signal
+		});
+		return {
+			kind: "scoped",
+			descriptor: resolved.descriptor,
+			target: targetFromExplicitScope(resolved.descriptor),
+			apiTarget: resolved.apiTarget,
+			addScope: resolved.scope
+		};
+	}
+	const gitBranch = await readLocalGitBranch(options.cwd, options.signal);
+	if (gitBranch) {
+		const branch = (await listBranchesByName(client, projectId, gitBranch, options.signal))[0];
+		if (!branch) return {
+			kind: "scoped",
+			descriptor: {
+				kind: "role",
+				role: "preview"
+			},
+			target: {
+				source: "local-git",
+				branchName: gitBranch,
+				branchExists: false,
+				envMap: "preview"
+			},
+			apiTarget: {
+				class: "preview",
+				branchId: null
+			},
+			addScope: {
+				kind: "branch",
+				branchName: gitBranch
+			}
+		};
+		if (branch.role === "production") return {
+			kind: "scoped",
+			descriptor: {
+				kind: "role",
+				role: "production"
+			},
+			target: {
+				source: "local-git",
+				branchName: branch.gitName,
+				branchId: branch.id,
+				branchRole: branch.role,
+				branchExists: true,
+				envMap: "production"
+			},
+			apiTarget: {
+				class: "production",
+				branchId: null
+			},
+			addScope: {
+				kind: "role",
+				role: "production"
+			}
+		};
+		return {
+			kind: "scoped",
+			descriptor: {
+				kind: "branch",
+				branchName: branch.gitName,
+				branchId: branch.id
+			},
+			target: {
+				source: "local-git",
+				branchName: branch.gitName,
+				branchId: branch.id,
+				branchRole: branch.role,
+				branchExists: true,
+				envMap: "preview"
+			},
+			apiTarget: {
+				class: "preview",
+				branchId: branch.id
+			},
+			addScope: {
+				kind: "branch",
+				branchName: branch.gitName
+			}
+		};
+	}
+	return {
+		kind: "overview",
+		descriptor: { kind: "overview" },
+		target: {
+			source: "overview",
+			envMap: "overview"
+		},
+		addScope: {
+			kind: "role",
+			role: "preview"
+		}
+	};
+}
+function targetFromExplicitScope(scope) {
+	if (scope.kind === "branch") return {
+		source: "explicit",
+		branchName: scope.branchName,
+		branchId: scope.branchId,
+		branchRole: "preview",
+		branchExists: true,
+		envMap: "preview"
+	};
+	if (scope.kind === "role") return {
+		source: "explicit",
+		envMap: scope.role
+	};
+	return {
+		source: "overview",
+		envMap: "overview"
+	};
+}
 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 }
-	} });
+async function listBranchesByName(client, projectId, branchName, signal) {
+	const { data, error, response } = await client.GET("/v1/projects/{projectId}/branches", {
+		params: {
+			path: { projectId },
+			query: { gitName: branchName }
+		},
+		signal
+	});
 	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];
+async function resolveExistingBranch(client, projectId, branchName, signal) {
+	const branch = (await listBranchesByName(client, projectId, branchName, signal))[0];
 	if (!branch) throw new CliError({
 		code: "ENV_BRANCH_NOT_FOUND",
 		domain: "app",
@@ -224,10 +363,10 @@ async function resolveExistingBranch(client, projectId, branchName) {
 	});
 	return branch;
 }
-async function resolveOrCreateBranch(client, projectId, branchName) {
-	const existing = (await listBranchesByName(client, projectId, branchName))[0];
+async function resolveOrCreateBranch(client, projectId, branchName, signal) {
+	const existing = (await listBranchesByName(client, projectId, branchName, signal))[0];
 	if (existing) return existing;
-	if (!await projectHasDefaultBranch(client, projectId)) throw new CliError({
+	if (!await projectHasDefaultBranch(client, projectId, signal)) throw new CliError({
 		code: "ENV_BRANCH_CREATE_REQUIRES_DEFAULT_BRANCH",
 		domain: "app",
 		summary: `Cannot create branch "${branchName}" from project env`,
@@ -241,58 +380,81 @@ async function resolveOrCreateBranch(client, projectId, branchName) {
 		body: {
 			gitName: branchName,
 			isDefault: false
-		}
+		},
+		signal
 	});
 	if (error || !data) {
 		if (response?.status === 409) {
-			const raced = (await listBranchesByName(client, projectId, branchName))[0];
+			const raced = (await listBranchesByName(client, projectId, branchName, signal))[0];
 			if (raced) return raced;
 		}
 		throw apiCallError(`Failed to create branch "${branchName}"`, response, error);
 	}
 	return data.data;
 }
-async function projectHasDefaultBranch(client, projectId) {
+async function projectHasDefaultBranch(client, projectId, signal) {
 	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
-		} });
+		const result = await client.GET("/v1/projects/{projectId}/branches", {
+			params: {
+				path: { projectId },
+				query
+			},
+			signal
+		});
 		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: {
-		projectId,
-		class: resolved.apiTarget.class,
-		key
-	} } });
+async function findVariableByNaturalKey(client, projectId, key, resolved, signal) {
+	const { data, error, response } = await client.GET("/v1/environment-variables", {
+		params: { query: {
+			projectId,
+			class: resolved.apiTarget.class,
+			key
+		} },
+		signal
+	});
 	if (error || !data) throw apiCallError(`Failed to look up ${key}`, response, error);
 	return data.data.filter((row) => rowMatchesExactScope(row, resolved))[0] ?? null;
 }
-async function listVariables(client, projectId, resolved) {
+async function listVariables(client, projectId, resolved, signal) {
+	return materializeEffectiveRows(await collectEnvironmentVariables(client, projectId, signal, {
+		className: resolved.apiTarget.class,
+		filter: (row) => rowMatchesScope(row, resolved)
+	}), resolved);
+}
+async function listOverviewVariables(client, projectId, signal) {
+	return (await collectEnvironmentVariables(client, projectId, signal, { filter: (row) => row.branchId === null && (row.class === "production" || row.class === "preview") })).sort((left, right) => {
+		const roleOrder = roleSortOrder(left.class) - roleSortOrder(right.class);
+		return roleOrder !== 0 ? roleOrder : left.key.localeCompare(right.key);
+	});
+}
+async function collectEnvironmentVariables(client, projectId, signal, options) {
 	const collected = [];
 	let cursor;
 	while (true) {
-		const query = {
-			projectId,
-			class: resolved.apiTarget.class
-		};
+		const query = { projectId };
+		if (options.className !== void 0) query.class = options.className;
 		if (cursor !== void 0) query.cursor = cursor;
-		const result = await client.GET("/v1/environment-variables", { params: { query } });
+		const result = await client.GET("/v1/environment-variables", {
+			params: { query },
+			signal
+		});
 		if (result.error || !result.data) throw apiCallError(`Failed to list environment variables`, result.response, result.error);
-		const page = result.data.data.filter((row) => rowMatchesScope(row, resolved));
+		const page = result.data.data.filter(options.filter);
 		collected.push(...page);
 		if (!result.data.pagination.hasMore || !result.data.pagination.nextCursor) break;
 		cursor = result.data.pagination.nextCursor;
 	}
-	return materializeEffectiveRows(collected, resolved);
+	return collected;
+}
+function roleSortOrder(role) {
+	return role === "production" ? 0 : 1;
 }
 function rowMatchesScope(row, resolved) {
 	if (row.class !== resolved.apiTarget.class) return false;
@@ -325,6 +487,7 @@ function toMetadata(row, requestedScope) {
 }
 function formatDescriptorLabel(scope) {
 	if (scope.kind === "role") return scope.role ?? "unknown";
+	if (scope.kind === "overview") return "overview";
 	return `branch:${scope.branchName ?? scope.branchId ?? "unknown"}`;
 }
 function apiCallError(summary, response, error) {