fix(wrangler): ignore comments when splitting sql into statements (#8175)

Author: edmundhung

.changeset/ten-falcons-applaud.md

@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+fix: `unstable_splitSqlQuery` should ignore comments when splitting sql into statements

fixtures/vitest-pool-workers-examples/d1/migrations/0000_initial.sql

@@ -10,3 +10,4 @@ CREATE TABLE posts (
 	body TEXT NOT NULL,
 	FOREIGN KEY (author) REFERENCES users(username)
 );
+-- Migration ends here

packages/wrangler/src/__tests__/d1/splitter.test.ts

@@ -112,13 +112,12 @@ describe("splitSqlQuery()", () => {
         AND "col;name" = \`other;col\`; -- or identifiers (Postgres or MySQL style)`
 			)
 		).toMatchInlineSnapshot(`
-		Array [
-		  "SELECT * FROM my_table -- semicolons; in; comments; don't count;
-		        WHERE val = 'foo;bar'
-		        AND \\"col;name\\" = \`other;col\`",
-		  "-- or identifiers (Postgres or MySQL style)",
-		]
-	`);
+			Array [
+			  "SELECT * FROM my_table 
+			        WHERE val = 'foo;bar'
+			        AND \\"col;name\\" = \`other;col\`",
+			]
+		`);
 	});
 
 	it("should handle block comments", () => {
@@ -131,14 +130,11 @@ describe("splitSqlQuery()", () => {
         WHERE val = 'foo;bar' AND count / 2 > 0`
 			)
 		).toMatchInlineSnapshot(`
-		Array [
-		  "/****
-		        * Block comments are ignored;
-		        ****/
-					SELECT * FROM my_table /* semicolons; in; comments; don't count; */
-		        WHERE val = 'foo;bar' AND count / 2 > 0",
-		]
-	`);
+			Array [
+			  "SELECT * FROM my_table 
+			        WHERE val = 'foo;bar' AND count / 2 > 0",
+			]
+		`);
 	});
 
 	it("should split multiple statements", () => {
@@ -157,6 +153,22 @@ describe("splitSqlQuery()", () => {
 	`);
 	});
 
+	it("should ignore comment at the end", () => {
+		expect(
+			splitSqlQuery(
+				`
+		-- This is a comment
+        SELECT * FROM my_table WHERE id = 42 - 10;
+		-- This is a comment
+      `
+			)
+		).toMatchInlineSnapshot(`
+			Array [
+			  "SELECT * FROM my_table WHERE id = 42 - 10",
+			]
+		`);
+	});
+
 	it("should handle whitespace between statements", () => {
 		expect(
 			splitSqlQuery(`

packages/wrangler/src/d1/splitter.ts

@@ -67,21 +67,25 @@ function splitSqlIntoStatements(sql: string): string[] {
 				break;
 			}
 			case `-`:
-				str += char;
 				next = iterator.next();
 				if (!next.done && next.value === "-") {
-					str += next.value + consumeUntilMarker(iterator, "\n");
+					// Skip to the end of the comment
+					consumeUntilMarker(iterator, "\n");
+					// Maintain the newline character
+					str += "\n";
 					break;
 				} else {
+					str += char;
 					continue;
 				}
 			case `/`:
-				str += char;
 				next = iterator.next();
 				if (!next.done && next.value === "*") {
-					str += next.value + consumeUntilMarker(iterator, "*/");
+					// Skip to the end of the comment
+					consumeUntilMarker(iterator, "*/");
 					break;
 				} else {
+					str += char;
 					continue;
 				}
 			case `;`: