Add Hyperdrive Bindings (#718)

* Add Hyperdrive Binding support

* Add tests for the hyperdrive binding

Author: tmthecoder

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

@@ -0,0 +1,109 @@
+import { z } from "zod";
+import { Service, Worker_Binding } from "../../runtime";
+import { Plugin } from "../shared";
+
+export const HYPERDRIVE_PLUGIN_NAME = "hyperdrive";
+
+export const HyperdriveSchema = z
+  .string()
+  .url()
+  .transform((urlString, ctx) => {
+    const url = new URL(urlString);
+    if (url.protocol === "") {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "You must specify the database protocol - e.g. 'postgresql'.",
+      });
+    } else if (
+      url.protocol !== "postgresql:" &&
+      url.protocol !== "postgres:" &&
+      url.protocol !== ""
+    ) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message:
+          "Only PostgreSQL or PostgreSQL compatible databases are currently supported.",
+      });
+    }
+    if (url.host === "") {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message:
+          "You must provide a hostname or IP address in your connection string - e.g. 'user:[email protected]:5432/databasename",
+      });
+    }
+    if (url.port === "") {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message:
+          "You must provide a port number - e.g. 'user:[email protected]:port/databasename",
+      });
+    }
+    if (url.pathname === "") {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message:
+          "You must provide a database name as the path component - e.g. /postgres",
+      });
+    }
+    if (url.username === "") {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message:
+          "You must provide a username - e.g. 'user:[email protected]:port/databasename'",
+      });
+    }
+    if (url.password === "") {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message:
+          "You must provide a password - e.g. 'user:[email protected]:port/databasename' ",
+      });
+    }
+    return {
+      database: url.pathname.replace("/", ""),
+      user: url.username,
+      password: url.password,
+      scheme: url.protocol.replace(":", ""),
+      host: url.host,
+      port: url.port,
+    };
+  });
+
+export const HyperdriveInputOptionsSchema = z.object({
+  hyperdrives: z.record(z.string(), HyperdriveSchema).optional(),
+});
+
+export const HYPERDRIVE_PLUGIN: Plugin<typeof HyperdriveInputOptionsSchema> = {
+  options: HyperdriveInputOptionsSchema,
+  getBindings(options) {
+    return Object.entries(options.hyperdrives ?? {}).map<Worker_Binding>(
+      ([name, config]) => ({
+        name,
+        hyperdrive: {
+          designator: {
+            name: `${HYPERDRIVE_PLUGIN_NAME}:${name}`,
+          },
+          database: config.database,
+          user: config.user,
+          password: config.password,
+          scheme: config.scheme,
+        },
+      })
+    );
+  },
+  getNodeBindings() {
+    return {};
+  },
+  async getServices({ options }) {
+    return Object.entries(options.hyperdrives ?? {}).map<Service>(
+      ([name, config]) => ({
+        name: `${HYPERDRIVE_PLUGIN_NAME}:${name}`,
+        external: {
+          address: `${config.host}:${config.port}`,
+          tcp: {},
+        },
+      })
+    );
+  },
+};

packages/miniflare/src/plugins/index.ts

@@ -4,6 +4,7 @@ import { CACHE_PLUGIN, CACHE_PLUGIN_NAME } from "./cache";
 import { CORE_PLUGIN, CORE_PLUGIN_NAME } from "./core";
 import { D1_PLUGIN, D1_PLUGIN_NAME } from "./d1";
 import { DURABLE_OBJECTS_PLUGIN, DURABLE_OBJECTS_PLUGIN_NAME } from "./do";
+import { HYPERDRIVE_PLUGIN, HYPERDRIVE_PLUGIN_NAME } from "./hyperdrive";
 import { KV_PLUGIN, KV_PLUGIN_NAME } from "./kv";
 import { QUEUES_PLUGIN, QUEUES_PLUGIN_NAME } from "./queues";
 import { R2_PLUGIN, R2_PLUGIN_NAME } from "./r2";
@@ -16,6 +17,7 @@ export const PLUGINS = {
   [KV_PLUGIN_NAME]: KV_PLUGIN,
   [QUEUES_PLUGIN_NAME]: QUEUES_PLUGIN,
   [R2_PLUGIN_NAME]: R2_PLUGIN,
+  [HYPERDRIVE_PLUGIN_NAME]: HYPERDRIVE_PLUGIN,
 };
 export type Plugins = typeof PLUGINS;
 
@@ -60,7 +62,8 @@ export type WorkerOptions = z.infer<typeof CORE_PLUGIN.options> &
   z.infer<typeof DURABLE_OBJECTS_PLUGIN.options> &
   z.infer<typeof KV_PLUGIN.options> &
   z.infer<typeof QUEUES_PLUGIN.options> &
-  z.infer<typeof R2_PLUGIN.options>;
+  z.infer<typeof R2_PLUGIN.options> &
+  z.input<typeof HYPERDRIVE_PLUGIN.options>;
 export type SharedOptions = z.infer<typeof CORE_PLUGIN.sharedOptions> &
   z.infer<typeof CACHE_PLUGIN.sharedOptions> &
   z.infer<typeof D1_PLUGIN.sharedOptions> &
@@ -104,3 +107,4 @@ export * from "./do";
 export * from "./kv";
 export * from "./queues";
 export * from "./r2";
+export * from "./hyperdrive";

packages/miniflare/test/plugins/hyperdrive/index.spec.ts

@@ -0,0 +1,36 @@
+import { Hyperdrive } from "@cloudflare/workers-types/experimental";
+import { MiniflareOptions } from "miniflare";
+import { MiniflareTestContext, miniflareTest } from "../../test-shared";
+
+const TEST_CONN_STRING = `postgresql://user:password@localhost:5432/database`;
+
+const opts: Partial<MiniflareOptions> = {
+  hyperdrives: {
+    hyperdrive: TEST_CONN_STRING,
+  },
+};
+
+const test = miniflareTest<{ hyperdrive: Hyperdrive }, MiniflareTestContext>(
+  opts,
+  async (global, _, env) => {
+    return global.Response.json({
+      connectionString: env.hyperdrive.connectionString,
+      user: env.hyperdrive.user,
+      password: env.hyperdrive.password,
+      database: env.hyperdrive.database,
+      host: env.hyperdrive.host,
+    });
+  }
+);
+
+test("configuration: fields match expected", async (t) => {
+  const hyperdriveResp = await t.context.mf.dispatchFetch("http://localhost/");
+  const hyperdrive: any = await hyperdriveResp.json();
+  // Since the host is random, this connectionString should be different
+  t.not(hyperdrive.connectionString, TEST_CONN_STRING);
+  t.is(hyperdrive.user, "user");
+  t.is(hyperdrive.password, "password");
+  t.is(hyperdrive.database, "database");
+  // Random host should not be the same as the original
+  t.not(hyperdrive.host, "localhost");
+});