Fix useragent string on metadata object in 5.3

Author: ConorNeo

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

@@ -200,7 +200,11 @@ export default class RequestMessage {
    * @return {RequestMessage} new HELLO message.
    */
   static hello5x3 (userAgent, boltAgent, notificationFilter = null, routing = null) {
-    const metadata = { user_agent: userAgent, bolt_agent: boltAgent }
+    const metadata = { bolt_agent: boltAgent }
+
+    if (userAgent) {
+      metadata.user_agent = userAgent
+    }
 
     if (notificationFilter) {
       if (notificationFilter.minimumSeverityLevel) {

packages/core/src/internal/bolt-agent/browser/BoltAgent.ts renamed to packages/core/src/internal/bolt-agent/browser/bolt-agent.ts

@@ -17,4 +17,4 @@
  * limitations under the License.
  */
 
-export * from './BoltAgent'
+export * from './bolt-agent'

packages/core/src/internal/bolt-agent/browser/index.ts

@@ -17,4 +17,4 @@
  * limitations under the License.
  */
 
-export * from './BoltAgent'
+export * from './bolt-agent'

packages/core/src/internal/bolt-agent/deno/BoltAgent.ts renamed to packages/core/src/internal/bolt-agent/deno/bolt-agent.ts

@@ -17,4 +17,4 @@
  * limitations under the License.
  */
 
-export * from './node/index'
+export * from './node'

packages/core/src/internal/bolt-agent/deno/index.ts

@@ -17,4 +17,4 @@
  * limitations under the License.
  */
 
-export * from './BoltAgent'
+export * from './bolt-agent'

packages/core/src/internal/bolt-agent/index.ts

@@ -129,13 +129,25 @@ async function copyAndTransform(inDir: string, outDir: string) {
         }
       }
 
-      // Special fix for bolt-connection/channel/index.js and core/bolt-agent/index.js
-      // Replace the "node channel" with the "deno channel", since Deno supports different APIs
+      // Special fix for core/internal/bolt-agent/index.js
       // Replace the "node boltAgent" with the "deno boltAgent", since Deno supports different APIs
-      if (inPath.endsWith("channel/index.js") || inPath.endsWith("bolt-agent/index.ts")) {
+      if(inPath.endsWith("bolt-agent/index.ts")){
+        console.log(inPath)
+        console.log(contents)
+        contents = contents.replace(
+            `export * from './node/index.ts'`,
+            `export * from './deno/index.ts'`,
+        );
+      }
+
+      // Special fix for bolt-connection/channel/index.js and core/internal/bolt-agent/index.js
+      // Replace the "node channel" with the "deno channel", since Deno supports different APIs
+      if (inPath.endsWith("channel/index.js")) {
+        console.log(inPath)
+        console.log(contents)
         contents = contents.replace(
-          `export * from './node/index'`,
-          `export * from './deno/index'`,
+          `export * from './node/index.js'`,
+          `export * from './deno/index.js'`,
         );
       }
     }

packages/core/src/internal/bolt-agent/node/BoltAgent.ts renamed to packages/core/src/internal/bolt-agent/node/bolt-agent.ts

@@ -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)
@@ -184,7 +184,7 @@ export default class BoltProtocol {
     // passing notification filter on this protocol version throws an error
     assertNotificationFilterIsEmpty(notificationFilter, this._onProtocolError, observer)
 
-    this.write(RequestMessage.init(userAgent, authToken), observer, true)
+    this.write(RequestMessage.init(userAgent === '' || userAgent == null ? boltAgent : userAgent, authToken), observer, true)
 
     return observer
   }

packages/core/src/internal/bolt-agent/node/index.ts

@@ -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)
@@ -78,7 +78,7 @@ export default class BoltProtocol extends BoltProtocolV2 {
     // passing notification filter on this protocol version throws an error
     assertNotificationFilterIsEmpty(notificationFilter, this._onProtocolError, observer)
 
-    this.write(RequestMessage.hello(userAgent, authToken), observer, true)
+    this.write(RequestMessage.hello(userAgent === '' || userAgent == null ? boltAgent : userAgent, authToken), observer, true)
 
     return observer
   }

packages/neo4j-driver-deno/generate.ts

@@ -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)
@@ -83,7 +83,7 @@ export default class BoltProtocol extends BoltProtocolV4 {
     assertNotificationFilterIsEmpty(notificationFilter, this._onProtocolError, observer)
 
     this.write(
-      RequestMessage.hello(userAgent, authToken, this._serversideRouting),
+      RequestMessage.hello(userAgent === '' || userAgent == null ? boltAgent : userAgent, authToken, this._serversideRouting),
       observer,
       true
     )

packages/neo4j-driver-deno/lib/bolt-connection/bolt/bolt-protocol-v1.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 => {
@@ -104,7 +104,7 @@ export default class BoltProtocol extends BoltProtocolV42 {
     assertNotificationFilterIsEmpty(notificationFilter, this._onProtocolError, observer)
 
     this.write(
-      RequestMessage.hello(userAgent, authToken, this._serversideRouting, ['utc']),
+      RequestMessage.hello(userAgent === '' || userAgent == null ? boltAgent : userAgent, authToken, this._serversideRouting, ['utc']),
       observer,
       true
     )

packages/neo4j-driver-deno/lib/bolt-connection/bolt/bolt-protocol-v3.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)
@@ -63,7 +63,7 @@ export default class BoltProtocol extends BoltProtocolV44 {
     assertNotificationFilterIsEmpty(notificationFilter, this._onProtocolError, observer)
 
     this.write(
-      RequestMessage.hello(userAgent, authToken, this._serversideRouting),
+      RequestMessage.hello(userAgent === '' || userAgent == null ? boltAgent : userAgent, authToken, this._serversideRouting),
       observer,
       true
     )

packages/neo4j-driver-deno/lib/bolt-connection/bolt/bolt-protocol-v4x1.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),
@@ -71,7 +71,7 @@ export default class BoltProtocol extends BoltProtocolV5x0 {
     assertNotificationFilterIsEmpty(notificationFilter, this._onProtocolError, observer)
 
     this.write(
-      RequestMessage.hello5x1(userAgent, this._serversideRouting),
+      RequestMessage.hello5x1(userAgent === '' || userAgent == null ? boltAgent : userAgent, this._serversideRouting),
       observer,
       false
     )

packages/neo4j-driver-deno/lib/bolt-connection/bolt/bolt-protocol-v4x3.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,7 +68,8 @@ export default class BoltProtocol extends BoltProtocolV5x1 {
     })
 
     this.write(
-      RequestMessage.hello5x2(userAgent, notificationFilter, this._serversideRouting),
+      // if useragent is null then for all versions before 5.3 it should be bolt agent by default
+      RequestMessage.hello5x2(userAgent === '' || userAgent == null ? boltAgent : userAgent, notificationFilter, this._serversideRouting),
       observer,
       false
     )

packages/neo4j-driver-deno/lib/bolt-connection/bolt/bolt-protocol-v5x0.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.js'
+
+import transformersFactories from './bolt-protocol-v5x3.transformer.js'
+import Transformer from './transformer.js'
+import RequestMessage from './request-message.js'
+import { LoginObserver } from './stream-observers.js'
+
+import { internal } from '../../core/index.ts'
+
+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/neo4j-driver-deno/lib/bolt-connection/bolt/bolt-protocol-v5x1.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.js'
+
+export default {
+  ...v5x2
+}

packages/neo4j-driver-deno/lib/bolt-connection/bolt/bolt-protocol-v5x2.js

@@ -29,6 +29,7 @@ import BoltProtocolV4x4 from './bolt-protocol-v4x4.js'
 import BoltProtocolV5x0 from './bolt-protocol-v5x0.js'
 import BoltProtocolV5x1 from './bolt-protocol-v5x1.js'
 import BoltProtocolV5x2 from './bolt-protocol-v5x2.js'
+import BoltProtocolV5x3 from './bolt-protocol-v5x3.js'
 // eslint-disable-next-line no-unused-vars
 import { Chunker, Dechunker } from '../channel/index.js'
 import ResponseHandler from './response-handler.js'
@@ -213,6 +214,14 @@ function createProtocol (
         onProtocolError,
         serversideRouting
       )
+    case 5.3:
+      return new BoltProtocolV5x3(server,
+        chunker,
+        packingConfig,
+        createResponseHandler,
+        log,
+        onProtocolError,
+        serversideRouting)
     default:
       throw newError('Unknown Bolt protocol version: ' + version)
   }

packages/neo4j-driver-deno/lib/bolt-connection/bolt/bolt-protocol-v5x3.js

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

packages/neo4j-driver-deno/lib/bolt-connection/bolt/bolt-protocol-v5x3.transformer.js

@@ -191,6 +191,42 @@ export default class RequestMessage {
     )
   }
 
+  /**
+   * Create a new HELLO message.
+   * @param {string} userAgent the user agent.
+   * @param {string} boltAgent the bolt agent.
+   * @param {NotificationFilter} notificationFilter the notification filter configured
+   * @param {Object} routing server side routing, set to routing context to turn on server side routing (> 4.1)
+   * @return {RequestMessage} new HELLO message.
+   */
+  static hello5x3 (userAgent, boltAgent, notificationFilter = null, routing = null) {
+    const metadata = { bolt_agent: boltAgent }
+
+    if (userAgent) {
+      metadata.user_agent = userAgent
+    }
+
+    if (notificationFilter) {
+      if (notificationFilter.minimumSeverityLevel) {
+        metadata.notifications_minimum_severity = notificationFilter.minimumSeverityLevel
+      }
+
+      if (notificationFilter.disabledCategories) {
+        metadata.notifications_disabled_categories = notificationFilter.disabledCategories
+      }
+    }
+
+    if (routing) {
+      metadata.routing = routing
+    }
+
+    return new RequestMessage(
+      HELLO,
+      [metadata],
+      () => `HELLO ${json.stringify(metadata)}`
+    )
+  }
+
   /**
    * Create a new LOGON message.
    *

packages/neo4j-driver-deno/lib/bolt-connection/bolt/create.js

@@ -32,8 +32,8 @@ const {
 const { SERVICE_UNAVAILABLE } = error
 
 export default class DirectConnectionProvider extends PooledConnectionProvider {
-  constructor ({ id, config, log, address, userAgent, authToken }) {
-    super({ id, config, log, userAgent, authToken })
+  constructor ({ id, config, log, address, userAgent, boltAgent, authToken }) {
+    super({ id, config, log, userAgent, boltAgent, authToken })
 
     this._address = address
   }