knex 3.1.0 → 3.2.1

package/scripts/docker-compose.yml

@@ -1,152 +1,150 @@
-version: '3'
-
-services:
-  mssql:
-    image: mcr.microsoft.com/mssql/server:2019-latest
-    ports:
-      - '21433:1433'
-    environment:
-      - ACCEPT_EULA=Y
-      - SA_PASSWORD=S0meVeryHardPassword
-    healthcheck:
-      test: /opt/mssql-tools/bin/sqlcmd -S mssql -U sa -P 'S0meVeryHardPassword' -Q 'select 1'
-  waitmssql:
-    image: mcr.microsoft.com/mssql/server:2017-latest
-    links:
-      - mssql
-    depends_on:
-      - mssql
-    entrypoint:
-      - bash
-      - -c
-      # https://docs.microsoft.com/en-us/sql/relational-databases/logs/control-transaction-durability?view=sql-server-ver15#bkmk_DbControl
-      - 'until /opt/mssql-tools/bin/sqlcmd -S mssql -U sa -P S0meVeryHardPassword -d master -Q "CREATE DATABASE knex_test; ALTER DATABASE knex_test SET ALLOW_SNAPSHOT_ISOLATION ON; ALTER DATABASE knex_test SET DELAYED_DURABILITY = FORCED"; do sleep 5; done'
-
-  mysql:
-    image: mysql
-    # https://dev.mysql.com/doc/refman/8.0/en/mysql-acid.html
-    # https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_flush_method
-    # nosync only for unix, edit for local start on other systems
-    command: --default-authentication-plugin=mysql_native_password --sync_binlog=0 --innodb_doublewrite=OFF  --innodb-flush-log-at-trx-commit=0 --innodb-flush-method=nosync
-    ports:
-      - '23306:3306'
-    environment:
-      - MYSQL_ROOT_PASSWORD=testrootpassword
-      - MYSQL_DATABASE=knex_test
-      - MYSQL_USER=testuser
-      - MYSQL_PASSWORD=testpassword
-    healthcheck:
-      test:
-        [
-          'CMD',
-          '/usr/bin/mysql',
-          '-hlocalhost',
-          '-utestuser',
-          '-ptestpassword',
-          '-e',
-          'SELECT 1',
-        ]
-      interval: 30s
-      timeout: 5s
-      retries: 3
-    restart: always
-    volumes:
-      - mysql_data:/var/lib/mysql
-  waitmysql:
-    image: mysql
-    links:
-      - mysql
-    depends_on:
-      - mysql
-    entrypoint:
-      - bash
-      - -c
-      - 'until /usr/bin/mysql -hmysql -utestuser -ptestpassword -e "SELECT 1"; do sleep 5; done'
-
-  postgres:
-    image: postgres:13-alpine
-    # see https://www.postgresql.org/docs/current/non-durability.html
-    command: '-c full_page_writes=off -c fsync=off -c synchronous_commit=off'
-    ports:
-      - '25432:5432'
-    environment:
-      - POSTGRES_USER=testuser
-      - POSTGRES_PASSWORD=knextest
-      - POSTGRES_DB=knex_test
-  waitpostgres:
-    image: postgres:13-alpine
-    links:
-      - postgres
-    depends_on:
-      - postgres
-    entrypoint:
-      - bash
-      - -c
-      - 'until /usr/local/bin/psql postgres://testuser:knextest@postgres/knex_test -c "SELECT 1"; do sleep 5; done'
-
-  cockroachdb:
-    image: cockroachdb/cockroach:latest-v21.2
-    container_name: crdb
-    hostname: crdb
-    command: start-single-node --cluster-name=example-single-node --insecure
-    ports:
-      - '26257:26257'
-      - '8080:8080'
-
-  waitcockroachdb:
-    container_name: crdb-init
-    hostname: crdb-init
-    image: timveil/cockroachdb-remote-client:latest
-    environment:
-      - COCKROACH_HOST=crdb:26257
-      - COCKROACH_INSECURE=true
-      - DATABASE_NAME=test
-    depends_on:
-      - cockroachdb
-
-  pgnative:
-    image: postgres:13-alpine
-    # see https://www.postgresql.org/docs/current/non-durability.html
-    command: '-c full_page_writes=off -c fsync=off -c synchronous_commit=off'
-    ports:
-      - '25433:5432'
-    environment:
-      - POSTGRES_USER=testuser
-      - POSTGRES_PASSWORD=knextest
-      - POSTGRES_DB=knex_test
-  waitpgnative:
-    image: postgres:13-alpine
-    links:
-      - pgnative
-    depends_on:
-      - pgnative
-    entrypoint:
-      - bash
-      - -c
-      - 'until /usr/local/bin/psql postgres://testuser:knextest@pgnative/knex_test -c "SELECT 1"; do sleep 5; done'
-
-  oracledb:
-    image: quillbuilduser/oracle-18-xe
-    container_name: oracledb_container
-    ports:
-      - '21521:1521'
-    environment:
-      - ORACLE_ALLOW_REMOTE=true
-  waitoracledb:
-    image: quillbuilduser/oracle-18-xe
-    links:
-      - oracledb
-    depends_on:
-      - oracledb
-    environment:
-      - ORACLE_HOME=/opt/oracle/product/18c/dbhomeXE
-    entrypoint:
-      - bash
-      - -c
-      - 'until /opt/oracle/product/18c/dbhomeXE/bin/sqlplus -s sys/Oracle18@oracledb/XE as sysdba <<< "SELECT 13376411 FROM DUAL; exit;" | grep "13376411"; do echo "Could not connect to oracle... sleep for a while"; sleep 5; done'
-
-volumes:
-  mysql_data:
-    driver_opts:
-      type: tmpfs
-      device: tmpfs
+services:
+  mssql:
+    image: mcr.microsoft.com/mssql/server:2019-latest
+    ports:
+      - '21433:1433'
+    environment:
+      - ACCEPT_EULA=Y
+      - SA_PASSWORD=S0meVeryHardPassword
+    healthcheck:
+      test: /opt/mssql-tools/bin/sqlcmd -S mssql -U sa -P 'S0meVeryHardPassword' -Q 'select 1'
+  waitmssql:
+    image: mcr.microsoft.com/mssql/server:2017-latest
+    links:
+      - mssql
+    depends_on:
+      - mssql
+    entrypoint:
+      - bash
+      - -c
+      # https://docs.microsoft.com/en-us/sql/relational-databases/logs/control-transaction-durability?view=sql-server-ver15#bkmk_DbControl
+      - 'until /opt/mssql-tools/bin/sqlcmd -S mssql -U sa -P S0meVeryHardPassword -d master -Q "CREATE DATABASE knex_test; ALTER DATABASE knex_test SET ALLOW_SNAPSHOT_ISOLATION ON; ALTER DATABASE knex_test SET DELAYED_DURABILITY = FORCED"; do sleep 5; done'
+
+  mysql:
+    image: mysql:8.0.40
+    # https://dev.mysql.com/doc/refman/8.0/en/mysql-acid.html
+    # https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_flush_method
+    # nosync only for unix, edit for local start on other systems
+    command: --default-authentication-plugin=mysql_native_password --sync_binlog=0 --innodb_doublewrite=OFF  --innodb-flush-log-at-trx-commit=0 --innodb-flush-method=nosync
+    ports:
+      - '23306:3306'
+    environment:
+      - MYSQL_ROOT_PASSWORD=testrootpassword
+      - MYSQL_DATABASE=knex_test
+      - MYSQL_USER=testuser
+      - MYSQL_PASSWORD=testpassword
+    healthcheck:
+      test:
+        [
+          'CMD',
+          '/usr/bin/mysql',
+          '-hlocalhost',
+          '-utestuser',
+          '-ptestpassword',
+          '-e',
+          'SELECT 1',
+        ]
+      interval: 30s
+      timeout: 5s
+      retries: 3
+    restart: always
+    volumes:
+      - mysql_data:/var/lib/mysql
+  waitmysql:
+    image: mysql:8.0.40
+    links:
+      - mysql
+    depends_on:
+      - mysql
+    entrypoint:
+      - bash
+      - -c
+      - 'until /usr/bin/mysql -hmysql -utestuser -ptestpassword -e "SELECT 1"; do sleep 5; done'
+
+  postgres:
+    image: postgres:17-alpine
+    # see https://www.postgresql.org/docs/current/non-durability.html
+    command: '-c full_page_writes=off -c fsync=off -c synchronous_commit=off'
+    ports:
+      - '25432:5432'
+    environment:
+      - POSTGRES_USER=testuser
+      - POSTGRES_PASSWORD=knextest
+      - POSTGRES_DB=knex_test
+  waitpostgres:
+    image: postgres:17-alpine
+    links:
+      - postgres
+    depends_on:
+      - postgres
+    entrypoint:
+      - bash
+      - -c
+      - 'until /usr/local/bin/psql postgres://testuser:knextest@postgres/knex_test -c "SELECT 1"; do sleep 5; done'
+
+  cockroachdb:
+    image: cockroachdb/cockroach:latest-v23.2
+    container_name: crdb
+    hostname: crdb
+    command: start-single-node --cluster-name=example-single-node --insecure --store=type=mem,size=0.25
+    ports:
+      - '26257:26257'
+      - '8080:8080'
+
+  waitcockroachdb:
+    container_name: crdb-init
+    hostname: crdb-init
+    image: timveil/cockroachdb-remote-client:latest
+    environment:
+      - COCKROACH_HOST=crdb:26257
+      - COCKROACH_INSECURE=true
+      - DATABASE_NAME=test
+    depends_on:
+      - cockroachdb
+
+  pgnative:
+    image: postgres:17-alpine
+    # see https://www.postgresql.org/docs/current/non-durability.html
+    command: '-c full_page_writes=off -c fsync=off -c synchronous_commit=off'
+    ports:
+      - '25433:5432'
+    environment:
+      - POSTGRES_USER=testuser
+      - POSTGRES_PASSWORD=knextest
+      - POSTGRES_DB=knex_test
+  waitpgnative:
+    image: postgres:17-alpine
+    links:
+      - pgnative
+    depends_on:
+      - pgnative
+    entrypoint:
+      - bash
+      - -c
+      - 'until /usr/local/bin/psql postgres://testuser:knextest@pgnative/knex_test -c "SELECT 1"; do sleep 5; done'
+
+  oracledb:
+    image: quillbuilduser/oracle-18-xe
+    container_name: oracledb_container
+    ports:
+      - '21521:1521'
+    environment:
+      - ORACLE_ALLOW_REMOTE=true
+  waitoracledb:
+    image: quillbuilduser/oracle-18-xe
+    links:
+      - oracledb
+    depends_on:
+      - oracledb
+    environment:
+      - ORACLE_HOME=/opt/oracle/product/18c/dbhomeXE
+    entrypoint:
+      - bash
+      - -c
+      - 'until /opt/oracle/product/18c/dbhomeXE/bin/sqlplus -s sys/Oracle18@oracledb/XE as sysdba <<< "SELECT 13376411 FROM DUAL; exit;" | grep "13376411"; do echo "Could not connect to oracle... sleep for a while"; sleep 5; done'
+
+volumes:
+  mysql_data:
+    driver_opts:
+      type: tmpfs
+      device: tmpfs

package/scripts/format-changelog.js

@@ -0,0 +1,55 @@
+const { readFileSync, writeFileSync } = require('fs');
+const { resolve } = require('path');
+const { greenBright, redBright } = require('colorette');
+
+const CHANGELOG = resolve(__dirname, '..', 'CHANGELOG.md');
+const lines = readFileSync(CHANGELOG, 'utf-8').split(/\r?\n/);
+
+// ensure that every `#NNNN` is a markdown link
+// to https://github.com/knex/knex/issues/NNNN
+//
+// https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#list-repository-issues
+//
+// GitHub's REST API considers every pull request an issue, but not every issue is a pull request.
+// For this reason, "Issues" endpoints may return both issues and pull requests in the response.
+//
+// Web links to /issues/NNNN will redirect to /pull/NNNN
+
+// match first: a markdown link, then: #NNNN
+const markdownRE = /\[#(\d+)\]\(([^)]+)\)/;
+const referenceRE = /#(\d+)/;
+const regex = new RegExp(`${markdownRE.source}|${referenceRE.source}`, 'g');
+// eslint-disable-next-line no-control-regex
+const ansiRegex = /\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])/g;
+const stripAnsi = (str) => str.replace(ansiRegex, '');
+
+for (let i = 0; i < lines.length; i++) {
+  const line = lines[i];
+
+  const newLine = line.replace(regex, (match, anchor, url, issueno) => {
+    if (issueno !== undefined) {
+      return `${greenBright('[#')}${issueno}${greenBright(
+        `](https://github.com/knex/knex/issues/${issueno})`
+      )}`;
+    }
+
+    if (url !== undefined && anchor !== undefined) {
+      if (!url.endsWith(`/${anchor}`)) {
+        console.warn('Mismatched URL:', url);
+        return `${redBright(
+          `[#${anchor}](https://github.com/knex/knex/issues/${anchor})`
+        )}`;
+      } else {
+        return match;
+      }
+    }
+    throw new Error('Regex failed');
+  });
+
+  if (line !== newLine) {
+    lines[i] = stripAnsi(newLine);
+    console.log(newLine);
+  }
+}
+
+writeFileSync(CHANGELOG, lines.join('\n'), 'utf-8');

package/scripts/next-release-howto.md

@@ -1,24 +1,24 @@
-# Checklist for crating knex @next releases
-
-1. Go through all commits since the last release and add them to CHANGELOG.md under unreleased changes section.
-2. Commit changes to CHANGELOG
-3. Check that master compiles and tests are running fine (check also that CI tests are passing)
-
-```sh
-      npm run build
-
-      # run bunch of tests, but skipping coverage which doesn't really work locally at least
-      npm plaintest
-      npm bin_test
-      npm oracledb:test
-      npm mssql:init
-      npm mssql:test
-      npm mssql:destroy
-```
-
-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
-
-```sh
-      npm publish --tag next
-```
+# Checklist for crating knex @next releases
+
+1. Go through all commits since the last release and add them to CHANGELOG.md under unreleased changes section.
+2. Commit changes to CHANGELOG
+3. Check that master compiles and tests are running fine (check also that CI tests are passing)
+
+```sh
+      npm run build
+
+      # run bunch of tests, but skipping coverage which doesn't really work locally at least
+      npm plaintest
+      npm bin_test
+      npm oracledb:test
+      npm mssql:init
+      npm mssql:test
+      npm mssql:destroy
+```
+
+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
+
+```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,36 +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 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
+#!/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