fix(schema): use utf8mb4 charset in mysql schema

Charset can be also configured via new `charset` option.

Closes: #513

docs/docs/configuration.md

@@ -112,6 +112,7 @@ export interface ConnectionOptions {
   port?: number;
   user?: string;
   password?: string;
+  charset?: string;
   multipleStatements?: boolean; // for mysql driver
   pool?: PoolConfig; // provided by `knex`
 }

lib/migrations/MigrationRunner.ts

@@ -1,5 +1,5 @@
 import { AbstractSqlDriver } from '../drivers';
-import { MigrationsOptions, Utils } from '../utils';
+import { Configuration, MigrationsOptions, Utils } from '../utils';
 import { Migration } from './Migration';
 import { Transaction } from '../connections';
 
@@ -10,15 +10,17 @@ export class MigrationRunner {
   private masterTransaction?: Transaction;
 
   constructor(protected readonly driver: AbstractSqlDriver,
-              protected readonly options: MigrationsOptions) { }
+              protected readonly options: MigrationsOptions,
+              protected readonly config: Configuration) { }
 
   async run(migration: Migration, method: 'up' | 'down'): Promise<void> {
     migration.reset();
     await migration[method]();
     let queries = migration.getQueries();
 
     if (this.options.disableForeignKeys) {
-      queries.unshift(...this.helper.getSchemaBeginning().split('\n'));
+      const charset = this.config.get('charset')!;
+      queries.unshift(...this.helper.getSchemaBeginning(charset).split('\n'));
       queries.push(...this.helper.getSchemaEnd().split('\n'));
     }
 

lib/migrations/Migrator.ts

@@ -12,7 +12,7 @@ export class Migrator {
 
   private readonly umzug: Umzug;
   private readonly options = this.config.get('migrations');
-  private readonly runner = new MigrationRunner(this.driver, this.options);
+  private readonly runner = new MigrationRunner(this.driver, this.options, this.config);
   private readonly generator = new MigrationGenerator(this.driver, this.options);
   private readonly storage = new MigrationStorage(this.driver, this.options);
 

lib/platforms/MySqlPlatform.ts

@@ -5,4 +5,8 @@ export class MySqlPlatform extends Platform {
 
   protected readonly schemaHelper = new MySqlSchemaHelper();
 
+  getDefaultCharset(): string {
+    return 'utf8mb4';
+  }
+
 }

lib/platforms/Platform.ts

@@ -90,4 +90,8 @@ export abstract class Platform {
     return 'bigint';
   }
 
+  getDefaultCharset(): string {
+    return 'utf8';
+  }
+
 }

lib/schema/MySqlSchemaHelper.ts

@@ -34,17 +34,17 @@ export class MySqlSchemaHelper extends SchemaHelper {
     '0': ['0', 'false'],
   };
 
-  getSchemaBeginning(): string {
-    return 'set names utf8;\nset foreign_key_checks = 0;\n\n';
+  getSchemaBeginning(charset: string): string {
+    return `set names ${charset};\nset foreign_key_checks = 0;\n\n`;
   }
 
   getSchemaEnd(): string {
     return 'set foreign_key_checks = 1;\n';
   }
 
-  finalizeTable(table: CreateTableBuilder): void {
+  finalizeTable(table: CreateTableBuilder, charset: string): void {
     table.engine('InnoDB');
-    table.charset('utf8');
+    table.charset(charset);
   }
 
   getTypeDefinition(prop: EntityProperty): string {

lib/schema/PostgreSqlSchemaHelper.ts

@@ -37,8 +37,8 @@ export class PostgreSqlSchemaHelper extends SchemaHelper {
     'null::timestamp without time zone': ['null'],
   };
 
-  getSchemaBeginning(): string {
-    return `set names 'utf8';\nset session_replication_role = 'replica';\n\n`;
+  getSchemaBeginning(charset: string): string {
+    return `set names '${charset}';\nset session_replication_role = 'replica';\n\n`;
   }
 
   getSchemaEnd(): string {

lib/schema/SchemaGenerator.ts

@@ -166,7 +166,7 @@ export class SchemaGenerator {
       return sql;
     }
 
-    let ret = this.helper.getSchemaBeginning();
+    let ret = this.helper.getSchemaBeginning(this.config.get('charset'));
     ret += sql;
     ret += this.helper.getSchemaEnd();
 
@@ -198,7 +198,7 @@ export class SchemaGenerator {
 
       meta.indexes.forEach(index => createIndex(index, false));
       meta.uniques.forEach(index => createIndex(index, true));
-      this.helper.finalizeTable(table);
+      this.helper.finalizeTable(table, this.config.get('charset'));
     });
   }
 

lib/schema/SchemaHelper.ts

@@ -7,15 +7,15 @@ import { AbstractSqlConnection, Connection } from '../connections';
 
 export abstract class SchemaHelper {
 
-  getSchemaBeginning(): string {
+  getSchemaBeginning(charset: string): string {
     return '';
   }
 
   getSchemaEnd(): string {
     return '';
   }
 
-  finalizeTable(table: TableBuilder): void {
+  finalizeTable(table: TableBuilder, charset: string): void {
     //
   }
 

lib/schema/SqliteSchemaHelper.ts

@@ -19,7 +19,7 @@ export class SqliteSchemaHelper extends SchemaHelper {
     text: ['text'],
   };
 
-  getSchemaBeginning(): string {
+  getSchemaBeginning(charset: string): string {
     return 'pragma foreign_keys = off;\n\n';
   }
 

lib/utils/Configuration.ts

@@ -207,6 +207,10 @@ export class Configuration<D extends IDatabaseDriver = IDatabaseDriver> {
     if (this.options.entitiesDirsTs.length === 0) {
       this.options.entitiesDirsTs = this.options.entitiesDirs;
     }
+
+    if (!this.options.charset) {
+      this.options.charset = this.platform.getDefaultCharset();
+    }
   }
 
   private validateOptions(): void {
@@ -253,6 +257,7 @@ export interface ConnectionOptions {
   port?: number;
   user?: string;
   password?: string;
+  charset?: string;
   multipleStatements?: boolean; // for mysql driver
   pool?: PoolConfig;
 }

tests/Migrator.test.ts

@@ -116,7 +116,7 @@ describe('Migrator', () => {
     expect(spy1).toBeCalledWith('select 1 + 1');
     expect(mock.mock.calls.length).toBe(6);
     expect(mock.mock.calls[0][0]).toMatch('begin');
-    expect(mock.mock.calls[1][0]).toMatch('set names utf8;');
+    expect(mock.mock.calls[1][0]).toMatch('set names utf8mb4;');
     expect(mock.mock.calls[2][0]).toMatch('set foreign_key_checks = 0;');
     expect(mock.mock.calls[3][0]).toMatch('select 1 + 1');
     expect(mock.mock.calls[4][0]).toMatch('set foreign_key_checks = 1;');

tests/SchemaHelper.test.ts

@@ -9,7 +9,7 @@ describe('SchemaHelper', () => {
 
   test('default schema helpers', async () => {
     const helper = new SchemaHelperTest();
-    expect(helper.getSchemaBeginning()).toBe('');
+    expect(helper.getSchemaBeginning('utf8')).toBe('');
     expect(helper.getSchemaEnd()).toBe('');
     expect(helper.getTypeDefinition({ type: 'test' } as any)).toBe('test');
     expect(helper.isSame({ reference: 'scalar', type: 'number', nullable: false, columnTypes: ['integer'], default: 42 } as any, { type: 'integer', nullable: false, defaultValue: '42' } as any).all).toBe(true);