Add default Text module rule for .sql files (#11738)

* Add failing fixture

* Add default SQL rule to Wrangler

* Add failing Vite playground test

* Add default SQL rule to Vite plugin

* Add changeset

* Update snapshot

Author: jamesopstad

.changeset/sour-plants-spend.md

@@ -0,0 +1,8 @@
+---
+"@cloudflare/vite-plugin": minor
+"wrangler": minor
+---
+
+Add default `Text` module rule for `.sql` files.
+
+This enables importing `.sql` files directly in Wrangler and the Cloudflare Vite plugin without extra configuration.

fixtures/additional-modules/src/example.sql

@@ -0,0 +1 @@
+SELECT * FROM users;

fixtures/additional-modules/src/index.ts

@@ -1,5 +1,6 @@
 import common from "./common.cjs";
 import dep from "./dep";
+import sql from "./example.sql";
 import text from "./text.txt";
 
 export default <ExportedHandler>{
@@ -11,6 +12,9 @@ export default <ExportedHandler>{
 		if (url.pathname === "/text") {
 			return new Response(text);
 		}
+		if (url.pathname === "/sql") {
+			return new Response(sql);
+		}
 		if (url.pathname === "/common") {
 			return new Response(common);
 		}

fixtures/additional-modules/src/text.d.ts

@@ -2,3 +2,8 @@ declare module "*.txt" {
 	const value: string;
 	export default value;
 }
+
+declare module "*.sql" {
+	const value: string;
+	export default value;
+}

fixtures/additional-modules/test/index.test.ts

@@ -69,6 +69,10 @@ describe("find_additional_modules dev", () => {
 		const res = await get(worker, "/text");
 		expect(await res.text()).toBe("test\n");
 	});
+	test("supports SQL modules", async () => {
+		const res = await get(worker, "/sql");
+		expect(await res.text()).toBe("SELECT * FROM users;\n");
+	});
 	test("supports dynamic imports", async () => {
 		const res = await get(worker, "/dynamic");
 		expect(await res.text()).toBe("dynamic");
@@ -160,6 +164,7 @@ describe("find_additional_modules deploy", () => {
 			var dep_default = "bundled";
 
 			// src/index.ts
+			import sql from "./example.sql";
 			import text from "./text.txt";
 			var index_default = {
 			  async fetch(request) {
@@ -170,6 +175,9 @@ describe("find_additional_modules deploy", () => {
 			    if (url.pathname === "/text") {
 			      return new Response(text);
 			    }
+			    if (url.pathname === "/sql") {
+			      return new Response(sql);
+			    }
 			    if (url.pathname === "/common") {
 			      return new Response(common);
 			    }

packages/vite-plugin-cloudflare/playground/additional-modules/__tests__/additional-modules.spec.ts

@@ -22,6 +22,11 @@ test("supports Text modules with a '.txt' extension", async () => {
 	expect(result).toBe("Example text content.\n");
 });
 
+test("supports Text modules with a '.sql' extension", async () => {
+	const result = await getTextResponse("/sql");
+	expect(result).toBe("SELECT * FROM users;\n");
+});
+
 test("supports modules with `__`s in the filename", async () => {
 	const result = await getTextResponse("/text2");
 	expect(result).toBe("Example text content 2");

packages/vite-plugin-cloudflare/playground/additional-modules/src/index.ts

@@ -1,5 +1,6 @@
 import bin from "./modules/bin-example.bin";
 import html from "./modules/html-example.html";
+import sql from "./modules/sql-example.sql";
 import text2 from "./modules/text__example__2.txt";
 import text from "./modules/text-example.txt";
 import wasm from "./modules/wasm-example.wasm";
@@ -24,14 +25,13 @@ export default {
 				return new Response(html, { headers: { "Content-Type": "text/html" } });
 			}
 			case "/text": {
-				return new Response(text, {
-					headers: { "Content-Type": "text/plain" },
-				});
+				return new Response(text);
 			}
 			case "/text2": {
-				return new Response(text2, {
-					headers: { "Content-Type": "text/plain" },
-				});
+				return new Response(text2);
+			}
+			case "/sql": {
+				return new Response(sql);
 			}
 			case "/wasm": {
 				const instance = (await WebAssembly.instantiate(wasm)) as Instance;

packages/vite-plugin-cloudflare/playground/additional-modules/src/modules/sql-example.sql

@@ -0,0 +1 @@
+SELECT * FROM users;

packages/vite-plugin-cloudflare/playground/additional-modules/src/types.d.ts

@@ -8,6 +8,11 @@ declare module '*.html' {
   export default html
 }
 
+declare module '*.sql' {
+	const sql: string
+  export default sql
+}
+
 declare module '*.wasm' {
 	const wasm: WebAssembly.Module
 	export default wasm

packages/vite-plugin-cloudflare/src/plugins/additional-modules.ts

@@ -126,7 +126,7 @@ type ModuleRules = Array<{
 const moduleRules: ModuleRules = [
 	{ type: "CompiledWasm", extensions: [".wasm", ".wasm?module"] },
 	{ type: "Data", extensions: [".bin"] },
-	{ type: "Text", extensions: [".txt", ".html"] },
+	{ type: "Text", extensions: [".txt", ".html", ".sql"] },
 ];
 
 function matchAdditionalModule(source: string) {