knex 0.12.9 → 0.13.0

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 
 # Master (Unreleased)
 
+# 0.13 - 29 Apr, 2017
+
+### Breaking Changes:
+- Multiple concurrent migration runners blocks instead of throwing error when possible #1962
+- Fixed transaction promise mutation issue #1991
+
+### Other Changes:
+- Allow passing version of connected db in configuration file #1993
+- Bugfixes on batchInsert and transactions for mysql/maria #1992
+- Add fetchAsString optional parameter to oracledb dialect #1998
+- fix: escapeObject parameter order for Postgres dialect. #2003
+
 # 0.12.9 - 23 Mar, 2017
 - Fixed unhandled exception in batchInsert when the rows to be inserted resulted in duplicate key violation #1880
 

package/lib/client.js

@@ -97,7 +97,7 @@ function clientId() {
 // The base client provides the general structure
 // for a dialect specific client object.
 function Client() {
-  var config = arguments.length <= 0 || arguments[0] === undefined ? {} : arguments[0];
+  var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
 
   this.config = config;
 

package/lib/dialects/maria/transaction.js

@@ -14,6 +14,10 @@ var _inherits2 = require('babel-runtime/helpers/inherits');
 
 var _inherits3 = _interopRequireDefault(_inherits2);
 
+var _isUndefined2 = require('lodash/isUndefined');
+
+var _isUndefined3 = _interopRequireDefault(_isUndefined2);
+
 var _debug = require('debug');
 
 var _debug2 = _interopRequireDefault(_debug);
@@ -53,7 +57,12 @@ var Transaction_Maria = function (_Transaction) {
       debug('%s error running transaction query', t.txid);
     }).tap(function () {
       if (status === 1) t._resolver(value);
-      if (status === 2) t._rejecter(value);
+      if (status === 2) {
+        if ((0, _isUndefined3.default)(value)) {
+          value = new Error('Transaction rejected with non-error: ' + value);
+        }
+        t._rejecter(value);
+      }
     });
     if (status === 1 || status === 2) {
       t._completed = true;

package/lib/dialects/mssql/index.js

@@ -180,8 +180,8 @@ function Client_MSSQL(config) {
         rejecter(err);
       });
       stream.on('end', resolver);
-      var _obj = obj;
-      var sql = _obj.sql;
+      var _obj = obj,
+          sql = _obj.sql;
 
       if (!sql) return resolver();
       var req = (connection.tx_ || connection).request();
@@ -207,8 +207,8 @@ function Client_MSSQL(config) {
     // convert ? params into positional bindings (@p1)
     obj.sql = this.positionBindings(obj.sql);
     return new _bluebird2.default(function (resolver, rejecter) {
-      var _obj2 = obj;
-      var sql = _obj2.sql;
+      var _obj2 = obj,
+          sql = _obj2.sql;
 
       if (!sql) return resolver();
       var req = (connection.tx_ || connection).request();

package/lib/dialects/mysql/index.js

@@ -144,8 +144,8 @@ function Client_MySQL(config) {
   _query: function _query(connection, obj) {
     if (!obj || typeof obj === 'string') obj = { sql: obj };
     return new _bluebird2.default(function (resolver, rejecter) {
-      var _obj = obj;
-      var sql = _obj.sql;
+      var _obj = obj,
+          sql = _obj.sql;
 
       if (!sql) return resolver();
       if (obj.options) sql = (0, _assign3.default)({ sql: sql }, obj.options);

package/lib/dialects/mysql/transaction.js

@@ -2,6 +2,10 @@
 
 exports.__esModule = true;
 
+var _isUndefined2 = require('lodash/isUndefined');
+
+var _isUndefined3 = _interopRequireDefault(_isUndefined2);
+
 var _assign2 = require('lodash/assign');
 
 var _assign3 = _interopRequireDefault(_assign2);
@@ -47,7 +51,12 @@ function Transaction_MySQL() {
       debug('%s error running transaction query', t.txid);
     }).tap(function () {
       if (status === 1) t._resolver(value);
-      if (status === 2) t._rejecter(value);
+      if (status === 2) {
+        if ((0, _isUndefined3.default)(value)) {
+          value = new Error('Transaction rejected with non-error: ' + value);
+        }
+        t._rejecter(value);
+      }
     });
     if (status === 1 || status === 2) {
       t._completed = true;

package/lib/dialects/mysql2/transaction.js

@@ -2,6 +2,10 @@
 
 exports.__esModule = true;
 
+var _isUndefined2 = require('lodash/isUndefined');
+
+var _isUndefined3 = _interopRequireDefault(_isUndefined2);
+
 var _assign2 = require('lodash/assign');
 
 var _assign3 = _interopRequireDefault(_assign2);
@@ -44,7 +48,12 @@ function Transaction_MySQL2() {
       debug('%s error running transaction query', t.txid);
     }).tap(function () {
       if (status === 1) t._resolver(value);
-      if (status === 2) t._rejecter(value);
+      if (status === 2) {
+        if ((0, _isUndefined3.default)(value)) {
+          value = new Error('Transaction rejected with non-error: ' + value);
+        }
+        t._rejecter(value);
+      }
     });
     if (status === 1 || status === 2) {
       t._completed = true;

package/lib/dialects/oracle/transaction.js

@@ -14,6 +14,10 @@ var _inherits2 = require('babel-runtime/helpers/inherits');
 
 var _inherits3 = _interopRequireDefault(_inherits2);
 
+var _isUndefined2 = require('lodash/isUndefined');
+
+var _isUndefined3 = _interopRequireDefault(_isUndefined2);
+
 var _bluebird = require('bluebird');
 
 var _bluebird2 = _interopRequireDefault(_bluebird);
@@ -49,9 +53,17 @@ var Oracle_Transaction = function (_Transaction) {
   };
 
   Oracle_Transaction.prototype.rollback = function rollback(conn, err) {
+    var _this2 = this;
+
     this._completed = true;
     debugTx('%s: rolling back', this.txid);
-    return conn.rollbackAsync().throw(err).catch(this._rejecter);
+    return conn.rollbackAsync().throw(err).catch(function (error) {
+      if ((0, _isUndefined3.default)(error)) {
+        error = new Error('Transaction rejected with non-error: ' + error);
+      }
+
+      return _this2._rejecter(error);
+    });
   };
 
   Oracle_Transaction.prototype.acquireConnection = function acquireConnection(config) {

package/lib/dialects/oracledb/index.js

@@ -43,7 +43,21 @@ inherits(Client_Oracledb, Client_Oracle);
 Client_Oracledb.prototype.driverName = 'oracledb';
 
 Client_Oracledb.prototype._driver = function () {
+  var client = this;
   var oracledb = require('oracledb');
+  client.fetchAsString = [];
+  if (this.config.fetchAsString && _.isArray(this.config.fetchAsString)) {
+    this.config.fetchAsString.forEach(function (type) {
+      if (!_.isString(type)) return;
+      type = type.toUpperCase();
+      if (oracledb[type]) {
+        if (type !== 'NUMBER' && type !== 'DATE' && type !== 'CLOB') {
+          helpers.warn('Only "date", "number" and "clob" are supported for fetchAsString');
+        }
+        client.fetchAsString.push(oracledb[type]);
+      }
+    });
+  }
   return oracledb;
 };
 
@@ -100,6 +114,8 @@ Client_Oracledb.prototype.acquireRawConnection = function () {
       oracleDbConfig.stmtCacheSize = client.connectionSettings.stmtCacheSize;
     }
 
+    client.driver.fetchAsString = client.fetchAsString;
+
     client.driver.getConnection(oracleDbConfig, function (err, connection) {
       if (err) {
         return rejecter(err);

package/lib/dialects/oracledb/transaction.js

@@ -14,6 +14,10 @@ var _inherits2 = require('babel-runtime/helpers/inherits');
 
 var _inherits3 = _interopRequireDefault(_inherits2);
 
+var _isUndefined2 = require('lodash/isUndefined');
+
+var _isUndefined3 = _interopRequireDefault(_isUndefined2);
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 var Promise = require('bluebird');
@@ -49,6 +53,9 @@ var Oracle_Transaction = function (_Transaction) {
     return conn.rollbackAsync().timeout(5000).catch(Promise.TimeoutError, function (e) {
       self._rejecter(e);
     }).then(function () {
+      if ((0, _isUndefined3.default)(err)) {
+        err = new Error('Transaction rejected with non-error: ' + err);
+      }
       self._rejecter(err);
     });
   };

package/lib/dialects/postgres/index.js

@@ -61,6 +61,10 @@ function Client_PG(config) {
   if (config.searchPath) {
     this.searchPath = config.searchPath;
   }
+
+  if (config.version) {
+    this.version = config.version;
+  }
 }
 (0, _inherits2.default)(Client_PG, _client2.default);
 
@@ -112,8 +116,8 @@ function Client_PG(config) {
       }
       return escaped;
     },
-    escapeObject: function escapeObject(val, timezone, prepareValue) {
-      var seen = arguments.length <= 3 || arguments[3] === undefined ? [] : arguments[3];
+    escapeObject: function escapeObject(val, prepareValue, timezone) {
+      var seen = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : [];
 
       if (val && typeof val.toPostgres === 'function') {
         seen = seen || [];

package/lib/migrate/index.js

@@ -127,7 +127,20 @@ var Migrator = function () {
 
     this.config = this.setConfig(config);
     return this._migrationData().tap(validateMigrationList).spread(function (all, completed) {
-      return _this._runBatch((0, _difference3.default)(all, completed), 'up');
+      var migrations = (0, _difference3.default)(all, completed);
+
+      var transactionForAll = !_this.config.disableTransactions && (0, _isEmpty3.default)((0, _filter3.default)(migrations, function (name) {
+        var migration = require(_path2.default.join(_this._absoluteConfigDir(), name));
+        return !_this._useTransaction(migration);
+      }));
+
+      if (transactionForAll) {
+        return _this.knex.transaction(function (trx) {
+          return _this._runBatch(migrations, 'up', trx);
+        });
+      } else {
+        return _this._runBatch(migrations, 'up');
+      }
     });
   };
 
@@ -228,18 +241,20 @@ var Migrator = function () {
   Migrator.prototype._ensureTable = function _ensureTable() {
     var _this5 = this;
 
+    var trx = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.knex;
+
     var table = this.config.tableName;
     var lockTable = this._getLockTableName();
-    return this.knex.schema.hasTable(table).then(function (exists) {
-      return !exists && _this5._createMigrationTable(table);
+    return trx.schema.hasTable(table).then(function (exists) {
+      return !exists && _this5._createMigrationTable(table, trx);
     }).then(function () {
-      return _this5.knex.schema.hasTable(lockTable);
+      return trx.schema.hasTable(lockTable);
     }).then(function (exists) {
-      return !exists && _this5._createMigrationLockTable(lockTable);
+      return !exists && _this5._createMigrationLockTable(lockTable, trx);
     }).then(function () {
-      return _this5.knex(lockTable).select('*');
+      return trx.from(lockTable).select('*');
     }).then(function (data) {
-      return !data.length && _this5.knex(lockTable).insert({ is_locked: 0 });
+      return !data.length && trx.into(lockTable).insert({ is_locked: 0 });
     });
   };
 
@@ -247,7 +262,9 @@ var Migrator = function () {
 
 
   Migrator.prototype._createMigrationTable = function _createMigrationTable(tableName) {
-    return this.knex.schema.createTableIfNotExists(tableName, function (t) {
+    var trx = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this.knex;
+
+    return trx.schema.createTableIfNotExists(tableName, function (t) {
       t.increments();
       t.string('name');
       t.integer('batch');
@@ -256,7 +273,9 @@ var Migrator = function () {
   };
 
   Migrator.prototype._createMigrationLockTable = function _createMigrationLockTable(tableName) {
-    return this.knex.schema.createTableIfNotExists(tableName, function (t) {
+    var trx = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this.knex;
+
+    return trx.schema.createTableIfNotExists(tableName, function (t) {
       t.integer('is_locked');
     });
   };
@@ -277,10 +296,16 @@ var Migrator = function () {
     return this.knex(tableName).transacting(trx).update({ is_locked: 1 });
   };
 
-  Migrator.prototype._getLock = function _getLock() {
+  Migrator.prototype._getLock = function _getLock(trx) {
     var _this6 = this;
 
-    return this.knex.transaction(function (trx) {
+    var transact = trx ? function (fn) {
+      return fn(trx);
+    } : function (fn) {
+      return _this6.knex.transaction(fn);
+    };
+
+    return transact(function (trx) {
       return _this6._isLocked(trx).then(function (isLocked) {
         if (isLocked) {
           throw new Error("Migration table is already locked");
@@ -294,27 +319,36 @@ var Migrator = function () {
   };
 
   Migrator.prototype._freeLock = function _freeLock() {
+    var trx = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.knex;
+
     var tableName = this._getLockTableName();
-    return this.knex(tableName).update({ is_locked: 0 });
+    return trx.table(tableName).update({ is_locked: 0 });
   };
 
   // Run a batch of current migrations, in sequence.
 
 
-  Migrator.prototype._runBatch = function _runBatch(migrations, direction) {
+  Migrator.prototype._runBatch = function _runBatch(migrations, direction, trx) {
     var _this7 = this;
 
-    return this._getLock().then(function () {
+    return this._getLock(trx)
+    // When there is a wrapping transaction, some migrations
+    // could have been done while waiting for the lock:
+    .then(function () {
+      return trx ? _this7._listCompleted(trx) : [];
+    }).then(function (completed) {
+      return migrations = (0, _difference3.default)(migrations, completed);
+    }).then(function () {
       return _bluebird2.default.all((0, _map3.default)(migrations, (0, _bind3.default)(_this7._validateMigrationStructure, _this7)));
     }).then(function () {
-      return _this7._latestBatchNumber();
+      return _this7._latestBatchNumber(trx);
     }).then(function (batchNo) {
       if (direction === 'up') batchNo++;
       return batchNo;
     }).then(function (batchNo) {
-      return _this7._waterfallBatch(batchNo, migrations, direction);
+      return _this7._waterfallBatch(batchNo, migrations, direction, trx);
     }).tap(function () {
-      return _this7._freeLock();
+      return _this7._freeLock(trx);
     }).catch(function (error) {
       var cleanupReady = _bluebird2.default.resolve();
 
@@ -325,7 +359,7 @@ var Migrator = function () {
       } else {
         helpers.warn('migrations failed with error: ' + error.message);
         // If the error was not due to a locking issue, then remove the lock.
-        cleanupReady = _this7._freeLock();
+        cleanupReady = _this7._freeLock(trx);
       }
 
       return cleanupReady.finally(function () {
@@ -351,12 +385,11 @@ var Migrator = function () {
 
 
   Migrator.prototype._listCompleted = function _listCompleted() {
-    var _this8 = this;
-
+    var trx = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.knex;
     var tableName = this.config.tableName;
 
-    return this._ensureTable(tableName).then(function () {
-      return _this8.knex(tableName).orderBy('id').select('name');
+    return this._ensureTable(trx).then(function () {
+      return trx.from(tableName).orderBy('id').select('name');
     }).then(function (migrations) {
       return (0, _map3.default)(migrations, 'name');
     });
@@ -410,7 +443,9 @@ var Migrator = function () {
 
 
   Migrator.prototype._latestBatchNumber = function _latestBatchNumber() {
-    return this.knex(this.config.tableName).max('batch as max_batch').then(function (obj) {
+    var trx = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.knex;
+
+    return trx.from(this.config.tableName).max('batch as max_batch').then(function (obj) {
       return obj[0].max_batch || 0;
     });
   };
@@ -431,13 +466,13 @@ var Migrator = function () {
   // appropriate database information as the migrations are run.
 
 
-  Migrator.prototype._waterfallBatch = function _waterfallBatch(batchNo, migrations, direction) {
-    var _this9 = this;
+  Migrator.prototype._waterfallBatch = function _waterfallBatch(batchNo, migrations, direction, trx) {
+    var _this8 = this;
 
-    var knex = this.knex;
-    var _config = this.config;
-    var tableName = _config.tableName;
-    var disableTransactions = _config.disableTransactions;
+    var trxOrKnex = trx || this.knex;
+    var _config = this.config,
+        tableName = _config.tableName,
+        disableTransactions = _config.disableTransactions;
 
     var directory = this._absoluteConfigDir();
     var current = _bluebird2.default.bind({ failed: false, failedOn: 0 });
@@ -448,21 +483,21 @@ var Migrator = function () {
 
       // We're going to run each of the migrations in the current "up".
       current = current.then(function () {
-        if (_this9._useTransaction(migration, disableTransactions)) {
-          return _this9._transaction(migration, direction, name);
+        if (!trx && _this8._useTransaction(migration, disableTransactions)) {
+          return _this8._transaction(migration, direction, name);
         }
-        return warnPromise(migration[direction](knex, _bluebird2.default), name);
+        return warnPromise(migration[direction](trxOrKnex, _bluebird2.default), name);
       }).then(function () {
         log.push(_path2.default.join(directory, name));
         if (direction === 'up') {
-          return knex(tableName).insert({
+          return trxOrKnex.into(tableName).insert({
             name: name,
             batch: batchNo,
             migration_time: new Date()
           });
         }
         if (direction === 'down') {
-          return knex(tableName).where({ name: name }).del();
+          return trxOrKnex.from(tableName).where({ name: name }).del();
         }
       });
     });

package/lib/migrate/stub/coffee.stub

@@ -1,13 +1,13 @@
-
-exports.up = (knex, Promise) ->
-  <% if (d.tableName) { %>
-  knex.schema.createTable "<%= d.tableName %>", (t) ->
-    t.increments()
-    t.timestamp()
-  <% } %>
-
-
-exports.down = (knex, Promise) ->
-  <% if (d.tableName) { %>
-  knex.schema.dropTable "<%= d.tableName %>"
+
+exports.up = (knex, Promise) ->
+  <% if (d.tableName) { %>
+  knex.schema.createTable "<%= d.tableName %>", (t) ->
+    t.increments()
+    t.timestamp()
+  <% } %>
+
+
+exports.down = (knex, Promise) ->
+  <% if (d.tableName) { %>
+  knex.schema.dropTable "<%= d.tableName %>"
   <% } %>

package/lib/migrate/stub/eg.stub

@@ -1,14 +1,14 @@
-provide: up, down
-
-up = (knex, Promise) ->
-  <% if (d.tableName) { %>
-  knex.schema.createTable "<%= d.tableName %>": t ->
-    t.increments()
-    t.timestamp()
-  <% } %>
-
-
-down = (knex, Promise) ->
-  <% if (d.tableName) { %>
-  knex.schema.dropTable("<%= d.tableName %>")
-  <% } %>
+provide: up, down
+
+up = (knex, Promise) ->
+  <% if (d.tableName) { %>
+  knex.schema.createTable "<%= d.tableName %>": t ->
+    t.increments()
+    t.timestamp()
+  <% } %>
+
+
+down = (knex, Promise) ->
+  <% if (d.tableName) { %>
+  knex.schema.dropTable("<%= d.tableName %>")
+  <% } %>

package/lib/migrate/stub/js.stub

@@ -1,15 +1,15 @@
-
-exports.up = function(knex, Promise) {
-  <% if (d.tableName) { %>
-  return knex.schema.createTable("<%= d.tableName %>", function(t) {
-    t.increments();
-    t.timestamp();
-  });
-  <% } %>
-};
-
-exports.down = function(knex, Promise) {
-  <% if (d.tableName) { %>
-  return knex.schema.dropTable("<%= d.tableName %>");
-  <% } %>
-};
+
+exports.up = function(knex, Promise) {
+  <% if (d.tableName) { %>
+  return knex.schema.createTable("<%= d.tableName %>", function(t) {
+    t.increments();
+    t.timestamp();
+  });
+  <% } %>
+};
+
+exports.down = function(knex, Promise) {
+  <% if (d.tableName) { %>
+  return knex.schema.dropTable("<%= d.tableName %>");
+  <% } %>
+};

package/lib/migrate/stub/knexfile-coffee.stub

@@ -1,34 +1,34 @@
-# Update with your config settings.
-
-module.exports =
-
-  development:
-    client: 'sqlite3'
-    connection:
-      filename: './dev.sqlite3'
-    migrations:
-      tableName: 'knex_migrations'
-
-  staging:
-    client: 'postgresql'
-    connection:
-      database: 'my_db'
-      user:     'username'
-      password: 'password'
-    pool:
-      min: 2
-      max: 10
-    migrations:
-      tableName: 'knex_migrations'
-
-  production:
-    client: 'postgresql'
-    connection:
-      database: 'my_db'
-      user:     'username'
-      password: 'password'
-    pool:
-      min: 2
-      max: 10
-    migrations:
-      tableName: 'knex_migrations'
+# Update with your config settings.
+
+module.exports =
+
+  development:
+    client: 'sqlite3'
+    connection:
+      filename: './dev.sqlite3'
+    migrations:
+      tableName: 'knex_migrations'
+
+  staging:
+    client: 'postgresql'
+    connection:
+      database: 'my_db'
+      user:     'username'
+      password: 'password'
+    pool:
+      min: 2
+      max: 10
+    migrations:
+      tableName: 'knex_migrations'
+
+  production:
+    client: 'postgresql'
+    connection:
+      database: 'my_db'
+      user:     'username'
+      password: 'password'
+    pool:
+      min: 2
+      max: 10
+    migrations:
+      tableName: 'knex_migrations'