wrangler 2.12.2 → 2.13.0

package/src/deployments.ts

@@ -1,9 +1,21 @@
 import { URLSearchParams } from "url";
+import TOML from "@iarna/toml";
+import chalk from "chalk";
+import { FormData } from "undici";
 import { fetchResult } from "./cfetch";
+import { readConfig } from "./config";
+import { confirm, prompt } from "./dialogs";
+import { mapBindings } from "./init";
 import { logger } from "./logger";
 import * as metrics from "./metrics";
+import { requireAuth } from "./user";
+import { getScriptName, printWranglerBanner } from ".";
+
 import type { Config } from "./config";
+import type { WorkerMetadataBinding } from "./create-worker-upload-form";
 import type { ServiceMetadataRes } from "./init";
+import type { CommonYargsOptions } from "./yargs-types";
+import type { ArgumentsCamelCase } from "yargs";
 
 type DeploymentDetails = {
 	id: string;
@@ -11,6 +23,7 @@ type DeploymentDetails = {
 	annotations: {
 		"workers/triggered_by": string;
 		"workers/rollback_from": string;
+		"workers/message": string;
 	};
 	metadata: {
 		author_id: string;
@@ -20,8 +33,15 @@ type DeploymentDetails = {
 		modified_on: string;
 	};
 	resources: {
-		script: string;
-		bindings: unknown[];
+		script: {
+			handlers: string[];
+		};
+		bindings: WorkerMetadataBinding[];
+		script_runtime: {
+			compatibility_date: string | undefined;
+			compatibility_flags: string[] | undefined;
+			usage_model: string | undefined;
+		};
 	};
 };
 
@@ -49,11 +69,12 @@ export async function deployments(
 		}
 	);
 
-	const scriptMetadata = await fetchResult<ServiceMetadataRes>(
-		`/accounts/${accountId}/workers/services/${scriptName}`
-	);
+	const scriptTag = (
+		await fetchResult<ServiceMetadataRes>(
+			`/accounts/${accountId}/workers/services/${scriptName}`
+		)
+	).default_environment.script.tag;
 
-	const scriptTag = scriptMetadata.default_environment.script.tag;
 	const params = new URLSearchParams({ order: "asc" });
 	const { items: deploys } = await fetchResult<DeploymentListResult>(
 		`/accounts/${accountId}/workers/deployments/by-script/${scriptTag}`,
@@ -72,12 +93,16 @@ export async function deployments(
 Deployment ID: ${versions.id}
 Created on:    ${versions.metadata.created_on}
 Author:        ${versions.metadata.author_email}
-Trigger:       ${triggerStr}`;
+Source:        ${triggerStr}`;
 
 		if (versions.annotations?.["workers/rollback_from"]) {
 			version += `\nRollback from: ${versions.annotations["workers/rollback_from"]}`;
 		}
 
+		if (versions.annotations?.["workers/message"]) {
+			version += `\nMessage:       ${versions.annotations["workers/message"]}`;
+		}
+
 		return version + `\n`;
 	});
 
@@ -99,7 +124,6 @@ function formatSource(source: string): string {
 			return "Other";
 	}
 }
-
 function formatTrigger(trigger: string): string {
 	switch (trigger) {
 		case "upload":
@@ -114,3 +138,231 @@ function formatTrigger(trigger: string): string {
 			return "Unknown";
 	}
 }
+
+export async function rollbackDeployment(
+	accountId: string,
+	scriptName: string | undefined,
+	{ send_metrics: sendMetrics }: { send_metrics?: Config["send_metrics"] } = {},
+	deploymentId: string | undefined,
+	message: string | undefined
+) {
+	if (deploymentId === undefined) {
+		const scriptTag = (
+			await fetchResult<ServiceMetadataRes>(
+				`/accounts/${accountId}/workers/services/${scriptName}`
+			)
+		).default_environment.script.tag;
+
+		const params = new URLSearchParams({ order: "asc" });
+		const { items: deploys } = await fetchResult<DeploymentListResult>(
+			`/accounts/${accountId}/workers/deployments/by-script/${scriptTag}`,
+			undefined,
+			params
+		);
+
+		if (deploys.length < 2) {
+			throw new Error(
+				"Cannot rollback to previous deployment since there are less than 2 deployemnts"
+			);
+		}
+
+		deploymentId = deploys.at(-2)?.id;
+		if (deploymentId === undefined) {
+			throw new Error("Cannot find previous deployment");
+		}
+	}
+
+	const firstHash = deploymentId.substring(0, deploymentId.indexOf("-"));
+
+	let rollbackMessage = "";
+	if (message !== undefined) {
+		rollbackMessage = message;
+	} else {
+		if (
+			!(await confirm(
+				`This deployment ${chalk.underline(
+					firstHash
+				)} will immediately replace the current deployment and become the active deployment across all your deployed routes and domains. However, your local development environment will not be affected by this rollback. ${chalk.blue.bold(
+					"Note:"
+				)} Rolling back to a previous deployment will not rollback any of the bound resources (Durable Object, R2, KV, etc.).`
+			))
+		) {
+			return;
+		}
+
+		rollbackMessage = await prompt(
+			"Please provide a message for this rollback (120 characters max)",
+			{ defaultValue: "" }
+		);
+	}
+
+	let deployment_id = await rollbackRequest(
+		accountId,
+		scriptName,
+		deploymentId,
+		rollbackMessage
+	);
+
+	await metrics.sendMetricsEvent(
+		"rollback deployments",
+		{ view: scriptName ? "single" : "all" },
+		{
+			sendMetrics,
+		}
+	);
+
+	deploymentId = addHyphens(deploymentId) ?? deploymentId;
+	deployment_id = addHyphens(deployment_id) ?? deployment_id;
+
+	logger.log(`\nSuccessfully rolled back to Deployment ID: ${deploymentId}`);
+	logger.log("Current Deployment ID:", deployment_id);
+}
+
+async function rollbackRequest(
+	accountId: string,
+	scriptName: string | undefined,
+	deploymentId: string,
+	rollbackReason: string
+): Promise<string | null> {
+	const body = new FormData();
+	body.set("message", rollbackReason);
+
+	const { deployment_id } = await fetchResult<{
+		deployment_id: string | null;
+	}>(
+		`/accounts/${accountId}/workers/scripts/${scriptName}?rollback_to=${deploymentId}`,
+		{
+			method: "PUT",
+			body,
+		}
+	);
+
+	return deployment_id;
+}
+
+export async function viewDeployment(
+	accountId: string,
+	scriptName: string | undefined,
+	{ send_metrics: sendMetrics }: { send_metrics?: Config["send_metrics"] } = {},
+	deploymentId: string | undefined
+) {
+	await metrics.sendMetricsEvent(
+		"view deployments",
+		{ view: scriptName ? "single" : "all" },
+		{
+			sendMetrics,
+		}
+	);
+
+	const scriptTag = (
+		await fetchResult<ServiceMetadataRes>(
+			`/accounts/${accountId}/workers/services/${scriptName}`
+		)
+	).default_environment.script.tag;
+
+	if (deploymentId === undefined) {
+		const params = new URLSearchParams({ order: "asc" });
+		const { latest } = await fetchResult<DeploymentListResult>(
+			`/accounts/${accountId}/workers/deployments/by-script/${scriptTag}`,
+			undefined,
+			params
+		);
+
+		deploymentId = latest.id;
+		if (deploymentId === undefined) {
+			throw new Error("Cannot find previous deployment");
+		}
+	}
+
+	const deploymentDetails = await fetchResult<DeploymentListResult["latest"]>(
+		`/accounts/${accountId}/workers/deployments/by-script/${scriptTag}/detail/${deploymentId}`
+	);
+
+	const triggerStr = deploymentDetails.annotations?.["workers/triggered_by"]
+		? `${formatTrigger(
+				deploymentDetails.annotations["workers/triggered_by"]
+		  )} from ${formatSource(deploymentDetails.metadata.source)}`
+		: `${formatSource(deploymentDetails.metadata.source)}`;
+
+	const rollbackStr = deploymentDetails.annotations?.["workers/rollback_from"]
+		? `\nRollback from:       ${deploymentDetails.annotations["workers/rollback_from"]}`
+		: ``;
+
+	const reasonStr = deploymentDetails.annotations?.["workers/message"]
+		? `\nMessage:             ${deploymentDetails.annotations["workers/message"]}`
+		: ``;
+
+	const compatDateStr = deploymentDetails.resources.script_runtime
+		?.compatibility_date
+		? `\nCompatibility Date:  ${deploymentDetails.resources.script_runtime?.compatibility_date}`
+		: ``;
+	const compatFlagsStr = deploymentDetails.resources.script_runtime
+		?.compatibility_flags
+		? `\nCompatibility Flags: ${deploymentDetails.resources.script_runtime?.compatibility_flags}`
+		: ``;
+
+	const bindings = deploymentDetails.resources.bindings;
+
+	const version = `
+Deployment ID:       ${deploymentDetails.id}
+Created on:          ${deploymentDetails.metadata.created_on}
+Author:              ${deploymentDetails.metadata.author_email}
+Source:              ${triggerStr}${rollbackStr}${reasonStr}
+------------------------------------------------------------
+Author ID:           ${deploymentDetails.metadata.author_id}
+Usage Model:         ${deploymentDetails.resources.script_runtime.usage_model}
+Handlers:            ${
+		deploymentDetails.resources.script.handlers
+	}${compatDateStr}${compatFlagsStr}
+--------------------------bindings--------------------------
+${
+	bindings.length > 0
+		? TOML.stringify(mapBindings(bindings) as TOML.JsonMap)
+		: `None`
+}
+`;
+
+	logger.log(version);
+
+	// early return to skip the deployments listings
+	return;
+}
+
+export async function commonDeploymentCMDSetup(
+	yargs: ArgumentsCamelCase<CommonYargsOptions>,
+	deploymentsWarning: string
+) {
+	await printWranglerBanner();
+	const config = readConfig(yargs.config, yargs);
+	const accountId = await requireAuth(config);
+	const scriptName = getScriptName(
+		{ name: yargs.name as string, env: undefined },
+		config
+	);
+
+	logger.log(`${deploymentsWarning}\n`);
+
+	return { accountId, scriptName, config };
+}
+
+export function addHyphens(uuid: string | null): string | null {
+	if (uuid == null) {
+		return uuid;
+	}
+
+	if (uuid.length != 32) {
+		return null;
+	}
+
+	const uuid_parts: string[] = [];
+	uuid_parts.push(uuid.slice(0, 8));
+	uuid_parts.push(uuid.slice(8, 12));
+	uuid_parts.push(uuid.slice(12, 16));
+	uuid_parts.push(uuid.slice(16, 20));
+	uuid_parts.push(uuid.slice(20));
+
+	let hyphenated = "";
+	uuid_parts.forEach((part) => (hyphenated += part + "-"));
+
+	return hyphenated.slice(0, 36);
+}

package/src/index.ts

@@ -9,7 +9,12 @@ import { isBuildFailure } from "./bundle";
 import { loadDotEnv, readConfig } from "./config";
 import { d1 } from "./d1";
 import { deleteHandler, deleteOptions } from "./delete";
-import { deployments } from "./deployments";
+import {
+	deployments,
+	commonDeploymentCMDSetup,
+	rollbackDeployment,
+	viewDeployment,
+} from "./deployments";
 import {
 	buildHandler,
 	buildOptions,
@@ -41,13 +46,7 @@ import { secret, secretBulkHandler, secretBulkOptions } from "./secret";
 import { tailOptions, tailHandler } from "./tail";
 import { generateTypes } from "./type-generation";
 import { updateCheck } from "./update-check";
-import {
-	listScopes,
-	login,
-	logout,
-	requireAuth,
-	validateScopeKeys,
-} from "./user";
+import { listScopes, login, logout, validateScopeKeys } from "./user";
 import { whoami } from "./whoami";
 
 import type { Config } from "./config";
@@ -581,27 +580,81 @@ export function createCLIParser(argv: string[]) {
 		"🚧`wrangler deployments` is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose";
 	wrangler.command(
 		"deployments",
-		"🚢 Displays the 10 most recent deployments for a worker",
+		"🚢 List and view details for deployments",
 		(yargs) =>
 			yargs
 				.option("name", {
 					describe: "The name of your worker",
 					type: "string",
 				})
-				.epilogue(deploymentsWarning),
-		async (deploymentsYargs) => {
-			await printWranglerBanner();
-			const config = readConfig(deploymentsYargs.config, deploymentsYargs);
-			const accountId = await requireAuth(config);
-			const scriptName = getScriptName(
-				{ name: deploymentsYargs.name, env: undefined },
-				config
-			);
-
-			logger.log(`${deploymentsWarning}\n`);
-			await deployments(accountId, scriptName, config);
-		}
+				.command(
+					"list",
+					"🚢 Displays the 10 most recent deployments for a worker",
+					async (listYargs) => listYargs,
+					async (listYargs) => {
+						const { accountId, scriptName, config } =
+							await commonDeploymentCMDSetup(listYargs, deploymentsWarning);
+						await deployments(accountId, scriptName, config);
+					}
+				)
+				.command(
+					"view [deployment-id]",
+					"🔍 View a deployment",
+					async (viewYargs) =>
+						viewYargs.positional("deployment-id", {
+							describe: "The ID of the deployment you want to inspect",
+							type: "string",
+							demandOption: false,
+						}),
+					async (viewYargs) => {
+						const { accountId, scriptName, config } =
+							await commonDeploymentCMDSetup(viewYargs, deploymentsWarning);
+
+						await viewDeployment(
+							accountId,
+							scriptName,
+							config,
+							viewYargs.deploymentId
+						);
+					}
+				)
+				.command(subHelp)
+				.epilogue(deploymentsWarning)
 	);
+	const rollbackWarning =
+		"🚧`wrangler rollback` is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose";
+	wrangler
+		.command(
+			"rollback [deployment-id]",
+			"🔙 Rollback a deployment",
+			(rollbackYargs) =>
+				rollbackYargs
+					.positional("deployment-id", {
+						describe: "The ID of the deployment to rollback to",
+						type: "string",
+						demandOption: false,
+					})
+					.option("message", {
+						alias: "m",
+						describe:
+							"Skip confirmation and message prompts, uses provided argument as message",
+						type: "string",
+						default: undefined,
+					}),
+			async (rollbackYargs) => {
+				const { accountId, scriptName, config } =
+					await commonDeploymentCMDSetup(rollbackYargs, rollbackWarning);
+
+				await rollbackDeployment(
+					accountId,
+					scriptName,
+					config,
+					rollbackYargs.deploymentId,
+					rollbackYargs.message
+				);
+			}
+		)
+		.epilogue(rollbackWarning);
 
 	// This set to false to allow overwrite of default behaviour
 	wrangler.version(false);