knex-migrator 4.2.1 → 4.2.4

package/bin/knex-migrator-health

@@ -3,7 +3,7 @@
 var program = require('commander');
 var utils = require('../lib/utils');
 
-var logging = require('../logging');
+var logging = require('@tryghost/logging');
 var knexMigrator;
 
 utils.getKnexMigrator({path: process.cwd()})

package/bin/knex-migrator-init

@@ -3,7 +3,7 @@
 var program = require('commander');
 var utils = require('../lib/utils');
 
-var logging = require('../logging');
+var logging = require('@tryghost/logging');
 var knexMigrator;
 
 utils.getKnexMigrator({path: process.cwd()})

package/bin/knex-migrator-migrate

@@ -3,7 +3,7 @@
 var program = require('commander');
 var utils = require('../lib/utils');
 
-var logging = require('../logging');
+var logging = require('@tryghost/logging');
 var knexMigrator;
 
 utils.getKnexMigrator({path: process.cwd()})

package/bin/knex-migrator-reset

@@ -3,7 +3,7 @@
 var program = require('commander');
 var utils = require('../lib/utils');
 
-var logging = require('../logging');
+var logging = require('@tryghost/logging');
 var knexMigrator;
 
 utils.getKnexMigrator({path: process.cwd()})

package/bin/knex-migrator-rollback

@@ -3,7 +3,7 @@
 const program = require('commander');
 const utils = require('../lib/utils');
 
-const logging = require('../logging');
+const logging = require('@tryghost/logging');
 let knexMigrator;
 
 utils.getKnexMigrator({path: process.cwd()})

package/lib/database.js

@@ -3,6 +3,7 @@ const knex = require('knex'),
     omit = require('lodash/omit'),
     debug = require('debug')('knex-migrator:database'),
     errors = require('./errors');
+const DatabaseInfo = require('@tryghost/database-info');
 
 /**
  * @NOTE: Knex-migrator only supports knex query builder.
@@ -21,6 +22,12 @@ exports.connect = function connect(options) {
     const client = options.client;
 
     if (client === 'sqlite3') {
+        // TODO: remove this hack
+        // I need to monkey-patch the sqlite3 dialect to use `sqlite3` to make
+        // the jumps smaller as I'm updating `knex`
+        const Dialect = require(`knex/lib/dialects/sqlite3/index.js`);
+        Dialect.prototype._driver = () => require('sqlite3');
+
         options.useNullAsDefault = options.useNullAsDefault || false;
     }
 
@@ -28,6 +35,8 @@ exports.connect = function connect(options) {
         options.connection.timezone = options.connection.timezone || 'Z';
         options.connection.charset = options.connection.charset || 'utf8mb4';
         options.connection.decimalNumbers = true;
+
+        delete options.connection.filename;
     }
 
     return knex(options);
@@ -75,23 +84,21 @@ module.exports.createTransaction = function (connection, callback) {
  * @TODO: https://github.com/TryGhost/knex-migrator/issues/91
  * @returns {Bluebird<R> | Bluebird<any> | * | Promise<T>}
  */
-exports.createMigrationsTable = function createMigrationsTable(connection) {
-    return connection('migrations')
-        .catch(function (err) {
-            // CASE: table does not exist
-            if (err.errno === 1 || err.errno === 1146) {
-                debug('Creating table: migrations');
-
-                return connection.schema.createTable('migrations', function (table) {
-                    table.increments().primary();
-                    table.string('name');
-                    table.string('version');
-                    table.string('currentVersion');
-                });
-            }
+exports.createMigrationsTable = async function createMigrationsTable(connection) {
+    const hasTable = await connection.schema.hasTable('migrations');
+    if (hasTable) {
+        return;
+    }
 
-            throw err;
-        });
+    // CASE: table does not exist
+    debug('Creating table: migrations');
+
+    await connection.schema.createTable('migrations', function (table) {
+        table.increments().primary();
+        table.string('name');
+        table.string('version');
+        table.string('currentVersion');
+    });
 };
 
 /**
@@ -106,9 +113,9 @@ exports.createDatabaseIfNotExist = function createDatabaseIfNotExist(dbConfig) {
         collation = dbConfig.connection.collation || 'utf8mb4_general_ci';
 
     // @NOTE: Skip, because sqlite3 is a file based database.
-    if (dbConfig.client === 'sqlite3') {
+    if (DatabaseInfo.isSQLiteConfig(dbConfig)) {
         return Promise.resolve();
-    } else if (!['mysql', 'mysql2'].includes(dbConfig.client)) {
+    } else if (!DatabaseInfo.isMySQLConfig(dbConfig)) {
         return Promise.reject(new errors.KnexMigrateError({
             message: 'Database is not supported.'
         }));
@@ -163,7 +170,7 @@ exports.drop = function drop(options) {
     const connection = options.connection,
         dbConfig = options.dbConfig;
 
-    if (['mysql', 'mysql2'].includes(dbConfig.client)) {
+    if (DatabaseInfo.isMySQL(connection)) {
         debug('Drop database: ' + dbConfig.connection.database);
 
         return connection.raw('DROP DATABASE `' + dbConfig.connection.database + '`;')
@@ -177,7 +184,7 @@ exports.drop = function drop(options) {
                     err: err
                 }));
             });
-    } else if (dbConfig.client === 'sqlite3') {
+    } else if (DatabaseInfo.isSQLite(connection)) {
         // @NOTE: sqlite3 does not support "DROP DATABASE". We have to drop each table instead.
         // @NOTE: We cannot just remove the sqlite3 file, because any database connection will get invalid.
         return connection.raw('SELECT name FROM sqlite_master WHERE type="table";')

package/lib/index.js

@@ -5,7 +5,7 @@ const debug = require('debug')('knex-migrator:index');
 const database = require('./database');
 const utils = require('./utils');
 const errors = require('./errors');
-const logging = require('../logging');
+const logging = require('@tryghost/logging');
 const migrations = require('../migrations');
 const locking = require('./locking');
 

package/migrations/add-primary-key-to-lock-table.js

@@ -1,12 +1,11 @@
 const debug = require('debug')('knex-migrator:lock-table');
+const DatabaseInfo = require('@tryghost/database-info');
 
 /**
  * Checks if primary key index exists in a table over the given columns.
  */
 function hasPrimaryKeySQLite(tableName, knex) {
-    const client = knex.client.config.client;
-
-    if (client !== 'sqlite3') {
+    if (!DatabaseInfo.isSQLite(knex)) {
         throw new Error('Must use hasPrimaryKeySQLite on an SQLite3 database');
     }
 
@@ -21,8 +20,7 @@ function hasPrimaryKeySQLite(tableName, knex) {
  * Adds an primary key index to a table over the given columns.
  */
 function addPrimaryKey(tableName, columns, knex) {
-    const isSQLite = knex.client.config.client === 'sqlite3';
-    if (isSQLite) {
+    if (DatabaseInfo.isSQLite(knex)) {
         return hasPrimaryKeySQLite(tableName, knex)
             .then((primaryKeyExists) => {
                 if (primaryKeyExists) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex-migrator",
-  "version": "4.2.1",
+  "version": "4.2.4",
   "description": "Database migrations with knex.",
   "keywords": [
     "ghost",
@@ -47,14 +47,17 @@
     "node": "^12.22.1 || ^14.17.0 || ^16.13.0"
   },
   "dependencies": {
+    "@tryghost/database-info": "0.3.0",
+    "@tryghost/logging": "2.1.1",
     "bluebird": "3.7.2",
     "commander": "5.1.0",
     "compare-ver": "2.0.2",
-    "debug": "4.3.3",
+    "debug": "4.3.4",
     "ghost-ignition": "4.6.3",
-    "knex": "0.21.19",
+    "knex": "1.0.4",
     "lodash": "4.17.21",
     "moment": "2.24.0",
+    "mysql2": "2.3.3",
     "nconf": "0.11.3",
     "resolve": "1.22.0"
   },
@@ -74,7 +77,6 @@
     "sinon": "9.2.4"
   },
   "optionalDependencies": {
-    "mysql2": "2.3.3",
     "sqlite3": "5.0.2"
   }
 }

package/logging.js

@@ -1,8 +0,0 @@
-var logging = require('ghost-ignition').logging;
-
-module.exports = logging({
-    env: process.env.NODE_ENV,
-    mode: 'long',
-    level: 'info',
-    transports: ['stdout', 'stderr']
-});