wrangler: Try to URL decode hyperdrive password and database name bef…

…ore sending them to API Also do the same in miniflare plugin
cloudflare · Mar 1, 2024 · 0e82e17 · 0e82e17
1 parent bdff159
commit 0e82e17
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 7 deletions.
diff --git a/.changeset/twenty-laws-mix.md b/.changeset/twenty-laws-mix.md
@@ -0,0 +1,6 @@
+---
+"miniflare": minor
+"wrangler": minor
+---
+
+URL decode components of the Hyperdrive config connection string
diff --git a/packages/miniflare/src/plugins/hyperdrive/index.ts b/packages/miniflare/src/plugins/hyperdrive/index.ts
@@ -81,9 +81,9 @@ export const HYPERDRIVE_PLUGIN: Plugin<typeof HyperdriveInputOptionsSchema> = {
 						designator: {
 							name: `${HYPERDRIVE_PLUGIN_NAME}:${name}`,
 						},
-						database,
+						database: decodeURIComponent(database),
 						user: url.username,
-						password: url.password,
+						password: decodeURIComponent(url.password),
 						scheme,
 					},
 				};

diff --git a/packages/wrangler/e2e/dev.test.ts b/packages/wrangler/e2e/dev.test.ts
@@ -451,7 +451,7 @@ describe("hyperdrive dev tests", () => {
 					[[hyperdrive]]
 					binding = "HYPERDRIVE"
 					id = "hyperdrive_id"
-					localConnectionString = "postgresql://user:pass@127.0.0.1:${port}/some_db"
+					localConnectionString = "postgresql://user:%21pass@127.0.0.1:${port}/some_db"
 			`,
 			"src/index.ts": dedent`
 					export default {
@@ -484,7 +484,7 @@ describe("hyperdrive dev tests", () => {
 			const url = new URL(text);
 			expect(url.pathname).toBe("/some_db");
 			expect(url.username).toBe("user");
-			expect(url.password).toBe("pass");
+			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
@@ -178,6 +178,54 @@ describe("hyperdrive commands", () => {
 	`);
 	});
 
+	it("should handle creating a hyperdrive config if the password is URL encoded", async () => {
+		mockHyperdriveRequest();
+		await runWrangler(
+			"hyperdrive create test123 --connection-string='postgresql://test:a%23%3F81n%287@foo.us-east-2.aws.neon.tech/neondb'"
+		);
+		expect(std.out).toMatchInlineSnapshot(`
+		"🚧 Creating 'test123'
+		✅ Created new Hyperdrive config
+		 {
+		  \\"id\\": \\"7a040c1eee714e91a30ea6707a2d125c\\",
+		  \\"name\\": \\"test123\\",
+		  \\"origin\\": {
+		    \\"host\\": \\"foo.us-east-2.aws.neon.tech\\",
+		    \\"port\\": 5432,
+		    \\"database\\": \\"neondb\\",
+		    \\"user\\": \\"test\\"
+		  },
+		  \\"caching\\": {
+		    \\"disabled\\": false
+		  }
+		}"
+	`);
+	});
+
+	it("should handle creating a hyperdrive config if the database name is URL encoded", async () => {
+		mockHyperdriveRequest();
+		await runWrangler(
+			"hyperdrive create test123 --connection-string='postgresql://test:password@foo.us-east-2.aws.neon.tech/%22weird%22%20dbname'"
+		);
+		expect(std.out).toMatchInlineSnapshot(`
+		"🚧 Creating 'test123'
+		✅ Created new Hyperdrive config
+		 {
+		  \\"id\\": \\"7a040c1eee714e91a30ea6707a2d125c\\",
+		  \\"name\\": \\"test123\\",
+		  \\"origin\\": {
+		    \\"host\\": \\"foo.us-east-2.aws.neon.tech\\",
+		    \\"port\\": 5432,
+		    \\"database\\": \\"/\\"weird/\\" dbname\\",
+		    \\"user\\": \\"test\\"
+		  },
+		  \\"caching\\": {
+		    \\"disabled\\": false
+		  }
+		}"
+	`);
+	});
+
 	it("should handle listing configs", async () => {
 		mockHyperdriveRequest();
 		await runWrangler("hyperdrive list");

diff --git a/packages/wrangler/src/hyperdrive/create.ts b/packages/wrangler/src/hyperdrive/create.ts
@@ -88,9 +88,9 @@ export async function handler(
 				host: url.hostname,
 				port: parseInt(url.port),
 				scheme: url.protocol.replace(":", ""),
-				database: url.pathname.replace("/", ""),
+				database: decodeURIComponent(url.pathname.replace("/", "")),
 				user: url.username,
-				password: url.password,
+				password: decodeURIComponent(url.password),
 			},
 			caching: {
 				disabled: args.cachingDisabled,
@@ -103,4 +103,4 @@ export async function handler(
 			JSON.stringify(database, null, 2)
 		);
 	}
-}
+}