lib: Always drop keys not created by mysql-plus during migrations

This fixes a bug where mysql-plus would crash when attempting to drop a key it didn't create.

Author: nwoltman

lib/TableDefinition.js

@@ -96,6 +96,7 @@ class TableDefinition {
       this._getMigrateKeysOperations(oldSchema, KEY_TYPES.UNIQUE, 'uniqueKeys'),
       this._getMigrateKeysOperations(oldSchema, KEY_TYPES.INDEX, 'indexes'),
       this._getMigrateKeysOperations(oldSchema, KEY_TYPES.SPATIAL, 'spatialIndexes'),
+      this._getDropUnknownKeysOperations(oldSchema),
       this._getMigrateTableOptionsOperations(oldSchema)
     );
     const operations = this._getMigrateForeignKeysOperations(oldSchema, alterOperations);
@@ -217,6 +218,21 @@ class TableDefinition {
     return operations;
   }
 
+  _getDropUnknownKeysOperations(oldSchema) {
+    const operations = [];
+    const unknownKeys = oldSchema.$unknownKeys;
+
+    for (var i = 0; i < unknownKeys.length; i++) {
+      operations.push(Operation.create(
+        Operation.Types.DROP_KEY,
+        'DROP KEY ' + this._pool.escapeId(unknownKeys[i].name),
+        unknownKeys[i].columns
+      ));
+    }
+
+    return operations;
+  }
+
   _getMigrateForeignKeysOperations(oldSchema, otherOperations) {
     const operations = [];
     const oldForeignKeys = oldSchema.foreignKeys;
@@ -582,6 +598,7 @@ function sqlToSchema(sql) {
     indexes: generateKeysSchema(createDefinitions, KEY_TYPES.INDEX),
     spatialIndexes: generateKeysSchema(createDefinitions, KEY_TYPES.SPATIAL),
     foreignKeys: generateForegnKeysSchema(createDefinitions),
+    $unknownKeys: getUnknownKeys(createDefinitions),
   };
 
   let match = /ENGINE=(\w+)/.exec(tableOptions);
@@ -712,13 +729,13 @@ function generateKeysSchema(createDefinitions, keyType) {
 
   switch (keyType) {
     case KEY_TYPES.UNIQUE:
-      rgxKey = /^\s*UNIQUE KEY `\w+` \((.*?)\)/;
+      rgxKey = /^\s*UNIQUE KEY `unique_\w+` \((.*?)\)/;
       break;
     case KEY_TYPES.INDEX:
-      rgxKey = /^\s*(?:INDEX|KEY) `\w+` \((.*?)\)/;
+      rgxKey = /^\s*KEY `index_\w+` \((.*?)\)/;
       break;
     case KEY_TYPES.SPATIAL:
-      rgxKey = /^\s*SPATIAL (?:INDEX|KEY) `\w+` \((.*?)\)/;
+      rgxKey = /^\s*SPATIAL KEY `spatial_\w+` \((.*?)\)/;
       break;
   }
 
@@ -732,6 +749,24 @@ function generateKeysSchema(createDefinitions, keyType) {
   return keys.length ? keys : null;
 }
 
+function getUnknownKeys(createDefinitions) {
+  const keys = [];
+  const rgxKey =
+    /^\s*(?:UNIQUE KEY `((?!unique_)\w+)`|KEY `((?!index_)\w+)`|SPATIAL KEY `((?!spatial_)\w+)`) \((.*?)\)/;
+
+  for (var i = 0; i < createDefinitions.length; i++) {
+    const keyMatch = rgxKey.exec(createDefinitions[i]);
+    if (keyMatch) {
+      keys.push({
+        name: keyMatch[1] || keyMatch[2] || keyMatch[3],
+        columns: columnsSQLToSchema(keyMatch[4]),
+      });
+    }
+  }
+
+  return keys;
+}
+
 function generateForegnKeysSchema(createDefinitions) {
   const foreignKeys = {};
   const rgxForeignKey =

test/integration/dropUnknownKeys.test.js

@@ -0,0 +1,61 @@
+'use strict';
+
+const MySQLPlus = require('../../lib/MySQLPlus');
+
+const config = require('../config');
+
+const ColTypes = MySQLPlus.ColTypes;
+
+describe('when migrating a table with keys not created by mysql-plus', function() {
+
+  const pool = MySQLPlus.createPool(config);
+
+  pool.defineTable('unknown_keys', {
+    columns: {
+      id: ColTypes.int(),
+      p: ColTypes.point().notNull(),
+    },
+    indexes: ['id'],
+  });
+
+  before(done => {
+    pool.query(
+      'CREATE TABLE `unknown_keys` (' +
+      '`id` int, ' +
+      '`p` point NOT NULL, ' +
+      'UNIQUE KEY `unknown_unique_key` (`id`),' +
+      'INDEX `unknown_index` (`id`),' +
+      'KEY `fk_unknown_keys_id` (`id`),' +
+      'SPATIAL KEY `unknown_spatial_key` (`p`))',
+      done
+    );
+  });
+
+  after(done => {
+    pool.end(done);
+  });
+
+  it('should remove the unknown keys', done => {
+    pool.sync(err => {
+      if (err) {
+        throw err;
+      }
+
+      pool.query('SHOW CREATE TABLE `unknown_keys`', (err, rows) => {
+        if (err) {
+          throw err;
+        }
+
+        rows[0]['Create Table'].should.equal(
+          'CREATE TABLE `unknown_keys` (\n' +
+          '  `id` int(11) DEFAULT NULL,\n' +
+          '  `p` point NOT NULL,\n' +
+          '  KEY `index_unknown_keys_id` (`id`)\n' +
+          ') ENGINE=InnoDB DEFAULT CHARSET=utf8'
+        );
+        done();
+      });
+    });
+  });
+
+});