refactored adapters to run test suites (#126)

* refactored adapters to run test suites

* fix bun version for tests

* added missing adapter tests and refactored examples to use `bknd.config.ts` where applicable

app/src/adapter/cloudflare/cloudflare-workers.adapter.spec.ts

@@ -0,0 +1,60 @@
+import { afterAll, beforeAll, describe, expect, it } from "bun:test";
+import { makeApp } from "./modes/fresh";
+import { makeConfig } from "./config";
+import { disableConsoleLog, enableConsoleLog } from "core/utils";
+import { adapterTestSuite } from "adapter/adapter-test-suite";
+import { bunTestRunner } from "adapter/bun/test";
+import type { CloudflareBkndConfig } from "./cloudflare-workers.adapter";
+
+beforeAll(disableConsoleLog);
+afterAll(enableConsoleLog);
+
+describe("cf adapter", () => {
+   const DB_URL = ":memory:";
+   const $ctx = (env?: any, request?: Request, ctx?: ExecutionContext) => ({
+      request: request ?? (null as any),
+      env: env ?? { DB_URL },
+      ctx: ctx ?? (null as any),
+   });
+
+   it("makes config", async () => {
+      expect(
+         makeConfig(
+            {
+               connection: { url: DB_URL },
+            },
+            {},
+         ),
+      ).toEqual({ connection: { url: DB_URL } });
+
+      expect(
+         makeConfig(
+            {
+               app: (env) => ({
+                  connection: { url: env.DB_URL },
+               }),
+            },
+            {
+               DB_URL,
+            },
+         ),
+      ).toEqual({ connection: { url: DB_URL } });
+   });
+
+   adapterTestSuite<CloudflareBkndConfig, object>(bunTestRunner, {
+      makeApp,
+      makeHandler: (c, a, o) => {
+         return async (request: any) => {
+            const app = await makeApp(
+               // needs a fallback, otherwise tries to launch D1
+               c ?? {
+                  connection: { url: DB_URL },
+               },
+               a,
+               o,
+            );
+            return app.fetch(request);
+         };
+      },
+   });
+});

app/src/adapter/cloudflare/cloudflare-workers.adapter.ts

@@ -1,19 +1,16 @@
 /// <reference types="@cloudflare/workers-types" />
 
-import { type FrameworkBkndConfig, makeConfig } from "bknd/adapter";
+import type { FrameworkBkndConfig } from "bknd/adapter";
 import { Hono } from "hono";
 import { serveStatic } from "hono/cloudflare-workers";
-import { D1Connection } from "./D1Connection";
-import { registerMedia } from "./StorageR2Adapter";
-import { getBinding } from "./bindings";
 import { getCached } from "./modes/cached";
 import { getDurable } from "./modes/durable";
 import { getFresh, getWarm } from "./modes/fresh";
-import type { CreateAppConfig } from "App";
 
-export type CloudflareBkndConfig<Env = any> = FrameworkBkndConfig<Context<Env>> & {
+export type CloudflareEnv = object;
+export type CloudflareBkndConfig<Env = CloudflareEnv> = FrameworkBkndConfig<Env> & {
    mode?: "warm" | "fresh" | "cache" | "durable";
-   bindings?: (args: Context<Env>) => {
+   bindings?: (args: Env) => {
       kv?: KVNamespace;
       dobj?: DurableObjectNamespace;
       db?: D1Database;
@@ -27,58 +24,15 @@ export type CloudflareBkndConfig<Env = any> = FrameworkBkndConfig<Context<Env>>
    html?: string;
 };
 
-export type Context<Env = any> = {
+export type Context<Env = CloudflareEnv> = {
    request: Request;
    env: Env;
    ctx: ExecutionContext;
 };
 
-export const constants = {
-   exec_async_event_id: "cf_register_waituntil",
-   cache_endpoint: "/__bknd/cache",
-   do_endpoint: "/__bknd/do",
-};
-
-let media_registered: boolean = false;
-export function makeCfConfig(config: CloudflareBkndConfig, context: Context): CreateAppConfig {
-   if (!media_registered) {
-      registerMedia(context.env as any);
-      media_registered = true;
-   }
-
-   const appConfig = makeConfig(config, context);
-   const bindings = config.bindings?.(context);
-   if (!appConfig.connection) {
-      let db: D1Database | undefined;
-      if (bindings?.db) {
-         console.log("Using database from bindings");
-         db = bindings.db;
-      } else if (Object.keys(context.env ?? {}).length > 0) {
-         const binding = getBinding(context.env, "D1Database");
-         if (binding) {
-            console.log(`Using database from env "${binding.key}"`);
-            db = binding.value;
-         }
-      }
-
-      if (db) {
-         appConfig.connection = new D1Connection({ binding: db });
-      } else {
-         throw new Error("No database connection given");
-      }
-   }
-
-   return {
-      ...appConfig,
-      options: {
-         ...appConfig.options,
-         // if not specified explicitly, disable it to use ExecutionContext's waitUntil
-         asyncEventsMode: config.options?.asyncEventsMode ?? "none",
-      },
-   };
-}
-
-export function serve<Env = any>(config: CloudflareBkndConfig<Env> = {}) {
+export function serve<Env extends CloudflareEnv = CloudflareEnv>(
+   config: CloudflareBkndConfig<Env> = {},
+) {
    return {
       async fetch(request: Request, env: Env, ctx: ExecutionContext) {
          const url = new URL(request.url);
@@ -113,7 +67,7 @@ export function serve<Env = any>(config: CloudflareBkndConfig<Env> = {}) {
             }
          }
 
-         const context = { request, env, ctx } as Context;
+         const context = { request, env, ctx } as Context<Env>;
          const mode = config.mode ?? "warm";
 
          switch (mode) {

app/src/adapter/cloudflare/config.ts

@@ -0,0 +1,64 @@
+import { registerMedia } from "./storage/StorageR2Adapter";
+import { getBinding } from "./bindings";
+import { D1Connection } from "./D1Connection";
+import type { CloudflareBkndConfig, CloudflareEnv } from ".";
+import { App } from "bknd";
+import { makeConfig as makeAdapterConfig } from "bknd/adapter";
+import type { ExecutionContext } from "hono";
+
+export const constants = {
+   exec_async_event_id: "cf_register_waituntil",
+   cache_endpoint: "/__bknd/cache",
+   do_endpoint: "/__bknd/do",
+};
+
+let media_registered: boolean = false;
+export function makeConfig<Env extends CloudflareEnv = CloudflareEnv>(
+   config: CloudflareBkndConfig<Env>,
+   args: Env = {} as Env,
+) {
+   if (!media_registered) {
+      registerMedia(args as any);
+      media_registered = true;
+   }
+
+   const appConfig = makeAdapterConfig(config, args);
+   const bindings = config.bindings?.(args);
+   if (!appConfig.connection) {
+      let db: D1Database | undefined;
+      if (bindings?.db) {
+         console.log("Using database from bindings");
+         db = bindings.db;
+      } else if (Object.keys(args).length > 0) {
+         const binding = getBinding(args, "D1Database");
+         if (binding) {
+            console.log(`Using database from env "${binding.key}"`);
+            db = binding.value;
+         }
+      }
+
+      if (db) {
+         appConfig.connection = new D1Connection({ binding: db });
+      } else {
+         throw new Error("No database connection given");
+      }
+   }
+
+   return appConfig;
+}
+
+export function registerAsyncsExecutionContext(
+   app: App,
+   ctx: { waitUntil: ExecutionContext["waitUntil"] },
+) {
+   app.emgr.onEvent(
+      App.Events.AppBeforeResponse,
+      async (event) => {
+         ctx.waitUntil(event.params.app.emgr.executeAsyncs());
+      },
+      {
+         mode: "sync",
+         id: constants.exec_async_event_id,
+      },
+   );
+}

app/src/adapter/cloudflare/modes/cached.ts

@@ -1,8 +1,12 @@
 import { App } from "bknd";
 import { createRuntimeApp } from "bknd/adapter";
-import { type CloudflareBkndConfig, constants, type Context, makeCfConfig } from "../index";
+import type { CloudflareBkndConfig, Context, CloudflareEnv } from "../index";
+import { makeConfig, registerAsyncsExecutionContext, constants } from "../config";
 
-export async function getCached(config: CloudflareBkndConfig, { env, ctx, ...args }: Context) {
+export async function getCached<Env extends CloudflareEnv = CloudflareEnv>(
+   config: CloudflareBkndConfig<Env>,
+   { env, ctx, ...args }: Context<Env>,
+) {
    const { kv } = config.bindings?.(env)!;
    if (!kv) throw new Error("kv namespace is not defined in cloudflare.bindings");
    const key = config.key ?? "app";
@@ -16,9 +20,10 @@ export async function getCached(config: CloudflareBkndConfig, { env, ctx, ...arg
 
    const app = await createRuntimeApp(
       {
-         ...makeCfConfig(config, { env, ctx, ...args }),
+         ...makeConfig(config, env),
          initialConfig,
          onBuilt: async (app) => {
+            registerAsyncsExecutionContext(app, ctx);
             app.module.server.client.get(constants.cache_endpoint, async (c) => {
                await kv.delete(key);
                return c.json({ message: "Cache cleared" });
@@ -26,16 +31,6 @@ export async function getCached(config: CloudflareBkndConfig, { env, ctx, ...arg
             await config.onBuilt?.(app);
          },
          beforeBuild: async (app) => {
-            app.emgr.onEvent(
-               App.Events.AppBeforeResponse,
-               async (event) => {
-                  ctx.waitUntil(event.params.app.emgr.executeAsyncs());
-               },
-               {
-                  mode: "sync",
-                  id: constants.exec_async_event_id,
-               },
-            );
             app.emgr.onEvent(
                App.Events.AppConfigUpdatedEvent,
                async ({ params: { app } }) => {

app/src/adapter/cloudflare/modes/durable.ts

@@ -1,9 +1,13 @@
 import { DurableObject } from "cloudflare:workers";
-import { App, type CreateAppConfig } from "bknd";
+import type { App, CreateAppConfig } from "bknd";
 import { createRuntimeApp, makeConfig } from "bknd/adapter";
-import { type CloudflareBkndConfig, type Context, constants } from "../index";
+import type { CloudflareBkndConfig, Context, CloudflareEnv } from "../index";
+import { constants, registerAsyncsExecutionContext } from "../config";
 
-export async function getDurable(config: CloudflareBkndConfig, ctx: Context) {
+export async function getDurable<Env extends CloudflareEnv = CloudflareEnv>(
+   config: CloudflareBkndConfig<Env>,
+   ctx: Context<Env>,
+) {
    const { dobj } = config.bindings?.(ctx.env)!;
    if (!dobj) throw new Error("durable object is not defined in cloudflare.bindings");
    const key = config.key ?? "app";
@@ -17,7 +21,7 @@ export async function getDurable(config: CloudflareBkndConfig, ctx: Context) {
    const id = dobj.idFromName(key);
    const stub = dobj.get(id) as unknown as DurableBkndApp;
 
-   const create_config = makeConfig(config, ctx);
+   const create_config = makeConfig(config, ctx.env);
 
    const res = await stub.fire(ctx.request, {
       config: create_config,
@@ -67,16 +71,7 @@ export class DurableBkndApp extends DurableObject {
          this.app = await createRuntimeApp({
             ...config,
             onBuilt: async (app) => {
-               app.emgr.onEvent(
-                  App.Events.AppBeforeResponse,
-                  async (event) => {
-                     this.ctx.waitUntil(event.params.app.emgr.executeAsyncs());
-                  },
-                  {
-                     mode: "sync",
-                     id: constants.exec_async_event_id,
-                  },
-               );
+               registerAsyncsExecutionContext(app, this.ctx);
                app.modules.server.get(constants.do_endpoint, async (c) => {
                   // @ts-ignore
                   const context: any = c.req.raw.cf ? c.req.raw.cf : c.env.cf;

app/src/adapter/cloudflare/modes/fresh.ts

@@ -1,40 +1,48 @@
-import { App } from "bknd";
-import { createRuntimeApp } from "bknd/adapter";
-import { type CloudflareBkndConfig, type Context, makeCfConfig, constants } from "../index";
+import { createRuntimeApp, type RuntimeOptions } from "bknd/adapter";
+import type { CloudflareBkndConfig, Context, CloudflareEnv } from "../index";
+import { makeConfig, registerAsyncsExecutionContext } from "../config";
 
-export async function makeApp(config: CloudflareBkndConfig, ctx: Context) {
-   return await createRuntimeApp(
+export async function makeApp<Env extends CloudflareEnv = CloudflareEnv>(
+   config: CloudflareBkndConfig<Env>,
+   args: Env = {} as Env,
+   opts?: RuntimeOptions,
+) {
+   return await createRuntimeApp<Env>(
       {
-         ...makeCfConfig(config, ctx),
+         ...makeConfig(config, args),
          adminOptions: config.html ? { html: config.html } : undefined,
-         onBuilt: async (app) => {
-            app.emgr.onEvent(
-               App.Events.AppBeforeResponse,
-               async (event) => {
-                  ctx.ctx.waitUntil(event.params.app.emgr.executeAsyncs());
-               },
-               {
-                  mode: "sync",
-                  id: constants.exec_async_event_id,
-               },
-            );
-            await config.onBuilt?.(app);
-         },
       },
-      ctx,
+      args,
+      opts,
    );
 }
 
-export async function getFresh(config: CloudflareBkndConfig, ctx: Context) {
-   const app = await makeApp(config, ctx);
+export async function getWarm<Env extends CloudflareEnv = CloudflareEnv>(
+   config: CloudflareBkndConfig<Env>,
+   ctx: Context<Env>,
+   opts: RuntimeOptions = {},
+) {
+   const app = await makeApp(
+      {
+         ...config,
+         onBuilt: async (app) => {
+            registerAsyncsExecutionContext(app, ctx.ctx);
+            config.onBuilt?.(app);
+         },
+      },
+      ctx.env,
+      opts,
+   );
    return app.fetch(ctx.request);
 }
 
-let warm_app: App;
-export async function getWarm(config: CloudflareBkndConfig, ctx: Context) {
-   if (!warm_app) {
-      warm_app = await makeApp(config, ctx);
-   }
-
-   return warm_app.fetch(ctx.request);
+export async function getFresh<Env extends CloudflareEnv = CloudflareEnv>(
+   config: CloudflareBkndConfig<Env>,
+   ctx: Context<Env>,
+   opts: RuntimeOptions = {},
+) {
+   return await getWarm(config, ctx, {
+      ...opts,
+      force: true,
+   });
 }

app/src/adapter/cloudflare/storage/StorageR2Adapter.native-spec.ts

@@ -0,0 +1,32 @@
+import { createWriteStream, readFileSync } from "node:fs";
+import { test } from "node:test";
+import { Miniflare } from "miniflare";
+import { StorageR2Adapter } from "./StorageR2Adapter";
+import { adapterTestSuite } from "media";
+import { nodeTestRunner } from "adapter/node";
+import path from "node:path";
+
+// https://github.com/nodejs/node/issues/44372#issuecomment-1736530480
+console.log = async (message: any) => {
+   const tty = createWriteStream("/dev/tty");
+   const msg = typeof message === "string" ? message : JSON.stringify(message, null, 2);
+   return tty.write(`${msg}\n`);
+};
+
+test("StorageR2Adapter", async () => {
+   const mf = new Miniflare({
+      modules: true,
+      script: "export default { async fetch() { return new Response(null); } }",
+      r2Buckets: ["BUCKET"],
+   });
+
+   const bucket = (await mf.getR2Bucket("BUCKET")) as unknown as R2Bucket;
+   const adapter = new StorageR2Adapter(bucket);
+
+   const basePath = path.resolve(import.meta.dirname, "../../../../__test__/_assets");
+   const buffer = readFileSync(path.join(basePath, "image.png"));
+   const file = new File([buffer], "image.png", { type: "image/png" });
+
+   await adapterTestSuite(nodeTestRunner, adapter, file);
+   await mf.dispose();
+});

app/src/adapter/cloudflare/storage/StorageR2Adapter.ts

@@ -1,10 +1,8 @@
 import { registries } from "bknd";
 import { isDebug } from "bknd/core";
 import { StringEnum, Type } from "bknd/utils";
-import type { FileBody } from "media/storage/Storage";
-import { StorageAdapter } from "media/storage/StorageAdapter";
-import { guess } from "media/storage/mime-types-tiny";
-import { getBindings } from "./bindings";
+import { guessMimeType as guess, StorageAdapter, type FileBody } from "bknd/media";
+import { getBindings } from "../bindings";
 
 export function makeSchema(bindings: string[] = []) {
    return Type.Object(