Expose sqlite in Vitest (#6725)

Co-authored-by: Joshua Howard <[email protected]>

.changeset/quiet-dolphins-compete.md

@@ -0,0 +1,5 @@
+---
+"@cloudflare/vitest-pool-workers": patch
+---
+
+fix: SQLite Durable Objects cannot be tested with vitest-pool-workers

fixtures/vitest-pool-workers-examples/durable-objects/src/env.d.ts

@@ -1,3 +1,4 @@
 interface Env {
 	COUNTER: DurableObjectNamespace;
+	SQL: DurableObjectNamespace;
 }

fixtures/vitest-pool-workers-examples/durable-objects/src/index.ts

@@ -27,9 +27,21 @@ export class Counter implements DurableObject {
 	}
 }
 
+export class SQLiteDurableObject implements DurableObject {
+	constructor(readonly ctx: DurableObjectState) {}
+	fetch() {
+		return new Response(this.ctx.storage.sql.databaseSize.toString());
+	}
+}
+
 export default <ExportedHandler<Env>>{
 	fetch(request, env) {
 		const { pathname } = new URL(request.url);
+		if (pathname === "/sql") {
+			const id = env.SQL.idFromName(pathname);
+			const stub = env.SQL.get(id);
+			return stub.fetch(request);
+		}
 		const id = env.COUNTER.idFromName(pathname);
 		const stub = env.COUNTER.get(id);
 		return stub.fetch(request);

fixtures/vitest-pool-workers-examples/durable-objects/test/sqlite-in-do.test.ts

@@ -0,0 +1,7 @@
+import { SELF } from "cloudflare:test";
+import { expect, it } from "vitest";
+
+it("enables SQL API with migrations", async () => {
+	const response = await SELF.fetch("https://example.com/sql");
+	expect(await response.text()).toBe("4096");
+});

fixtures/vitest-pool-workers-examples/durable-objects/wrangler.toml

@@ -5,9 +5,11 @@ compatibility_flags = ["nodejs_compat"]
 
 [durable_objects]
 bindings = [
-	{ name = "COUNTER", class_name = "Counter" }
+	{ name = "COUNTER", class_name = "Counter" },
+	{ name = "SQL", class_name = "SQLiteDurableObject" }
 ]
 
 [[migrations]]
 tag = "v1"
 new_classes = ["Counter"]
+new_sqlite_classes = ["SQLiteDurableObject"]

fixtures/vitest-pool-workers-examples/package.json

@@ -6,7 +6,9 @@
 		"check:type": "node tsc-all.mjs",
 		"list": "vitest --config vitest.workers.config.ts list",
 		"test": "vitest --config vitest.workers.config.ts --reporter basic",
-		"test:ci": "vitest run --config vitest.workers.config.ts --reporter basic"
+		"test:ci": "run-script-os",
+		"test:ci:default": "vitest run --config vitest.workers.config.ts --reporter basic",
+		"test:ci:win32": "vitest run --config vitest.workers.config.ts --reporter basic --exclude test/sqlite-in-do.test.ts"
 	},
 	"devDependencies": {
 		"@cloudflare/vitest-pool-workers": "workspace:*",
@@ -15,6 +17,7 @@
 		"ext-dep": "file:./internal-module-resolution/vendor/ext-dep",
 		"jose": "^5.2.2",
 		"miniflare": "workspace:*",
+		"run-script-os": "^1.1.6",
 		"toucan-js": "^3.3.1",
 		"typescript": "^5.5.2",
 		"vitest": "catalog:default",

packages/wrangler/src/api/integrations/platform/index.ts

@@ -8,6 +8,7 @@ import {
 	buildMiniflareBindingOptions,
 	buildSitesOptions,
 } from "../../../dev/miniflare";
+import { getClassNamesWhichUseSQLite } from "../../../dev/validate-dev-props";
 import { run } from "../../../experimental-flags";
 import { getLegacyAssetPaths, getSiteAssetPaths } from "../../../sites";
 import { CacheStorage } from "./caches";
@@ -284,15 +285,24 @@ export function unstable_getMiniflareWorkerOptions(
 		);
 	}
 	if (bindings.durable_objects !== undefined) {
+		type DurableObjectDefinition = NonNullable<
+			typeof bindingOptions.durableObjects
+		>[string];
+
+		const classNameToUseSQLite = getClassNamesWhichUseSQLite(config.migrations);
+
 		bindingOptions.durableObjects = Object.fromEntries(
-			bindings.durable_objects.bindings.map((binding) => [
-				binding.name,
-				{
-					className: binding.class_name,
-					scriptName: binding.script_name,
-					binding,
-				},
-			])
+			bindings.durable_objects.bindings.map((binding) => {
+				const useSQLite = classNameToUseSQLite.get(binding.class_name);
+				return [
+					binding.name,
+					{
+						className: binding.class_name,
+						scriptName: binding.script_name,
+						useSQLite,
+					} satisfies DurableObjectDefinition,
+				];
+			})
 		);
 	}