Merge branch 'release/2.5.1'

Author: rusher

.travis.yml

@@ -52,6 +52,8 @@ matrix:
     env: DB=mariadb:10.5 SKIP_LEAK=1 ADDITIONAL_CONF=--version=10.5.199
   - node_js: "14"
     env: DB=mariadb:10.5 SKIP_LEAK=1
+  - node_js: "15"
+    env: DB=mariadb:10.5 SKIP_LEAK=1
   - node_js: "12"
     env: DB=mariadb:10.5 SKIP_LEAK=1 TEST_COLLATION=cp1251_general_ci
   - node_js: "12"

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [2.5.1](https://github.com/mariadb-corporation/mariadb-connector-nodejs/tree/2.5.1) (23 Oct 2020)
+[Full Changelog](https://github.com/mariadb-corporation/mariadb-connector-nodejs/compare/2.5.0...2.5.1)
+
+* CONJS-149 - [CONJS-149] correcting possible TypeError [ERR_UNKNOWN_ENCODING], Node v15 compatibility
+
+
 ## [2.5.0](https://github.com/mariadb-corporation/mariadb-connector-nodejs/tree/2.5.0) (15 Oct 2020)
 [Full Changelog](https://github.com/mariadb-corporation/mariadb-connector-nodejs/compare/2.4.2...2.5.0)
 

documentation/connection-options.md

@@ -61,14 +61,18 @@ Integers in JavaScript use IEEE-754 representation.  This means that Node.js can
 
 This means that when the value set on a column is not in the [safe](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger) range, the default implementation receives an inexact representation of the number.
 
-The Connector provides two options to address this issue. 
+The Connector provides 3 options to address this issue. 
 
 |option|description|type|default| 
 |---:|---|:---:|:---:| 
 | **bigNumberStrings** | When an integer is not in the safe range, the Connector interprets the value as a string. |*boolean* |false| 
 | **supportBigNumbers** | When an integer is not in the safe range, the Connector interprets the value as a [Long](https://www.npmjs.com/package/long) object. |*boolean* |false|
+| **supportBigInt** | Whether resultset should return javascript ES2020 [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) for [BIGINT](https://mariadb.com/kb/en/bigint/) data type. This ensures having expected value even for value > 2^53 (see [safe](#big-integer-support) range). |*boolean* | false |
 
 
+Native `supportBigInt` implementation is recommended over `supportBigNumbers` (remains for compability with older version). `supportBigInt` is not enabled by default for compatibilty to avoid major regression. 
+It will be in a future 3.x version.
+ 
 ## SSL
 
 The Connector can encrypt data during transfer using the Transport Layer Security (TLS) protocol.  TLS/SSL allows for transfer encryption, and can optionally use identity validation for the server and client.
@@ -361,7 +365,7 @@ mariadb.createConnection({
 | **rsaPublicKey** | Indicate path/content to MySQL server RSA public key. use requires Node.js v11.6+ |*string* | |
 | **cachingRsaPublicKey** | Indicate path/content to MySQL server caching RSA public key. use requires Node.js v11.6+ |*string* | |
 | **allowPublicKeyRetrieval** | Indicate that if `rsaPublicKey` or `cachingRsaPublicKey` public key are not provided, if client can ask server to send public key. |*boolean* | false |
-| **supportBigInt** | Whether resultset should return javascript ES2020 [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) for [BIGINT](https://mariadb.com/kb/en/bigint/) data type. This ensures having expected value even for value > 2^53 (see [safe](documentation/connection-options.md#support-for-big-integer) range). |*boolean* | false |
+| **supportBigInt** | Whether resultset should return javascript ES2020 [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) for [BIGINT](https://mariadb.com/kb/en/bigint/) data type. This ensures having expected value even for value > 2^53 (see [safe](#big-integer-support) range). |*boolean* | false |
 
 
 ## F.A.Q.

documentation/promise-api.md

@@ -50,7 +50,9 @@ To use the Connector, you need to import the package into your application code.
 const mariadb = require('mariadb');
 ```
 
-## Timezone consideration
+## Recommendation
+
+### Timezone consideration
 
 It's not recommended, but in some cases, Node.js and database are configured with different timezone. 
 
@@ -63,7 +65,7 @@ If client and server timezone differ, `timezone` option has to be set to server
 Connector will then convert date to server timezone, rather than the current Node.js timezone. 
 
 
-## Security consideration
+### Security consideration
 
 Connection details such as URL, username, and password are better hidden into environment variables.
 using code like : 
@@ -104,6 +106,12 @@ DB_PWD=secretPasswrd
 ```
 .env files must NOT be pushed into repository,  using .gitignore
 
+### Default options consideration
+
+For new project, enabling option `supportBigInt` is recommended (It will be in a future 3.x version).
+
+This option permits to avoid exact value for big integer (value > 2^53) (see [javascript ES2020 
+BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) ) 
 
 # Promise API
 
@@ -596,7 +604,8 @@ Whether you want the Connector to retrieve date values as strings, rather than `
 
 *boolean, default: false*
 
-Whether the query should return integers as [`Long`](https://www.npmjs.com/package/long) objects when they are not in the [safe](documentation/connection-options.md#support-for-big-integer) range.
+Whether the query should return integers as [`Long`](https://www.npmjs.com/package/long) objects when they are not in
+ the [safe](/documentation/connection-options.md#big-integer-support) range.
 
 
 #### `supportBigInt`
@@ -605,7 +614,7 @@ Whether the query should return integers as [`Long`](https://www.npmjs.com/packa
 
 Whether the query should return javascript ES2020 [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) 
 for [BIGINT](https://mariadb.com/kb/en/bigint/) data type. 
-This ensures having expected value even for value > 2^53 (> 9007199254740991) (see [safe](documentation/connection-options.md#support-for-big-integer) range).
+This ensures having expected value even for value > 2^53 (see [safe](/documentation/connection-options.md#big-integer-support) range).
 This option can be set to query level, supplanting connection option `supportBigInt` value. 
 
 ```javascript
@@ -622,7 +631,7 @@ const res2 = await shareConn.query({sql: 'select * from bigIntTable', supportBig
 
 *boolean, default: false*
 
-Whether the query should return integers as strings when they are not in the [safe](documentation/connection-options.md#support-for-big-integer) range.
+Whether the query should return integers as strings when they are not in the [safe](documentation/connection-options.md#big-integer-support) range.
 
 
 #### `typeCast`

lib/connection.js

@@ -946,7 +946,7 @@ function Connection(options) {
       }.bind(this)
     );
 
-    _socket.writeBuf = _socket.write;
+    _socket.writeBuf = (buf) => _socket.write(buf);
     _socket.flush = () => {};
     _out.setStream(_socket);
   };
@@ -1037,7 +1037,7 @@ function Connection(options) {
       secureSocket.on('data', _in.onData.bind(_in));
       secureSocket.on('error', _socketError);
       secureSocket.on('end', _socketError);
-      secureSocket.writeBuf = secureSocket.write;
+      secureSocket.writeBuf = (buf) => secureSocket.write(buf);
       secureSocket.flush = () => {};
 
       _socket.removeAllListeners('data');

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mariadb",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "description": "fast mariadb/mysql connector.",
   "main": "promise.js",
   "types": "types/index.d.ts",