knex 0.20.6 → 0.20.10

package/CHANGELOG.md

@@ -1,5 +1,67 @@
 # Master (Unreleased)
 
+# 0.20.10 - 13 February, 2020
+
+### Bug fixes:
+
+- Oracle: commit was a no-op causing race conditions #3668
+- CLI: Knex calls process.chdir() before opening Knexfile #3661
+- Fixed unresolved promise in cancelQuery() #3666
+
+### Typings:
+
+- `fn.now` takes optionally a precision argument. #3662
+- PG: Include SSL in connection definition #3659 
+
+### Test / internal changes:
+
+- replace Bluebird.timeout #3634
+
+# 0.20.9 - 08 February, 2020
+
+### Bug fixes:
+
+- CLI: Improve Support for Liftoff's Preloaders - this should fix some cases like using TS for your migrations #3613
+
+### Typings:
+
+- MSSQL: Add `enableArithAbort` to `MsSqlConnectionConfig` 
+
+### Test / internal changes:
+
+- Refactor more tests to use cli-testlab #3640
+- Update QueryCompiler implementation to use classes #3647
+
+# 0.20.8 - 14 January, 2020
+
+### New features:
+
+- CLI: Support ES6 modules via flag --esm #3616
+
+### Bug fixes:
+
+- CLI: Print help only when there are no arguments #3617
+
+### Typings:
+
+- Fix incorrect type of QueryBuilder.first('*') result #3621
+
+# 0.20.7 - 07 January, 2020
+
+### New features:
+
+- Throw better error when trying to modify schema while using unsupported dialect #3609
+
+### Bug fixes:
+
+- Oracle: dispose connection on connection error #3611
+- Oracle: fix not releasing connection from pool on disconnect #3605
+- CLI: prevent warning with root command #3604
+
+### Typings:
+
+- Add create/drop schema methods to SchemaBuilder #3579
+
 # 0.20.6 - 29 December, 2019
 
 ### Bug fixes:

package/README.md

@@ -41,7 +41,7 @@ We have several examples [on the website](http://knexjs.org). Here is the first
 
 ```js
 const knex = require('knex')({
-  dialect: 'sqlite3',
+  client: 'sqlite3',
   connection: {
     filename: './data.db',
   },

package/bin/cli.js

@@ -12,7 +12,6 @@ const { promisify } = require('util');
 const cliPkg = require('../package');
 const {
   mkConfigObj,
-  resolveKnexFilePath,
   resolveEnvironmentConfig,
   exit,
   success,
@@ -29,6 +28,17 @@ const fsPromised = {
   writeFile: promisify(fs.writeFile),
 };
 
+function openKnexfile(configPath) {
+  const config = require(configPath);
+
+  // FYI: By default, the extension for the migration files is inferred
+  //      from the knexfile's extension. So, the following lines are in
+  //      place for backwards compatibility purposes.
+  config.ext = config.ext || path.extname(configPath).replace('.', '');
+
+  return config;
+}
+
 function initKnex(env, opts) {
   checkLocalModule(env);
   if (process.cwd() !== env.cwd) {
@@ -39,37 +49,15 @@ function initKnex(env, opts) {
     );
   }
 
-  if (!opts.knexfile) {
-    const configurationPath = resolveKnexFilePath();
-    const configuration = configurationPath
-      ? require(configurationPath.path)
-      : undefined;
-
-    env.configuration = configuration || mkConfigObj(opts);
-    if (!env.configuration.ext && configurationPath) {
-      env.configuration.ext = configurationPath.extension;
-    }
-  }
-  // If knexfile is specified
-  else {
-    const resolvedKnexfilePath = path.resolve(opts.knexfile);
-    const knexfileDir = path.dirname(resolvedKnexfilePath);
-    process.chdir(knexfileDir);
-    env.configuration = require(resolvedKnexfilePath);
-
-    if (!env.configuration) {
-      exit(
-        'Knexfile not found. Specify a path with --knexfile or pass --client and --connection params in commandline'
-      );
-    }
-
-    if (!env.configuration.ext) {
-      env.configuration.ext = path
-        .extname(resolvedKnexfilePath)
-        .replace('.', '');
-    }
+  if (opts.esm) {
+    // enable esm interop via 'esm' module
+    require = require('esm')(module);
   }
 
+  env.configuration = env.configPath
+    ? openKnexfile(env.configPath)
+    : mkConfigObj(opts);
+
   const resolvedConfig = resolveEnvironmentConfig(opts, env.configuration);
   const knex = require(env.modulePath);
   return knex(resolvedConfig);
@@ -110,7 +98,8 @@ function invoke(env) {
     .option(
       '--env [name]',
       'environment, default: process.env.NODE_ENV || development'
-    );
+    )
+    .option('--esm', 'Enable ESM interop.');
 
   commander
     .command('init')
@@ -341,12 +330,11 @@ function invoke(env) {
         .catch(exit);
     });
 
-  commander.parse(process.argv);
-
-  Promise.resolve(pending).then(() => {
+  if (!process.argv.slice(2).length) {
     commander.outputHelp();
-    exit('Unknown command-line options, exiting');
-  });
+  }
+
+  commander.parse(process.argv);
 }
 
 const cli = new Liftoff({
@@ -364,11 +352,21 @@ cli.on('requireFail', function(name) {
   console.log(color.red('Failed to load external module'), color.magenta(name));
 });
 
+// FYI: The handling for the `--cwd` and `--knexfile` arguments is a bit strange,
+//      but we decided to retain the behavior for backwards-compatibility.  In
+//      particular: if `--knexfile` is a relative path, then it will be resolved
+//      relative to `--cwd` instead of the shell's CWD.
+//
+//      So, the easiest way to replicate this behavior is to have the CLI change
+//      its CWD to `--cwd` immediately before initializing everything else.  This
+//      ensures that Liftoff will then resolve the path to `--knexfile` correctly.
+if (argv.cwd) {
+  process.chdir(argv.cwd);
+}
+
 cli.launch(
   {
-    cwd: argv.cwd,
-    knexfile: argv.knexfile,
-    knexpath: argv.knexpath,
+    configPath: argv.knexfile,
     require: argv.require,
     completion: argv.completion,
   },

package/bin/utils/cli-config-utils.js

@@ -8,9 +8,8 @@ const argv = require('getopts')(process.argv.slice(2));
 
 function mkConfigObj(opts) {
   if (!opts.client) {
-    const path = resolveDefaultKnexfilePath();
     throw new Error(
-      `No default configuration file '${path}' found and no commandline connection parameters passed`
+      `No configuration file found and no commandline connection parameters passed`
     );
   }
 
@@ -31,34 +30,6 @@ function mkConfigObj(opts) {
   };
 }
 
-function resolveKnexFilePath() {
-  const jsPath = resolveDefaultKnexfilePath('js');
-  if (fs.existsSync(jsPath)) {
-    return {
-      path: jsPath,
-      extension: 'js',
-    };
-  }
-
-  const tsPath = resolveDefaultKnexfilePath('ts');
-  if (fs.existsSync(tsPath)) {
-    return {
-      path: tsPath,
-      extension: 'ts',
-    };
-  }
-
-  console.warn(
-    `Failed to find configuration at default location of ${resolveDefaultKnexfilePath(
-      'js'
-    )}`
-  );
-}
-
-function resolveDefaultKnexfilePath(extension) {
-  return process.cwd() + `/knexfile.${extension}`;
-}
-
 function resolveEnvironmentConfig(opts, allConfigs) {
   const environment = opts.env || process.env.NODE_ENV || 'development';
   const result = allConfigs[environment] || allConfigs;
@@ -156,7 +127,6 @@ function getStubPath(configKey, env, opts) {
 
 module.exports = {
   mkConfigObj,
-  resolveKnexFilePath,
   resolveEnvironmentConfig,
   exit,
   success,

package/lib/client.js

@@ -25,6 +25,7 @@ const { makeEscape } = require('./query/string');
 const { uniqueId, cloneDeep, defaults } = require('lodash');
 
 const Logger = require('./logger');
+const { KnexTimeoutError } = require('./util/timeout');
 
 const debug = require('debug')('knex:client');
 const _debugQuery = require('debug')('knex:query');
@@ -344,11 +345,15 @@ Object.assign(Client.prototype, {
           debug('acquired connection from pool: %s', connection.__knexUid);
           return connection;
         })
-        .catch(TimeoutError, () => {
-          throw new Bluebird.TimeoutError(
-            'Knex: Timeout acquiring a connection. The pool is probably full. ' +
-              'Are you missing a .transacting(trx) call?'
-          );
+        .catch((error) => {
+          let convertedError = error;
+          if (error instanceof TimeoutError) {
+            convertedError = new KnexTimeoutError(
+              'Knex: Timeout acquiring a connection. The pool is probably full. ' +
+                'Are you missing a .transacting(trx) call?'
+            );
+          }
+          throw convertedError;
         });
     } catch (e) {
       return Bluebird.reject(e);

package/lib/dialects/mssql/query/compiler.js

@@ -1,15 +1,9 @@
 // MSSQL Query Compiler
 // ------
-const inherits = require('inherits');
 const QueryCompiler = require('../../../query/compiler');
 
 const { isEmpty, compact, identity } = require('lodash');
 
-function QueryCompiler_MSSQL(client, builder) {
-  QueryCompiler.call(this, client, builder);
-}
-inherits(QueryCompiler_MSSQL, QueryCompiler);
-
 const components = [
   'columns',
   'join',
@@ -23,14 +17,17 @@ const components = [
   'offset',
 ];
 
-Object.assign(QueryCompiler_MSSQL.prototype, {
-  _emptyInsertValue: 'default values',
+class QueryCompiler_MSSQL extends QueryCompiler {
+  constructor(client, builder) {
+    super(client, builder);
+    this._emptyInsertValue = 'default values';
+  }
 
   select() {
     const sql = this.with();
     const statements = components.map((component) => this[component](this));
     return sql + compact(statements).join(' ');
-  },
+  }
 
   // Compiles an "insert" query, allowing for multiple
   // inserts using a single query statement.
@@ -79,7 +76,7 @@ Object.assign(QueryCompiler_MSSQL.prototype, {
       sql,
       returning,
     };
-  },
+  }
 
   // Compiles an `update` query, allowing for a return value.
   update() {
@@ -103,7 +100,7 @@ Object.assign(QueryCompiler_MSSQL.prototype, {
         (!returning ? this._returning('rowcount', '@@rowcount') : ''),
       returning: returning || '@@rowcount',
     };
-  },
+  }
 
   // Compiles a `delete` query.
   del() {
@@ -121,7 +118,7 @@ Object.assign(QueryCompiler_MSSQL.prototype, {
         (!returning ? this._returning('rowcount', '@@rowcount') : ''),
       returning: returning || '@@rowcount',
     };
-  },
+  }
 
   // Compiles the columns in the query, specifying if an item was distinct.
   columns() {
@@ -156,7 +153,7 @@ Object.assign(QueryCompiler_MSSQL.prototype, {
       sql.join(', ') +
       (this.tableName ? ` from ${this.tableName}` : '')
     );
-  },
+  }
 
   _returning(method, value) {
     switch (method) {
@@ -172,23 +169,23 @@ Object.assign(QueryCompiler_MSSQL.prototype, {
       case 'rowcount':
         return value ? ';select @@rowcount' : '';
     }
-  },
+  }
 
   // Compiles a `truncate` query.
   truncate() {
     return `truncate table ${this.tableName}`;
-  },
+  }
 
   forUpdate() {
     // this doesn't work exacltly as it should, one should also mention index while locking
     // https://stackoverflow.com/a/9818448/360060
     return 'with (UPDLOCK)';
-  },
+  }
 
   forShare() {
     // http://www.sqlteam.com/article/introduction-to-locking-in-sql-server
     return 'with (HOLDLOCK)';
-  },
+  }
 
   // Compiles a `columnInfo` query.
   columnInfo() {
@@ -230,18 +227,18 @@ Object.assign(QueryCompiler_MSSQL.prototype, {
         return (column && out[column]) || out;
       },
     };
-  },
+  }
 
   top() {
     const noLimit = !this.single.limit && this.single.limit !== 0;
     const noOffset = !this.single.offset;
     if (noLimit || !noOffset) return '';
     return `top (${this.formatter.parameter(this.single.limit)})`;
-  },
+  }
 
   limit() {
     return '';
-  },
+  }
 
   offset() {
     const noLimit = !this.single.limit && this.single.limit !== 0;
@@ -256,8 +253,8 @@ Object.assign(QueryCompiler_MSSQL.prototype, {
       )} rows only`;
     }
     return offset;
-  },
-});
+  }
+}
 
 // Set the QueryBuilder & QueryCompiler on the client object,
 // in case anyone wants to modify things to suit their own purposes.

package/lib/dialects/mysql/index.js

@@ -170,28 +170,18 @@ Object.assign(Client_MySQL.prototype, {
 
   canCancelQuery: true,
 
-  cancelQuery(connectionToKill) {
-    const acquiringConn = this.acquireConnection();
-
-    // Error out if we can't acquire connection in time.
-    // Purposely not putting timeout on `KILL QUERY` execution because erroring
-    // early there would release the `connectionToKill` back to the pool with
-    // a `KILL QUERY` command yet to finish.
-    return acquiringConn
-      .timeout(100)
-      .then((conn) =>
-        this.query(conn, {
-          method: 'raw',
-          sql: 'KILL QUERY ?',
-          bindings: [connectionToKill.threadId],
-          options: {},
-        })
-      )
-      .finally(() => {
-        // NOT returning this promise because we want to release the connection
-        // in a non-blocking fashion
-        acquiringConn.then((conn) => this.releaseConnection(conn));
+  async cancelQuery(connectionToKill) {
+    const conn = await this.acquireConnection();
+    try {
+      return await this.query(conn, {
+        method: 'raw',
+        sql: 'KILL QUERY ?',
+        bindings: [connectionToKill.threadId],
+        options: {},
       });
+    } finally {
+      await this.releaseConnection(conn);
+    }
   },
 });
 

package/lib/dialects/mysql/query/compiler.js

@@ -1,26 +1,22 @@
 // MySQL Query Compiler
 // ------
-const inherits = require('inherits');
 const QueryCompiler = require('../../../query/compiler');
 
 const { identity } = require('lodash');
 
-function QueryCompiler_MySQL(client, builder) {
-  QueryCompiler.call(this, client, builder);
+class QueryCompiler_MySQL extends QueryCompiler {
+  constructor(client, builder) {
+    super(client, builder);
 
-  const { returning } = this.single;
+    const { returning } = this.single;
 
-  if (returning) {
-    this.client.logger.warn(
-      '.returning() is not supported by mysql and will not have any effect.'
-    );
+    if (returning) {
+      this.client.logger.warn(
+        '.returning() is not supported by mysql and will not have any effect.'
+      );
+    }
+    this._emptyInsertValue = '() values ()';
   }
-}
-
-inherits(QueryCompiler_MySQL, QueryCompiler);
-
-Object.assign(QueryCompiler_MySQL.prototype, {
-  _emptyInsertValue: '() values ()',
 
   // Update method, including joins, wheres, order & limits.
   update() {
@@ -38,25 +34,25 @@ Object.assign(QueryCompiler_MySQL.prototype, {
       (order ? ` ${order}` : '') +
       (limit ? ` ${limit}` : '')
     );
-  },
+  }
 
   forUpdate() {
     return 'for update';
-  },
+  }
 
   forShare() {
     return 'lock in share mode';
-  },
+  }
 
   // Only supported on MySQL 8.0+
   skipLocked() {
     return 'skip locked';
-  },
+  }
 
   // Supported on MySQL 8.0+ and MariaDB 10.3.0+
   noWait() {
     return 'nowait';
-  },
+  }
 
   // Compiles a `columnInfo` query.
   columnInfo() {
@@ -72,7 +68,7 @@ Object.assign(QueryCompiler_MySQL.prototype, {
         'select * from information_schema.columns where table_name = ? and table_schema = ?',
       bindings: [table, this.client.database()],
       output(resp) {
-        const out = resp.reduce(function(columns, val) {
+        const out = resp.reduce(function (columns, val) {
           columns[val.COLUMN_NAME] = {
             defaultValue: val.COLUMN_DEFAULT,
             type: val.DATA_TYPE,
@@ -84,7 +80,7 @@ Object.assign(QueryCompiler_MySQL.prototype, {
         return (column && out[column]) || out;
       },
     };
-  },
+  }
 
   limit() {
     const noLimit = !this.single.limit && this.single.limit !== 0;
@@ -97,8 +93,8 @@ Object.assign(QueryCompiler_MySQL.prototype, {
         ? '18446744073709551615'
         : this.formatter.parameter(this.single.limit);
     return `limit ${limit}`;
-  },
-});
+  }
+}
 
 // Set the QueryBuilder & QueryCompiler on the client object,
 // in case anyone wants to modify things to suit their own purposes.

package/lib/dialects/oracle/query/compiler.js

@@ -3,7 +3,6 @@
 // Oracle Query Builder & Compiler
 // ------
 const {
-  assign,
   isPlainObject,
   isEmpty,
   isString,
@@ -12,7 +11,6 @@ const {
   compact,
   identity,
 } = require('lodash');
-const inherits = require('inherits');
 const QueryCompiler = require('../../../query/compiler');
 const { ReturningHelper } = require('../utils');
 
@@ -33,13 +31,16 @@ const components = [
 // Set the "Formatter" to use for the queries,
 // ensuring that all parameterized values (even across sub-queries)
 // are properly built into the same query.
-function QueryCompiler_Oracle(client, builder) {
-  QueryCompiler.call(this, client, builder);
-}
+class QueryCompiler_Oracle extends QueryCompiler {
+  constructor(client, builder) {
+    super(client, builder);
 
-inherits(QueryCompiler_Oracle, QueryCompiler);
+    // Compiles the `select` statement, or nested sub-selects
+    // by calling each of the component compilers, trimming out
+    // the empties, and returning a generated query string.
+    this.first = this.select;
+  }
 
-assign(QueryCompiler_Oracle.prototype, {
   // Compiles an "insert" query, allowing for multiple
   // inserts using a single query statement.
   insert() {
@@ -167,7 +168,7 @@ assign(QueryCompiler_Oracle.prototype, {
     }
 
     return sql;
-  },
+  }
 
   // Update method, including joins, wheres, order & limits.
   update() {
@@ -190,16 +191,16 @@ assign(QueryCompiler_Oracle.prototype, {
     }
 
     return this._addReturningToSqlAndConvert(sql, returning, this.tableName);
-  },
+  }
 
   // Compiles a `truncate` query.
   truncate() {
     return `truncate table ${this.tableName}`;
-  },
+  }
 
   forUpdate() {
     return 'for update';
-  },
+  }
 
   forShare() {
     // lock for share is not directly supported by oracle
@@ -208,7 +209,7 @@ assign(QueryCompiler_Oracle.prototype, {
       'lock for share is not supported by oracle dialect'
     );
     return '';
-  },
+  }
 
   // Compiles a `columnInfo` query.
   columnInfo() {
@@ -247,7 +248,7 @@ assign(QueryCompiler_Oracle.prototype, {
         return (column && out[column]) || out;
       },
     };
-  },
+  }
 
   select() {
     let query = this.with();
@@ -256,11 +257,11 @@ assign(QueryCompiler_Oracle.prototype, {
     });
     query += compact(statements).join(' ');
     return this._surroundQueryWithLimitAndOffset(query);
-  },
+  }
 
   aggregate(stmt) {
     return this._aggregate(stmt, { aliasSeparator: ' ' });
-  },
+  }
 
   // for single commands only
   _addReturningToSqlAndConvert(sql, returning, tableName) {
@@ -284,7 +285,7 @@ assign(QueryCompiler_Oracle.prototype, {
     res.outParams = [returningHelper];
     res.returning = returning;
     return res;
-  },
+  }
 
   _surroundQueryWithLimitAndOffset(query) {
     let { limit } = this.single;
@@ -314,12 +315,7 @@ assign(QueryCompiler_Oracle.prototype, {
       'where rownum_ > ' +
       this.formatter.parameter(offset)
     );
-  },
-});
-
-// Compiles the `select` statement, or nested sub-selects
-// by calling each of the component compilers, trimming out
-// the empties, and returning a generated query string.
-QueryCompiler_Oracle.prototype.first = QueryCompiler_Oracle.prototype.select;
+  }
+}
 
 module.exports = QueryCompiler_Oracle;