feat!: Update to support MySQL 8.0

BREAKING CHANGE: The code that handles foreign keys now follows MySQL 8.0's semantics for the `NO ACTION` foreign key constraint (it's treated the same as omitting the constraint).

Author: nwoltman

lib/KeyDefinitions/ForeignKeyDefinition.js

@@ -5,6 +5,21 @@ const {escapeId} = require('mysql/lib/protocol/SqlString');
 
 const referenceOptions = ['RESTRICT', 'CASCADE', 'SET NULL', 'NO ACTION'];
 
+function sanitizeReferenceOption(option) {
+  const refOption = option.toUpperCase();
+  if (referenceOptions.indexOf(refOption) === -1) {
+    throw new Error('Invalid foreign key reference option: ' + option);
+  }
+
+  // NO ACTION is the same as RESTRICT in MySQL 8
+  // https://dev.mysql.com/doc/refman/8.0/en/create-table-foreign-keys.html#foreign-key-referential-actions
+  if (refOption === 'NO ACTION') {
+    return 'RESTRICT';
+  }
+
+  return refOption;
+}
+
 class ForeignKeyDefinition {
   constructor(columns) {
     this.$columns = columns;
@@ -24,20 +39,12 @@ class ForeignKeyDefinition {
   }
 
   onDelete(option) {
-    const refOption = option.toUpperCase();
-    if (referenceOptions.indexOf(refOption) === -1) {
-      throw new Error('Invalid foreign key reference option: ' + option);
-    }
-    this._onDelete = refOption;
+    this._onDelete = sanitizeReferenceOption(option);
     return this;
   }
 
   onUpdate(option) {
-    const refOption = option.toUpperCase();
-    if (referenceOptions.indexOf(refOption) === -1) {
-      throw new Error('Invalid foreign key reference option: ' + option);
-    }
-    this._onUpdate = refOption;
+    this._onUpdate = sanitizeReferenceOption(option);
     return this;
   }
 
@@ -77,6 +84,9 @@ class ForeignKeyDefinition {
       `CONSTRAINT ${escapeId(this.$name)}\n  FOREIGN KEY (${escapeId(this.$columns)}) ` +
       `REFERENCES ${escapeId(this._referenceTable)} (${escapeId(this._referenceColumns)})`;
 
+    // RESTRICT and NO ACTION are equivalent to omitting the clause:
+    // https://dev.mysql.com/doc/refman/8.0/en/create-table-foreign-keys.html#foreign-key-referential-actions
+    // (NO ACTION is transformed into RESTRICT above because it's basically an alias in MySQL 8)
     if (this._onDelete !== 'RESTRICT') {
       sql += ' ON DELETE ' + this._onDelete;
     }

tasks/createTestDB.js

@@ -19,7 +19,7 @@ module.exports = function(grunt) {
         throw err;
       }
 
-      db.query('CREATE DATABASE ?? CHARACTER SET utf8 COLLATE utf8_general_ci', [database], (err) => {
+      db.query('CREATE DATABASE ?? CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci', [database], (err) => {
         if (err) {
           throw err;
         }