knex 0.19.4 → 0.19.5

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Master (Unreleased)
 
+# 0.19.5 - 06 October, 2019
+
+### New features:
+
+- CLI: Migrations up/down commands - filename parameter #3416
+- Oracle: Support stored procedures #3449
+
+### Bug fixes:
+
+- MSSQL: Escape column ids correctly in all cases (reported by Snyk Security Research Team) #3382
+- SQLite: Fix handling of multiline SQL in SQLite3 schema #3411
+- Fix concurrent child transactions failing #2213 #3440
+
+### Typings:
+
+- Add missing Migrator.list typing #3460
+- Fix Typescript type inference for to better support wildcard (*) calls #3444
+- Make options argument optional in timeout #3442
+
+### Test / internal changes:
+
+- Enable linting in CI #3450
+
 # 0.19.4 - 09 September, 2019
 
 ### New features:

package/bin/cli.js

@@ -190,11 +190,13 @@ function invoke(env) {
     });
 
   commander
-    .command('migrate:up')
-    .description('        Run the next migration that has not yet been run.')
-    .action(() => {
+    .command('migrate:up [<name>]')
+    .description(
+      '        Run the next or the specified migration that has not yet been run.'
+    )
+    .action((name) => {
       pending = initKnex(env, commander.opts())
-        .migrate.up()
+        .migrate.up({ name })
         .then(([batchNo, log]) => {
           if (log.length === 0) {
             success(color.cyan('Already up to date'));
@@ -235,11 +237,13 @@ function invoke(env) {
     });
 
   commander
-    .command('migrate:down')
-    .description('        Undo the last migration performed.')
-    .action(() => {
+    .command('migrate:down [<name>]')
+    .description(
+      '        Undo the last or the specified migration that was already run.'
+    )
+    .action((name) => {
       pending = initKnex(env, commander.opts())
-        .migrate.down()
+        .migrate.down({ name })
         .then(([batchNo, log]) => {
           if (log.length === 0) {
             success(color.cyan('Already at the base migration'));

package/lib/dialects/mssql/index.js

@@ -207,7 +207,11 @@ Object.assign(Client_MSSQL.prototype, {
   },
 
   wrapIdentifierImpl(value) {
-    return value !== '*' ? `[${value.replace(/\[/g, '[')}]` : '*';
+    if (value === '*') {
+      return '*';
+    }
+
+    return `[${value.replace(/[[\]']+/g, '')}]`;
   },
 
   // Get a raw connection, called by the `pool` whenever a new

package/lib/dialects/oracledb/index.js

@@ -263,6 +263,13 @@ Client_Oracledb.prototype._query = function(connection, obj) {
           ? response.rows.rowsAffected
           : response.rowsAffected;
 
+        //added for outBind parameter
+        if (obj.method === 'raw' && outBinds.length > 0) {
+          return resolver({
+            response: outBinds,
+          });
+        }
+
         if (obj.method === 'update') {
           const modifiedRowsCount = obj.rowsAffected.length || obj.rowsAffected;
           const updatedObjOutBinding = [];

package/lib/dialects/sqlite3/schema/ddl.js

@@ -129,7 +129,8 @@ assign(SQLite3_DDL.prototype, {
   },
 
   _doReplace(sql, from, to) {
-    const matched = sql.match(/^CREATE TABLE (\S+) \((.*)\)/);
+    const oneLineSql = sql.replace(/\s+/g, ' ');
+    const matched = oneLineSql.match(/^CREATE TABLE (\S+) \((.*)\)/);
 
     const tableName = matched[1];
     const defs = matched[2];
@@ -166,23 +167,27 @@ assign(SQLite3_DDL.prototype, {
     }
     args.push(defs.slice(ptr, i));
 
-    // Backwards compatible for double quoted sqlite databases
-    // Detect CREATE TABLE "accounts" ("id"...)
-    // The "from" and "to" field use backsticks, because this is the default notation for
-    // SQlite3 since Knex 0.14.
-    // e.g. from: `about`
-    //
-    // We have to replace the from+to field with double slashes in case you created your SQlite3
-    // database with Knex < 0.14.
-    if (sql.match(/CREATE\sTABLE\s".*"\s\("/)) {
-      from = from.replace(/[`]/g, '"');
-      to = to.replace(/[`]/g, '"');
-    }
+    const fromIdentifier = from.replace(/[`"]/g, '');
 
     args = args.map(function(item) {
-      let split = item.split(' ');
+      let split = item.trim().split(' ');
+
+      let normalizedFrom = from;
 
-      if (split[0] === from) {
+      // Backwards compatible for double quoted sqlite databases
+      // The "from" and "to" field use backsticks, because this is the default notation for
+      // SQlite3 since Knex 0.14.
+      // e.g. from: `about`
+      //
+      // We have to replace the from+to field with double slashes in case you created your SQlite3
+      // database with Knex < 0.14.
+      if (item.match(`"${fromIdentifier}"`)) {
+        normalizedFrom = `"${fromIdentifier}"`;
+      } else if (item.match(`\`${fromIdentifier}\``)) {
+        normalizedFrom = `\`${fromIdentifier}\``;
+      }
+
+      if (split[0] === normalizedFrom) {
         // column definition
         if (to) {
           split[0] = to;
@@ -198,7 +203,9 @@ assign(SQLite3_DDL.prototype, {
       // columns from this table listed between (); replace
       // one if it matches
       if (/primary|unique/i.test(split[idx])) {
-        return item.replace(/\(.*\)/, (columns) => columns.replace(from, to));
+        return item.replace(/\(.*\)/, (columns) =>
+          columns.replace(normalizedFrom, to)
+        );
       }
 
       // foreign keys have one or more columns from this table
@@ -210,11 +217,11 @@ assign(SQLite3_DDL.prototype, {
         split = item.split(/ references /i);
         // the quoted column names save us from having to do anything
         // other than a straight replace here
-        split[0] = split[0].replace(from, to);
+        split[0] = split[0].replace(normalizedFrom, to);
 
         if (split[1].slice(0, tableName.length) === tableName) {
           split[1] = split[1].replace(/\(.*\)/, (columns) =>
-            columns.replace(from, to)
+            columns.replace(normalizedFrom, to)
           );
         }
         return split.join(' references ');
@@ -222,7 +229,7 @@ assign(SQLite3_DDL.prototype, {
 
       return item;
     });
-    return sql
+    return oneLineSql
       .replace(/\(.*\)/, () => `(${args.join(', ')})`)
       .replace(/,\s*([,)])/, '$1');
   },

package/lib/helpers.js

@@ -65,7 +65,7 @@ function getUndefinedIndices(mixed) {
       if (containsUndefined(mixed[key])) {
         indices.push(key);
       }
-    })
+    });
   } else {
     indices.push(0);
   }

package/lib/migrate/Migrator.js

@@ -108,16 +108,38 @@ class Migrator {
         return value;
       })
       .then(([all, completed]) => {
-        const migrationToRun = getNewMigrations(
+        const newMigrations = getNewMigrations(
           this.config.migrationSource,
           all,
           completed
-        ).slice(0, 1);
+        );
+
+        let migrationToRun;
+        const name = this.config.name;
+        if (name) {
+          if (!completed.includes(name)) {
+            migrationToRun = newMigrations.find((migration) => {
+              return (
+                this.config.migrationSource.getMigrationName(migration) === name
+              );
+            });
+            if (!migrationToRun) {
+              throw new Error(`Migration "${name}" not found.`);
+            }
+          }
+        } else {
+          migrationToRun = newMigrations[0];
+        }
+
+        const migrationsToRun = [];
+        if (migrationToRun) {
+          migrationsToRun.push(migrationToRun);
+        }
 
         const transactionForAll =
           !this.config.disableTransactions &&
           isEmpty(
-            filter(migrationToRun, (migration) => {
+            filter(migrationsToRun, (migration) => {
               const migrationContents = this.config.migrationSource.getMigration(
                 migration
               );
@@ -128,10 +150,10 @@ class Migrator {
 
         if (transactionForAll) {
           return this.knex.transaction((trx) => {
-            return this._runBatch(migrationToRun, 'up', trx);
+            return this._runBatch(migrationsToRun, 'up', trx);
           });
         } else {
-          return this._runBatch(migrationToRun, 'up');
+          return this._runBatch(migrationsToRun, 'up');
         }
       });
   }
@@ -180,16 +202,33 @@ class Migrator {
         return value;
       })
       .then(([all, completed]) => {
-        const migrationToRun = all
-          .filter((migration) => {
-            return completed.includes(
-              this.config.migrationSource.getMigrationName(migration)
+        const completedMigrations = all.filter((migration) => {
+          return completed.includes(
+            this.config.migrationSource.getMigrationName(migration)
+          );
+        });
+
+        let migrationToRun;
+        const name = this.config.name;
+        if (name) {
+          migrationToRun = completedMigrations.find((migration) => {
+            return (
+              this.config.migrationSource.getMigrationName(migration) === name
             );
-          })
-          .reverse()
-          .slice(0, 1);
+          });
+          if (!migrationToRun) {
+            throw new Error(`Migration "${name}" was not run.`);
+          }
+        } else {
+          migrationToRun = completedMigrations[completedMigrations.length - 1];
+        }
+
+        const migrationsToRun = [];
+        if (migrationToRun) {
+          migrationsToRun.push(migrationToRun);
+        }
 
-        return this._runBatch(migrationToRun, 'down');
+        return this._runBatch(migrationsToRun, 'down');
       });
   }
 

package/lib/query/builder.js

@@ -1271,8 +1271,8 @@ Builder.prototype.del = Builder.prototype.delete;
 require('../interface')(Builder);
 helpers.addQueryContext(Builder);
 
-Builder.extend = function(methodName, fn) {
-  if (Builder.prototype.hasOwnProperty(methodName)) {
+Builder.extend = (methodName, fn) => {
+  if (Object.prototype.hasOwnProperty.call(Builder.prototype, methodName)) {
     throw new Error(
       `Can't extend QueryBuilder with existing method ('${methodName}').`
     );

package/lib/query/compiler.js

@@ -100,7 +100,9 @@ assign(QueryCompiler.prototype, {
       debugBindings(query.bindings);
       throw new Error(
         `Undefined binding(s) detected when compiling ` +
-          `${method.toUpperCase()}. Undefined column(s): [${this.undefinedBindingsInfo.join(', ')}] query: ${query.sql}`
+          `${method.toUpperCase()}. Undefined column(s): [${this.undefinedBindingsInfo.join(
+            ', '
+          )}] query: ${query.sql}`
       );
     }
 
@@ -373,7 +375,7 @@ assign(QueryCompiler.prototype, {
         Object.prototype.hasOwnProperty.call(stmt, 'value') &&
         helpers.containsUndefined(stmt.value)
       ) {
-        this.undefinedBindingsInfo.push(stmt.column)
+        this.undefinedBindingsInfo.push(stmt.column);
         this._undefinedInWhereClause = true;
       }
       const val = this[stmt.type](stmt);

package/lib/raw.js

@@ -104,7 +104,9 @@ assign(Raw.prototype, {
 
     obj.bindings = obj.bindings || [];
     if (helpers.containsUndefined(obj.bindings)) {
-      const undefinedBindingIndices = helpers.getUndefinedIndices(this.bindings);
+      const undefinedBindingIndices = helpers.getUndefinedIndices(
+        this.bindings
+      );
       debugBindings(obj.bindings);
       throw new Error(
         `Undefined binding(s) detected for keys [${undefinedBindingIndices}] when compiling RAW query: ${obj.sql}`

package/lib/transaction.js

@@ -210,6 +210,7 @@ class Transaction extends EventEmitter {
   // the original promise is marked completed.
   acquireConnection(client, config, txid) {
     const configConnection = config && config.connection;
+    const trx = this;
     return new Bluebird((resolve, reject) => {
       try {
         resolve(configConnection || client.acquireConnection());
@@ -220,7 +221,12 @@ class Transaction extends EventEmitter {
       .then(function(connection) {
         connection.__knexTxId = txid;
 
-        return connection;
+        return (trx._previousSibling
+          ? trx._previousSibling.reflect()
+          : Promise.resolve()
+        ).then(function() {
+          return connection;
+        });
       })
       .disposer(function(connection) {
         if (!configConnection) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex",
-  "version": "0.19.4",
+  "version": "0.19.5",
   "description": "A batteries-included SQL query & schema builder for Postgres, MySQL and SQLite3 and the Browser",
   "main": "knex.js",
   "types": "types/index.d.ts",
@@ -14,8 +14,10 @@
     "coveralls": "nyc report --reporter=text-lcov | coveralls",
     "lint": "eslint \"lib/**/*.js\" \"test/**/*.js\"",
     "lint:types": "dtslint types",
+    "lint:everything": "npm run lint:types && npm run lint",
     "test": "mocha --exit -t 10000 test/index.js && npm run test:tape && npm run test:cli",
-    "test:nyc": "nyc mocha --exit --check-leaks --globals __core-js_shared__ -t 10000 test/index.js && npm run test:tape && npm run test:cli",
+    "test:coverage": "nyc mocha --exit --check-leaks --globals __core-js_shared__ -t 10000 test/index.js && npm run test:tape && npm run test:cli",
+    "test:everything": "npm run lint:everything && npm run test:coverage",
     "test:sqlite": "cross-env DB=sqlite3 npm test",
     "test:tape": "node test/tape/index.js | tap-spec",
     "test:cli": "cross-env KNEX_PATH=../knex.js KNEX=bin/cli.js jake -f test/jake/Jakefile",
@@ -26,9 +28,9 @@
     "stress:destroy": "docker-compose -f scripts/stress-test/docker-compose.yml stop"
   },
   "dependencies": {
-    "bluebird": "^3.5.5",
+    "bluebird": "^3.7.0",
     "colorette": "1.1.0",
-    "commander": "^3.0.1",
+    "commander": "^3.0.2",
     "debug": "4.1.1",
     "getopts": "2.2.5",
     "inherits": "~2.0.4",
@@ -49,21 +51,21 @@
     ]
   },
   "devDependencies": {
-    "@types/node": "^10.14.17",
+    "@types/node": "^10.14.20",
     "JSONStream": "^1.3.5",
     "chai": "^4.2.0",
     "chai-subset-in-order": "^2.1.3",
-    "cli-testlab": "^1.7.0",
+    "cli-testlab": "^1.8.0",
     "coveralls": "^3.0.6",
-    "cross-env": "^5.2.1",
-    "dtslint": "^0.9.6",
-    "eslint": "^6.3.0",
-    "eslint-config-prettier": "^6.2.0",
+    "cross-env": "^6.0.3",
+    "dtslint": "^0.9.8",
+    "eslint": "^6.5.1",
+    "eslint-config-prettier": "^6.4.0",
     "eslint-plugin-import": "^2.18.2",
-    "husky": "^3.0.5",
+    "husky": "^3.0.8",
     "jake": "^8.1.1",
-    "lint-staged": "^9.2.5",
-    "mocha": "^6.2.0",
+    "lint-staged": "^9.4.1",
+    "mocha": "^6.2.1",
     "mock-fs": "^4.10.1",
     "mssql": "^5.1.0",
     "mysql": "^2.17.1",
@@ -73,15 +75,15 @@
     "pg-query-stream": "^2.0.0",
     "prettier": "^1.18.2",
     "rimraf": "^3.0.0",
-    "sinon": "^7.4.2",
+    "sinon": "^7.5.0",
     "sinon-chai": "^3.3.0",
     "source-map-support": "^0.5.13",
     "sqlite3": "^4.1.0",
     "tap-spec": "^5.0.0",
     "tape": "^4.11.0",
     "toxiproxy-node-client": "^2.0.6",
-    "typescript": "^3.6.2",
-    "webpack-cli": "^3.3.8"
+    "typescript": "^3.6.3",
+    "webpack-cli": "^3.3.9"
   },
   "buildDependencies": [
     "rimraf"

package/types/index.d.ts

@@ -548,6 +548,10 @@ declare namespace Knex {
     ): QueryBuilder<TRecord, TRecord[K][]>;
     pluck<TResult2 extends {}>(column: string): QueryBuilder<TRecord, TResult2>;
 
+    insert(
+      data: MaybeArray<SafePartial<TRecord>>,
+      returning: '*'
+    ): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     insert<
       TKey extends StrKey<TRecord>,
       TResult2 = DeferredIndex.Augment<
@@ -601,6 +605,10 @@ declare namespace Knex {
       ...args: any[]
     ): QueryBuilder<TRecord2, TResult2>;
 
+    update(
+      data: MaybeArray<SafePartial<TRecord>>,
+      returning: '*'
+    ): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     update<
       TKey extends StrKey<TRecord>,
       TResult2 = DeferredIndex.Augment<
@@ -685,6 +693,7 @@ declare namespace Knex {
     ): QueryBuilder<TRecord, TResult2>;
     update<TResult2 = number>(columnName: string, value: Value): QueryBuilder<TRecord, TResult2>;
 
+    returning(column: '*'): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     returning<
       TKey extends StrKey<TRecord>,
       TResult2 = DeferredIndex.Augment<
@@ -708,6 +717,9 @@ declare namespace Knex {
       column: string | string[]
     ): QueryBuilder<TRecord, TResult2>;
 
+    del(
+      returning: '*'
+    ): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     del<
       TKey extends StrKey<TRecord>,
       TResult2 = DeferredIndex.Augment<
@@ -733,6 +745,9 @@ declare namespace Knex {
     ): QueryBuilder<TRecord, TResult2>;
     del<TResult2 = number>(): QueryBuilder<TRecord, TResult2>;
 
+    delete(
+      returning: '*'
+    ): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     delete<
       TKey extends StrKey<TRecord>,
       TResult2 = DeferredIndex.Augment<
@@ -1340,7 +1355,6 @@ declare namespace Knex {
   >
     extends QueryInterface<TRecord, TResult>,
       ChainableInterface<ResolveResult<TResult>> {
-
     or: QueryBuilder<TRecord, TResult>;
     not: QueryBuilder<TRecord, TResult>;
     and: QueryBuilder<TRecord, TResult>;
@@ -1364,7 +1378,7 @@ declare namespace Knex {
     queryContext(context: any): QueryBuilder<TRecord, TResult>;
 
     clone(): QueryBuilder<TRecord, TResult>;
-    timeout(ms: number, options: {cancel?: boolean}): QueryBuilder<TRecord, TResult>;
+    timeout(ms: number, options?: {cancel?: boolean}): QueryBuilder<TRecord, TResult>;
   }
 
   interface Sql {
@@ -1812,6 +1826,7 @@ declare namespace Knex {
     rollback(config?: MigratorConfig, all?: boolean): Promise<any>;
     status(config?: MigratorConfig): Promise<number>;
     currentVersion(config?: MigratorConfig): Promise<string>;
+    list(config?: MigratorConfig): Promise<any>;
     up(config?: MigratorConfig): Promise<any>;
     down(config?: MigratorConfig): Promise<any>;
   }
@@ -1858,7 +1873,7 @@ declare namespace Knex {
   }
 
   class QueryBuilder {
-    public static extend(
+    static extend(
       methodName: string,
       fn: <TRecord extends {} = any, TResult = unknown[]>(
         this: Knex<TRecord, TResult>,