knex 2.4.2 → 2.5.1

package/lib/query/querycompiler.js

@@ -28,6 +28,7 @@ const {
 const debugBindings = debug('knex:bindings');
 
 const components = [
+  'comments',
   'columns',
   'join',
   'where',
@@ -50,6 +51,7 @@ class QueryCompiler {
     this.method = builder._method || 'select';
     this.options = builder._options;
     this.single = builder._single;
+    this.queryComments = builder._comments;
     this.timeout = builder._timeout || false;
     this.cancelOnTimeout = builder._cancelOnTimeout || false;
     this.grouped = groupBy(builder._statements, 'grouping');
@@ -138,6 +140,7 @@ class QueryCompiler {
         case 'union':
           unionStatement = statement;
           break;
+        case 'comments':
         case 'columns':
         case 'join':
         case 'where':
@@ -317,6 +320,14 @@ class QueryCompiler {
     );
   }
 
+  // Add comments to the query
+  comments() {
+    if (!this.queryComments.length) return '';
+    return this.queryComments
+      .map((comment) => `/* ${comment.comment} */`)
+      .join(' ');
+  }
+
   _aggregate(stmt, { aliasSeparator = ' as ', distinctParentheses } = {}) {
     const value = stmt.value;
     const method = stmt.method;

package/lib/util/security.js

@@ -0,0 +1,26 @@
+/**
+ * Sets a hidden (non-enumerable) property on the `target` object, copying it
+ * from `source`.
+ *
+ * This is useful when we want to protect certain data from being accidentally
+ * leaked through logs, also when the property is non-enumerable on the `source`
+ * object and we want to ensure that it is properly copied.
+ *
+ * @param {object} target
+ * @param {object} source - default: target
+ * @param {string} propertyName - default: 'password'
+ */
+function setHiddenProperty(target, source, propertyName = 'password') {
+  if (!source) {
+    source = target;
+  }
+
+  Object.defineProperty(target, propertyName, {
+    enumerable: false,
+    value: source[propertyName],
+  });
+}
+
+module.exports = {
+  setHiddenProperty,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex",
-  "version": "2.4.2",
+  "version": "2.5.1",
   "description": "A batteries-included SQL query & schema builder for PostgresSQL, MySQL, CockroachDB, MSSQL and SQLite3",
   "main": "knex",
   "types": "types/index.d.ts",
@@ -8,18 +8,20 @@
     "node": ">=12"
   },
   "scripts": {
-    "build": "npm run build:gitignore && npm run build:ts",
+    "build": "npm run build:gitignore && npm run build:ts && npm run format",
     "clean": "node scripts/clean.js",
     "build:ts": "tsc",
     "build:gitignore": "node scripts/update_gitignore_for_tsc_output.js run",
-    "format": "prettier --write \"{lib,bin,scripts,test}/**/*.js\"",
-    "format:check-difference": "prettier --list-different \"{lib,bin,scripts,test}/**/*.js\"",
+    "format": "prettier --write --list-different .",
+    "format:check": "prettier --list-different .",
     "debug:test": "mocha --inspect-brk --exit -t 0 test/all-tests-suite.js",
     "debug:tape": "node --inspect-brk test/tape/index.js",
     "coveralls": "nyc report --reporter=lcov",
-    "lint": "eslint \"lib/**/*.js\" \"test/**/*.js\" \"bin/**/*.js\"",
+    "lint": "eslint --cache \"**/*.js\"",
+    "lint:fix": "eslint --cache --fix \"**/*.js\"",
     "lint:types": "tsd && dtslint types",
-    "lint:everything": "npm run lint:types && npm run lint",
+    "lint:everything": "npm run lint && npm run lint:types",
+    "lint:fix:everything": "npm run lint:fix && npm run lint:types",
     "test:unit": "npm run test:unit-only && npm run test:cli",
     "test:unit-only": "mocha --exit -t 10000 --config test/mocha-unit-config-test.js",
     "test:db": "mocha --exit -t 10000 --config test/mocha-integration-config-test.js",
@@ -58,11 +60,11 @@
     "stress:test": "node scripts/stress-test/knex-stress-test.js | grep -A 5 -B 60 -- '- STATS '",
     "stress:destroy": "docker-compose -f scripts/stress-test/docker-compose.yml stop",
     "prepare": "husky install && npm run clean && npm run build",
-    "prepublishOnly": "npm run format:check-difference && npm run lint && npm run clean && npm run build"
+    "prepublishOnly": "npm run format:check && npm run lint:everything && npm run clean && npm run build"
   },
   "dependencies": {
     "colorette": "2.0.19",
-    "commander": "^9.1.0",
+    "commander": "^10.0.0",
     "debug": "4.3.4",
     "escalade": "^3.1.1",
     "esm": "^3.2.25",
@@ -70,7 +72,7 @@
     "getopts": "2.3.0",
     "interpret": "^2.2.0",
     "lodash": "^4.17.21",
-    "pg-connection-string": "2.5.0",
+    "pg-connection-string": "2.6.1",
     "rechoir": "^0.8.0",
     "resolve-from": "^5.0.0",
     "tarn": "^3.0.2",
@@ -100,13 +102,12 @@
     }
   },
   "lint-staged": {
-    "*.{js,json}": [
-      "prettier --write"
-    ]
+    "*": "prettier --ignore-unknown --write",
+    "*.js": "eslint --cache --fix"
   },
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.1",
-    "@types/node": "^18.7.14",
+    "@types/node": "^20.4.0",
     "better-sqlite3": "^7.6.2",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
@@ -127,12 +128,12 @@
     "mocha": "^10.0.0",
     "mock-fs": "^5.1.4",
     "mysql": "^2.18.1",
-    "mysql2": "^2.3.3",
+    "mysql2": "^3.2.0",
     "nyc": "^15.1.0",
     "oracledb": "^5.4.0",
     "pg": "^8.8.0",
     "pg-query-stream": "^4.2.4",
-    "prettier": "2.8.3",
+    "prettier": "2.8.7",
     "rimraf": "^3.0.2",
     "sinon": "^15.0.1",
     "sinon-chai": "^3.7.0",
@@ -143,8 +144,8 @@
     "tedious": "^14.4.0",
     "toxiproxy-node-client": "^2.0.6",
     "ts-node": "^10.9.1",
-    "tsd": "^0.25.0",
-    "typescript": "4.8.3"
+    "tsd": "^0.28.1",
+    "typescript": "5.0.4"
   },
   "buildDependencies": [
     "rimraf"
@@ -234,6 +235,7 @@
     "CHANGELOG.md",
     "CONTRIBUTING.md",
     "knex.js",
+    "knex.mjs",
     "LICENSE",
     "README.md",
     "UPGRADING.md"
@@ -251,7 +253,8 @@
     ],
     "exclude": [
       "lib/dialects/oracle",
-      "lib/dialects/oracledb"
+      "lib/dialects/oracledb",
+      "test/**/*.spec.js"
     ]
   },
   "tsd": {

package/scripts/docker-compose.yml

@@ -90,8 +90,8 @@ services:
     hostname: crdb
     command: start-single-node --cluster-name=example-single-node --insecure
     ports:
-      - "26257:26257"
-      - "8080:8080"
+      - '26257:26257'
+      - '8080:8080'
 
   waitcockroachdb:
     container_name: crdb-init

package/scripts/next-release-howto.md

@@ -17,7 +17,7 @@
 ```
 
 4. Update package.json version to be e.g. 0.16.0-next1 or 0.16.0-next2 and commit yo master
-5. Publish it under @next tag 
+5. Publish it under @next tag
 
 ```sh
       npm publish --tag next

package/scripts/oracledb-install-driver-libs.sh

@@ -1,82 +1,82 @@
-#!/usr/bin/env bash
-
-# Exit on error
-set -e
-
-# Directory constants
-repo_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." >/dev/null 2>&1 && pwd )"
-exec_dir="$( pwd )"
-script_dir="$repo_dir/scripts/"
-docker_compose_file="$repo_dir/scripts/docker-compose.yml"
-
-help_text="
-Helper script to install oracle drivers on local linux machine from Oracle
-database container.
-
-    oracledb-install-driver-libs.sh COMMAND
-
-    COMMAND:
-        run: Do the driver install.
-        dry-run: Do the driver install but do not save any files.
-        help: Print this menu.
-
-    NOTES FOR USAGE:
-    1. This script is tested to work on Ubuntu 18.04 LTS.
-    2. This script requires you to have sudo capabilities so to use ldconfig.
-"
-
-# Main script logic
-cmd="$1"
-
-function main () {
-    case "$1" in
-        "run")
-            printf "Starting run ...\n"
-            do_install true
-            exit 0
-            ;;
-        "dry-run")
-            printf "Starting dry-run ...\n"
-            do_install false
-            exit 0
-            ;;
-        "help"|"--help"|"-h"|"")
-            printf "$help_text"
-            exit 0
-            ;;
-        *)
-            printf "Unsupported command: $cmd\n"
-            printf "Try running with 'help' to see supported commands.\n"
-            exit 1
-            ;;
-    esac
-}
-
-function do_install () {
-    do_changes="$1"
-    printf "\nEnsuring oracle containers from docker-compose are up ...\n"
-    docker-compose -f "$docker_compose_file" up --build -d oracledb
-    docker-compose -f "$docker_compose_file" up waitoracledb
-    printf "\nSleeping an extra 15 seconds to ensure oracle has fully started ...\n"
-    sleep 15
-    printf "\nInstalling oracle client libs to db container ...\n"
-    set -x
-    docker-compose -f "$docker_compose_file" exec -T oracledb curl http://yum.oracle.com/public-yum-ol7.repo -o /etc/yum.repos.d/public-yum-ol7.repo
-    docker-compose -f "$docker_compose_file" exec -T oracledb yum install -y yum-utils
-    docker-compose -f "$docker_compose_file" exec -T oracledb yum-config-manager --enable ol7_oracle_instantclient
-    docker-compose -f "$docker_compose_file" exec -T oracledb yum install -y oracle-instantclient18.3-basiclite
-    set +x
-    printf "\nCopying to host's ~/lib directory and adding to ldconfig ...\n"
-    if [ "$do_changes" = "true" ]; then
-        set -x
-        docker cp oracledb_container:/usr/lib/oracle/18.3/client64/lib/ ~/
-        sudo sh -c "echo $HOME/lib > /etc/ld.so.conf.d/oracle-instantclient.conf"
-        sudo ldconfig
-        set +x
-    else
-        printf "(skipping because dry-run)\n"
-    fi
-}
-
-# Start the bash app's main function
-main "$cmd"
+#!/usr/bin/env bash
+
+# Exit on error
+set -e
+
+# Directory constants
+repo_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." >/dev/null 2>&1 && pwd )"
+exec_dir="$( pwd )"
+script_dir="$repo_dir/scripts/"
+docker_compose_file="$repo_dir/scripts/docker-compose.yml"
+
+help_text="
+Helper script to install oracle drivers on local linux machine from Oracle
+database container.
+
+    oracledb-install-driver-libs.sh COMMAND
+
+    COMMAND:
+        run: Do the driver install.
+        dry-run: Do the driver install but do not save any files.
+        help: Print this menu.
+
+    NOTES FOR USAGE:
+    1. This script is tested to work on Ubuntu 18.04 LTS.
+    2. This script requires you to have sudo capabilities so to use ldconfig.
+"
+
+# Main script logic
+cmd="$1"
+
+function main () {
+    case "$1" in
+        "run")
+            printf "Starting run ...\n"
+            do_install true
+            exit 0
+            ;;
+        "dry-run")
+            printf "Starting dry-run ...\n"
+            do_install false
+            exit 0
+            ;;
+        "help"|"--help"|"-h"|"")
+            printf "$help_text"
+            exit 0
+            ;;
+        *)
+            printf "Unsupported command: $cmd\n"
+            printf "Try running with 'help' to see supported commands.\n"
+            exit 1
+            ;;
+    esac
+}
+
+function do_install () {
+    do_changes="$1"
+    printf "\nEnsuring oracle containers from docker-compose are up ...\n"
+    docker-compose -f "$docker_compose_file" up --build -d oracledb
+    docker-compose -f "$docker_compose_file" up waitoracledb
+    printf "\nSleeping an extra 15 seconds to ensure oracle has fully started ...\n"
+    sleep 15
+    printf "\nInstalling oracle client libs to db container ...\n"
+    set -x
+    docker-compose -f "$docker_compose_file" exec -T oracledb curl http://yum.oracle.com/public-yum-ol7.repo -o /etc/yum.repos.d/public-yum-ol7.repo
+    docker-compose -f "$docker_compose_file" exec -T oracledb yum install -y yum-utils
+    docker-compose -f "$docker_compose_file" exec -T oracledb yum-config-manager --enable ol7_oracle_instantclient
+    docker-compose -f "$docker_compose_file" exec -T oracledb yum install -y oracle-instantclient18.3-basiclite
+    set +x
+    printf "\nCopying to host's ~/lib directory and adding to ldconfig ...\n"
+    if [ "$do_changes" = "true" ]; then
+        set -x
+        docker cp oracledb_container:/usr/lib/oracle/18.3/client64/lib/ ~/
+        sudo sh -c "echo $HOME/lib > /etc/ld.so.conf.d/oracle-instantclient.conf"
+        sudo ldconfig
+        set +x
+    else
+        printf "(skipping because dry-run)\n"
+    fi
+}
+
+# Start the bash app's main function
+main "$cmd"

package/scripts/release.sh

@@ -1,34 +1,36 @@
-#!/bin/bash -e
-
-changelog=node_modules/.bin/changelog
-
-update_version() {
-  echo "$(node -p "p=require('./${1}');p.version='${2}';JSON.stringify(p,null,2)")" > $1
-  echo "Updated ${1} version to ${2}"
-}
-
-current_version=$(node -p "require('./package').version")
-
-printf "Next version (current is $current_version)? "
-read next_version
-
-if ! [[ $next_version =~ ^[0-9]\.[0-9]+\.[0-9](-.+)? ]]; then
-  echo "Version must be a valid semver string, e.g. 1.0.2 or 2.3.0-beta.1"
-  exit 1
-fi
-
-next_ref="v$next_version"
-
-git add -u
-
-npm run build
-npm test
-
-update_version 'package.json' $next_version
-
-git commit -am "release $next_version"
-git tag $next_version
-
-git push --tags
-
-npm publish
+#!/bin/bash -e
+
+changelog=node_modules/.bin/changelog
+
+update_version() {
+  echo "$(node -p "p=require('./${1}');p.version='${2}';JSON.stringify(p,null,2)")" > $1
+  echo "Updated ${1} version to ${2}"
+}
+
+current_version=$(node -p "require('./package').version")
+
+printf "Next version (current is $current_version)? "
+read next_version
+
+if ! [[ $next_version =~ ^[0-9]\.[0-9]+\.[0-9](-.+)? ]]; then
+  echo "Version must be a valid semver string, e.g. 1.0.2 or 2.3.0-beta.1"
+  exit 1
+fi
+
+next_ref="v$next_version"
+
+git add -u
+
+npm run build
+npm run format:check
+npm run lint:everything
+npm test
+
+update_version 'package.json' $next_version
+
+git commit -am "release $next_version"
+git tag $next_version
+
+git push --tags
+
+npm publish

package/scripts/runkit-example.js

@@ -6,6 +6,7 @@ const knexSqlite = Knex({
   connection: ':memory:',
 });
 
+// eslint-disable-next-line no-unused-vars
 const knexMysql = Knex({
   client: 'mysql2',
 });

package/scripts/stress-test/README.txt

@@ -1,18 +1,18 @@
-# Test scripts to evaluate stability of drivers / pool etc.
-
-# To run this test you need to be in this directory + have node >= 8
-# and startup docker containers with proxy and sql servers
-
-docker-compose up --no-start
-docker-compose start
-
-# Select different test script to run:
-
-node mysql2-random-hanging-every-now-and-then.js 2> /dev/null | grep -B500 -A2 -- "- STATS" 
-node mysql2-sudden-exit-without-error
-node knex-stress-test.js | grep -A 3 -- "- STATS "
-node reconnect-test-mysql-based-drivers.js 2> /dev/null | grep -A 3 -- "- STATS "
-
-# Shut down docker instances when done:
-
-docker-compose down
+# Test scripts to evaluate stability of drivers / pool etc.
+
+# To run this test you need to be in this directory + have node >= 8
+# and startup docker containers with proxy and sql servers
+
+docker-compose up --no-start
+docker-compose start
+
+# Select different test script to run:
+
+node mysql2-random-hanging-every-now-and-then.js 2> /dev/null | grep -B500 -A2 -- "- STATS" 
+node mysql2-sudden-exit-without-error
+node knex-stress-test.js | grep -A 3 -- "- STATS "
+node reconnect-test-mysql-based-drivers.js 2> /dev/null | grep -A 3 -- "- STATS "
+
+# Shut down docker instances when done:
+
+docker-compose down

package/scripts/stress-test/docker-compose.yml

@@ -4,23 +4,23 @@ services:
   toxiproxy:
     image: shopify/toxiproxy
     ports:
-      - "8474:8474"
-      - "23306:23306"
-      - "25432:25432"
-      - "25433:25433"
-      - "21521:21521"
-      - "21433:21433"
+      - '8474:8474'
+      - '23306:23306'
+      - '25432:25432'
+      - '25433:25433'
+      - '21521:21521'
+      - '21433:21433'
     links:
-      - "mysql"
-      - "postgresql"
-      - "pgnative"
-      - "oracledb"
-      - "mssql"
+      - 'mysql'
+      - 'postgresql'
+      - 'pgnative'
+      - 'oracledb'
+      - 'mssql'
 
   mysql:
     image: mysql:5.7
     ports:
-      - "33306:3306"
+      - '33306:3306'
     environment:
       - TZ=UTC
       - MYSQL_ROOT_PASSWORD=mysqlrootpassword
@@ -28,7 +28,7 @@ services:
   postgresql:
     image: mdillon/postgis
     ports:
-      - "35432:5432"
+      - '35432:5432'
     environment:
       - POSTGRES_PASSWORD=postgresrootpassword
       - POSTGRES_USER=postgres
@@ -36,7 +36,7 @@ services:
   pgnative:
     image: mdillon/postgis
     ports:
-      - "35433:5432"
+      - '35433:5432'
     environment:
       - POSTGRES_PASSWORD=postgresrootpassword
       - POSTGRES_USER=postgres
@@ -44,14 +44,14 @@ services:
   oracledb:
     image: quillbuilduser/oracle-18-xe
     ports:
-      - "31521:1521"
+      - '31521:1521'
     environment:
       - ORACLE_ALLOW_REMOTE=true
 
   mssql:
     image: microsoft/mssql-server-linux:2017-latest
     ports:
-      - "31433:1433"
+      - '31433:1433'
     environment:
       - ACCEPT_EULA=Y
       - SA_PASSWORD=S0meVeryHardPassword

package/scripts/stress-test/knex-stress-test.js

@@ -81,7 +81,7 @@ let lastCounters = _.cloneDeep(counters);
 
 setInterval(() => {
   const reqsPerSec = {};
-  for (let key of Object.keys(counters)) {
+  for (const key of Object.keys(counters)) {
     reqsPerSec[key] = {
       queries: (counters[key].queries - lastCounters[key].queries) / 2,
       results: (counters[key].results - lastCounters[key].results) / 2,
@@ -106,7 +106,7 @@ async function killConnectionsPg(client) {
 }
 
 async function killConnectionsMyslq(client) {
-  const [rows, colDefs] = await client.raw(`SHOW FULL PROCESSLIST`);
+  const [rows] = await client.raw(`SHOW FULL PROCESSLIST`);
   await Promise.all(rows.map((row) => client.raw(`KILL ${row.Id}`)));
 }
 
@@ -119,6 +119,7 @@ async function main() {
   async function loopQueries(prefix, query) {
     const queries = () => [...Array(50).fill(query)];
 
+    // eslint-disable-next-line no-constant-condition
     while (true) {
       try {
         await Promise.all(queries());
@@ -133,7 +134,9 @@ async function main() {
       await rp.delete({
         url: `${toxicli.host}/proxies/${serviceName}`,
       });
-    } catch (err) {}
+    } catch (err) {
+      /* empty */
+    }
 
     const proxy = await toxicli.createProxy({
       name: serviceName,
@@ -188,6 +191,7 @@ async function main() {
 
   setInterval(recreateProxies, 2000);
 
+  // eslint-disable-next-line no-constant-condition
   while (true) {
     await delay(20); // kill everything every quite often from server side
     try {

package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js

@@ -56,7 +56,7 @@ async function mysql2Query(sql) {
 
 const counters = {};
 function setMysqlQueryCounters(name) {
-  const counts = (counters[name] = { queries: 0, results: 0, errors: 0 });
+  counters[name] = { queries: 0, results: 0, errors: 0 };
 }
 setMysqlQueryCounters('mysql2');
 
@@ -64,7 +64,7 @@ setMysqlQueryCounters('mysql2');
 let lastCounters = _.cloneDeep(counters);
 setInterval(() => {
   const reqsPerSec = {};
-  for (let key of Object.keys(counters)) {
+  for (const key of Object.keys(counters)) {
     reqsPerSec[key] = {
       queries: counters[key].queries - lastCounters[key].queries,
       results: counters[key].results - lastCounters[key].results,
@@ -86,7 +86,9 @@ async function recreateProxy(serviceName, listenPort, proxyToPort) {
     await rp.delete({
       url: `${toxicli.host}/proxies/${serviceName}`,
     });
-  } catch (err) {}
+  } catch (err) {
+    /* empty */
+  }
 
   const proxy = await toxicli.createProxy({
     name: serviceName,
@@ -118,6 +120,7 @@ async function main() {
   async function loopQueries(prefix, query) {
     const counts = counters[prefix];
 
+    // eslint-disable-next-line no-constant-condition
     while (true) {
       try {
         counts.queries += 1;
@@ -135,6 +138,7 @@ async function main() {
   loopQueries('mysql2', () => mysql2Query('select 1'));
 
   // wait forever
+  // eslint-disable-next-line no-constant-condition
   while (true) {
     await delay(1000);
   }

package/scripts/stress-test/mysql2-sudden-exit-without-error.js

@@ -18,7 +18,7 @@ async function recreateProxy(serviceName, listenPort, proxyToPort) {
     // there was no proxy by that name... its ok
   }
 
-  const proxy = await toxicli.createProxy({
+  await toxicli.createProxy({
     name: serviceName,
     listen: `0.0.0.0:${listenPort}`,
     upstream: `${serviceName}:${proxyToPort}`,
@@ -69,6 +69,7 @@ async function main() {
   console.log('Proxy recreated... start waiting');
 
   // wait forever
+  // eslint-disable-next-line no-constant-condition
   while (true) {
     await delay(1000);
     try {