Implementing new structures for DateTime in Bolt 5.0 (#948)

The structures with signature `0x46` and `0x66` are being replaced by `0x49` and `0x69`. This new structures changes the meaning of seconds and nano seconds from `adjusted Unix epoch`  to `UTC`.

This changes have with goal of avoiding un-existing or ambiguous ZonedDateTime to be received or sent over Bolt.

Bolt v4.3 and v4.4 were patched to support this feature if the server supports the patch.

Author: bigmontz

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

@@ -87,7 +87,7 @@ export default class BoltProtocol {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

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

@@ -37,7 +37,7 @@ export default class BoltProtocol extends BoltProtocolV1 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v3.js

@@ -48,7 +48,7 @@ export default class BoltProtocol extends BoltProtocolV2 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v4x0.js

@@ -46,7 +46,7 @@ export default class BoltProtocol extends BoltProtocolV3 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

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

@@ -67,7 +67,7 @@ export default class BoltProtocol extends BoltProtocolV4 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v4x2.js

@@ -34,7 +34,7 @@ export default class BoltProtocol extends BoltProtocolV41 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v4x3.js

@@ -18,9 +18,10 @@
  */
 import BoltProtocolV42 from './bolt-protocol-v4x2'
 import RequestMessage from './request-message'
-import { RouteObserver } from './stream-observers'
+import { LoginObserver, RouteObserver } from './stream-observers'
 
 import transformersFactories from './bolt-protocol-v4x3.transformer'
+import utcTransformersFactories from './bolt-protocol-v5x0.utc.transformer'
 import Transformer from './transformer'
 
 import { internal } from 'neo4j-driver-core'
@@ -37,7 +38,7 @@ export default class BoltProtocol extends BoltProtocolV42 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }
@@ -75,4 +76,51 @@ export default class BoltProtocol extends BoltProtocolV42 {
 
     return observer
   }
+
+  /**
+   * Initialize a connection with the server
+   *
+   * @param {Object} param0 The params
+   * @param {string} param0.userAgent The user agent
+   * @param {any} param0.authToken The auth token
+   * @param {function(error)} param0.onError On error callback
+   * @param {function(onComplte)} param0.onComplete On complete callback
+   * @returns {LoginObserver} The Login observer
+   */
+  initialize ({ userAgent, authToken, onError, onComplete } = {}) {
+    const observer = new LoginObserver({
+      onError: error => this._onLoginError(error, onError),
+      onCompleted: metadata => {
+        if (metadata.patch_bolt !== undefined) {
+          this._applyPatches(metadata.patch_bolt)
+        }
+        return this._onLoginCompleted(metadata, onComplete)
+      }
+    })
+
+    this.write(
+      RequestMessage.hello(userAgent, authToken, this._serversideRouting, ['utc']),
+      observer,
+      true
+    )
+
+    return observer
+  }
+
+  /**
+   *
+   * @param {string[]} patches Patches to be applied to the protocol
+   */
+  _applyPatches (patches) {
+    if (patches.includes('utc')) {
+      this._applyUtcPatch()
+    }
+  }
+
+  _applyUtcPatch () {
+    this._transformer = new Transformer(Object.values({
+      ...transformersFactories,
+      ...utcTransformersFactories
+    }).map(create => create(this._config, this._log)))
+  }
 }

packages/bolt-connection/src/bolt/bolt-protocol-v4x4.js

@@ -23,6 +23,7 @@ import RequestMessage from './request-message'
 import { RouteObserver, ResultStreamObserver } from './stream-observers'
 
 import transformersFactories from './bolt-protocol-v4x4.transformer'
+import utcTransformersFactories from './bolt-protocol-v5x0.utc.transformer'
 import Transformer from './transformer'
 
 const {
@@ -37,7 +38,7 @@ export default class BoltProtocol extends BoltProtocolV43 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }
@@ -163,4 +164,11 @@ export default class BoltProtocol extends BoltProtocolV43 {
 
     return observer
   }
+
+  _applyUtcPatch () {
+    this._transformer = new Transformer(Object.values({
+      ...transformersFactories,
+      ...utcTransformersFactories
+    }).map(create => create(this._config, this._log)))
+  }
 }

packages/bolt-connection/src/bolt/bolt-protocol-v5x0.js

@@ -20,6 +20,8 @@ import BoltProtocolV44 from './bolt-protocol-v4x4'
 
 import transformersFactories from './bolt-protocol-v5x0.transformer'
 import Transformer from './transformer'
+import RequestMessage from './request-message'
+import { LoginObserver } from './stream-observers'
 
 import { internal } from 'neo4j-driver-core'
 
@@ -34,8 +36,33 @@ export default class BoltProtocol extends BoltProtocolV44 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }
+
+  /**
+   * Initialize a connection with the server
+   *
+   * @param {Object} param0 The params
+   * @param {string} param0.userAgent The user agent
+   * @param {any} param0.authToken The auth token
+   * @param {function(error)} param0.onError On error callback
+   * @param {function(onComplte)} param0.onComplete On complete callback
+   * @returns {LoginObserver} The Login observer
+   */
+  initialize ({ userAgent, authToken, onError, onComplete } = {}) {
+    const observer = new LoginObserver({
+      onError: error => this._onLoginError(error, onError),
+      onCompleted: metadata => this._onLoginCompleted(metadata, onComplete)
+    })
+
+    this.write(
+      RequestMessage.hello(userAgent, authToken, this._serversideRouting),
+      observer,
+      true
+    )
+
+    return observer
+  }
 }

packages/bolt-connection/src/bolt/bolt-protocol-v5x0.transformer.js

@@ -18,8 +18,14 @@
  */
 
 import { structure } from '../packstream'
-import { Node, Relationship, UnboundRelationship } from 'neo4j-driver-core'
+import {
+  Node,
+  Relationship,
+  UnboundRelationship
+} from 'neo4j-driver-core'
+
 import v4x4 from './bolt-protocol-v4x4.transformer'
+import v5x0Utc from './bolt-protocol-v5x0.utc.transformer'
 
 const NODE_STRUCT_SIZE = 4
 const RELATIONSHIP_STRUCT_SIZE = 8
@@ -118,6 +124,7 @@ function createUnboundRelationshipTransformer (config) {
 
 export default {
   ...v4x4,
+  ...v5x0Utc,
   createNodeTransformer,
   createRelationshipTransformer,
   createUnboundRelationshipTransformer