Implements bookmarks in the ROUTE message

This important in the case of a creation of a new database to make sure the database is running in all the clusters nodes returned.

This change also skips a test which depends on feature which doesn't exists on the javascript driver.

Author: bigmontz

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

@@ -149,7 +149,6 @@ export default class BoltProtocol extends BoltProtocolV3 {
     routingContext = {},
     databaseName = null,
     sessionContext = {},
-    initialAddress = null,
     onError,
     onCompleted
   }) {

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

@@ -23,6 +23,7 @@ import { RouteObserver } from './stream-observers'
 import { internal } from 'neo4j-driver-core'
 
 const {
+  bookmark: { Bookmark },
   constants: { BOLT_PROTOCOL_V4_3 }
 } = internal
 
@@ -38,14 +39,15 @@ export default class BoltProtocol extends BoltProtocolV42 {
    * @param {object} param.routingContext The routing context used to define the routing table.
    *  Multi-datacenter deployments is one of its use cases
    * @param {string} param.databaseName The database name
+   * @param {Bookmark} params.sessionContext.bookmark The bookmark used for request the routing table
    * @param {function(err: Error)} param.onError
    * @param {function(RawRoutingTable)} param.onCompleted
    * @returns {RouteObserver} the route observer
    */
   requestRoutingInformation ({
     routingContext = {},
     databaseName = null,
-    initialAddress = null,
+    sessionContext = {},
     onError,
     onCompleted
   }) {
@@ -54,9 +56,9 @@ export default class BoltProtocol extends BoltProtocolV42 {
       onError,
       onCompleted
     })
-
+    const bookmark = sessionContext.bookmark || Bookmark.empty()
     this.write(
-      RequestMessage.route(routingContext, databaseName),
+      RequestMessage.route(routingContext, bookmark.values(), databaseName),
       observer,
       true
     )

bolt-connection/src/bolt/request-message.js

@@ -223,14 +223,18 @@ export default class RequestMessage {
    * Generate the ROUTE message, this message is used to fetch the routing table from the server
    *
    * @param {object} routingContext The routing context used to define the routing table. Multi-datacenter deployments is one of its use cases
+   * @param {string[]} bookmarks The list of the bookmark should be used
    * @param {string} databaseName The name of the database to get the routing table for.
    * @return {RequestMessage} the ROUTE message.
    */
-  static route (routingContext = {}, databaseName = null) {
+  static route (routingContext = {}, bookmarks = [], databaseName = null) {
     return new RequestMessage(
       ROUTE,
-      [routingContext, databaseName],
-      () => `ROUTE ${json.stringify(routingContext)} ${databaseName}`
+      [routingContext, bookmarks, databaseName],
+      () =>
+        `ROUTE ${json.stringify(routingContext)} ${json.stringify(
+          bookmarks
+        )} ${databaseName}`
     )
   }
 }

bolt-connection/test/bolt/bolt-protocol-v4x3.test.js

@@ -49,7 +49,31 @@ describe('#unit BoltProtocolV4x3', () => {
 
     protocol.verifyMessageCount(1)
     expect(protocol.messages[0]).toBeMessage(
-      RequestMessage.route(routingContext, databaseName)
+      RequestMessage.route(routingContext, [], databaseName)
+    )
+    expect(protocol.observers).toEqual([observer])
+    expect(observer).toEqual(jasmine.any(RouteObserver))
+    expect(protocol.flushes).toEqual([true])
+  })
+
+  it('should request routing information sending bookmarks', () => {
+    const recorder = new utils.MessageRecordingConnection()
+    const protocol = new BoltProtocolV4x3(recorder, null, false)
+    utils.spyProtocolWrite(protocol)
+    const routingContext = { someContextParam: 'value' }
+    const listOfBookmarks = ['a', 'b', 'c']
+    const bookmark = new Bookmark(listOfBookmarks)
+    const databaseName = 'name'
+
+    const observer = protocol.requestRoutingInformation({
+      routingContext,
+      databaseName,
+      sessionContext: { bookmark }
+    })
+
+    protocol.verifyMessageCount(1)
+    expect(protocol.messages[0]).toBeMessage(
+      RequestMessage.route(routingContext, listOfBookmarks, databaseName)
     )
     expect(protocol.observers).toEqual([observer])
     expect(observer).toEqual(jasmine.any(RouteObserver))

bolt-connection/test/bolt/request-message.test.js

@@ -242,23 +242,28 @@ describe('#unit RequestMessage', () => {
   describe('BoltV4.3', () => {
     it('should create ROUTE message', () => {
       const requestContext = { someValue: '1234' }
+      const bookmarks = ['a', 'b']
       const database = 'user_db'
 
-      const message = RequestMessage.route(requestContext, database)
+      const message = RequestMessage.route(requestContext, bookmarks, database)
 
       expect(message.signature).toEqual(0x66)
-      expect(message.fields).toEqual([requestContext, database])
+      expect(message.fields).toEqual([requestContext, bookmarks, database])
       expect(message.toString()).toEqual(
-        `ROUTE ${json.stringify(requestContext)} ${database}`
+        `ROUTE ${json.stringify(requestContext)} ${json.stringify(
+          bookmarks
+        )} ${database}`
       )
     })
 
     it('should create ROUTE message with default values', () => {
       const message = RequestMessage.route()
 
       expect(message.signature).toEqual(0x66)
-      expect(message.fields).toEqual([{}, null])
-      expect(message.toString()).toEqual(`ROUTE ${json.stringify({})} ${null}`)
+      expect(message.fields).toEqual([{}, [], null])
+      expect(message.toString()).toEqual(
+        `ROUTE ${json.stringify({})} ${json.stringify([])} ${null}`
+      )
     })
   })
 })

testkit-backend/src/skipped-tests.js

@@ -23,6 +23,10 @@ const skippedTests = [
     'Routing tests are disabled until the fix on the test scenario be merged',
     or(ifStartsWith('stub.routing'), ifStartsWith('stub.retry.TestRetry'))
   ),
+  skip(
+    'The driver no support domain_name_resolver',
+    ifEndsWith('test_should_successfully_acquire_rt_when_router_ip_changes')
+  ),
   skip(
     'Driver is failing trying to update the routing table using the original routing server',
     ifEndsWith(