Database Notification Improvements

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

@@ -85,7 +85,7 @@ function assertImpersonatedUserIsEmpty (impersonatedUser, onProtocolError = () =
  * @param {any} observer
  */
 function assertNotificationFiltersIsEmpty (notificationFilters, onProtocolError = () => {}, observer) {
-  if (notificationFilters != null) {
+  if (notificationFilters !== undefined) {
     const error = newError(
       'Driver is connected to the database that does not support user notification filters. ' +
         'Please upgrade to neo4j 5.3.0 or later in order to use this functionality. ' +

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

@@ -179,7 +179,7 @@ function sanitizeNotificationFilters (filters) {
   }
 
   if (filters[0] === 'SERVER_DEFAULT') {
-    return undefined
+    return null
   }
 
   return filters.map(filter => filter.replace(/^ALL\./, '*.').replace(/\.ALL$/, '.*'))

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

@@ -136,7 +136,7 @@ export default class RequestMessage {
       extra.routing = routing
     }
 
-    if (notificationFilters) {
+    if (notificationFilters !== undefined) {
       extra.notifications = notificationFilters
     }
 
@@ -330,7 +330,7 @@ function buildTxMetadata (bookmarks, txConfig, database, mode, impersonatedUser,
   if (impersonatedUser) {
     metadata.imp_user = assertString(impersonatedUser, 'impersonatedUser')
   }
-  if (notificationFilters) {
+  if (notificationFilters !== undefined) {
     metadata.notifications = notificationFilters
   }
   if (mode === ACCESS_MODE_READ) {

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

@@ -1124,7 +1124,7 @@ describe('#unit BoltProtocolV5x1', () => {
     return [
       [['ALL.ALL', 'WARNING.ALL', 'ALL.HINT', 'INFORMATION.QUERY'], ['*.*', 'WARNING.*', '*.HINT', 'INFORMATION.QUERY']],
       [['NONE'], []],
-      [['SERVER_DEFAULT'], undefined]
+      [['SERVER_DEFAULT'], null]
     ]
   }
 })

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

@@ -448,22 +448,37 @@ describe('#unit RequestMessage', () => {
       )
     })
 
-    it('should create HELLO message without notification filters if it is not supplied or null', () => {
-      ;[null, undefined].forEach(notificationFilters => {
-        const userAgent = 'my-driver/1.0.2'
-        const authToken = { username: 'neo4j', password: 'secret' }
+    it('should create HELLO message with notification filters=null', () => {
+      const userAgent = 'my-driver/1.0.2'
+      const authToken = { username: 'neo4j', password: 'secret' }
+      const notificationFilters = null
 
-        const message = RequestMessage.hello5x1(authToken, { userAgent, notificationFilters })
+      const message = RequestMessage.hello5x1(authToken, { userAgent, notificationFilters })
 
-        expect(message.signature).toEqual(0x01)
-        expect(message.fields).toEqual([
-          { username: 'neo4j', password: 'secret' },
-          { user_agent: userAgent }
-        ])
-        expect(message.toString()).toEqual(
-          `HELLO {...} {"user_agent":"${userAgent}"}`
-        )
-      })
+      expect(message.signature).toEqual(0x01)
+      expect(message.fields).toEqual([
+        { username: 'neo4j', password: 'secret' },
+        { user_agent: userAgent, notifications: notificationFilters }
+      ])
+      expect(message.toString()).toEqual(
+        `HELLO {...} {"user_agent":"${userAgent}","notifications":null}`
+      )
+    })
+
+    it('should create HELLO message without notification filters if it is not supplied', () => {
+      const userAgent = 'my-driver/1.0.2'
+      const authToken = { username: 'neo4j', password: 'secret' }
+
+      const message = RequestMessage.hello5x1(authToken, { userAgent, notificationFilters: undefined })
+
+      expect(message.signature).toEqual(0x01)
+      expect(message.fields).toEqual([
+        { username: 'neo4j', password: 'secret' },
+        { user_agent: userAgent }
+      ])
+      expect(message.toString()).toEqual(
+        `HELLO {...} {"user_agent":"${userAgent}"}`
+      )
     })
 
     it('should create HELLO message with routing', () => {
@@ -512,21 +527,25 @@ describe('#unit RequestMessage', () => {
       })
     })
 
-    it('should create BEGIN message without notification filters if it is not supplied or null', () => {
-      ;[undefined, null].forEach(notificationFilters => {
+    it('should create BEGIN message with notification filters=null', () => {
+      ;[READ, WRITE].forEach(mode => {
         const bookmarks = new Bookmarks([
           'neo4j:bookmark:v1:tx1',
           'neo4j:bookmark:v1:tx10'
         ])
-        const mode = WRITE
+        const notificationFilters = null
         const txConfig = new TxConfig({ timeout: 42, metadata: { key: 42 } })
 
         const message = RequestMessage.begin({ bookmarks, txConfig, mode, notificationFilters })
 
         const expectedMetadata = {
           bookmarks: bookmarks.values(),
           tx_timeout: int(42),
-          tx_metadata: { key: 42 }
+          tx_metadata: { key: 42 },
+          notifications: notificationFilters
+        }
+        if (mode === READ) {
+          expectedMetadata.mode = 'r'
         }
 
         expect(message.signature).toEqual(0x11)
@@ -537,6 +556,29 @@ describe('#unit RequestMessage', () => {
       })
     })
 
+    it('should create BEGIN message without notification filters if it is not supplied', () => {
+      const bookmarks = new Bookmarks([
+        'neo4j:bookmark:v1:tx1',
+        'neo4j:bookmark:v1:tx10'
+      ])
+      const mode = WRITE
+      const txConfig = new TxConfig({ timeout: 42, metadata: { key: 42 } })
+
+      const message = RequestMessage.begin({ bookmarks, txConfig, mode, notificationFilters: undefined })
+
+      const expectedMetadata = {
+        bookmarks: bookmarks.values(),
+        tx_timeout: int(42),
+        tx_metadata: { key: 42 }
+      }
+
+      expect(message.signature).toEqual(0x11)
+      expect(message.fields).toEqual([expectedMetadata])
+      expect(message.toString()).toEqual(
+        `BEGIN ${json.stringify(expectedMetadata)}`
+      )
+    })
+
     it('should create RUN message with the notification filters', () => {
       ;[READ, WRITE].forEach(mode => {
         const query = 'RETURN $x'
@@ -579,9 +621,8 @@ describe('#unit RequestMessage', () => {
       })
     })
 
-    it('should create RUN message without notification filters if it is not supplied or null', () => {
-      ;[undefined, null].forEach(notificationFilters => {
-        const mode = WRITE
+    it('should create RUN message with the notification filters = null', () => {
+      ;[READ, WRITE].forEach(mode => {
         const query = 'RETURN $x'
         const parameters = { x: 42 }
         const bookmarks = new Bookmarks([
@@ -593,6 +634,7 @@ describe('#unit RequestMessage', () => {
           timeout: 999,
           metadata: { a: 'a', b: 'b' }
         })
+        const notificationFilters = null
 
         const message = RequestMessage.runWithMetadata(query, parameters, {
           bookmarks,
@@ -604,7 +646,11 @@ describe('#unit RequestMessage', () => {
         const expectedMetadata = {
           bookmarks: bookmarks.values(),
           tx_timeout: int(999),
-          tx_metadata: { a: 'a', b: 'b' }
+          tx_metadata: { a: 'a', b: 'b' },
+          notifications: notificationFilters
+        }
+        if (mode === READ) {
+          expectedMetadata.mode = 'r'
         }
 
         expect(message.signature).toEqual(0x10)
@@ -616,5 +662,41 @@ describe('#unit RequestMessage', () => {
         )
       })
     })
+
+    it('should create RUN message without notification filters if it is not supplied', () => {
+      const mode = WRITE
+      const query = 'RETURN $x'
+      const parameters = { x: 42 }
+      const bookmarks = new Bookmarks([
+        'neo4j:bookmark:v1:tx1',
+        'neo4j:bookmark:v1:tx10',
+        'neo4j:bookmark:v1:tx100'
+      ])
+      const txConfig = new TxConfig({
+        timeout: 999,
+        metadata: { a: 'a', b: 'b' }
+      })
+
+      const message = RequestMessage.runWithMetadata(query, parameters, {
+        bookmarks,
+        txConfig,
+        mode,
+        notificationFilters: undefined
+      })
+
+      const expectedMetadata = {
+        bookmarks: bookmarks.values(),
+        tx_timeout: int(999),
+        tx_metadata: { a: 'a', b: 'b' }
+      }
+
+      expect(message.signature).toEqual(0x10)
+      expect(message.fields).toEqual([query, parameters, expectedMetadata])
+      expect(message.toString()).toEqual(
+        `RUN ${query} ${json.stringify(parameters)} ${json.stringify(
+          expectedMetadata
+        )}`
+      )
+    })
   })
 })

packages/core/src/driver.ts

@@ -216,7 +216,9 @@ class SessionConfig {
      * // using default server configuration
      * const sessionWithSeverDefaultNotifications = driver.session({ database:'neo4j', notificationFilters: neo4j.notificationFilter.serverDefault() })
      * // EQUIVALENT TO:  const sessionWithSeverDefaultNotifications = driver.session({ database:'neo4j', notificationFilters: ["SERVER_DEFAULT"] })
-     * // OR SIMPLY:  const sessionWithSeverDefaultNotifications = driver.session({ database:'neo4j' })
+     *
+     * // using default configured in the connection/driver configuration
+     * const sessionWithSeverDefaultNotifications = driver.session({ database:'neo4j' })
      *
      * // Enable all notifications
      * const sessionWithAllNotifications = driver.session({ database:'neo4j', notificationFilters: [neo4j.notificationFilter.ALL.ALL] })

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

@@ -85,7 +85,7 @@ function assertImpersonatedUserIsEmpty (impersonatedUser, onProtocolError = () =
  * @param {any} observer
  */
 function assertNotificationFiltersIsEmpty (notificationFilters, onProtocolError = () => {}, observer) {
-  if (notificationFilters != null) {
+  if (notificationFilters !== undefined) {
     const error = newError(
       'Driver is connected to the database that does not support user notification filters. ' +
         'Please upgrade to neo4j 5.3.0 or later in order to use this functionality. ' +

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

@@ -179,7 +179,7 @@ function sanitizeNotificationFilters (filters) {
   }
 
   if (filters[0] === 'SERVER_DEFAULT') {
-    return undefined
+    return null
   }
 
   return filters.map(filter => filter.replace(/^ALL\./, '*.').replace(/\.ALL$/, '.*'))

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

@@ -136,7 +136,7 @@ export default class RequestMessage {
       extra.routing = routing
     }
 
-    if (notificationFilters) {
+    if (notificationFilters !== undefined) {
       extra.notifications = notificationFilters
     }
 
@@ -330,7 +330,7 @@ function buildTxMetadata (bookmarks, txConfig, database, mode, impersonatedUser,
   if (impersonatedUser) {
     metadata.imp_user = assertString(impersonatedUser, 'impersonatedUser')
   }
-  if (notificationFilters) {
+  if (notificationFilters !== undefined) {
     metadata.notifications = notificationFilters
   }
   if (mode === ACCESS_MODE_READ) {

packages/neo4j-driver-deno/lib/core/driver.ts

@@ -216,7 +216,9 @@ class SessionConfig {
      * // using default server configuration
      * const sessionWithSeverDefaultNotifications = driver.session({ database:'neo4j', notificationFilters: neo4j.notificationFilter.serverDefault() })
      * // EQUIVALENT TO:  const sessionWithSeverDefaultNotifications = driver.session({ database:'neo4j', notificationFilters: ["SERVER_DEFAULT"] })
-     * // OR SIMPLY:  const sessionWithSeverDefaultNotifications = driver.session({ database:'neo4j' })
+     *
+     * // using default configured in the connection/driver configuration
+     * const sessionWithSeverDefaultNotifications = driver.session({ database:'neo4j' })
      *
      * // Enable all notifications
      * const sessionWithAllNotifications = driver.session({ database:'neo4j', notificationFilters: [neo4j.notificationFilter.ALL.ALL] })