Add notification filters to Connection.initialize

Author: bigmontz

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

@@ -24,7 +24,7 @@ import { error, ConnectionProvider, ServerInfo } from 'neo4j-driver-core'
 const { SERVICE_UNAVAILABLE } = error
 export default class PooledConnectionProvider extends ConnectionProvider {
   constructor (
-    { id, config, log, userAgent, authToken },
+    { id, config, log, userAgent, authToken, notificationFilters },
     createChannelConnectionHook = null
   ) {
     super()
@@ -34,6 +34,7 @@ export default class PooledConnectionProvider extends ConnectionProvider {
     this._log = log
     this._userAgent = userAgent
     this._authToken = authToken
+    this._notificationFilters = notificationFilters
     this._createChannelConnection =
       createChannelConnectionHook ||
       (address => {
@@ -76,7 +77,7 @@ export default class PooledConnectionProvider extends ConnectionProvider {
       }
       this._openConnections[connection.id] = connection
       return connection
-        .connect(this._userAgent, this._authToken)
+        .connect(this._userAgent, this._authToken, this._notificationFilters)
         .catch(error => {
           // let's destroy this connection
           this._destroyConnection(connection)

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

@@ -169,24 +169,27 @@ export default class ChannelConnection extends Connection {
    * Send initialization message.
    * @param {string} userAgent the user agent for this driver.
    * @param {Object} authToken the object containing auth information.
+   * @param {?string[]} notificationFilters the notification filters.
    * @return {Promise<Connection>} promise resolved with the current connection if connection is successful. Rejected promise otherwise.
    */
-  connect (userAgent, authToken) {
-    return this._initialize(userAgent, authToken)
+  connect (userAgent, authToken, notificationFilters) {
+    return this._initialize(userAgent, authToken, notificationFilters)
   }
 
   /**
    * Perform protocol-specific initialization which includes authentication.
    * @param {string} userAgent the user agent for this driver.
    * @param {Object} authToken the object containing auth information.
+   * @param {?string[]} notificationFilters the notification filters.
    * @return {Promise<Connection>} promise resolved with the current connection if initialization is successful. Rejected promise otherwise.
    */
-  _initialize (userAgent, authToken) {
+  _initialize (userAgent, authToken, notificationFilters) {
     const self = this
     return new Promise((resolve, reject) => {
       this._protocol.initialize({
         userAgent,
         authToken,
+        notificationFilters,
         onError: err => reject(err),
         onComplete: metadata => {
           if (metadata) {
@@ -340,13 +343,14 @@ export default class ChannelConnection extends Connection {
     })
   }
 
-  _reset(observer) {
+  _reset (observer) {
     if (this._reseting) {
       if (!this._protocol.isLastMessageReset()) {
         this._protocol.reset({
           onError: error => {
             observer.onError(error)
-          }, onComplete: () => {
+          },
+          onComplete: () => {
             observer.onComplete()
           }
         })
@@ -369,7 +373,8 @@ export default class ChannelConnection extends Connection {
     this._protocol.reset({
       onError: error => {
         notifyFinish(obs => obs.onError(error))
-      }, onComplete: () => {
+      },
+      onComplete: () => {
         notifyFinish(obs => obs.onComplete())
       }
     })

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

@@ -71,8 +71,8 @@ export default class DelegateConnection extends Connection {
     return this._delegate.protocol()
   }
 
-  connect (userAgent, authToken) {
-    return this._delegate.connect(userAgent, authToken)
+  connect (userAgent, authToken, notificationFilters) {
+    return this._delegate.connect(userAgent, authToken, notificationFilters)
   }
 
   write (message, observer, flush) {

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

@@ -79,9 +79,10 @@ 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 {Object} authToken the object containing auth information.
+   * @param {?string[]} notificationFilters the notification filters.
    * @return {Promise<Connection>} promise resolved with the current connection if connection is successful. Rejected promise otherwise.
    */
-  connect (userAgent, authToken) {
+  connect (userAgent, authToken, notificationFilters) {
     throw new Error('not implemented')
   }
 

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

@@ -124,6 +124,27 @@ describe('ChannelConnection', () => {
         )
       }
     )
+
+    it.each([
+      undefined,
+      null,
+      [],
+      ['*.*', 'WARNING.*']
+    ])('should call protocol.initialize with notification filters when notificationFilters is %o',
+      async (notificationFilters) => {
+        const protocol = {
+          initialize: jest.fn(observer => observer.onComplete({}))
+        }
+        const protocolSupplier = () => protocol
+        const connection = spyOnConnectionChannel({ protocolSupplier })
+
+        await connection.connect('userAgent', {}, notificationFilters)
+
+        expect(protocol.initialize).toHaveBeenCalledTimes(1)
+        expect(protocol.initialize).toBeCalledWith(expect.objectContaining({
+          notificationFilters
+        }))
+      })
   })
 
   describe('._handleFatalError()', () => {

packages/neo4j-driver-deno/lib/bolt-connection/connection-provider/connection-provider-pooled.js

@@ -24,7 +24,7 @@ import { error, ConnectionProvider, ServerInfo } from '../../core/index.ts'
 const { SERVICE_UNAVAILABLE } = error
 export default class PooledConnectionProvider extends ConnectionProvider {
   constructor (
-    { id, config, log, userAgent, authToken },
+    { id, config, log, userAgent, authToken, notificationFilters },
     createChannelConnectionHook = null
   ) {
     super()
@@ -34,6 +34,7 @@ export default class PooledConnectionProvider extends ConnectionProvider {
     this._log = log
     this._userAgent = userAgent
     this._authToken = authToken
+    this._notificationFilters = notificationFilters
     this._createChannelConnection =
       createChannelConnectionHook ||
       (address => {
@@ -76,7 +77,7 @@ export default class PooledConnectionProvider extends ConnectionProvider {
       }
       this._openConnections[connection.id] = connection
       return connection
-        .connect(this._userAgent, this._authToken)
+        .connect(this._userAgent, this._authToken, this._notificationFilters)
         .catch(error => {
           // let's destroy this connection
           this._destroyConnection(connection)

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

@@ -169,24 +169,27 @@ export default class ChannelConnection extends Connection {
    * Send initialization message.
    * @param {string} userAgent the user agent for this driver.
    * @param {Object} authToken the object containing auth information.
+   * @param {?string[]} notificationFilters the notification filters.
    * @return {Promise<Connection>} promise resolved with the current connection if connection is successful. Rejected promise otherwise.
    */
-  connect (userAgent, authToken) {
-    return this._initialize(userAgent, authToken)
+  connect (userAgent, authToken, notificationFilters) {
+    return this._initialize(userAgent, authToken, notificationFilters)
   }
 
   /**
    * Perform protocol-specific initialization which includes authentication.
    * @param {string} userAgent the user agent for this driver.
    * @param {Object} authToken the object containing auth information.
+   * @param {?string[]} notificationFilters the notification filters.
    * @return {Promise<Connection>} promise resolved with the current connection if initialization is successful. Rejected promise otherwise.
    */
-  _initialize (userAgent, authToken) {
+  _initialize (userAgent, authToken, notificationFilters) {
     const self = this
     return new Promise((resolve, reject) => {
       this._protocol.initialize({
         userAgent,
         authToken,
+        notificationFilters,
         onError: err => reject(err),
         onComplete: metadata => {
           if (metadata) {
@@ -340,13 +343,14 @@ export default class ChannelConnection extends Connection {
     })
   }
 
-  _reset(observer) {
+  _reset (observer) {
     if (this._reseting) {
       if (!this._protocol.isLastMessageReset()) {
         this._protocol.reset({
           onError: error => {
             observer.onError(error)
-          }, onComplete: () => {
+          },
+          onComplete: () => {
             observer.onComplete()
           }
         })
@@ -369,7 +373,8 @@ export default class ChannelConnection extends Connection {
     this._protocol.reset({
       onError: error => {
         notifyFinish(obs => obs.onError(error))
-      }, onComplete: () => {
+      },
+      onComplete: () => {
         notifyFinish(obs => obs.onComplete())
       }
     })

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

@@ -71,8 +71,8 @@ export default class DelegateConnection extends Connection {
     return this._delegate.protocol()
   }
 
-  connect (userAgent, authToken) {
-    return this._delegate.connect(userAgent, authToken)
+  connect (userAgent, authToken, notificationFilters) {
+    return this._delegate.connect(userAgent, authToken, notificationFilters)
   }
 
   write (message, observer, flush) {

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

@@ -79,9 +79,10 @@ 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 {Object} authToken the object containing auth information.
+   * @param {?string[]} notificationFilters the notification filters.
    * @return {Promise<Connection>} promise resolved with the current connection if connection is successful. Rejected promise otherwise.
    */
-  connect (userAgent, authToken) {
+  connect (userAgent, authToken, notificationFilters) {
     throw new Error('not implemented')
   }