Use protocol version instead of server agent string

Author: technige

src/internal/bolt-protocol-v4.js renamed to src/internal/bolt-protocol-v4x0.js

@@ -19,11 +19,11 @@
 import BoltProtocolV3 from './bolt-protocol-v3'
 import RequestMessage, { ALL } from './request-message'
 import { ResultStreamObserver } from './stream-observers'
-import { BOLT_PROTOCOL_V4 } from './constants'
+import { BOLT_PROTOCOL_V4_0 } from './constants'
 
 export default class BoltProtocol extends BoltProtocolV3 {
   get version () {
-    return BOLT_PROTOCOL_V4
+    return BOLT_PROTOCOL_V4_0
   }
 
   beginTransaction ({

src/internal/connection-provider-direct.js

@@ -20,7 +20,7 @@
 import PooledConnectionProvider from './connection-provider-pooled'
 import DelegateConnection from './connection-delegate'
 import ChannelConnection from './connection-channel'
-import { BOLT_PROTOCOL_V4, BOLT_PROTOCOL_V3 } from './constants'
+import { BOLT_PROTOCOL_V4_0, BOLT_PROTOCOL_V3 } from './constants'
 
 export default class DirectConnectionProvider extends PooledConnectionProvider {
   constructor ({ id, config, log, address, userAgent, authToken }) {
@@ -63,7 +63,7 @@ export default class DirectConnectionProvider extends PooledConnectionProvider {
 
   async supportsMultiDb () {
     return await this._hasProtocolVersion(
-      version => version >= BOLT_PROTOCOL_V4
+      version => version >= BOLT_PROTOCOL_V4_0
     )
   }
 

src/internal/connection-provider-routing.js

@@ -25,15 +25,14 @@ import Rediscovery from './rediscovery'
 import RoutingUtil from './routing-util'
 import { HostNameResolver } from './node'
 import SingleConnectionProvider from './connection-provider-single'
-import { ServerVersion, VERSION_4_0_0 } from './server-version'
 import PooledConnectionProvider from './connection-provider-pooled'
 import ConnectionErrorHandler from './connection-error-handler'
 import DelegateConnection from './connection-delegate'
 import LeastConnectedLoadBalancingStrategy from './least-connected-load-balancing-strategy'
 import Bookmark from './bookmark'
 import ChannelConnection from './connection-channel'
 import { int } from '../integer'
-import { BOLT_PROTOCOL_V4, BOLT_PROTOCOL_V3 } from './constants'
+import { BOLT_PROTOCOL_V3, BOLT_PROTOCOL_V4_0 } from './constants'
 
 const UNAUTHORIZED_ERROR_CODE = 'Neo.ClientError.Security.Unauthorized'
 const DATABASE_NOT_FOUND_ERROR_CODE =
@@ -189,7 +188,7 @@ export default class RoutingConnectionProvider extends PooledConnectionProvider
 
   async supportsMultiDb () {
     return await this._hasProtocolVersion(
-      version => version >= BOLT_PROTOCOL_V4
+      version => version >= BOLT_PROTOCOL_V4_0
     )
   }
 
@@ -424,8 +423,8 @@ export default class RoutingConnectionProvider extends PooledConnectionProvider
       const connection = await this._connectionPool.acquire(routerAddress)
       const connectionProvider = new SingleConnectionProvider(connection)
 
-      const version = ServerVersion.fromString(connection.version)
-      if (version.compareTo(VERSION_4_0_0) < 0) {
+      const protocolVersion = connection.protocol().version
+      if (protocolVersion < 4.0) {
         return new Session({
           mode: WRITE,
           bookmark: Bookmark.empty(),

src/internal/constants.js

@@ -23,13 +23,13 @@ const ACCESS_MODE_WRITE = 'WRITE'
 const BOLT_PROTOCOL_V1 = 1
 const BOLT_PROTOCOL_V2 = 2
 const BOLT_PROTOCOL_V3 = 3
-const BOLT_PROTOCOL_V4 = 4
+const BOLT_PROTOCOL_V4_0 = 4.0
 
 export {
   ACCESS_MODE_READ,
   ACCESS_MODE_WRITE,
   BOLT_PROTOCOL_V1,
   BOLT_PROTOCOL_V2,
   BOLT_PROTOCOL_V3,
-  BOLT_PROTOCOL_V4
+  BOLT_PROTOCOL_V4_0
 }

src/internal/protocol-handshaker.js

@@ -22,9 +22,8 @@ import { newError } from '../error'
 import BoltProtocolV1 from './bolt-protocol-v1'
 import BoltProtocolV2 from './bolt-protocol-v2'
 import BoltProtocolV3 from './bolt-protocol-v3'
-import BoltProtocolV4 from './bolt-protocol-v4'
+import BoltProtocolV4x0 from './bolt-protocol-v4x0'
 
-const HTTP_MAGIC_PREAMBLE = 1213486160 // == 0x48545450 == "HTTP"
 const BOLT_MAGIC_PREAMBLE = 0x6060b017
 
 export default class ProtocolHandshaker {
@@ -58,7 +57,19 @@ export default class ProtocolHandshaker {
    * @throws {Neo4jError} when bolt protocol can't be instantiated.
    */
   createNegotiatedProtocol (buffer) {
-    const negotiatedVersion = buffer.readInt32()
+    const h = [
+      buffer.readUInt8(),
+      buffer.readUInt8(),
+      buffer.readUInt8(),
+      buffer.readUInt8()
+    ]
+    if (h[0] === 0x48 && h[1] === 0x54 && h[2] === 0x54 && h[3] === 0x50) {
+      throw newError(
+        'Server responded HTTP. Make sure you are not trying to connect to the http endpoint ' +
+          '(HTTP defaults to port 7474 whereas BOLT defaults to port 7687)'
+      )
+    }
+    const negotiatedVersion = Number(h[3] + '.' + h[2])
     if (this._log.isDebugEnabled()) {
       this._log.debug(
         `${this._connection} negotiated protocol version ${negotiatedVersion}`
@@ -91,17 +102,12 @@ export default class ProtocolHandshaker {
           this._chunker,
           this._disableLosslessIntegers
         )
-      case 4:
-        return new BoltProtocolV4(
+      case 4.0:
+        return new BoltProtocolV4x0(
           this._connection,
           this._chunker,
           this._disableLosslessIntegers
         )
-      case HTTP_MAGIC_PREAMBLE:
-        throw newError(
-          'Server responded HTTP. Make sure you are not trying to connect to the http endpoint ' +
-            '(HTTP defaults to port 7474 whereas BOLT defaults to port 7687)'
-        )
       default:
         throw newError('Unknown Bolt protocol version: ' + version)
     }

src/internal/routing-util.js

@@ -141,8 +141,8 @@ export default class RoutingUtil {
       let query
       let params
 
-      const version = ServerVersion.fromString(connection.version)
-      if (version.compareTo(VERSION_4_0_0) >= 0) {
+      const protocolVersion = connection.protocol().version
+      if (protocolVersion >= 4.0) {
         query = CALL_GET_ROUTING_TABLE_MULTI_DB
         params = {
           context: this._routingContext,

src/result-summary.js

@@ -29,8 +29,9 @@ class ResultSummary {
    * @param {string} query - The query this summary is for
    * @param {Object} parameters - Parameters for the query
    * @param {Object} metadata - Query metadata
+   * @param {number} protocolVersion - Bolt protocol version
    */
-  constructor (query, parameters, metadata) {
+  constructor (query, parameters, metadata, protocolVersion) {
     /**
      * The query and parameters this summary is for.
      * @type {{text: string, parameters: Object}}
@@ -96,7 +97,7 @@ class ResultSummary {
      * @type {ServerInfo}
      * @public
      */
-    this.server = new ServerInfo(metadata.server)
+    this.server = new ServerInfo(metadata.server, protocolVersion)
 
     /**
      * The time it took the server to consume the result.
@@ -313,12 +314,14 @@ class ServerInfo {
    * Create a ServerInfo instance
    * @constructor
    * @param {Object} serverMeta - Object with serverMeta data
+   * @param {number} protocolVersion - Bolt protocol version
    */
-  constructor (serverMeta) {
+  constructor (serverMeta, protocolVersion) {
     if (serverMeta) {
       this.address = serverMeta.address
       this.version = serverMeta.version
     }
+    this.protocolVersion = protocolVersion
   }
 }
 

src/result.js

@@ -162,15 +162,34 @@ class Result {
   subscribe (observer) {
     const onCompletedOriginal = observer.onCompleted || DEFAULT_ON_COMPLETED
     const onCompletedWrapper = metadata => {
-      // notify connection holder that the used connection is not needed any more because result has
-      // been fully consumed; call the original onCompleted callback after that
-      this._connectionHolder.releaseConnection().then(() => {
-        onCompletedOriginal.call(
-          observer,
-          new ResultSummary(this._query, this._parameters, metadata)
-        )
-      })
+      const connectionHolder = this._connectionHolder
+      const query = this._query
+      const parameters = this._parameters
+
+      function release (protocolVersion) {
+        // notify connection holder that the used connection is not needed any more because result has
+        // been fully consumed; call the original onCompleted callback after that
+        connectionHolder.releaseConnection().then(() => {
+          onCompletedOriginal.call(
+            observer,
+            new ResultSummary(query, parameters, metadata, protocolVersion)
+          )
+        })
+      }
+
+      connectionHolder.getConnection().then(
+        // onFulfilled:
+        connection => {
+          release(connection ? connection.protocol().version : undefined)
+        },
+
+        // onRejected:
+        _ => {
+          release()
+        }
+      )
     }
+
     observer.onCompleted = onCompletedWrapper
 
     const onErrorOriginal = observer.onError || DEFAULT_ON_ERROR

test/bolt-v3.test.js

@@ -19,7 +19,6 @@
 
 import neo4j from '../src'
 import sharedNeo4j from './internal/shared-neo4j'
-import { ServerVersion, VERSION_3_5_0 } from '../src/internal/server-version'
 
 const TX_CONFIG_WITH_METADATA = { metadata: { a: 1, b: 2 } }
 const TX_CONFIG_WITH_TIMEOUT = { timeout: 42 }
@@ -34,7 +33,7 @@ const INVALID_METADATA_VALUES = [
 describe('#integration Bolt V3 API', () => {
   let driver
   let session
-  let serverVersion
+  let protocolVersion
   let originalTimeout
 
   beforeEach(async () => {
@@ -43,7 +42,7 @@ describe('#integration Bolt V3 API', () => {
     originalTimeout = jasmine.DEFAULT_TIMEOUT_INTERVAL
     jasmine.DEFAULT_TIMEOUT_INTERVAL = 20000
 
-    serverVersion = await sharedNeo4j.cleanupAndGetVersion(driver)
+    protocolVersion = await sharedNeo4j.cleanupAndGetProtocolVersion(driver)
   })
 
   afterEach(async () => {
@@ -497,6 +496,6 @@ describe('#integration Bolt V3 API', () => {
   }
 
   function databaseSupportsBoltV3 () {
-    return serverVersion.compareTo(VERSION_3_5_0) >= 0
+    return protocolVersion >= 3
   }
 })

test/bolt-v4.test.js renamed to test/bolt-v4x0.test.js

@@ -19,12 +19,11 @@
 
 import neo4j from '../src'
 import sharedNeo4j from './internal/shared-neo4j'
-import { ServerVersion, VERSION_4_0_0 } from '../src/internal/server-version'
 
-describe('#integration Bolt V4 API', () => {
+describe('#integration Bolt V4.0 API', () => {
   let driver
   let session
-  let serverVersion
+  let protocolVersion
   let originalTimeout
 
   beforeEach(async () => {
@@ -33,7 +32,7 @@ describe('#integration Bolt V4 API', () => {
     originalTimeout = jasmine.DEFAULT_TIMEOUT_INTERVAL
     jasmine.DEFAULT_TIMEOUT_INTERVAL = 20000
 
-    serverVersion = await sharedNeo4j.cleanupAndGetVersion(driver)
+    protocolVersion = await sharedNeo4j.cleanupAndGetProtocolVersion(driver)
   })
 
   afterEach(async () => {
@@ -231,6 +230,6 @@ describe('#integration Bolt V4 API', () => {
   }
 
   function databaseSupportsBoltV4 () {
-    return serverVersion.compareTo(VERSION_4_0_0) >= 0
+    return protocolVersion >= 4.0
   }
 })