Database Notification Improvements

[bigmontz]

Cypher are improving the notifications that are produced by query execution by making it configurable what level of notifications can be returned and adding additional information to notifications.

Usage:

const neo4j from 'neo4j-driver'

// Configuring at the driver level
const driver = neo4j.driver(<ADDRESS>, <TOKEN>, { 
    notificationFilters: [ neo4j.notificationFilter.WARNING.ALL ]
})

// Configuring a the session level
const session = driver.session({
    database: 'neo4j',
    notificationFilters: [ 
       neo4j.notificationFilter.WARNING.ALL,
       neo4j.notificationFilter.INFORMANTION.QUERY
    ]
})

// Configuring using plain string.
const session = driver.session({
    database: 'neo4j',
    notificationFilters: [ 
       'WARNING.ALL',
       'INFORMANTION.QUERY'
    ]
})


const { summary }  = await session.executeWrite(tx => tx.run(<QUERY>, <PARAMS>))

// Reading notifications
for (const notification of summary.notifications) {
     switch(notification.severityLevel) {
          case neo4j.notificationSeverityLevel.INFORMATION: // or simply 'INFORMATION'
              console.info(`[${notification.category}] ${notification.title} - ${notification.description}`)
              break
          case neo4j.notificationSeverityLevel.WARNING: // or simply 'WARNING'
              console.warn(`[${notification.category}]${notification.title} - ${notification.description}`)
              break
          case neo4j.notificationSeverityLevel.UNKNOWN: // or simply 'UNKNOWN'
          default:
              // the raw info came from the server could be found at notification.rawSeverityLevel
              console.log(`[${notification.category}]${notification.title} - ${notification.description}`)
              break
     }
}

More details in the methods documentation and type signature.

[robsdedude]

It is not yet clear if this feature will make it into 5.3 or later.

[bigmontz]

I will hold this comment/pr until we have the functionality merged in the server and we know which version it will be part of.

[robsdedude]

👍 just make sure to not forget to update the parts of the PR that mention the version (also some doc comments).

[robsdedude]

Suggested change

	* // using default configured in the connection/driver configuration
	* // using whatever filters were configured for the {@link Driver} (default behavior)

[bigmontz]

Replaced by #1064