@prisma/cli 3.0.0-dev.56.1 → 3.0.0-dev.57.1

package/README.md

@@ -57,6 +57,7 @@ Useful next commands:
 npx prisma-cli app logs
 npx prisma-cli app open
 npx prisma-cli project env add DATABASE_URL=postgresql://example --role preview
+npx prisma-cli project env list
 npx prisma-cli project env list --role preview
 ```
 

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, {
@@ -108,25 +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 resolved = await resolveListScopeToApi(client, projectId, explicit, {
+		cwd: context.runtime.cwd,
 		signal: context.runtime.signal
 	});
-	const variables = await listVariables(client, projectId, resolved, 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) {
@@ -196,12 +196,12 @@ async function resolveScopeToApi(client, projectId, scope, options) {
 		}
 	};
 	const branch = options.createBranchIfMissing ? await resolveOrCreateBranch(client, projectId, scope.branchName, options.signal) : await resolveExistingBranch(client, projectId, scope.branchName, options.signal);
-	if (branch.isDefault) throw new CliError({
+	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"]
 	});
@@ -218,6 +218,123 @@ 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}`;
@@ -306,25 +423,38 @@ async function findVariableByNaturalKey(client, projectId, key, resolved, signal
 	return data.data.filter((row) => rowMatchesExactScope(row, resolved))[0] ?? null;
 }
 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 },
 			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;
@@ -357,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) {

package/dist/controllers/app.js

@@ -16,6 +16,7 @@ import { LOCAL_RESOLUTION_PIN_RELATIVE_PATH, readLocalResolutionPin } from "../l
 import { buildProjectSetupNextActions, inferTargetName, projectNotFoundError, resolveDurablePlatformMapping, resolveProjectTarget, sortProjects } from "../lib/project/resolution.js";
 import { bindProjectToDirectory, projectCreateFailedError, projectSetupNameRequiredError, resolveProjectForSetup, toProjectSummary } from "../lib/project/setup.js";
 import { promptForProjectSetupChoice } from "../lib/project/interactive-setup.js";
+import { readLocalGitBranch } from "../lib/git/local-branch.js";
 import { PREVIEW_BUILD_TYPES, RESOLVED_PREVIEW_BUILD_TYPES, executePreviewBuild } from "../lib/app/preview-build.js";
 import { PREVIEW_DEFAULT_REGION } from "../lib/app/preview-interaction.js";
 import { createPreviewDeployProgress, createPreviewDeployProgressState, createPreviewPromoteProgress } from "../lib/app/preview-progress.js";
@@ -1481,42 +1482,6 @@ async function resolveDeployBranch(context, explicitBranchName) {
 		annotation: "default"
 	};
 }
-async function readLocalGitBranch(cwd, signal) {
-	const headPath = await resolveGitHeadPath(path.join(cwd, ".git"), signal);
-	if (!headPath) return null;
-	try {
-		const head = (await readFile(headPath, {
-			encoding: "utf8",
-			signal
-		})).trim();
-		if (head.startsWith("ref: refs/heads/")) return head.slice(16);
-	} catch (error) {
-		if (signal.aborted) throw error;
-		return null;
-	}
-	return null;
-}
-async function resolveGitHeadPath(gitPath, signal) {
-	signal.throwIfAborted();
-	try {
-		const raw = await readFile(gitPath, {
-			encoding: "utf8",
-			signal
-		});
-		if (raw.startsWith("gitdir:")) return path.join(path.resolve(path.dirname(gitPath), raw.slice(7).trim()), "HEAD");
-	} catch (error) {
-		if (signal.aborted) throw error;
-	}
-	signal.throwIfAborted();
-	try {
-		await access(path.join(gitPath, "HEAD"));
-		signal.throwIfAborted();
-		return path.join(gitPath, "HEAD");
-	} catch (error) {
-		if (signal.aborted) throw error;
-		return null;
-	}
-}
 async function resolveDeployFramework(context, options) {
 	if (options.requestedFramework) return frameworkFromUserFacingValue(options.requestedFramework, "set by --framework");
 	if (options.entrypoint) return {

package/dist/lib/git/local-branch.js

@@ -0,0 +1,41 @@
+import { access, readFile } from "node:fs/promises";
+import path from "node:path";
+//#region src/lib/git/local-branch.ts
+async function readLocalGitBranch(cwd, signal) {
+	const headPath = await resolveGitHeadPath(path.join(cwd, ".git"), signal);
+	if (!headPath) return null;
+	try {
+		const head = (await readFile(headPath, {
+			encoding: "utf8",
+			signal
+		})).trim();
+		if (head.startsWith("ref: refs/heads/")) return head.slice(16);
+	} catch (error) {
+		if (signal.aborted) throw error;
+		return null;
+	}
+	return null;
+}
+async function resolveGitHeadPath(gitPath, signal) {
+	signal.throwIfAborted();
+	try {
+		const raw = await readFile(gitPath, {
+			encoding: "utf8",
+			signal
+		});
+		if (raw.startsWith("gitdir:")) return path.join(path.resolve(path.dirname(gitPath), raw.slice(7).trim()), "HEAD");
+	} catch (error) {
+		if (signal.aborted) throw error;
+	}
+	signal.throwIfAborted();
+	try {
+		await access(path.join(gitPath, "HEAD"));
+		signal.throwIfAborted();
+		return path.join(gitPath, "HEAD");
+	} catch (error) {
+		if (signal.aborted) throw error;
+		return null;
+	}
+}
+//#endregion
+export { readLocalGitBranch };

package/dist/presenters/app-env.js

@@ -2,8 +2,18 @@ import { renderList, renderShow, serializeList } from "../output/patterns.js";
 //#region src/presenters/app-env.ts
 function scopeLabel(scope) {
 	if (scope.kind === "role") return scope.role ?? "unknown";
+	if (scope.kind === "overview") return "overview";
 	return `branch:${scope.branchName ?? scope.branchId ?? "unknown"}`;
 }
+function listTargetLabel(result) {
+	const target = result.target;
+	if (target.source === "overview") return "overview";
+	if (target.branchName) {
+		const suffix = target.branchExists === false ? " (not created yet)" : "";
+		return `branch:${target.branchName} -> ${target.envMap}${suffix}`;
+	}
+	return scopeLabel(result.scope);
+}
 function renderEnvAdd(context, descriptor, result) {
 	return renderShow({
 		title: "Setting a new environment variable.",
@@ -75,8 +85,8 @@ function renderEnvList(context, descriptor, result) {
 		title: "Listing environment variables for the selected scope.",
 		descriptor,
 		parentContext: {
-			key: "scope",
-			value: scopeLabel(result.scope)
+			key: "target",
+			value: listTargetLabel(result)
 		},
 		items: result.variables.map((variable) => ({
 			noun: "variable",
@@ -91,8 +101,9 @@ function serializeEnvList(result) {
 	return {
 		projectId: result.projectId,
 		scope: result.scope,
+		target: result.target,
 		...serializeList({
-			context: { scope: scopeLabel(result.scope) },
+			context: { target: listTargetLabel(result) },
 			items: result.variables.map((variable) => ({
 				noun: "variable",
 				label: `${variable.key} (${variable.source})`,

package/dist/shell/command-meta.js

@@ -379,7 +379,7 @@ const DESCRIPTORS = [
 		],
 		description: "Manage environment variables for the active project",
 		examples: [
-			"prisma-cli project env list --role production",
+			"prisma-cli project env list",
 			"prisma-cli project env add STRIPE_KEY=sk_test_xxx --role production",
 			"prisma-cli project env add DATABASE_URL=postgresql://branch --branch feature/foo",
 			"prisma-cli project env remove STRIPE_KEY --role preview"
@@ -426,6 +426,7 @@ const DESCRIPTORS = [
 		],
 		description: "List environment variable metadata for a scope (no values).",
 		examples: [
+			"prisma-cli project env list",
 			"prisma-cli project env list --role production",
 			"prisma-cli project env list --role preview",
 			"prisma-cli project env list --branch feature/foo"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prisma/cli",
-  "version": "3.0.0-dev.56.1",
+  "version": "3.0.0-dev.57.1",
   "description": "Command-line interface for the Prisma Developer Platform.",
   "type": "module",
   "bin": {