Custom user agent

Author: Peter Wilhelmsson

src/index.js

@@ -173,6 +173,9 @@ import ServerAddress from './internal/server-address'
  *       resolver: function(address) {
  *         return ['127.0.0.1:8888', 'fallback.db.com:7687'];
  *       },
+ *
+ *      // Optionally override the default user agent name.
+ *       userAgent: USER_AGENT
  *     }
  *
  * @param {string} url The URL for the Neo4j database, for instance "neo4j://localhost" and/or "bolt://localhost"
@@ -232,11 +235,14 @@ function driver (url, authToken, config = {}) {
   authToken = authToken || {}
   authToken.scheme = authToken.scheme || 'none'
 
+  // Use default user agent or user agent specified by user.
+  config.userAgent = config.userAgent || USER_AGENT
+
   if (routing) {
     return new RoutingDriver(
       ServerAddress.fromUrl(parsedUrl.hostAndPort),
       parsedUrl.query,
-      USER_AGENT,
+      config.userAgent,
       authToken,
       config
     )
@@ -248,7 +254,7 @@ function driver (url, authToken, config = {}) {
     }
     return new Driver(
       ServerAddress.fromUrl(parsedUrl.hostAndPort),
-      USER_AGENT,
+      config.userAgent,
       authToken,
       config
     )

test/internal/node/direct.driver.boltkit.test.js

@@ -65,6 +65,23 @@ describe('#stub-direct direct driver with stub server', () => {
     it('v4', () => verifyShouldRunQuery('v4'))
   })
 
+  it('should use custom user agent', async () => {
+    if (!boltStub.supported) {
+      return
+    }
+    const server = await boltStub.start(
+      './test/resources/boltstub/v4/hello_custom_user_agent.script',
+      9001
+    )
+    const driver = boltStub.newDriver('bolt://127.0.0.1:9001', {
+      userAgent: 'custom user agent'
+    })
+    const session = driver.session()
+    await session.run('MATCH (n) RETURN n.name')
+    await driver.close()
+    await server.exit()
+  })
+
   describe('should not send any routing with hello to disable server routing', () => {
     async function verify (version) {
       if (!boltStub.supported) {

test/internal/node/routing.driver.boltkit.test.js

@@ -38,6 +38,23 @@ describe('#stub-routing routing driver with stub server', () => {
     jasmine.DEFAULT_TIMEOUT_INTERVAL = originalTimeout
   })
 
+  it('should use custom user agent', async () => {
+    if (!boltStub.supported) {
+      return
+    }
+    const server = await boltStub.start(
+      './test/resources/boltstub/v4/hello_custom_user_agent.script',
+      9001
+    )
+    const driver = boltStub.newDriver('bolt://127.0.0.1:9001', {
+      userAgent: 'custom user agent'
+    })
+    const session = driver.session()
+    await session.run('MATCH (n) RETURN n.name')
+    await driver.close()
+    await server.exit()
+  })
+
   it('should discover servers', async () => {
     if (!boltStub.supported) {
       return

test/resources/boltstub/v4/hello_custom_user_agent.script

@@ -0,0 +1,10 @@
+!: BOLT 4
+!: AUTO RESET
+
+C: HELLO {"credentials": "password", "scheme": "basic", "user_agent": "custom user agent", "principal": "neo4j"}
+S: SUCCESS {"server": "Neo4j/9.9.9", "connection_id": "bolt-123456789"}
+C: RUN "MATCH (n) RETURN n.name" {} {}
+   PULL {"n": 1000}
+S: SUCCESS {"fields": ["n.name"]}
+   SUCCESS {}
+S: <EXIT>