@prisma/cli 3.0.0-dev.125.1 → 3.0.0-dev.127.1

package/dist/cli2.js

@@ -3,7 +3,7 @@ import { attachCommandDescriptor } from "./shell/command-meta.js";
 import { createShellUi } from "./shell/ui.js";
 import { addCompactGlobalFlags } from "./shell/global-flags.js";
 import { configureRuntimeCommand, createCommandContext } from "./shell/runtime.js";
-import { formatUnexpectedError, writeHumanError, writeJsonError, writeJsonSuccess } from "./shell/output.js";
+import { formatUnexpectedError, unexpectedErrorFeedbackCommand, writeHumanError, writeJsonError, writeJsonSuccess, writeJsonUnexpectedError } from "./shell/output.js";
 import { createAgentCommand } from "./commands/agent/index.js";
 import "./shell/prompt.js";
 import { createAppCommand } from "./commands/app/index.js";
@@ -11,10 +11,11 @@ import { createAuthCommand } from "./commands/auth/index.js";
 import { createBranchCommand } from "./commands/branch/index.js";
 import { createBuildCommand } from "./commands/build/index.js";
 import { createDatabaseCommand } from "./commands/database/index.js";
+import { getCliName, getCliVersion } from "./lib/version.js";
+import { createFeedbackCommand } from "./commands/feedback/index.js";
 import { createGitCommand } from "./commands/git/index.js";
 import { createInitCommand } from "./commands/init/index.js";
 import { createProjectCommand } from "./commands/project/index.js";
-import { getCliName, getCliVersion } from "./lib/version.js";
 import { runVersion } from "./controllers/version.js";
 import { createVersionCommand } from "./commands/version/index.js";
 import { maybeWriteCachedUpdateNotification } from "./shell/update-check.js";
@@ -37,7 +38,15 @@ async function runCli(options = {}) {
 		return process.exitCode ?? 0;
 	} catch (error) {
 		if (error instanceof CommanderError) return error.code === "commander.helpDisplayed" ? 0 : 2;
-		runtime.stderr.write(formatUnexpectedError(error, runtime.argv.includes("--trace")));
+		if (runtime.argv.includes("--json")) {
+			writeJsonUnexpectedError({
+				stdout: runtime.stdout,
+				stderr: runtime.stderr
+			}, runtime.argv, error);
+			return 1;
+		}
+		const quiet = runtime.argv.includes("--quiet") || runtime.argv.includes("-q");
+		runtime.stderr.write(formatUnexpectedError(error, runtime.argv.includes("--trace"), quiet ? void 0 : unexpectedErrorFeedbackCommand(runtime.argv, error)));
 		return 1;
 	} finally {
 		runtime.stdin;
@@ -50,6 +59,7 @@ function createProgram(runtime) {
 	program.name("prisma").showSuggestionAfterError();
 	program.addCommand(createVersionCommand(runtime));
 	program.addCommand(createInitCommand(runtime));
+	program.addCommand(createFeedbackCommand(runtime));
 	program.addCommand(createAgentCommand(runtime));
 	program.addCommand(createAuthCommand(runtime));
 	program.addCommand(createProjectCommand(runtime));

package/dist/commands/feedback/index.js

@@ -0,0 +1,20 @@
+import { attachCommandDescriptor } from "../../shell/command-meta.js";
+import { addGlobalFlags } from "../../shell/global-flags.js";
+import { configureRuntimeCommand } from "../../shell/runtime.js";
+import { runCommand } from "../../shell/command-runner.js";
+import { runFeedback } from "../../controllers/feedback.js";
+import { renderFeedbackSuccess } from "../../presenters/feedback.js";
+import { Command, Option } from "commander";
+//#region src/commands/feedback/index.ts
+function createFeedbackCommand(runtime) {
+	const command = attachCommandDescriptor(configureRuntimeCommand(new Command("feedback"), runtime), "feedback");
+	command.argument("<message>", "Feedback text (up to 4000 characters)").addOption(new Option("--email <address>", "Contact email if you want a reply; feedback is anonymous without it"));
+	addGlobalFlags(command);
+	command.action(async (message, options) => {
+		const flags = options;
+		await runCommand(runtime, "feedback", options, (context) => runFeedback(context, message, { email: flags.email }), { renderHuman: (context, descriptor, result) => renderFeedbackSuccess(context, descriptor, result) });
+	});
+	return command;
+}
+//#endregion
+export { createFeedbackCommand };

package/dist/controllers/feedback.js

@@ -0,0 +1,86 @@
+import { CliError, usageError } from "../shell/errors.js";
+import { getCliVersion } from "../lib/version.js";
+//#region src/controllers/feedback.ts
+const DEFAULT_FEEDBACK_ENDPOINT = "https://hiieirp2pwqnjvq9axzyg6d0.fra.prisma.build/feedback";
+const FEEDBACK_TIMEOUT_MS = 3e3;
+const MAX_MESSAGE_LENGTH = 4e3;
+const MAX_EMAIL_LENGTH = 320;
+const EMAIL_PATTERN = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+async function runFeedback(context, messageArg, flags) {
+	const message = messageArg.trim();
+	if (!message) throw usageError("Feedback message required", "The message argument is empty.", "Pass a non-empty message.", ["prisma-cli feedback \"the deploy flow is great\""]);
+	if (message.length > MAX_MESSAGE_LENGTH) throw usageError("Feedback message too long", `The message is ${message.length} characters; the limit is ${MAX_MESSAGE_LENGTH}.`, "Shorten the message.");
+	const email = flags.email?.trim();
+	if (email !== void 0 && (email.length > MAX_EMAIL_LENGTH || !EMAIL_PATTERN.test(email))) throw usageError("Invalid email", `"${flags.email}" is not a valid email address of at most ${MAX_EMAIL_LENGTH} characters.`, "Pass a valid address with --email, or drop the flag to stay anonymous.", ["prisma-cli feedback \"please add X\" --email you@example.com"]);
+	const feedbackContext = {
+		cliVersion: getCliVersion(),
+		nodeVersion: process.version,
+		platform: process.platform,
+		arch: process.arch
+	};
+	return {
+		command: "feedback",
+		result: {
+			id: await postFeedback(context, context.runtime.env.PRISMA_CLI_FEEDBACK_URL || DEFAULT_FEEDBACK_ENDPOINT, {
+				message,
+				...email ? { email } : {},
+				meta: { ...feedbackContext }
+			}),
+			email: email ?? null,
+			context: feedbackContext
+		},
+		warnings: [],
+		nextSteps: []
+	};
+}
+async function postFeedback(context, endpoint, body) {
+	let response;
+	try {
+		response = await fetch(endpoint, {
+			method: "POST",
+			headers: {
+				"content-type": "application/json",
+				"user-agent": `prisma-cli/${getCliVersion()}`
+			},
+			body: JSON.stringify(body),
+			signal: AbortSignal.any([context.runtime.signal, AbortSignal.timeout(FEEDBACK_TIMEOUT_MS)])
+		});
+	} catch (error) {
+		if (context.runtime.signal.aborted) throw error;
+		throw feedbackSendFailed(error instanceof Error && error.name === "TimeoutError" ? TIMEOUT_DETAIL : `The feedback service could not be reached${error instanceof Error && error.cause instanceof Error ? ` (${error.cause.message})` : ""}.`);
+	}
+	if (!response.ok) throw feedbackSendFailed(`The feedback service responded with HTTP ${response.status}${await readServiceError(context, response)}.`);
+	let payload;
+	try {
+		payload = await response.json();
+	} catch (error) {
+		if (context.runtime.signal.aborted) throw error;
+		if (!(error instanceof SyntaxError)) throw feedbackSendFailed(error instanceof Error && error.name === "TimeoutError" ? TIMEOUT_DETAIL : "The feedback service response could not be read.");
+		payload = null;
+	}
+	return typeof payload?.id === "string" ? payload.id : null;
+}
+const TIMEOUT_DETAIL = `The feedback service did not answer within ${FEEDBACK_TIMEOUT_MS / 1e3} seconds.`;
+async function readServiceError(context, response) {
+	let payload;
+	try {
+		payload = await response.json();
+	} catch (error) {
+		if (context.runtime.signal.aborted) throw error;
+		return "";
+	}
+	return typeof payload?.error?.message === "string" ? ` (${payload.error.message})` : "";
+}
+function feedbackSendFailed(detail) {
+	return new CliError({
+		code: "FEEDBACK_SEND_FAILED",
+		domain: "cli",
+		summary: "Feedback could not be delivered",
+		why: detail,
+		fix: "Check your network and rerun the command.",
+		exitCode: 1,
+		nextSteps: []
+	});
+}
+//#endregion
+export { runFeedback };

package/dist/presenters/feedback.js

@@ -0,0 +1,26 @@
+import { renderShow } from "../output/patterns.js";
+//#region src/presenters/feedback.ts
+function renderFeedbackSuccess(context, descriptor, result) {
+	return renderShow({
+		title: "Feedback sent. Thank you!",
+		descriptor,
+		fields: [
+			...result.id ? [{
+				key: "id",
+				value: result.id
+			}] : [],
+			{
+				key: "sent as",
+				value: result.email ?? "anonymous",
+				tone: result.email ? "default" : "dim"
+			},
+			{
+				key: "included",
+				value: `CLI ${result.context.cliVersion}, node ${result.context.nodeVersion}, ${result.context.platform} ${result.context.arch}`,
+				tone: "dim"
+			}
+		]
+	}, context.ui);
+}
+//#endregion
+export { renderFeedbackSuccess };

package/dist/shell/command-meta.js

@@ -20,6 +20,13 @@ const DESCRIPTORS = [
 		description: "Show CLI build and environment",
 		examples: ["prisma-cli version", "prisma-cli version --json"]
 	},
+	{
+		id: "feedback",
+		path: ["prisma", "feedback"],
+		description: "Send feedback to the Prisma CLI team",
+		longDescription: "Anonymous unless --email is passed. Every submission includes the CLI version, node version, and OS platform/arch, and nothing else.",
+		examples: ["prisma-cli feedback \"the deploy flow is great\"", "prisma-cli feedback \"please add X\" --email you@example.com"]
+	},
 	{
 		id: "init",
 		path: ["prisma", "init"],

package/dist/shell/output.js

@@ -1,3 +1,4 @@
+import { formatCommandArgument } from "./command-arguments.js";
 import { renderNextSteps, renderSummaryLine } from "./ui.js";
 //#region src/shell/output.ts
 function writeJsonSuccess(output, success) {
@@ -23,15 +24,76 @@ function cliErrorToJson(error) {
 		docsUrl: error.docsUrl
 	};
 }
-function formatUnexpectedError(error, trace) {
+function formatUnexpectedError(error, trace, feedbackCommand) {
+	const feedbackLine = feedbackCommand ? `Tell us what happened: ${feedbackCommand}` : null;
 	const debug = error instanceof Error ? error.stack ?? error.message : String(error);
-	if (trace) return `${debug}\n`;
+	if (trace) return [
+		debug,
+		...feedbackLine ? [feedbackLine] : [],
+		""
+	].join("\n");
 	return [
 		`Unexpected CLI error: ${error instanceof Error && error.message ? error.message : String(error)}`,
 		"More: Re-run with --trace for deeper diagnostics",
+		...feedbackLine ? [feedbackLine] : [],
 		""
 	].join("\n");
 }
+/** Command groups whose second argv token names the subcommand. */
+const COMMAND_GROUPS = new Set([
+	"agent",
+	"auth",
+	"project",
+	"git",
+	"branch",
+	"build",
+	"database",
+	"app"
+]);
+/** Best-effort `command` label for a crash that predates envelope assembly. */
+function unexpectedErrorCommandLabel(argv) {
+	const [group, action] = argv.filter((arg) => !arg.startsWith("-"));
+	if (!group) return "unknown";
+	return action && COMMAND_GROUPS.has(group) ? `${group}.${action}` : group;
+}
+/**
+* Pre-filled feedback command for a crash, so the report arrives carrying the
+* failing command and the error's first line.
+*/
+function unexpectedErrorFeedbackCommand(argv, error) {
+	return `prisma-cli feedback ${formatCommandArgument(`${unexpectedErrorCommandLabel(argv).replace(".", " ")} crashed: ${(error instanceof Error && error.message ? error.message : String(error)).split("\n")[0]}`.slice(0, 200))}`;
+}
+/**
+* A crash must not break the `--json` contract: agents still get a structured
+* envelope, with a recover action pointing at the feedback command.
+*/
+function writeJsonUnexpectedError(output, argv, error) {
+	const feedbackCommand = unexpectedErrorFeedbackCommand(argv, error);
+	output.stdout.write(`${JSON.stringify({
+		ok: false,
+		command: unexpectedErrorCommandLabel(argv),
+		error: {
+			code: "UNEXPECTED_ERROR",
+			domain: "cli",
+			severity: "error",
+			summary: "Unexpected CLI error",
+			why: error instanceof Error && error.message ? error.message : String(error),
+			fix: "Re-run with --trace for deeper diagnostics, and report the crash.",
+			where: null,
+			meta: {},
+			docsUrl: null
+		},
+		warnings: [],
+		nextSteps: [feedbackCommand],
+		nextActions: [{
+			kind: "run-command",
+			journey: "recover",
+			label: "Report this crash to the Prisma team",
+			command: feedbackCommand,
+			reason: "This looks like a CLI bug; the pre-filled report carries the failing command and error."
+		}]
+	}, null, 2)}\n`);
+}
 function writeJsonError(output, command, error) {
 	output.stdout.write(`${JSON.stringify({
 		ok: false,
@@ -79,4 +141,4 @@ function writeHumanError(output, ui, error, options) {
 	writeHumanLines(output, lines);
 }
 //#endregion
-export { cliErrorToJson, formatUnexpectedError, writeHumanError, writeHumanLines, writeJsonError, writeJsonEvent, writeJsonSuccess };
+export { cliErrorToJson, formatUnexpectedError, unexpectedErrorFeedbackCommand, writeHumanError, writeHumanLines, writeJsonError, writeJsonEvent, writeJsonSuccess, writeJsonUnexpectedError };

package/package.json

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