Log note of upcoming change of "Deployment ID" to "Version ID" (#5400)

cloudflare · Mar 28, 2024 · c90dd6b · c90dd6b
1 parent b341614
commit c90dd6b
Show file tree

Hide file tree

Showing 7 changed files with 731 additions and 215 deletions.
diff --git a/.changeset/soft-bees-report.md b/.changeset/soft-bees-report.md
@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+chore: log of impending change of "Deployment ID" to "Version ID" in `wrangler deploy`, `wrangler deployments list`, `wrangler deployments view` and `wrangler rollback`. This is a warning of a future change for anyone depending on the output text format, for example by grepping the output in automated flows.
diff --git a/packages/wrangler/src/__tests__/deploy.test.ts b/packages/wrangler/src/__tests__/deploy.test.ts
diff --git a/packages/wrangler/src/__tests__/deployments.test.ts b/packages/wrangler/src/__tests__/deployments.test.ts
@@ -107,7 +107,10 @@ describe("deployments", () => {
 			Author:        Jean-Luc-Picard@federation.org
 			Source:        Rollback from Wrangler 🤠
 			Rollback from: MOCK-DEPLOYMENT-ID-2222
-			🟩 Active"
+			🟩 Active
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 			});
 
@@ -139,7 +142,10 @@ describe("deployments", () => {
 			Author:        Jean-Luc-Picard@federation.org
 			Source:        Rollback from Wrangler 🤠
 			Rollback from: MOCK-DEPLOYMENT-ID-2222
-			🟩 Active"
+			🟩 Active
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 			});
 
@@ -171,7 +177,10 @@ describe("deployments", () => {
 			Handlers:            fetch
 			--------------------------bindings--------------------------
 			None
-			"
+
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 			});
 
@@ -197,7 +206,10 @@ describe("deployments", () => {
 			binding = \\"MY_BUCKET\\"
 			bucket_name = \\"testr2\\"
 
-			"
+
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 			});
 			it("should automatically log latest deployment details", async () => {
@@ -219,7 +231,10 @@ describe("deployments", () => {
 			Handlers:            fetch
 			--------------------------bindings--------------------------
 			None
-			"
+
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 			});
 		});
@@ -287,7 +302,10 @@ describe("deployments", () => {
 
 
 			Successfully rolled back to Deployment ID: 3mEgaU1T-Intrepid-someThing-tag:test-name
-			Current Deployment ID: galactic_mission_alpha"
+			Current Deployment ID: galactic_mission_alpha
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 
 				expect(requests.count).toEqual(1);
@@ -323,7 +341,10 @@ describe("deployments", () => {
 			🤖 Using default value in non-interactive context:
 
 			Successfully rolled back to Deployment ID: 3mEgaU1T-Intrepid-someThing-tag:test-name
-			Current Deployment ID: galactic_mission_alpha"
+			Current Deployment ID: galactic_mission_alpha
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 
 				expect(requests.count).toEqual(1);
@@ -339,7 +360,10 @@ describe("deployments", () => {
 
 
 			Successfully rolled back to Deployment ID: 3mEgaU1T-Intrepid-someThing-tag:test-name
-			Current Deployment ID: galactic_mission_alpha"
+			Current Deployment ID: galactic_mission_alpha
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 
 				expect(requests.count).toEqual(1);
@@ -355,7 +379,10 @@ describe("deployments", () => {
 
 
 			Successfully rolled back to Deployment ID: 3mEgaU1T-Intrepid-someThing-tag:test-name
-			Current Deployment ID: galactic_mission_alpha"
+			Current Deployment ID: galactic_mission_alpha
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 
 				expect(requests.count).toEqual(1);
@@ -379,7 +406,10 @@ describe("deployments", () => {
 
 
 			Successfully rolled back to Deployment ID: 3mEgaU1T-Intrepid-someThing-tag:test-name
-			Current Deployment ID: galactic_mission_alpha"
+			Current Deployment ID: galactic_mission_alpha
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 
 				expect(requests.count).toEqual(1);
@@ -410,7 +440,10 @@ describe("deployments", () => {
 
 
 			Successfully rolled back to Deployment ID: 3mEgaU1T-Intrepid-someThing-tag:something-else
-			Current Deployment ID: galactic_mission_alpha"
+			Current Deployment ID: galactic_mission_alpha
+
+
+			NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments"
 		`);
 
 				expect(requests.count).toEqual(1);

diff --git a/packages/wrangler/src/__tests__/deprecated-usage-model.test.ts b/packages/wrangler/src/__tests__/deprecated-usage-model.test.ts
@@ -57,7 +57,10 @@ describe("deprecated-usage-model", () => {
 		Uploaded test-name (TIMINGS)
 		Published test-name (TIMINGS)
 		  https://test-name.test-sub-domain.workers.dev
-		Current Deployment ID: Galaxy-Class",
+		Current Deployment ID: Galaxy-Class
+
+
+		NOTE: \\"Deployment ID\\" in this output will be changed to \\"Version ID\\" in a future version of Wrangler. To learn more visit: https://developers.cloudflare.com/workers/configuration/versions-and-deployments",
 		  "warn": "",
 		}
 	`);

diff --git a/packages/wrangler/src/deploy/deploy.ts b/packages/wrangler/src/deploy/deploy.ts
@@ -41,6 +41,7 @@ import {
 	getSourceMappedString,
 	maybeRetrieveFileSourceMap,
 } from "../sourcemap";
+import { logVersionIdChange } from "../utils/deployment-id-version-id-change";
 import { getZoneForRoute } from "../zones";
 import type { FetchError } from "../cfetch";
 import type { Config } from "../config";
@@ -962,6 +963,8 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 	}
 
 	logger.log("Current Deployment ID:", deploymentId);
+
+	logVersionIdChange();
 }
 
 function deployWfpUserWorker(
@@ -971,6 +974,8 @@ function deployWfpUserWorker(
 	// Will go under the "Uploaded" text
 	logger.log("  Dispatch Namespace:", dispatchNamespace);
 	logger.log("Current Deployment ID:", deploymentId);
+
+	logVersionIdChange();
 }
 
 export function helpIfErrorIsSizeOrScriptStartup(

diff --git a/packages/wrangler/src/deployments.ts b/packages/wrangler/src/deployments.ts
@@ -10,6 +10,7 @@ import { mapBindings } from "./init";
 import { logger } from "./logger";
 import * as metrics from "./metrics";
 import { requireAuth } from "./user";
+import { logVersionIdChange } from "./utils/deployment-id-version-id-change";
 import { getScriptName, printWranglerBanner } from ".";
 import type { Config } from "./config";
 import type { WorkerMetadataBinding } from "./deployment-bundle/create-worker-upload-form";
@@ -102,6 +103,8 @@ Source:        ${triggerStr}`;
 
 	versionMessages[versionMessages.length - 1] += "🟩 Active";
 	logger.log(...versionMessages);
+
+	logVersionIdChange();
 }
 
 function formatSource(source: string): string {
@@ -210,6 +213,8 @@ export async function rollbackDeployment(
 
 	logger.log(`\nSuccessfully rolled back to Deployment ID: ${deploymentId}`);
 	logger.log("Current Deployment ID:", deployment_id);
+
+	logVersionIdChange();
 }
 
 async function rollbackRequest(
@@ -318,8 +323,7 @@ ${
 
 	logger.log(version);
 
-	// early return to skip the deployments listings
-	return;
+	logVersionIdChange();
 }
 
 export async function commonDeploymentCMDSetup(

diff --git a/packages/wrangler/src/utils/deployment-id-version-id-change.ts b/packages/wrangler/src/utils/deployment-id-version-id-change.ts
@@ -0,0 +1,10 @@
+import { logger } from "../logger";
+
+export function logVersionIdChange() {
+	const docsLink =
+		"https://developers.cloudflare.com/workers/configuration/versions-and-deployments";
+
+	logger.log(
+		`\n\nNOTE: "Deployment ID" in this output will be changed to "Version ID" in a future version of Wrangler. To learn more visit: ${docsLink}`
+	);
+}