From de3bc2f1773afdaf63c702083475c4f42e1f4f57 Mon Sep 17 00:00:00 2001
From: MaxAake <61233757+MaxAake@users.noreply.github.com>
Date: Tue, 13 Aug 2024 11:45:13 +0200
Subject: [PATCH] Add SCHEMA notification category

Adds support for the SCHEMA notification category and associated tests. The SCHEMA category is used for sending additional information about indexes and constraints.
---
 packages/core/src/notification-filter.ts                   | 5 +++--
 packages/core/src/notification.ts                          | 5 +++--
 packages/core/test/notification-filter.test.ts             | 1 +
 packages/core/test/notification.test.ts                    | 2 ++
 packages/neo4j-driver-deno/lib/core/notification-filter.ts | 5 +++--
 packages/neo4j-driver-deno/lib/core/notification.ts        | 5 +++--
 packages/neo4j-driver/test/types/index.test.ts             | 4 ++++
 7 files changed, 19 insertions(+), 8 deletions(-)

diff --git a/packages/core/src/notification-filter.ts b/packages/core/src/notification-filter.ts
index 0426ca4b4..624c5287d 100644
--- a/packages/core/src/notification-filter.ts
+++ b/packages/core/src/notification-filter.ts
@@ -40,7 +40,7 @@ Object.freeze(notificationFilterMinimumSeverityLevel)
 
 type NotificationFilterDisabledCategory = ExcludeUnknown<NotificationCategory>
 /**
- * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC'} NotificationFilterDisabledCategory
+ * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA'} NotificationFilterDisabledCategory
  */
 /**
  * Constants that represents the disabled categories in the {@link NotificationFilter}
@@ -53,7 +53,8 @@ const notificationFilterDisabledCategory: EnumRecord<NotificationFilterDisabledC
   TOPOLOGY: 'TOPOLOGY',
   SECURITY: 'SECURITY',
   DEPRECATION: 'DEPRECATION',
-  GENERIC: 'GENERIC'
+  GENERIC: 'GENERIC',
+  SCHEMA: 'SCHEMA'
 }
 Object.freeze(notificationFilterDisabledCategory)
 
diff --git a/packages/core/src/notification.ts b/packages/core/src/notification.ts
index 3f857eb85..695373cd7 100644
--- a/packages/core/src/notification.ts
+++ b/packages/core/src/notification.ts
@@ -62,9 +62,9 @@ Object.freeze(notificationSeverityLevel)
 const severityLevels = Object.values(notificationSeverityLevel)
 
 type NotificationCategory = 'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' | 'PERFORMANCE' |
-'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'UNKNOWN'
+'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA' | 'UNKNOWN'
 /**
- * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'UNKNOWN' } NotificationCategory
+ * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA' | 'UNKNOWN' } NotificationCategory
  */
 /**
  * Constants that represents the Category in the {@link Notification}
@@ -78,6 +78,7 @@ const notificationCategory: { [key in NotificationCategory]: key } = {
   TOPOLOGY: 'TOPOLOGY',
   SECURITY: 'SECURITY',
   GENERIC: 'GENERIC',
+  SCHEMA: 'SCHEMA',
   UNKNOWN: 'UNKNOWN'
 }
 
diff --git a/packages/core/test/notification-filter.test.ts b/packages/core/test/notification-filter.test.ts
index c629428ed..54cae83db 100644
--- a/packages/core/test/notification-filter.test.ts
+++ b/packages/core/test/notification-filter.test.ts
@@ -103,6 +103,7 @@ function getValidNotificationsCategories (): NotificationFilterDisabledCategory[
     'PERFORMANCE',
     'TOPOLOGY',
     'SECURITY',
+    'SCHEMA',
     'UNRECOGNIZED',
     'UNSUPPORTED'
   ]
diff --git a/packages/core/test/notification.test.ts b/packages/core/test/notification.test.ts
index f1d1ea3d4..67d5de1f1 100644
--- a/packages/core/test/notification.test.ts
+++ b/packages/core/test/notification.test.ts
@@ -1393,6 +1393,7 @@ function getValidCategories (): NotificationCategory[] {
     'TOPOLOGY',
     'SECURITY',
     'DEPRECATION',
+    'SCHEMA',
     'GENERIC',
     'UNKNOWN'
   ]
@@ -1407,6 +1408,7 @@ function getValidClassifications (): NotificationClassification[] {
     'TOPOLOGY',
     'SECURITY',
     'DEPRECATION',
+    'SCHEMA',
     'GENERIC',
     'UNKNOWN'
   ]
diff --git a/packages/neo4j-driver-deno/lib/core/notification-filter.ts b/packages/neo4j-driver-deno/lib/core/notification-filter.ts
index 1523782b4..14d812312 100644
--- a/packages/neo4j-driver-deno/lib/core/notification-filter.ts
+++ b/packages/neo4j-driver-deno/lib/core/notification-filter.ts
@@ -40,7 +40,7 @@ Object.freeze(notificationFilterMinimumSeverityLevel)
 
 type NotificationFilterDisabledCategory = ExcludeUnknown<NotificationCategory>
 /**
- * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC'} NotificationFilterDisabledCategory
+ * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA'} NotificationFilterDisabledCategory
  */
 /**
  * Constants that represents the disabled categories in the {@link NotificationFilter}
@@ -53,7 +53,8 @@ const notificationFilterDisabledCategory: EnumRecord<NotificationFilterDisabledC
   TOPOLOGY: 'TOPOLOGY',
   SECURITY: 'SECURITY',
   DEPRECATION: 'DEPRECATION',
-  GENERIC: 'GENERIC'
+  GENERIC: 'GENERIC',
+  SCHEMA: 'SCHEMA'
 }
 Object.freeze(notificationFilterDisabledCategory)
 
diff --git a/packages/neo4j-driver-deno/lib/core/notification.ts b/packages/neo4j-driver-deno/lib/core/notification.ts
index da0006e47..0e2fc02c6 100644
--- a/packages/neo4j-driver-deno/lib/core/notification.ts
+++ b/packages/neo4j-driver-deno/lib/core/notification.ts
@@ -62,9 +62,9 @@ Object.freeze(notificationSeverityLevel)
 const severityLevels = Object.values(notificationSeverityLevel)
 
 type NotificationCategory = 'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' | 'PERFORMANCE' |
-'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'UNKNOWN'
+'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA' | 'UNKNOWN'
 /**
- * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'UNKNOWN' } NotificationCategory
+ * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA' | 'UNKNOWN' } NotificationCategory
  */
 /**
  * Constants that represents the Category in the {@link Notification}
@@ -78,6 +78,7 @@ const notificationCategory: { [key in NotificationCategory]: key } = {
   TOPOLOGY: 'TOPOLOGY',
   SECURITY: 'SECURITY',
   GENERIC: 'GENERIC',
+  SCHEMA: 'SCHEMA',
   UNKNOWN: 'UNKNOWN'
 }
 
diff --git a/packages/neo4j-driver/test/types/index.test.ts b/packages/neo4j-driver/test/types/index.test.ts
index 2dcf2dd86..41a13b320 100644
--- a/packages/neo4j-driver/test/types/index.test.ts
+++ b/packages/neo4j-driver/test/types/index.test.ts
@@ -149,6 +149,7 @@ const deprecationCategoryString: string = notificationCategory.DEPRECATION
 const performanceCategoryString: string = notificationCategory.PERFORMANCE
 const topologyCategoryString: string = notificationCategory.TOPOLOGY
 const securityCategoryString: string = notificationCategory.SECURITY
+const schemaCategoryString: string = notificationCategory.SCHEMA
 const genericCategoryString: string = notificationCategory.GENERIC
 const unrecognizedCategoryString: string = notificationCategory.UNRECOGNIZED
 const unsupportedCategoryString: string = notificationCategory.UNSUPPORTED
@@ -158,6 +159,7 @@ const deprecationCategory: NotificationCategory = notificationCategory.DEPRECATI
 const performanceCategory: NotificationCategory = notificationCategory.PERFORMANCE
 const topologyCategory: NotificationCategory = notificationCategory.TOPOLOGY
 const securityCategory: NotificationCategory = notificationCategory.SECURITY
+const schemaCategory: NotificationCategory = notificationCategory.SCHEMA
 const genericCategory: NotificationCategory = notificationCategory.GENERIC
 const unrecognizedCategory: NotificationCategory = notificationCategory.UNRECOGNIZED
 const unsupportedCategory: NotificationCategory = notificationCategory.UNSUPPORTED
@@ -168,6 +170,7 @@ const deprecationClassificationString: string = notificationClassification.DEPRE
 const performanceClassificationString: string = notificationClassification.PERFORMANCE
 const topologyClassificationString: string = notificationClassification.TOPOLOGY
 const securityClassificationString: string = notificationClassification.SECURITY
+const schemaClassificationString: string = notificationClassification.SCHEMA
 const genericClassificationString: string = notificationClassification.GENERIC
 const unrecognizedClassificationString: string = notificationClassification.UNRECOGNIZED
 const unsupportedClassificationString: string = notificationClassification.UNSUPPORTED
@@ -177,6 +180,7 @@ const deprecationClassification: NotificationClassification = notificationClassi
 const performanceClassification: NotificationClassification = notificationClassification.PERFORMANCE
 const topologyClassification: NotificationClassification = notificationClassification.TOPOLOGY
 const securityClassification: NotificationClassification = notificationClassification.SECURITY
+const schemaClassification: NotificationClassification = notificationClassification.SCHEMA
 const genericClassification: NotificationClassification = notificationClassification.GENERIC
 const unrecognizedClassification: NotificationClassification = notificationClassification.UNRECOGNIZED
 const unsupportedClassification: NotificationClassification = notificationClassification.UNSUPPORTED