Merge branch 'sidorares:master' into release-idle-connection

Author: yq

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "npm" 
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/benchmark.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16.x]
+        node-version: [18.x]
         mysql-version: ["mysql:8.0.18"]
         use-compression: [0]
         use-tls: [0]

.github/workflows/ci-linux.yml

@@ -29,7 +29,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16.x]
+        node-version: [16.x, 18.x]
         mysql-version: ["mysql:8.0.18", "mysql:8.0.22", "mysql:5.7"]
         use-compression: [0]
         use-tls: [0]
@@ -64,15 +64,15 @@ jobs:
     name: Node.js ${{ matrix.node-version }} - DB ${{ matrix.mysql-version }} - SSL=${{matrix.use-tls}} Compression=${{matrix.use-compression}}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up MySQL
         run: docker run -d -e MYSQL_ALLOW_EMPTY_PASSWORD=1 -e MYSQL_ROOT_PASSWORD=${{ env.MYSQL_PASSWORD }} -e MYSQL_DATABASE=${{ env.MYSQL_DATABASE }} -v $PWD/mysqldata:/var/lib/mysql/ -v $PWD/examples/custom-conf:/etc/mysql/conf.d -v $PWD/examples/ssl/certs:/certs -p ${{ env.MYSQL_PORT }}:3306 ${{ matrix.mysql-version }}
       - name: Set up Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.npm
           key: npm-${{ hashFiles('package-lock.json') }}
@@ -93,6 +93,7 @@ jobs:
           path: coverage/cobertura-coverage.xml
 
   coverage:
+    permissions: write-all
     needs: [ tests-linux ]
     runs-on: ubuntu-latest
     steps:
@@ -117,6 +118,7 @@ jobs:
 
       - name: Display coverage
         uses: ewjoachim/coverage-comment-action@v1
+        continue-on-error: true
         with:
           COVERAGE_FILE: "Cobertura.xml"
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci-windows.yml

@@ -18,25 +18,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16.x]
+        node-version: [16.x, 18.x]
         mysql-version: ['8.0']
         use-compression: [0, 1]
         use-tls: [0, 1]
 
     name: Node.js ${{ matrix.node-version }} - DB ${{ matrix.mysql-version }} - SSL=${{matrix.use-tls}} Compression=${{matrix.use-compression}}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up MySQL
         uses: shogo82148/actions-setup-mysql@v1
         with:
           mysql-version: ${{ matrix.mysql-version }}
       - name: Set up Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.npm
           key: npm-${{ hashFiles('package-lock.json') }}

.github/workflows/lint.yml

@@ -12,13 +12,13 @@ jobs:
   lint-js:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Use Node.js ${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ env.NODE_VERSION }}
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.npm
           key: npm-${{ hashFiles('package-lock.json') }}

.github/workflows/release.yml

@@ -0,0 +1,32 @@
+on:
+  push:
+    branches:
+      - master
+name: release-please
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: node
+          package-name: mysql2
+          changelog-path: 'Changelog.md'
+
+      - uses: actions/checkout@v3
+        if: ${{ steps.release.outputs.release_created }}
+
+      - uses: actions/setup-node@v3
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+
+      - run: npm ci
+        if: ${{ steps.release.outputs.release_created }}
+
+      - run: npm publish
+        if: ${{ steps.release.outputs.release_created }}
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

Changelog.md

@@ -1,3 +1,73 @@
+# Changelog
+
+## [3.0.1](https://github.com/sidorares/node-mysql2/compare/v3.0.0...v3.0.1) (2023-01-13)
+
+
+### Miscellaneous Chores
+
+* release 3.0.1 ([d5a6b2c](https://github.com/sidorares/node-mysql2/commit/d5a6b2ccccc7db4176c880e83c70ccd0be4ad81e))
+
+## [3.0.0](https://github.com/sidorares/node-mysql2/compare/v3.0.0-rc.1...v3.0.0) (2023-01-12)
+
+* named-placeholders library is updated to use newer `lru-cache` dependency, allowing it do dedupe and be shared between mysql2 and named-placeholders - https://github.com/sidorares/node-mysql2/issues/1711, https://github.com/mysqljs/named-placeholders/pull/19
+* `chai` and `mocha` moved to devDependencies #1774
+* Amazon RDS ssl certificates updated including AWS China #1754
+* `TCP_NODELAY` flag enabled, avoiding long connect timeout in some scenarios #1751
+* typing improvements: #1675, #1674
+* fix:  ensure pooled connections get released #1666
+
+### Miscellaneous Chores
+
+* release 3.0.0 ([11692b2](https://github.com/sidorares/node-mysql2/commit/11692b223ff26784089f444ca6291295bd0e405e))
+
+## [3.0.0-rc.1](https://github.com/sidorares/node-mysql2/compare/v2.3.3...v3.0.0-rc.1) (2022-11-06)
+
+
+### Bug Fixes
+
+* **typings:** Add the infileStreamFactory option to the type definition ([bf9cc4c](https://github.com/sidorares/node-mysql2/commit/bf9cc4c41e72f4a9014659a22b131739524bda1c))
+* webpack projects no longer show warning for cardinal dependency ([26c56ae](https://github.com/sidorares/node-mysql2/commit/26c56ae64846814eb8234c0d352871a7b6651d66))
+
+
+### Miscellaneous Chores
+
+* v3.0.0-rc.1 changes ([1b684bb](https://github.com/sidorares/node-mysql2/commit/1b684bbf8047200e5de5dd18874872880237de2f))
+
+3.0.0-rc.1 ( 6/11/2021 )
+  - fix .ping() return value signature #1650
+  - documentation: clarify `SUM()` and `AVG()` 
+    return types difference with mysqljs/myql    #1649
+  - misc: add release-please action              #1631, #1647
+  - fix: .end() callback is not called 
+    when connection is in closed state           #1642, #1638
+  - typescript: getConnection typings fix        #1620
+  - fix uncatchable exception                    #1359
+  - add mysql_clear_password built in support    #1552
+  - typescript: typings unit test, variouts type 
+    improvements, server protocol additions      #1610, #1610
+  - typescript: more complete way of adding 
+    typings for the Server module                #1606
+  - typescript, documentation: improve prepared 
+    typings statements                           #1493
+  - typescript: add type declarations for Prepare 
+    & PrepareStatementInfo                       #1565
+  - fix: webpack projects no longer show warning 
+    for cardinal dependency                      #1589
+  - typescript: accept Buffer and Buffer[] in 
+    typings for key, cert, and ca                #1599
+  - fix: use rotatingXor instead of xor in 
+    sha256_password plugin                       #1592, #1044
+  - documentation: add Simplified Chinese        #1572
+  - fix: add type as an alias to columnType      #1546, #1549
+  - Update collation list up to MySQL 8.0.26     #1410
+  - typescript: Add minVersion for ssl option.   #1517
+  - Add support for multi-factor authentication  #1436
+  - typescript: add namedPlaceholders option to 
+    QueryOptions interface                       #1475
+  - fix: update how the ECONNRESET error is 
+    caught when connection already closing       #1438
+
+
 2.3.3 ( 14/11/2021 )
   - no changes compared to 2.3.3-rc.0
 

README.md

@@ -8,7 +8,7 @@
 [![Windows Build][appveyor-image]][appveyor-url]
 [![License][license-image]][license-url]  
 
-[简体中文 Simplified Chinese](./documentation_zh-cn/)
+English | [简体中文](./documentation_zh-cn/)
 
 > MySQL client for Node.js with focus on performance. Supports prepared statements, non-utf8 encodings, binary log protocol, compression, ssl [much more](https://github.com/sidorares/node-mysql2/tree/master/documentation)
 
@@ -250,7 +250,9 @@ con.query({ sql: 'select 1 as foo, 2 as foo', rowsAsArray: true }, function(err,
 
 MySQL2 is mostly API compatible with [Node MySQL][node-mysql]. You should check their API documentation to see all available API options.
 
-If you find any incompatibility with [Node MySQL][node-mysql], Please report via Issue tracker. We will fix reported incompatibility on priority basis.
+One known incompatibility is that `DECIMAL` values are returned as strings whereas in [Node MySQL][node-mysql] they are returned as numbers. This includes the result of `SUM()` and `AVG()` functions when applied to `INTEGER` arguments. This is done deliberately to avoid loss of precision - see https://github.com/sidorares/node-mysql2/issues/935.
+
+If you find any other incompatibility with [Node MySQL][node-mysql], Please report via Issue tracker. We will fix reported incompatibility on priority basis.
 
 ## Documentation
 

SECURITY.md

@@ -4,4 +4,4 @@
 
 **Please do not file a public ticket** mentioning the vulnerability.
 
-If you believe you found a security vulnerability please contact [current maintainer](mailto:[email protected]?subject=mysql2%20security%20vulnerability%20report) as soon as practical - the team will triage severity and plan for rectification.
+If you believe you found a security vulnerability please contact [current maintainer](mailto:andrey.sidorov?subject=mysql2%20security%20vulnerability%20report) as soon as practical - the team will triage severity and plan for rectification.

documentation_zh-cn/README.md

@@ -8,6 +8,8 @@
 [![Windows Build][appveyor-image]][appveyor-url]
 [![License][license-image]][license-url]
 
+[English](../README.md) | 简体中文
+
 > 适用于Node.js的MySQL客户端，专注于性能优化。支持SQL预处理、非UTF-8编码支持、二进制文件编码支持、压缩和SSL等等 [查看更多](https://github.com/sidorares/node-mysql2/tree/master/documentation)
 
 __目录__