Add private host option for private networks support in hyperdrive (#…

…4932) * Add private host option * add tests and changeset, plus small improvements * private_host not privateHost * remove urlencoded username from e2e tests * More private host changes --------- Co-authored-by: Emilio Assuncao <emilio@cloudflare.com>
cloudflare · Mar 28, 2024 · dc0c1dc · dc0c1dc
1 parent 3e5a932
commit dc0c1dc
Show file tree

Hide file tree

Showing 6 changed files with 110 additions and 25 deletions.
diff --git a/.changeset/bright-planets-unite.md b/.changeset/bright-planets-unite.md
@@ -0,0 +1,5 @@
+---
+"wrangler": minor
+---
+
+feature: Add support for private networking in Hyperdrive configs
diff --git a/packages/wrangler/e2e/dev.test.ts b/packages/wrangler/e2e/dev.test.ts
@@ -484,7 +484,7 @@ describe("hyperdrive dev tests", () => {
 					[[hyperdrive]]
 					binding = "HYPERDRIVE"
 					id = "hyperdrive_id"
-					localConnectionString = "postgresql://user%3Aname:%21pass@127.0.0.1:${port}/some_db"
+					localConnectionString = "postgresql://user:%21pass@127.0.0.1:${port}/some_db"
 			`,
 			"src/index.ts": dedent`
 					export default {
@@ -516,7 +516,7 @@ describe("hyperdrive dev tests", () => {
 			);
 			const url = new URL(text);
 			expect(url.pathname).toBe("/some_db");
-			expect(url.username).toBe("user:name");
+			expect(url.username).toBe("user");
 			expect(url.password).toBe("!pass");
 			expect(url.host).not.toBe("localhost");
 		});

diff --git a/packages/wrangler/src/__tests__/hyperdrive.test.ts b/packages/wrangler/src/__tests__/hyperdrive.test.ts
@@ -107,7 +107,7 @@ describe("hyperdrive commands", () => {
 	it("should handle creating a hyperdrive config", async () => {
 		mockHyperdriveRequest();
 		await runWrangler(
-			"hyperdrive create test123 --connection-string='postgresql://test:password@example.com:12345/neondb'"
+			"hyperdrive create test123 --connection-string='postgresql://test:password@example.com:12345/database'"
 		);
 		expect(std.out).toMatchInlineSnapshot(`
 		"🚧 Creating 'test123'
@@ -118,8 +118,9 @@ describe("hyperdrive commands", () => {
 		  \\"origin\\": {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 12345,
-		    \\"database\\": \\"neondb\\",
-		    \\"user\\": \\"test\\"
+		    \\"database\\": \\"database\\",
+		    \\"user\\": \\"test\\",
+		    \\"private_host\\": false
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": false
@@ -131,7 +132,7 @@ describe("hyperdrive commands", () => {
 	it("should handle creating a hyperdrive config for postgres without a port specified", async () => {
 		mockHyperdriveRequest();
 		await runWrangler(
-			"hyperdrive create test123 --connection-string='postgresql://test:password@example.com/neondb'"
+			"hyperdrive create test123 --connection-string='postgresql://test:password@example.com/database'"
 		);
 		expect(std.out).toMatchInlineSnapshot(`
 		"🚧 Creating 'test123'
@@ -142,8 +143,9 @@ describe("hyperdrive commands", () => {
 		  \\"origin\\": {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 5432,
-		    \\"database\\": \\"neondb\\",
-		    \\"user\\": \\"test\\"
+		    \\"database\\": \\"database\\",
+		    \\"user\\": \\"test\\",
+		    \\"private_host\\": false
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": false
@@ -155,7 +157,7 @@ describe("hyperdrive commands", () => {
 	it("should handle creating a hyperdrive config with caching options", async () => {
 		mockHyperdriveRequest();
 		await runWrangler(
-			"hyperdrive create test123 --connection-string='postgresql://test:password@example.com:12345/neondb' --max-age=30 --swr=15"
+			"hyperdrive create test123 --connection-string='postgresql://test:password@example.com:12345/database' --max-age=30 --swr=15"
 		);
 		expect(std.out).toMatchInlineSnapshot(`
 		"🚧 Creating 'test123'
@@ -166,8 +168,9 @@ describe("hyperdrive commands", () => {
 		  \\"origin\\": {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 12345,
-		    \\"database\\": \\"neondb\\",
-		    \\"user\\": \\"test\\"
+		    \\"database\\": \\"database\\",
+		    \\"user\\": \\"test\\",
+		    \\"private_host\\": false
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": false,
@@ -178,6 +181,31 @@ describe("hyperdrive commands", () => {
 	`);
 	});
 
+	it("should handle creating a hyperdrive with a private host", async () => {
+		mockHyperdriveRequest();
+		await runWrangler(
+			"hyperdrive create test123 --connection-string='postgresql://test:password@private.example.com:12345/database' --private-host=true"
+		);
+		expect(std.out).toMatchInlineSnapshot(`
+		"🚧 Creating 'test123'
+		✅ Created new Hyperdrive config
+		 {
+		  \\"id\\": \\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\",
+		  \\"name\\": \\"test123\\",
+		  \\"origin\\": {
+		    \\"host\\": \\"private.example.com\\",
+		    \\"port\\": 12345,
+		    \\"database\\": \\"database\\",
+		    \\"user\\": \\"test\\",
+		    \\"private_host\\": true
+		  },
+		  \\"caching\\": {
+		    \\"disabled\\": false
+		  }
+		}"
+	`);
+	});
+
 	it("should handle creating a hyperdrive config if the user is URL encoded", async () => {
 		mockHyperdriveRequest();
 		await runWrangler(
@@ -193,7 +221,8 @@ describe("hyperdrive commands", () => {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 5432,
 		    \\"database\\": \\"neondb\\",
-		    \\"user\\": \\"user:name\\"
+		    \\"user\\": \\"user:name\\",
+		    \\"private_host\\": false
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": false
@@ -217,7 +246,8 @@ describe("hyperdrive commands", () => {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 5432,
 		    \\"database\\": \\"neondb\\",
-		    \\"user\\": \\"test\\"
+		    \\"user\\": \\"test\\",
+		    \\"private_host\\": false
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": false
@@ -241,7 +271,8 @@ describe("hyperdrive commands", () => {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 5432,
 		    \\"database\\": \\"/\\"weird/\\" dbname\\",
-		    \\"user\\": \\"test\\"
+		    \\"user\\": \\"test\\",
+		    \\"private_host\\": false
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": false
@@ -258,7 +289,7 @@ describe("hyperdrive commands", () => {
 		┌──────────────────────────────────────┬─────────┬────────┬────────────────┬──────┬──────────┬────────────────────┐
 		│ id                                   │ name    │ user   │ host           │ port │ database │ caching            │
 		├──────────────────────────────────────┼─────────┼────────┼────────────────┼──────┼──────────┼────────────────────┤
-		│ xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx │ test123 │ test   │ example.com    │ 5432 │ neondb   │ {\\"disabled\\":false} │
+		│ xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx │ test123 │ test   │ example.com    │ 5432 │ database │ {\\"disabled\\":false} │
 		├──────────────────────────────────────┼─────────┼────────┼────────────────┼──────┼──────────┼────────────────────┤
 		│ yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy │ new-db  │ dbuser │ www.google.com │ 3211 │ mydb     │ {\\"disabled\\":false} │
 		└──────────────────────────────────────┴─────────┴────────┴────────────────┴──────┴──────────┴────────────────────┘"
@@ -275,8 +306,9 @@ describe("hyperdrive commands", () => {
 		  \\"origin\\": {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 5432,
-		    \\"database\\": \\"neondb\\",
-		    \\"user\\": \\"test\\"
+		    \\"database\\": \\"database\\",
+		    \\"user\\": \\"test\\",
+		    \\"private_host\\": false
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": false
@@ -309,7 +341,33 @@ describe("hyperdrive commands", () => {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 1234,
 		    \\"database\\": \\"mydb\\",
-		    \\"user\\": \\"newuser\\"
+		    \\"user\\": \\"newuser\\",
+		    \\"private_host\\": false
+		  },
+		  \\"caching\\": {
+		    \\"disabled\\": false
+		  }
+		}"
+	`);
+	});
+
+	it("should handle updating a hyperdrive config's origin with private host", async () => {
+		mockHyperdriveRequest();
+		await runWrangler(
+			`hyperdrive update xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --origin-host=private.example.com --origin-port=1234 --database=mydb --origin-user=newuser --origin-password='passw0rd!' --private-host=true`
+		);
+		expect(std.out).toMatchInlineSnapshot(`
+		"🚧 Updating 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+		✅ Updated xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Hyperdrive config
+		 {
+		  \\"id\\": \\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\\",
+		  \\"name\\": \\"test123\\",
+		  \\"origin\\": {
+		    \\"host\\": \\"private.example.com\\",
+		    \\"port\\": 1234,
+		    \\"database\\": \\"mydb\\",
+		    \\"user\\": \\"newuser\\",
+		    \\"private_host\\": true
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": false
@@ -347,8 +405,9 @@ describe("hyperdrive commands", () => {
 		  \\"origin\\": {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 5432,
-		    \\"database\\": \\"neondb\\",
-		    \\"user\\": \\"test\\"
+		    \\"database\\": \\"database\\",
+		    \\"user\\": \\"test\\",
+		    \\"private_host\\": false
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": false,
@@ -373,8 +432,9 @@ describe("hyperdrive commands", () => {
 		  \\"origin\\": {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 5432,
-		    \\"database\\": \\"neondb\\",
-		    \\"user\\": \\"test\\"
+		    \\"database\\": \\"database\\",
+		    \\"user\\": \\"test\\",
+		    \\"private_host\\": false
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": true
@@ -397,8 +457,9 @@ describe("hyperdrive commands", () => {
 		  \\"origin\\": {
 		    \\"host\\": \\"example.com\\",
 		    \\"port\\": 5432,
-		    \\"database\\": \\"neondb\\",
-		    \\"user\\": \\"test\\"
+		    \\"database\\": \\"database\\",
+		    \\"user\\": \\"test\\",
+		    \\"private_host\\": false
 		  },
 		  \\"caching\\": {
 		    \\"disabled\\": false
@@ -414,8 +475,9 @@ const defaultConfig: HyperdriveConfig = {
 	origin: {
 		host: "example.com",
 		port: 5432,
-		database: "neondb",
+		database: "database",
 		user: "test",
+		private_host: false,
 	},
 	caching: {
 		disabled: false,
@@ -447,6 +509,7 @@ function mockHyperdriveRequest() {
 									database: reqBody.origin.database,
 									scheme: reqBody.origin.protocol,
 									user: reqBody.origin.user,
+									private_host: reqBody.origin.private_host,
 								},
 								caching: reqBody.caching,
 							},
@@ -473,6 +536,7 @@ function mockHyperdriveRequest() {
 												port: reqBody.origin.port,
 												database: reqBody.origin.database,
 												user: reqBody.origin.user,
+												private_host: reqBody.origin.private_host,
 										  }
 										: defaultConfig.origin,
 								caching: reqBody.caching ?? defaultConfig.caching,
@@ -503,6 +567,7 @@ function mockHyperdriveRequest() {
 									port: 3211,
 									database: "mydb",
 									user: "dbuser",
+									private_host: false,
 								},
 								caching: {
 									disabled: false,

diff --git a/packages/wrangler/src/hyperdrive/client.ts b/packages/wrangler/src/hyperdrive/client.ts
@@ -18,6 +18,7 @@ export type PublicOrigin = Origin & {
 	scheme?: string;
 	database?: string;
 	user?: string;
+	private_host?: boolean;
 };
 
 export type OriginWithPassword = PublicOrigin & {

diff --git a/packages/wrangler/src/hyperdrive/create.ts b/packages/wrangler/src/hyperdrive/create.ts
@@ -36,6 +36,12 @@ export function options(yargs: CommonYargsArgv) {
 				describe:
 					"Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled",
 			},
+			"private-host": {
+				type: "boolean",
+				describe:
+					"Whether the provided host is part of your Cloudflare Zero Trust private network",
+				default: false,
+			},
 		})
 		.epilogue(hyperdriveBetaWarning);
 }
@@ -91,6 +97,7 @@ export async function handler(
 				database: decodeURIComponent(url.pathname.replace("/", "")),
 				user: decodeURIComponent(url.username),
 				password: decodeURIComponent(url.password),
+				private_host: args.privateHost ?? false,
 			},
 			caching: {
 				disabled: args.cachingDisabled,

diff --git a/packages/wrangler/src/hyperdrive/update.ts b/packages/wrangler/src/hyperdrive/update.ts
@@ -58,6 +58,12 @@ export function options(yargs: CommonYargsArgv) {
 				describe:
 					"Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled",
 			},
+			"private-host": {
+				type: "boolean",
+				describe:
+					"Whether the provided host is part of your Cloudflare Zero Trust private network",
+				default: false,
+			},
 		})
 		.epilogue(hyperdriveBetaWarning);
 }
@@ -116,6 +122,7 @@ export async function handler(
 			database: args.database,
 			user: args.originUser,
 			password: args.originPassword,
+			private_host: args.privateHost,
 		};
 	}