Make bolt agent an object in intergration tests

Author: ConorNeo

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

@@ -183,7 +183,7 @@ export default class ChannelConnection extends Connection {
   /**
    * Send initialization message.
    * @param {string} userAgent the user agent for this driver.
-   * @param {string} boltAgent the bolt agent for this driver.
+   * @param {Object} boltAgent the bolt agent for this driver.
    * @param {Object} authToken the object containing auth information.
    * @param {boolean} waitReAuth whether ot not the connection will wait for re-authentication to happen
    * @return {Promise<Connection>} promise resolved with the current connection if connection is successful. Rejected promise otherwise.

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

@@ -90,7 +90,7 @@ export default class Connection {
   /**
    * Connect to the target address, negotiate Bolt protocol and send initialization message.
    * @param {string} userAgent the user agent for this driver.
-   * @param {string} boltAgent the bolt agent for this driver.
+   * @param {Object} boltAgent the bolt agent for this driver.
    * @param {Object} authToken the object containing auth information.
    * @param {boolean} shouldWaitReAuth whether ot not the connection will wait for re-authentication to happen
    * @return {Promise<Connection>} promise resolved with the current connection if connection is successful. Rejected promise otherwise.

packages/neo4j-driver/test/internal/connection-channel.test.js

@@ -47,6 +47,13 @@ const SUCCESS_MESSAGE = { signature: 0x70, fields: [{}] }
 const FAILURE_MESSAGE = { signature: 0x7f, fields: [newError('Hello')] }
 const RECORD_MESSAGE = { signature: 0x71, fields: [{ value: 'Hello' }] }
 
+const BOLT_AGENT = {
+  product: 'js-driver',
+  platform: 'SomePlatform',
+  language: 'js',
+  languageDetails: 'Some node or deno details'
+}
+
 describe('#integration ChannelConnection', () => {
   /** @type {Connection} */
   let connection
@@ -104,7 +111,7 @@ describe('#integration ChannelConnection', () => {
     }
 
     connection
-      .connect('mydriver/0.0.0', 'mydriver/0.0.0 some system info', basicAuthToken())
+      .connect('mydriver/0.0.0', BOLT_AGENT, basicAuthToken())
       .then(() => {
         connection
           .protocol()
@@ -177,7 +184,7 @@ describe('#integration ChannelConnection', () => {
     connection = await createConnection(`bolt://${sharedNeo4j.hostname}`)
 
     connection
-      .connect('mydriver/0.0.0', 'mydriver/0.0.0 some system info', basicAuthToken())
+      .connect('mydriver/0.0.0', BOLT_AGENT, basicAuthToken())
       .then(initializedConnection => {
         expect(initializedConnection).toBe(connection)
         done()
@@ -189,7 +196,7 @@ describe('#integration ChannelConnection', () => {
     connection = await createConnection(`bolt://${sharedNeo4j.hostname}`) // wrong port
 
     connection
-      .connect('mydriver/0.0.0', 'mydriver/0.0.0 some system info', basicWrongAuthToken())
+      .connect('mydriver/0.0.0', BOLT_AGENT, basicWrongAuthToken())
       .then(() => done.fail('Should not initialize'))
       .catch(error => {
         expect(error).toBeDefined()
@@ -200,7 +207,7 @@ describe('#integration ChannelConnection', () => {
   it('should have server version after connection initialization completed', async done => {
     connection = await createConnection(`bolt://${sharedNeo4j.hostname}`)
     connection
-      .connect('mydriver/0.0.0', 'mydriver/0.0.0 some system info', basicAuthToken())
+      .connect('mydriver/0.0.0', BOLT_AGENT, basicAuthToken())
       .then(initializedConnection => {
         expect(initializedConnection).toBe(connection)
         const serverVersion = ServerVersion.fromString(connection.version)
@@ -214,7 +221,7 @@ describe('#integration ChannelConnection', () => {
     connection = await createConnection(`bolt://${sharedNeo4j.hostname}`)
 
     connection
-      .connect('mydriver/0.0.0', 'mydriver/0.0.0 some system info', basicWrongAuthToken())
+      .connect('mydriver/0.0.0', BOLT_AGENT, basicWrongAuthToken())
       .then(() => done.fail('Should not connect'))
       .catch(initialError => {
         expect(initialError).toBeDefined()
@@ -274,7 +281,7 @@ describe('#integration ChannelConnection', () => {
     connection = await createConnection(`bolt://${sharedNeo4j.hostname}`)
 
     connection
-      .connect('my-driver/1.2.3', 'mydriver/0.0.0 some system info', basicAuthToken())
+      .connect('my-driver/1.2.3', BOLT_AGENT, basicAuthToken())
       .then(() => {
         connection
           .resetAndFlush()
@@ -297,7 +304,7 @@ describe('#integration ChannelConnection', () => {
   it('should fail to reset and flush when FAILURE received', async done => {
     createConnection(`bolt://${sharedNeo4j.hostname}`)
       .then(connection => {
-        connection.connect('my-driver/1.2.3', 'mydriver/0.0.0 some system info', basicAuthToken()).then(() => {
+        connection.connect('my-driver/1.2.3', BOLT_AGENT, basicAuthToken()).then(() => {
           connection
             .resetAndFlush()
             .then(() => done.fail('Should fail'))
@@ -325,7 +332,7 @@ describe('#integration ChannelConnection', () => {
     connection = await createConnection(`bolt://${sharedNeo4j.hostname}`)
 
     connection
-      .connect('my-driver/1.2.3', 'mydriver/0.0.0 some system info', basicAuthToken())
+      .connect('my-driver/1.2.3', BOLT_AGENT, basicAuthToken())
       .then(() => {
         connection
           .resetAndFlush()
@@ -353,7 +360,7 @@ describe('#integration ChannelConnection', () => {
     createConnection(`bolt://${sharedNeo4j.hostname}`)
       .then(connection => {
         connection
-          .connect('my-driver/1.2.3', 'mydriver/0.0.0 some system info', basicAuthToken())
+          .connect('my-driver/1.2.3', BOLT_AGENT, basicAuthToken())
           .then(() => {
             connection.protocol()._responseHandler._currentFailure = newError(
               'Hello'
@@ -419,7 +426,7 @@ describe('#integration ChannelConnection', () => {
     connection = await createConnection(`bolt://${sharedNeo4j.hostname}`)
     recordWrittenMessages(connection._protocol, messages)
 
-    await connection.connect('mydriver/0.0.0', 'mydriver/0.0.0 some system info', basicAuthToken())
+    await connection.connect('mydriver/0.0.0', BOLT_AGENT, basicAuthToken())
 
     expect(connection.isOpen()).toBeTruthy()
     await connection.close()
@@ -436,7 +443,7 @@ describe('#integration ChannelConnection', () => {
   it('should not prepare broken connection to close', async () => {
     connection = await createConnection(`bolt://${sharedNeo4j.hostname}`)
 
-    await connection.connect('my-connection/9.9.9', 'mydriver/0.0.0 some system info', basicAuthToken())
+    await connection.connect('my-connection/9.9.9', BOLT_AGENT, basicAuthToken())
     expect(connection._protocol).toBeDefined()
     expect(connection._protocol).not.toBeNull()