enable hyperdrive bindings in getPlatformProxy (cloudflare#6612)

* fix: fix hyperdrive bindings not getting proxied by miniflare

* skip hyperdrive e2e test in windows

.changeset/gold-maps-itch.md

@@ -0,0 +1,42 @@
+---
+"wrangler": patch
+---
+
+fix: Add hyperdrive binding support in `getPlatformProxy`
+
+example:
+
+```toml
+# wrangler.toml
+[[hyperdrive]]
+binding = "MY_HYPERDRIVE"
+id = "000000000000000000000000000000000"
+localConnectionString = "postgres://user:pass@127.0.0.1:1234/db"
+```
+
+```js
+// index.mjs
+
+import postgres from "postgres";
+import { getPlatformProxy } from "wrangler";
+
+const { env, dispose } = await getPlatformProxy();
+
+try {
+	const sql = postgres(
+		// Note: connectionString points to `postgres://user:pass@127.0.0.1:1234/db` not to the actual hyperdrive
+		//       connection string, for more details see the explanation below
+		env.MY_HYPERDRIVE.connectionString
+	);
+	const results = await sql`SELECT * FROM pg_tables`;
+	await sql.end();
+} catch (e) {
+	console.error(e);
+}
+
+await dispose();
+```
+
+Note: the returned binding values are no-op/passthrough that can be used inside node.js, meaning
+that besides direct connections via the `connect` methods, all the other values point to the
+same db connection specified in the user configuration

.changeset/slimy-waves-dance.md

@@ -0,0 +1,9 @@
+---
+"miniflare": patch
+---
+
+fix: add hyperdrive bindings support in `getBindings`
+
+Note: the returned binding values are no-op/passthrough that can be used inside node.js, meaning
+that besides direct connections via the `connect` methods, all the other values point to the
+same db connection specified in the user configuration

fixtures/get-platform-proxy/tests/get-platform-proxy.env.test.ts

@@ -1,4 +1,5 @@
 import { readdir } from "fs/promises";
+import * as nodeNet from "node:net";
 import path from "path";
 import {
 	D1Database,
@@ -18,7 +19,12 @@ import {
 import { unstable_dev } from "wrangler";
 import { getPlatformProxy } from "./shared";
 import type { NamedEntrypoint } from "../workers/rpc-worker";
-import type { KVNamespace, Rpc, Service } from "@cloudflare/workers-types";
+import type {
+	Hyperdrive,
+	KVNamespace,
+	Rpc,
+	Service,
+} from "@cloudflare/workers-types";
 import type { UnstableDevWorker } from "wrangler";
 
 type Env = {
@@ -35,6 +41,7 @@ type Env = {
 	MY_DO_B: DurableObjectNamespace;
 	MY_BUCKET: R2Bucket;
 	MY_D1: D1Database;
+	MY_HYPERDRIVE: Hyperdrive;
 };
 
 const wranglerTomlFilePath = path.join(__dirname, "..", "wrangler.toml");
@@ -303,6 +310,27 @@ describe("getPlatformProxy - env", () => {
 		}
 	});
 
+	// Important: the hyperdrive values are passthrough ones since the workerd specific hyperdrive values only make sense inside
+	//            workerd itself and would simply not work in a node.js process
+	it("correctly obtains passthrough Hyperdrive bindings", async () => {
+		const { env, dispose } = await getPlatformProxy<Env>({
+			configPath: wranglerTomlFilePath,
+		});
+		try {
+			const { MY_HYPERDRIVE } = env;
+			expect(MY_HYPERDRIVE.connectionString).toEqual(
+				"postgres://user:pass@127.0.0.1:1234/db"
+			);
+			expect(MY_HYPERDRIVE.database).toEqual("db");
+			expect(MY_HYPERDRIVE.host).toEqual("127.0.0.1");
+			expect(MY_HYPERDRIVE.user).toEqual("user");
+			expect(MY_HYPERDRIVE.password).toEqual("pass");
+			expect(MY_HYPERDRIVE.port).toEqual(1234);
+		} finally {
+			await dispose();
+		}
+	});
+
 	describe("with a target environment", () => {
 		it("should provide bindings targeting a specified environment and also inherit top-level ones", async () => {
 			const { env, dispose } = await getPlatformProxy<Env>({

fixtures/get-platform-proxy/wrangler.toml

@@ -27,6 +27,11 @@ bindings = [
   { name = "MY_DO_B", script_name = "do-worker-b", class_name = "DurableObjectClass" }
 ]
 
+[[hyperdrive]]
+binding = "MY_HYPERDRIVE"
+id = "000000000000000000000000000000000"
+localConnectionString = "postgres://user:pass@127.0.0.1:1234/db"
+
 [[d1_databases]]
 binding = "MY_D1"
 database_name = "test-db"

packages/miniflare/src/index.ts

@@ -39,13 +39,13 @@ import {
 	getDirectSocketName,
 	getGlobalServices,
 	HOST_CAPNP_CONNECT,
-	kProxyNodeBinding,
 	KV_PLUGIN_NAME,
 	normaliseDurableObject,
 	PLUGIN_ENTRIES,
 	Plugins,
 	PluginServicesOptions,
 	ProxyClient,
+	ProxyNodeBinding,
 	QueueConsumers,
 	QueueProducers,
 	QUEUES_PLUGIN_NAME,
@@ -1668,13 +1668,16 @@ export class Miniflare {
 			//  missing in other plugins' options.
 			const pluginBindings = await plugin.getNodeBindings(workerOpts[key]);
 			for (const [name, binding] of Object.entries(pluginBindings)) {
-				if (binding === kProxyNodeBinding) {
+				if (binding instanceof ProxyNodeBinding) {
 					const proxyBindingName = getProxyBindingName(key, workerName, name);
-					const proxy = proxyClient.env[proxyBindingName];
+					let proxy = proxyClient.env[proxyBindingName];
 					assert(
 						proxy !== undefined,
 						`Expected ${proxyBindingName} to be bound`
 					);
+					if (binding.proxyOverrideHandler) {
+						proxy = new Proxy(proxy, binding.proxyOverrideHandler);
+					}
 					bindings[name] = proxy;
 				} else {
 					bindings[name] = binding;

packages/miniflare/src/plugins/assets/index.ts

@@ -10,7 +10,7 @@ import { z } from "zod";
 import { Service } from "../../runtime";
 import { SharedBindings } from "../../workers";
 import { getUserServiceName } from "../core";
-import { kProxyNodeBinding, Plugin } from "../shared";
+import { Plugin, ProxyNodeBinding } from "../shared";
 import {
 	ASSETS_KV_SERVICE_NAME,
 	ASSETS_PLUGIN_NAME,
@@ -39,7 +39,7 @@ export const ASSETS_PLUGIN: Plugin<typeof AssetsOptionsSchema> = {
 			return {};
 		}
 		return {
-			[options.assets.bindingName]: kProxyNodeBinding,
+			[options.assets.bindingName]: new ProxyNodeBinding(),
 		};
 	},
 

packages/miniflare/src/plugins/core/index.ts

@@ -36,10 +36,10 @@ import {
 import { getCacheServiceName } from "../cache";
 import { DURABLE_OBJECTS_STORAGE_SERVICE_NAME } from "../do";
 import {
-	kProxyNodeBinding,
 	kUnsafeEphemeralUniqueKey,
 	parseRoutes,
 	Plugin,
+	ProxyNodeBinding,
 	SERVICE_LOOPBACK,
 	WORKER_BINDING_SERVICE_LOOPBACK,
 } from "../shared";
@@ -473,15 +473,15 @@ export const CORE_PLUGIN: Plugin<
 			bindingEntries.push(
 				...Object.keys(options.serviceBindings).map((name) => [
 					name,
-					kProxyNodeBinding,
+					new ProxyNodeBinding(),
 				])
 			);
 		}
 		if (options.wrappedBindings !== undefined) {
 			bindingEntries.push(
 				...Object.keys(options.wrappedBindings).map((name) => [
 					name,
-					kProxyNodeBinding,
+					new ProxyNodeBinding(),
 				])
 			);
 		}

packages/miniflare/src/plugins/d1/index.ts

@@ -10,13 +10,13 @@ import { SharedBindings } from "../../workers";
 import {
 	getMiniflareObjectBindings,
 	getPersistPath,
-	kProxyNodeBinding,
 	migrateDatabase,
 	namespaceEntries,
 	namespaceKeys,
 	objectEntryWorker,
 	PersistenceSchema,
 	Plugin,
+	ProxyNodeBinding,
 	SERVICE_LOOPBACK,
 } from "../shared";
 
@@ -69,7 +69,7 @@ export const D1_PLUGIN: Plugin<
 	getNodeBindings(options) {
 		const databases = namespaceKeys(options.d1Databases);
 		return Object.fromEntries(
-			databases.map((name) => [name, kProxyNodeBinding])
+			databases.map((name) => [name, new ProxyNodeBinding()])
 		);
 	},
 	async getServices({

packages/miniflare/src/plugins/do/index.ts

@@ -4,10 +4,10 @@ import { Worker_Binding } from "../../runtime";
 import { getUserServiceName } from "../core";
 import {
 	getPersistPath,
-	kProxyNodeBinding,
 	kUnsafeEphemeralUniqueKey,
 	PersistenceSchema,
 	Plugin,
+	ProxyNodeBinding,
 	UnsafeUniqueKey,
 } from "../shared";
 
@@ -83,7 +83,9 @@ export const DURABLE_OBJECTS_PLUGIN: Plugin<
 	},
 	getNodeBindings(options) {
 		const objects = Object.keys(options.durableObjects ?? {});
-		return Object.fromEntries(objects.map((name) => [name, kProxyNodeBinding]));
+		return Object.fromEntries(
+			objects.map((name) => [name, new ProxyNodeBinding()])
+		);
 	},
 	async getServices({
 		sharedOptions,

packages/miniflare/src/plugins/hyperdrive/index.ts

@@ -1,7 +1,7 @@
 import assert from "node:assert";
 import { z } from "zod";
 import { Service, Worker_Binding } from "../../runtime";
-import { Plugin } from "../shared";
+import { Plugin, ProxyNodeBinding } from "../shared";
 
 export const HYPERDRIVE_PLUGIN_NAME = "hyperdrive";
 
@@ -90,8 +90,24 @@ export const HYPERDRIVE_PLUGIN: Plugin<typeof HyperdriveInputOptionsSchema> = {
 			}
 		);
 	},
-	getNodeBindings() {
-		return {};
+	getNodeBindings(options) {
+		return Object.fromEntries(
+			Object.entries(options.hyperdrives ?? {}).map(([name, url]) => {
+				const connectionOverrides: Record<string | symbol, string | number> = {
+					connectionString: `${url}`,
+					port: Number.parseInt(url.port),
+					host: url.hostname,
+				};
+				const proxyNodeBinding = new ProxyNodeBinding({
+					get(target, prop) {
+						return prop in connectionOverrides
+							? connectionOverrides[prop]
+							: target[prop];
+					},
+				});
+				return [name, proxyNodeBinding];
+			})
+		);
 	},
 	async getServices({ options }) {
 		return Object.entries(options.hyperdrives ?? {}).map<Service>(

packages/miniflare/src/plugins/kv/index.ts

@@ -11,13 +11,13 @@ import { SharedBindings } from "../../workers";
 import {
 	getMiniflareObjectBindings,
 	getPersistPath,
-	kProxyNodeBinding,
 	migrateDatabase,
 	namespaceEntries,
 	namespaceKeys,
 	objectEntryWorker,
 	PersistenceSchema,
 	Plugin,
+	ProxyNodeBinding,
 	SERVICE_LOOPBACK,
 } from "../shared";
 import { KV_PLUGIN_NAME } from "./constants";
@@ -77,7 +77,7 @@ export const KV_PLUGIN: Plugin<
 	async getNodeBindings(options) {
 		const namespaces = namespaceKeys(options.kvNamespaces);
 		const bindings = Object.fromEntries(
-			namespaces.map((name) => [name, kProxyNodeBinding])
+			namespaces.map((name) => [name, new ProxyNodeBinding()])
 		);
 
 		if (isWorkersSitesEnabled(options)) {

packages/miniflare/src/plugins/kv/sites.ts

@@ -12,7 +12,7 @@ import {
 	SiteMatcherRegExps,
 	testSiteRegExps,
 } from "../../workers";
-import { kProxyNodeBinding } from "../shared";
+import { ProxyNodeBinding } from "../shared";
 import { KV_PLUGIN_NAME } from "./constants";
 
 async function* listKeysInDirectoryInner(
@@ -97,7 +97,7 @@ export async function getSitesNodeBindings(
 		siteRegExps
 	);
 	return {
-		[SiteBindings.KV_NAMESPACE_SITE]: kProxyNodeBinding,
+		[SiteBindings.KV_NAMESPACE_SITE]: new ProxyNodeBinding(),
 		[SiteBindings.JSON_SITE_MANIFEST]: __STATIC_CONTENT_MANIFEST,
 	};
 }

packages/miniflare/src/plugins/queues/index.ts

@@ -15,9 +15,9 @@ import {
 import { getUserServiceName } from "../core";
 import {
 	getMiniflareObjectBindings,
-	kProxyNodeBinding,
 	objectEntryWorker,
 	Plugin,
+	ProxyNodeBinding,
 	SERVICE_LOOPBACK,
 } from "../shared";
 
@@ -53,7 +53,9 @@ export const QUEUES_PLUGIN: Plugin<typeof QueuesOptionsSchema> = {
 	},
 	getNodeBindings(options) {
 		const queues = bindingKeys(options.queueProducers);
-		return Object.fromEntries(queues.map((name) => [name, kProxyNodeBinding]));
+		return Object.fromEntries(
+			queues.map((name) => [name, new ProxyNodeBinding()])
+		);
 	},
 	async getServices({
 		options,

packages/miniflare/src/plugins/r2/index.ts

@@ -10,13 +10,13 @@ import { SharedBindings } from "../../workers";
 import {
 	getMiniflareObjectBindings,
 	getPersistPath,
-	kProxyNodeBinding,
 	migrateDatabase,
 	namespaceEntries,
 	namespaceKeys,
 	objectEntryWorker,
 	PersistenceSchema,
 	Plugin,
+	ProxyNodeBinding,
 	SERVICE_LOOPBACK,
 } from "../shared";
 
@@ -51,7 +51,9 @@ export const R2_PLUGIN: Plugin<
 	},
 	getNodeBindings(options) {
 		const buckets = namespaceKeys(options.r2Buckets);
-		return Object.fromEntries(buckets.map((name) => [name, kProxyNodeBinding]));
+		return Object.fromEntries(
+			buckets.map((name) => [name, new ProxyNodeBinding()])
+		);
 	},
 	async getServices({
 		options,

packages/miniflare/src/plugins/ratelimit/index.ts

@@ -1,7 +1,7 @@
 import SCRIPT_RATELIMIT_OBJECT from "worker:ratelimit/ratelimit";
 import { z } from "zod";
 import { Worker_Binding } from "../../runtime";
-import { kProxyNodeBinding, Plugin } from "../shared";
+import { Plugin, ProxyNodeBinding } from "../shared";
 
 export enum PeriodType {
 	TENSECONDS = 10,
@@ -57,7 +57,10 @@ export const RATELIMIT_PLUGIN: Plugin<typeof RatelimitOptionsSchema> = {
 			return {};
 		}
 		return Object.fromEntries(
-			Object.keys(options.ratelimits).map((name) => [name, kProxyNodeBinding])
+			Object.keys(options.ratelimits).map((name) => [
+				name,
+				new ProxyNodeBinding(),
+			])
 		);
 	},
 	async getServices({ options }) {