Bolt agent added to hello metadata (#1076)

Author: ConorNeo

package.json

@@ -44,6 +44,7 @@
     "build::notci": "lerna bootstrap",
     "docs": "lerna run docs --stream --concurrency 1",
     "test::unit": "lerna run test::unit --stream",
+    "test::deno": "lerna run test::deno --stream",
     "test::integration": "lerna run test::integration --stream",
     "test::browser": "lerna run test::browser --stream",
     "test::stress": "lerna run test::stress  --stream",

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

@@ -175,7 +175,7 @@ export default class BoltProtocol {
    * @param {function()} param.onComplete the callback to invoke on completion.
    * @returns {StreamObserver} the stream observer that monitors the corresponding server response.
    */
-  initialize ({ userAgent, authToken, notificationFilter, onError, onComplete } = {}) {
+  initialize ({ userAgent, boltAgent, authToken, notificationFilter, onError, onComplete } = {}) {
     const observer = new LoginObserver({
       onError: error => this._onLoginError(error, onError),
       onCompleted: metadata => this._onLoginCompleted(metadata, onComplete)

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

@@ -69,7 +69,7 @@ export default class BoltProtocol extends BoltProtocolV2 {
     return metadata
   }
 
-  initialize ({ userAgent, authToken, notificationFilter, onError, onComplete } = {}) {
+  initialize ({ userAgent, boltAgent, authToken, notificationFilter, onError, onComplete } = {}) {
     const observer = new LoginObserver({
       onError: error => this._onLoginError(error, onError),
       onCompleted: metadata => this._onLoginCompleted(metadata, authToken, onComplete)

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

@@ -73,7 +73,7 @@ export default class BoltProtocol extends BoltProtocolV4 {
     return this._transformer
   }
 
-  initialize ({ userAgent, authToken, notificationFilter, onError, onComplete } = {}) {
+  initialize ({ userAgent, boltAgent, authToken, notificationFilter, onError, onComplete } = {}) {
     const observer = new LoginObserver({
       onError: error => this._onLoginError(error, onError),
       onCompleted: metadata => this._onLoginCompleted(metadata, authToken, onComplete)

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

@@ -89,7 +89,7 @@ export default class BoltProtocol extends BoltProtocolV42 {
    * @param {function(onComplte)} args.onComplete On complete callback
    * @returns {LoginObserver} The Login observer
    */
-  initialize ({ userAgent, authToken, notificationFilter, onError, onComplete } = {}) {
+  initialize ({ userAgent, boltAgent, authToken, notificationFilter, onError, onComplete } = {}) {
     const observer = new LoginObserver({
       onError: error => this._onLoginError(error, onError),
       onCompleted: metadata => {

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

@@ -53,7 +53,7 @@ export default class BoltProtocol extends BoltProtocolV44 {
    * @param {function(onComplte)} args.onComplete On complete callback
    * @returns {LoginObserver} The Login observer
    */
-  initialize ({ userAgent, authToken, notificationFilter, onError, onComplete } = {}) {
+  initialize ({ userAgent, boltAgent, authToken, notificationFilter, onError, onComplete } = {}) {
     const observer = new LoginObserver({
       onError: error => this._onLoginError(error, onError),
       onCompleted: metadata => this._onLoginCompleted(metadata, authToken, onComplete)

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

@@ -57,7 +57,7 @@ export default class BoltProtocol extends BoltProtocolV5x0 {
    * @param {function(onComplete)} args.onComplete On complete callback
    * @returns {LoginObserver} The Login observer
    */
-  initialize ({ userAgent, authToken, notificationFilter, onError, onComplete } = {}) {
+  initialize ({ userAgent, boltAgent, authToken, notificationFilter, onError, onComplete } = {}) {
     const state = {}
     const observer = new LoginObserver({
       onError: error => this._onLoginError(error, onError),

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

@@ -50,13 +50,14 @@ export default class BoltProtocol extends BoltProtocolV5x1 {
    *
    * @param {Object} args The params
    * @param {string} args.userAgent The user agent
+   * @param {string} args.boltAgent The bolt agent
    * @param {any} args.authToken The auth token
    * @param {NotificationFilter} args.notificationFilter The notification filters.
    * @param {function(error)} args.onError On error callback
    * @param {function(onComplete)} args.onComplete On complete callback
    * @returns {LoginObserver} The Login observer
    */
-  initialize ({ userAgent, authToken, notificationFilter, onError, onComplete } = {}) {
+  initialize ({ userAgent, boltAgent, authToken, notificationFilter, onError, onComplete } = {}) {
     const state = {}
     const observer = new LoginObserver({
       onError: error => this._onLoginError(error, onError),
@@ -67,6 +68,7 @@ export default class BoltProtocol extends BoltProtocolV5x1 {
     })
 
     this.write(
+      // if useragent is null then for all versions before 5.3 it should be bolt agent by default
       RequestMessage.hello5x2(userAgent, notificationFilter, this._serversideRouting),
       observer,
       false

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

@@ -0,0 +1,78 @@
+/**
+ * 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 BoltProtocolV5x2 from './bolt-protocol-v5x2'
+
+import transformersFactories from './bolt-protocol-v5x3.transformer'
+import Transformer from './transformer'
+import RequestMessage from './request-message'
+import { LoginObserver } from './stream-observers'
+
+import { internal } from 'neo4j-driver-core'
+
+const {
+  constants: { BOLT_PROTOCOL_V5_3 }
+} = internal
+
+export default class BoltProtocol extends BoltProtocolV5x2 {
+  get version () {
+    return BOLT_PROTOCOL_V5_3
+  }
+
+  get transformer () {
+    if (this._transformer === undefined) {
+      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} args The params
+   * @param {string} args.userAgent The user agent
+   * @param {any} args.authToken The auth token
+   * @param {NotificationFilter} args.notificationFilter The notification filters.
+   * @param {function(error)} args.onError On error callback
+   * @param {function(onComplete)} args.onComplete On complete callback
+   * @returns {LoginObserver} The Login observer
+   */
+  initialize ({ userAgent, boltAgent, authToken, notificationFilter, 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.hello5x3(userAgent, boltAgent, notificationFilter, this._serversideRouting),
+      observer,
+      false
+    )
+
+    return this.logon({
+      authToken,
+      onComplete: metadata => onComplete({ ...metadata, ...state.metadata }),
+      onError,
+      flush: true
+    })
+  }
+}

packages/bolt-connection/src/bolt/bolt-protocol-v5x3.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 v5x2 from './bolt-protocol-v5x2.transformer'
+
+export default {
+  ...v5x2
+}