Patching 4.3 and 4.4 with the UTC fix

Author: bigmontz

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'
@@ -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 {
@@ -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'
 
@@ -38,4 +40,29 @@ export default class BoltProtocol extends BoltProtocolV44 {
     }
     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/request-message.js

@@ -106,11 +106,14 @@ export default class RequestMessage {
    * @param {Object} optional server side routing, set to routing context to turn on server side routing (> 4.1)
    * @return {RequestMessage} new HELLO message.
    */
-  static hello (userAgent, authToken, routing = null) {
+  static hello (userAgent, authToken, routing = null, patchs = null) {
     const metadata = Object.assign({ user_agent: userAgent }, authToken)
     if (routing) {
       metadata.routing = routing
     }
+    if (patchs) {
+      metadata.patch_bolt = patchs
+    }
     return new RequestMessage(
       HELLO,
       [metadata],

packages/bolt-connection/test/bolt/__snapshots__/bolt-protocol-v4x3.test.js.snap

@@ -59,3 +59,11 @@ exports[`#unit BoltProtocolV4x3 .unpack() should not unpack with wrong size (Tim
 exports[`#unit BoltProtocolV4x3 .unpack() should not unpack with wrong size (UnboundRelationship with less fields) 1`] = `"Wrong struct size for UnboundRelationship, expected 3 but was 2"`;
 
 exports[`#unit BoltProtocolV4x3 .unpack() should not unpack with wrong size (UnboundRelationship with more fields) 1`] = `"Wrong struct size for UnboundRelationship, expected 3 but was 4"`;
+
+exports[`#unit BoltProtocolV4x3 utc patch the server accepted the patch should not unpack with wrong size (DateTimeWithZoneId with less fields) 1`] = `"Wrong struct size for DateTimeWithZoneId, expected 3 but was 2"`;
+
+exports[`#unit BoltProtocolV4x3 utc patch the server accepted the patch should not unpack with wrong size (DateTimeWithZoneId with more fields) 1`] = `"Wrong struct size for DateTimeWithZoneId, expected 3 but was 4"`;
+
+exports[`#unit BoltProtocolV4x3 utc patch the server accepted the patch should not unpack with wrong size (DateTimeWithZoneOffset with less fields) 1`] = `"Wrong struct size for DateTimeWithZoneOffset, expected 3 but was 2"`;
+
+exports[`#unit BoltProtocolV4x3 utc patch the server accepted the patch should not unpack with wrong size (DateTimeWithZoneOffset with more fields) 1`] = `"Wrong struct size for DateTimeWithZoneOffset, expected 3 but was 4"`;

packages/bolt-connection/test/bolt/__snapshots__/bolt-protocol-v4x4.test.js.snap

@@ -59,3 +59,11 @@ exports[`#unit BoltProtocolV4x4 .unpack() should not unpack with wrong size (Tim
 exports[`#unit BoltProtocolV4x4 .unpack() should not unpack with wrong size (UnboundRelationship with less fields) 1`] = `"Wrong struct size for UnboundRelationship, expected 3 but was 2"`;
 
 exports[`#unit BoltProtocolV4x4 .unpack() should not unpack with wrong size (UnboundRelationship with more fields) 1`] = `"Wrong struct size for UnboundRelationship, expected 3 but was 4"`;
+
+exports[`#unit BoltProtocolV4x4 utc patch the server accepted the patch should not unpack with wrong size (DateTimeWithZoneId with less fields) 1`] = `"Wrong struct size for DateTimeWithZoneId, expected 3 but was 2"`;
+
+exports[`#unit BoltProtocolV4x4 utc patch the server accepted the patch should not unpack with wrong size (DateTimeWithZoneId with more fields) 1`] = `"Wrong struct size for DateTimeWithZoneId, expected 3 but was 4"`;
+
+exports[`#unit BoltProtocolV4x4 utc patch the server accepted the patch should not unpack with wrong size (DateTimeWithZoneOffset with less fields) 1`] = `"Wrong struct size for DateTimeWithZoneOffset, expected 3 but was 2"`;
+
+exports[`#unit BoltProtocolV4x4 utc patch the server accepted the patch should not unpack with wrong size (DateTimeWithZoneOffset with more fields) 1`] = `"Wrong struct size for DateTimeWithZoneOffset, expected 3 but was 4"`;