[wrangler] improve formatting of cache options in hyperdrive list command (#8583)

Co-authored-by: knickish <[email protected]>
Co-authored-by: Carmen Popoviciu <[email protected]>

Author: 3 people

.changeset/good-taxis-repeat.md

@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+Improve formatting of cache options for hyperdrive list command

packages/wrangler/src/__tests__/hyperdrive.test.ts

@@ -668,15 +668,15 @@ describe("hyperdrive commands", () => {
 		await runWrangler("hyperdrive list");
 		expect(std.out).toMatchInlineSnapshot(`
 			"📋 Listing Hyperdrive configs
-			┌──────────────────────────────────────┬─────────────┬─────────┬────────────────┬──────┬────────────┬───────────┬───────────────────┬───────────────────────────────────────────────────────────────┐
-			│ id                                   │ name        │ user    │ host           │ port │ scheme     │ database  │ caching           │ mtls                                                          │
-			├──────────────────────────────────────┼─────────────┼─────────┼────────────────┼──────┼────────────┼───────────┼───────────────────┼───────────────────────────────────────────────────────────────┤
-			│ xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx │ test123     │ test    │ example.com    │ 5432 │ PostgreSQL │ neondb    │                   │                                                               │
-			├──────────────────────────────────────┼─────────────┼─────────┼────────────────┼──────┼────────────┼───────────┼───────────────────┼───────────────────────────────────────────────────────────────┤
-			│ yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy │ new-db      │ dbuser  │ www.google.com │ 3211 │ PostgreSQL │ mydb      │ {\\"disabled\\":true} │                                                               │
-			├──────────────────────────────────────┼─────────────┼─────────┼────────────────┼──────┼────────────┼───────────┼───────────────────┼───────────────────────────────────────────────────────────────┤
-			│ zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz │ new-db-mtls │ pg-mtls │ www.mtls.com   │ 3212 │            │ mydb-mtls │                   │ {\\"ca_certificate_uuid\\":\\"1234\\",\\"mtls_certificate_uuid\\":\\"1234\\"} │
-			└──────────────────────────────────────┴─────────────┴─────────┴────────────────┴──────┴────────────┴───────────┴───────────────────┴───────────────────────────────────────────────────────────────┘"
+			┌──────────────────────────────────────┬─────────────┬─────────┬────────────────┬──────┬────────────┬───────────┬──────────┬───────────────────────────────────────────────────────────────┐
+			│ id                                   │ name        │ user    │ host           │ port │ scheme     │ database  │ caching  │ mtls                                                          │
+			├──────────────────────────────────────┼─────────────┼─────────┼────────────────┼──────┼────────────┼───────────┼──────────┼───────────────────────────────────────────────────────────────┤
+			│ xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx │ test123     │ test    │ example.com    │ 5432 │ PostgreSQL │ neondb    │ enabled  │                                                               │
+			├──────────────────────────────────────┼─────────────┼─────────┼────────────────┼──────┼────────────┼───────────┼──────────┼───────────────────────────────────────────────────────────────┤
+			│ yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy │ new-db      │ dbuser  │ www.google.com │ 3211 │ PostgreSQL │ mydb      │ disabled │                                                               │
+			├──────────────────────────────────────┼─────────────┼─────────┼────────────────┼──────┼────────────┼───────────┼──────────┼───────────────────────────────────────────────────────────────┤
+			│ zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz │ new-db-mtls │ pg-mtls │ www.mtls.com   │ 3212 │            │ mydb-mtls │ enabled  │ {\\"ca_certificate_uuid\\":\\"1234\\",\\"mtls_certificate_uuid\\":\\"1234\\"} │
+			└──────────────────────────────────────┴─────────────┴─────────┴────────────────┴──────┴────────────┴───────────┴──────────┴───────────────────────────────────────────────────────────────┘"
 		`);
 	});
 

packages/wrangler/src/hyperdrive/list.ts

@@ -1,7 +1,7 @@
 import { readConfig } from "../config";
 import { logger } from "../logger";
 import { listConfigs } from "./client";
-import { capitalizeScheme } from "./shared";
+import { capitalizeScheme, formatCachingOptions } from "./shared";
 import type {
 	CommonYargsArgv,
 	StrictYargsOptionsToInterface,
@@ -27,7 +27,7 @@ export async function handler(
 			port: database.origin.port?.toString() ?? "",
 			scheme: capitalizeScheme(database.origin.scheme),
 			database: database.origin.database ?? "",
-			caching: JSON.stringify(database.caching),
+			caching: formatCachingOptions(database.caching),
 			mtls: JSON.stringify(database.mtls),
 		}))
 	);

packages/wrangler/src/hyperdrive/shared.ts

@@ -1,3 +1,5 @@
+import type { CachingOptions } from "./client";
+
 export function capitalizeScheme(scheme: string | undefined) {
 	switch (scheme) {
 		case "mysql":
@@ -9,3 +11,25 @@ export function capitalizeScheme(scheme: string | undefined) {
 			return "";
 	}
 }
+
+export function formatCachingOptions(
+	cachingOptions: CachingOptions | undefined
+): string {
+	switch (cachingOptions?.disabled) {
+		case false: {
+			if (cachingOptions.stale_while_revalidate === 0) {
+				return `max_age: ${cachingOptions.max_age}, stale_while_revalidate: disabled`;
+			} else {
+				return `max_age: ${cachingOptions.max_age}, stale_while_revalidate: ${cachingOptions.stale_while_revalidate}`;
+			}
+		}
+		case undefined: {
+			return "enabled";
+		}
+		case true: {
+			return "disabled";
+		}
+		default:
+			return JSON.stringify(cachingOptions);
+	}
+}