Add support for BigInt

Recent V8 release adds a new type - BigInt. It is thus available in latest NodeJS (v10+) and Chrome (v67+).

Driver could use this type instead of the custom Integer to represent lossy integer numbers. This is configurable because BigInt and Number are not fully compatible, so driver can't always return BitInts. For example `BigInt(1) / Number(1)` results in a TypeError, as well as `JSON.stringify({v: BigInt(1)})`.

The configuration property is `useBigInt` and it's `false` by default, in manner to break drivers user on update.

This configuration take precedence over `disableLosslessIntegers`

Author: bigmontz

bolt-connection/jest.config.js

@@ -137,7 +137,7 @@ module.exports = {
   // snapshotSerializers: [],
 
   // The test environment that will be used for testing
-  testEnvironment: 'node'
+  testEnvironment: 'node',
 
   // Options that will be passed to the testEnvironment
   // testEnvironmentOptions: {},
@@ -172,9 +172,9 @@ module.exports = {
   // timers: "real",
 
   // A map from regular expressions to paths to transformers
-  // transform: {
-  //   "^.+\\.(ts|tsx)$": "ts-jest"
-  // }
+  transform: {
+    '^.+\\.(ts|tsx|js)$': 'ts-jest'
+  }
   // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
   // transformIgnorePatterns: [
   //   "/node_modules/",

bolt-connection/package-lock.json

@@ -52,23 +52,25 @@ export default class BoltProtocol {
    * @constructor
    * @param {Object} server the server informatio.
    * @param {Chunker} chunker the chunker.
-   * @param {boolean} disableLosslessIntegers if this connection should convert all received integers to native JS numbers.
+   * @param {Object} packstreamConfig Packstream configuration
+   * @param {boolean} packstreamConfig.disableLosslessIntegers if this connection should convert all received integers to native JS numbers.
+   * @param {boolean} packstreamConfig.useBigInt if this connection should convert all received integers to native BigInt numbers.
    * @param {CreateResponseHandler} createResponseHandler Function which creates the response handler
    * @param {Logger} log the logger
    * @param {OnProtocolError} onProtocolError handles protocol errors
    */
   constructor (
     server,
     chunker,
-    disableLosslessIntegers,
+    { disableLosslessIntegers, useBigInt } = {},
     createResponseHandler = () => null,
     log,
     onProtocolError
   ) {
     this._server = server || {}
     this._chunker = chunker
     this._packer = this._createPacker(chunker)
-    this._unpacker = this._createUnpacker(disableLosslessIntegers)
+    this._unpacker = this._createUnpacker(disableLosslessIntegers, useBigInt)
     this._responseHandler = createResponseHandler(this)
     this._log = log
     this._onProtocolError = onProtocolError
@@ -317,8 +319,8 @@ export default class BoltProtocol {
     return new v1.Packer(chunker)
   }
 
-  _createUnpacker (disableLosslessIntegers) {
-    return new v1.Unpacker(disableLosslessIntegers)
+  _createUnpacker (disableLosslessIntegers, useBigInt) {
+    return new v1.Unpacker(disableLosslessIntegers, useBigInt)
   }
 
   /**

bolt-connection/src/bolt/bolt-protocol-v1.js

@@ -29,8 +29,8 @@ export default class BoltProtocol extends BoltProtocolV1 {
     return new v2.Packer(chunker)
   }
 
-  _createUnpacker (disableLosslessIntegers) {
-    return new v2.Unpacker(disableLosslessIntegers)
+  _createUnpacker (disableLosslessIntegers, useBigInt) {
+    return new v2.Unpacker(disableLosslessIntegers, useBigInt)
   }
 
   get version () {

bolt-connection/src/bolt/bolt-protocol-v2.js

@@ -30,7 +30,9 @@ export default class BoltProtocol extends BoltProtocolV4 {
    * @constructor
    * @param {Object} server the server informatio.
    * @param {Chunker} chunker the chunker.
-   * @param {boolean} disableLosslessIntegers if this connection should convert all received integers to native JS numbers.
+   * @param {Object} packstreamConfig Packstream configuration
+   * @param {boolean} packstreamConfig.disableLosslessIntegers if this connection should convert all received integers to native JS numbers.
+   * @param {boolean} packstreamConfig.useBigInt if this connection should convert all received integers to native BigInt numbers.
    * @param {CreateResponseHandler} createResponseHandler Function which creates the response handler
    * @param {Logger} log the logger
    * @param {Object} serversideRouting
@@ -39,7 +41,7 @@ export default class BoltProtocol extends BoltProtocolV4 {
   constructor (
     server,
     chunker,
-    disableLosslessIntegers,
+    packstreamConfig,
     createResponseHandler = () => null,
     log,
     onProtocolError,
@@ -48,7 +50,7 @@ export default class BoltProtocol extends BoltProtocolV4 {
     super(
       server,
       chunker,
-      disableLosslessIntegers,
+      packstreamConfig,
       createResponseHandler,
       log,
       onProtocolError

bolt-connection/src/bolt/bolt-protocol-v4x1.js

@@ -39,6 +39,7 @@ import ResponseHandler from './response-handler'
  * @param {Logger} config.log The logger
  * @param {ResponseHandler~Observer} config.observer Observer
  * @param {boolean} config.disableLosslessIntegers Disable the lossless integers
+ * @param {boolean} packstreamConfig.useBigInt if this connection should convert all received integers to native BigInt numbers.
  * @param {boolean} config.serversideRouting It's using server side routing
  */
 export default function create ({
@@ -47,6 +48,7 @@ export default function create ({
   dechunker,
   channel,
   disableLosslessIntegers,
+  useBigInt,
   serversideRouting,
   server, // server info
   log,
@@ -77,7 +79,7 @@ export default function create ({
     version,
     server,
     chunker,
-    disableLosslessIntegers,
+    { disableLosslessIntegers, useBigInt },
     serversideRouting,
     createResponseHandler,
     observer.onProtocolError.bind(observer),
@@ -89,7 +91,7 @@ function createProtocol (
   version,
   server,
   chunker,
-  disableLosslessIntegers,
+  packingConfig,
   serversideRouting,
   createResponseHandler,
   onProtocolError,
@@ -100,7 +102,7 @@ function createProtocol (
       return new BoltProtocolV1(
         server,
         chunker,
-        disableLosslessIntegers,
+        packingConfig,
         createResponseHandler,
         log,
         onProtocolError
@@ -109,7 +111,7 @@ function createProtocol (
       return new BoltProtocolV2(
         server,
         chunker,
-        disableLosslessIntegers,
+        packingConfig,
         createResponseHandler,
         log,
         onProtocolError
@@ -118,7 +120,7 @@ function createProtocol (
       return new BoltProtocolV3(
         server,
         chunker,
-        disableLosslessIntegers,
+        packingConfig,
         createResponseHandler,
         log,
         onProtocolError
@@ -127,7 +129,7 @@ function createProtocol (
       return new BoltProtocolV4x0(
         server,
         chunker,
-        disableLosslessIntegers,
+        packingConfig,
         createResponseHandler,
         log,
         onProtocolError
@@ -136,7 +138,7 @@ function createProtocol (
       return new BoltProtocolV4x1(
         server,
         chunker,
-        disableLosslessIntegers,
+        packingConfig,
         createResponseHandler,
         log,
         onProtocolError,
@@ -146,7 +148,7 @@ function createProtocol (
       return new BoltProtocolV4x2(
         server,
         chunker,
-        disableLosslessIntegers,
+        packingConfig,
         createResponseHandler,
         log,
         onProtocolError,
@@ -156,7 +158,7 @@ function createProtocol (
       return new BoltProtocolV4x3(
         server,
         chunker,
-        disableLosslessIntegers,
+        packingConfig,
         createResponseHandler,
         log,
         onProtocolError,

bolt-connection/src/bolt/create.js

@@ -62,6 +62,7 @@ export function createChannelConnection (
           chunker,
           dechunker,
           disableLosslessIntegers: config.disableLosslessIntegers,
+          useBigInt: config.useBigInt,
           serversideRouting,
           server: conn.server,
           log,

bolt-connection/src/connection/connection-channel.js

@@ -126,6 +126,8 @@ class Packer {
       return () => this.packFloat(x)
     } else if (typeof x === 'string') {
       return () => this.packString(x)
+    } else if (typeof x === 'bigint') {
+      return () => this.packInteger(int(x))
     } else if (isInt(x)) {
       return () => this.packInteger(x)
     } else if (x instanceof Int8Array) {
@@ -368,9 +370,11 @@ class Unpacker {
   /**
    * @constructor
    * @param {boolean} disableLosslessIntegers if this unpacker should convert all received integers to native JS numbers.
+   * @param {boolean} useBigInt if this unpacker should convert all received integers to Bigint
    */
-  constructor (disableLosslessIntegers = false) {
+  constructor (disableLosslessIntegers = false, useBigInt = false) {
     this._disableLosslessIntegers = disableLosslessIntegers
+    this._useBigInt = useBigInt
   }
 
   unpack (buffer) {
@@ -389,8 +393,12 @@ class Unpacker {
 
     const numberOrInteger = this._unpackNumberOrInteger(marker, buffer)
     if (numberOrInteger !== null) {
-      if (this._disableLosslessIntegers && isInt(numberOrInteger)) {
-        return numberOrInteger.toNumberOrInfinity()
+      if (isInt(numberOrInteger)) {
+        if (this._useBigInt) {
+          return numberOrInteger.toBigInt()
+        } else if (this._disableLosslessIntegers) {
+          return numberOrInteger.toNumberOrInfinity()
+        }
       }
       return numberOrInteger
     }

bolt-connection/src/packstream/packstream-v1.js

@@ -106,9 +106,10 @@ export class Unpacker extends v1.Unpacker {
   /**
    * @constructor
    * @param {boolean} disableLosslessIntegers if this unpacker should convert all received integers to native JS numbers.
+   * @param {boolean} useBigInt if this unpacker should convert all received integers to Bigint
    */
-  constructor (disableLosslessIntegers = false) {
-    super(disableLosslessIntegers)
+  constructor (disableLosslessIntegers = false, useBigInt = false) {
+    super(disableLosslessIntegers, useBigInt)
   }
 
   _unpackUnknownStruct (signature, structSize, buffer) {
@@ -584,15 +585,15 @@ function unpackDateTimeWithZoneId (
 }
 
 function convertIntegerPropsIfNeeded (obj, disableLosslessIntegers) {
-  if (!disableLosslessIntegers) {
-    return obj
-  }
+  // if (!disableLosslessIntegers) {
+  //  return obj
+  // }
 
   const clone = Object.create(Object.getPrototypeOf(obj))
   for (const prop in obj) {
     if (obj.hasOwnProperty(prop)) {
       const value = obj[prop]
-      clone[prop] = isInt(value) ? value.toNumberOrInfinity() : value
+      clone[prop] = isInt(value) ? value.toBigInt() : value
     }
   }
   Object.freeze(clone)

bolt-connection/src/packstream/packstream-v2.js

@@ -17,12 +17,11 @@
  * limitations under the License.
  */
 
-import BoltProtocolV1 from '../../../bolt-connection/lib/bolt/bolt-protocol-v1'
-import RequestMessage from '../../../bolt-connection/lib/bolt/request-message'
-import { WRITE } from '../../../src/driver'
-import utils from '../test-utils'
-import { LoginObserver } from '../../../bolt-connection/lib/bolt/stream-observers'
+import BoltProtocolV1 from '../../src/bolt/bolt-protocol-v1'
+import RequestMessage from '../../src/bolt/request-message'
 import { internal } from 'neo4j-driver-core'
+import utils from '../test-utils'
+import { LoginObserver } from '../../src/bolt/stream-observers'
 
 const {
   bookmark: { Bookmark },
@@ -31,7 +30,7 @@ const {
 
 describe('#unit BoltProtocolV1', () => {
   beforeEach(() => {
-    jasmine.addMatchers(utils.matchers)
+    expect.extend(utils.matchers)
   })
 
   it('should not change metadata', () => {
@@ -97,7 +96,7 @@ describe('#unit BoltProtocolV1', () => {
     const observer = protocol.run(query, parameters, {
       bookmark: Bookmark.empty(),
       txConfig: TxConfig.empty(),
-      mode: WRITE
+      mode: 'WRITE'
     })
 
     protocol.verifyMessageCount(2)
@@ -135,7 +134,7 @@ describe('#unit BoltProtocolV1', () => {
     const observer = protocol.beginTransaction({
       bookmark: bookmark,
       txConfig: TxConfig.empty(),
-      mode: WRITE
+      mode: 'WRITE'
     })
 
     protocol.verifyMessageCount(2)
@@ -275,4 +274,25 @@ describe('#unit BoltProtocolV1', () => {
       })
     })
   })
+
+  describe('unpacker configuration', () => {
+    test.each([
+      [false, false],
+      [false, true],
+      [true, false],
+      [true, true]
+    ])(
+      'should create unpacker with disableLosslessIntegers=%p and useBigInt=%p',
+      (disableLosslessIntegers, useBigInt) => {
+        const protocol = new BoltProtocolV1(null, null, {
+          disableLosslessIntegers,
+          useBigInt
+        })
+        expect(protocol._unpacker._disableLosslessIntegers).toBe(
+          disableLosslessIntegers
+        )
+        expect(protocol._unpacker._useBigInt).toBe(useBigInt)
+      }
+    )
+  })
 })

test/internal/bolt/bolt-protocol-v1.test.js renamed to bolt-connection/test/bolt/bolt-protocol-v1.test.js

@@ -17,17 +17,38 @@
  * limitations under the License.
  */
 
-import BoltProtocolV2 from '../../../bolt-connection/lib/bolt/bolt-protocol-v2'
+import BoltProtocolV2 from '../../src/bolt/bolt-protocol-v2'
 import utils from '../test-utils'
 
 describe('#unit BoltProtocolV2', () => {
   beforeEach(() => {
-    jasmine.addMatchers(utils.matchers)
+    expect.extend(utils.matchers)
   })
 
   it('should return correct bolt version number', () => {
     const protocol = new BoltProtocolV2(null, null, false)
 
     expect(protocol.version).toBe(2)
   })
+
+  describe('unpacker configuration', () => {
+    test.each([
+      [false, false],
+      [false, true],
+      [true, false],
+      [true, true]
+    ])(
+      'should create unpacker with disableLosslessIntegers=%p and useBigInt=%p',
+      (disableLosslessIntegers, useBigInt) => {
+        const protocol = new BoltProtocolV2(null, null, {
+          disableLosslessIntegers,
+          useBigInt
+        })
+        expect(protocol._unpacker._disableLosslessIntegers).toBe(
+          disableLosslessIntegers
+        )
+        expect(protocol._unpacker._useBigInt).toBe(useBigInt)
+      }
+    )
+  })
 })