Add login/logoff messages to the 5.1

Author: bigmontz

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

@@ -0,0 +1,132 @@
+/**
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import BoltProtocolV5x0 from './bolt-protocol-v5x0'
+
+import transformersFactories from './bolt-protocol-v5x1.transformer'
+import Transformer from './transformer'
+import RequestMessage from './request-message'
+import { LoginObserver, LogoffObserver } from './stream-observers'
+
+import { internal } from 'neo4j-driver-core'
+
+const {
+  constants: { BOLT_PROTOCOL_V5_1 }
+} = internal
+
+export default class BoltProtocol extends BoltProtocolV5x0 {
+  get version () {
+    return BOLT_PROTOCOL_V5_1
+  }
+
+  get transformer () {
+    if (this._transformer === undefined) {
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
+    }
+    return this._transformer
+  }
+
+  get supportsLogoff () {
+    return true
+  }
+
+  /**
+   * 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 state = {}
+    const observer = new LoginObserver({
+      onError: error => this._onLoginError(error, onError),
+      onCompleted: metadata => {
+        state.metadata = metadata
+        return this._onLoginCompleted(metadata)
+      }
+    })
+
+    this.write(
+      RequestMessage.hello5x1(userAgent, this._serversideRouting),
+      observer,
+      false
+    )
+
+    return this.login({
+      authToken,
+      onComplete: metadata => onComplete({ ...metadata, ...state.metadata }),
+      onError,
+      flush: true
+    })
+  }
+
+  /**
+   * Performs login of the underlying connection
+   *
+   * @param {Object} param
+   * @param {Object} param.authToken the authentication token.
+   * @param {function(err: Error)} param.onError the callback to invoke on error.
+   * @param {function()} param.onComplete the callback to invoke on completion.
+   * @param {boolean} param.flush whether to flush the buffered messages.
+   *
+   * @returns {StreamObserver} the stream observer that monitors the corresponding server response.
+   */
+  login ({ authToken, onComplete, onError, flush } = {}) {
+    const observer = new LoginObserver({
+      onCompleted: () => this._onLoginCompleted(null, authToken, onComplete),
+      onError: (error) => this._onLoginError(error, onError)
+    })
+
+    this.write(
+      RequestMessage.login(authToken),
+      observer,
+      flush
+    )
+
+    return observer
+  }
+
+  /**
+   * Performs logoff of the underlying connection
+   *
+   * @param {Object} param
+   * @param {function(err: Error)} param.onError the callback to invoke on error.
+   * @param {function()} param.onComplete the callback to invoke on completion.
+   * @param {boolean} param.flush whether to flush the buffered messages.
+   *
+   * @returns {StreamObserver} the stream observer that monitors the corresponding server response.
+  */
+  logoff ({ onComplete, onError, flush } = {}) {
+    const observer = new LogoffObserver({
+      onCompleted: onComplete,
+      onError: onError
+    })
+
+    this.write(
+      RequestMessage.logoff(),
+      observer,
+      flush
+    )
+
+    return observer
+  }
+}

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

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import v5x0 from './bolt-protocol-v5x0.transformer'
+
+export default {
+  ...v5x0
+}

packages/bolt-connection/src/bolt/create.js

@@ -27,6 +27,7 @@ import BoltProtocolV4x2 from './bolt-protocol-v4x2'
 import BoltProtocolV4x3 from './bolt-protocol-v4x3'
 import BoltProtocolV4x4 from './bolt-protocol-v4x4'
 import BoltProtocolV5x0 from './bolt-protocol-v5x0'
+import BoltProtocolV5x1 from './bolt-protocol-v5x1'
 // eslint-disable-next-line no-unused-vars
 import { Chunker, Dechunker } from '../channel'
 import ResponseHandler from './response-handler'
@@ -191,6 +192,16 @@ function createProtocol (
         onProtocolError,
         serversideRouting
       )
+    case 5.1:
+      return new BoltProtocolV5x1(
+        server,
+        chunker,
+        packingConfig,
+        createResponseHandler,
+        log,
+        onProtocolError,
+        serversideRouting
+      )
     default:
       throw newError('Unknown Bolt protocol version: ' + version)
   }

packages/bolt-connection/src/bolt/handshake.js

@@ -76,7 +76,7 @@ function parseNegotiatedResponse (buffer) {
  */
 function newHandshakeBuffer () {
   return createHandshakeMessage([
-    version(5, 0),
+    [version(5, 1), version(5, 0)],
     [version(4, 4), version(4, 2)],
     version(4, 1),
     version(3, 0)

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

@@ -40,6 +40,9 @@ const COMMIT = 0x12 // 0001 0010 // COMMIT
 const ROLLBACK = 0x13 // 0001 0011 // ROLLBACK
 const ROUTE = 0x66 // 0110 0110 // ROUTE
 
+const LOGIN = 0x6A // LOGON
+const LOGOFF = 0x6B // LOGOFF
+
 const DISCARD = 0x2f // 0010 1111 // DISCARD
 const PULL = 0x3f // 0011 1111 // PULL
 
@@ -121,6 +124,52 @@ export default class RequestMessage {
     )
   }
 
+  /**
+   * Create a new HELLO message.
+   * @param {string} userAgent the user agent.
+   * @param {Object} optional server side routing, set to routing context to turn on server side routing (> 4.1)
+   * @return {RequestMessage} new HELLO message.
+   */
+  static hello5x1 (userAgent, routing = null) {
+    const metadata = { user_agent: userAgent }
+    if (routing) {
+      metadata.routing = routing
+    }
+
+    return new RequestMessage(
+      HELLO,
+      [metadata],
+      () => `HELLO {user_agent: '${userAgent}', ...}`
+    )
+  }
+
+  /**
+   * Create a new LOGIN message.
+   *
+   * @param {object} authToken The auth token
+   * @returns {RequestMessage} new LOGIN message
+   */
+  static login (authToken) {
+    return new RequestMessage(
+      LOGIN,
+      [authToken],
+      () => 'LOGIN { ... }'
+    )
+  }
+
+  /**
+   * Create a new LOGOFF message.
+   *
+   * @returns {RequestMessage} new LOGOFF message
+   */
+  static logoff () {
+    return new RequestMessage(
+      LOGOFF,
+      [],
+      () => 'LOGOFF'
+    )
+  }
+
   /**
    * Create a new BEGIN message.
    * @param {Bookmarks} bookmarks the bookmarks.

packages/bolt-connection/test/bolt/index.test.js

@@ -44,13 +44,13 @@ describe('#unit Bolt', () => {
       const writtenBuffer = channel.written[0]
 
       const boltMagicPreamble = '60 60 b0 17'
-      const protocolVersion5x0 = '00 00 00 05'
+      const protocolVersion5x1to5x0 = '00 01 01 05'
       const protocolVersion4x4to4x2 = '00 02 04 04'
       const protocolVersion4x1 = '00 00 01 04'
       const protocolVersion3 = '00 00 00 03'
 
       expect(writtenBuffer.toHex()).toEqual(
-        `${boltMagicPreamble} ${protocolVersion5x0} ${protocolVersion4x4to4x2} ${protocolVersion4x1} ${protocolVersion3}`
+        `${boltMagicPreamble} ${protocolVersion5x1to5x0} ${protocolVersion4x4to4x2} ${protocolVersion4x1} ${protocolVersion3}`
       )
     })
 

packages/core/src/internal/constants.ts

@@ -34,6 +34,7 @@ const BOLT_PROTOCOL_V4_2: number = 4.2
 const BOLT_PROTOCOL_V4_3: number = 4.3
 const BOLT_PROTOCOL_V4_4: number = 4.4
 const BOLT_PROTOCOL_V5_0: number = 5.0
+const BOLT_PROTOCOL_V5_1: number = 5.1
 
 export {
   FETCH_ALL,
@@ -50,5 +51,6 @@ export {
   BOLT_PROTOCOL_V4_2,
   BOLT_PROTOCOL_V4_3,
   BOLT_PROTOCOL_V4_4,
-  BOLT_PROTOCOL_V5_0
+  BOLT_PROTOCOL_V5_0,
+  BOLT_PROTOCOL_V5_1
 }