fix: apostrophe in Postgres enum strings breaks query (typeorm#4631)

duckies · pleerock · commit 445c740bea17 · 2019-09-05T17:59:50.000+05:00
* Patch to allow apostrophes in postgres enum string.

* Make linter happy

* Testing fix for MySQL

* Limit to postgres and mysql, fix test description

* Lets not be greedy.
diff --git a/src/driver/mysql/MysqlQueryRunner.ts b/src/driver/mysql/MysqlQueryRunner.ts
@@ -1636,7 +1636,7 @@ export class MysqlQueryRunner extends BaseQueryRunner implements QueryRunner {
             c += " UNSIGNED";
         }
         if (column.enum)
-            c += ` (${column.enum.map(value => "'" + value + "'").join(", ")})`;
+            c += ` (${column.enum.map(value => "'" + value.replace("'", "''") + "'").join(", ")})`;
         if (column.charset)
             c += ` CHARACTER SET "${column.charset}"`;
         if (column.collation)
diff --git a/src/driver/postgres/PostgresQueryRunner.ts b/src/driver/postgres/PostgresQueryRunner.ts
@@ -1838,7 +1838,7 @@ export class PostgresQueryRunner extends BaseQueryRunner implements QueryRunner
     protected createEnumTypeSql(table: Table, column: TableColumn, enumName?: string): Query {
         if (!enumName)
             enumName = this.buildEnumName(table, column);
-        const enumValues = column.enum!.map(value => `'${value}'`).join(", ");
+        const enumValues = column.enum!.map(value => `'${value.replace("'", "''")}'`).join(", ");
         return new Query(`CREATE TYPE ${enumName} AS ENUM(${enumValues})`);
     }
 
diff --git a/test/github-issues/4630/entity/User.ts b/test/github-issues/4630/entity/User.ts
@@ -0,0 +1,15 @@
+import { Entity, Column, PrimaryGeneratedColumn } from "../../../../src";
+
+export enum Realm {
+    Blackrock = "Blackrock",
+    KelThuzad = "Kel'Thuzad",
+}
+
+@Entity()
+export class User {
+    @PrimaryGeneratedColumn()
+    id: number;
+
+    @Column({ type: "enum", enum: Realm })
+    realm: Realm;
+}
diff --git a/test/github-issues/4630/issue-4630.ts b/test/github-issues/4630/issue-4630.ts
@@ -0,0 +1,32 @@
+import "reflect-metadata";
+import {createTestingConnections, closeTestingConnections, reloadTestingDatabases} from "../../utils/test-utils";
+import {Connection} from "../../../src/connection/Connection";
+import { Realm } from "./entity/User";
+import {User} from "./entity/User";
+
+describe("github issues > #4630 Enum string not escaping resulting in broken migrations.", () => {
+
+    let connections: Connection[];
+    before(async () => connections = await createTestingConnections({
+        entities: [__dirname + "/entity/*{.js,.ts}"],
+        schemaCreate: true,
+        dropSchema: true,
+        enabledDrivers: ["mysql", "postgres"]
+    }));
+    beforeEach(() => reloadTestingDatabases(connections));
+    after(() => closeTestingConnections(connections));
+
+    it("should support enums of strings with apostrophes in them", () => Promise.all(connections.map(async connection => {
+        const user = new User();
+        user.realm = Realm.KelThuzad;
+
+        await connection.manager.save(user);
+
+        const users = await connection.manager.find(User);
+
+        users.should.eql([{
+            id: 1,
+            realm: "Kel'Thuzad"
+        }]);
+    })));
+});

Original file line number	Diff line number	Diff line change
`@@ -1636,7 +1636,7 @@ export class MysqlQueryRunner extends BaseQueryRunner implements QueryRunner {`
`1636`	`1636`	`c += " UNSIGNED";`
`1637`	`1637`	`}`
`1638`	`1638`	`if (column.enum)`
`1639`		- c += ` (${column.enum.map(value => "'" + value + "'").join(", ")})`;
	`1639`	+ c += ` (${column.enum.map(value => "'" + value.replace("'", "''") + "'").join(", ")})`;
`1640`	`1640`	`if (column.charset)`
`1641`	`1641`	c += ` CHARACTER SET "${column.charset}"`;
`1642`	`1642`	`if (column.collation)`
Original file line number	Diff line number	Diff line change
`@@ -1838,7 +1838,7 @@ export class PostgresQueryRunner extends BaseQueryRunner implements QueryRunner`
`1838`	`1838`	`protected createEnumTypeSql(table: Table, column: TableColumn, enumName?: string): Query {`
`1839`	`1839`	`if (!enumName)`
`1840`	`1840`	`enumName = this.buildEnumName(table, column);`
`1841`		- const enumValues = column.enum!.map(value => `'${value}'`).join(", ");
	`1841`	+ const enumValues = column.enum!.map(value => `'${value.replace("'", "''")}'`).join(", ");
`1842`	`1842`	return new Query(`CREATE TYPE ${enumName} AS ENUM(${enumValues})`);
`1843`	`1843`	`}`
`1844`	`1844`