Fix Notification.description polyfill from GqlStatusObject (#1205)

Bolt 5.6 introduces the original notification description back in the protocol level. This avoids the `Notification.description` changes when connected to GQL aware servers. This issues was detected during homologation, so the problem won't happen with any released server since the bolt version which miss information will not be released.
neo4j · Jul 24, 2024 · 132f69b · 132f69b
1 parent 4e8867c
commit 132f69b
Show file tree

Hide file tree

Showing 22 changed files with 1,881 additions and 25 deletions.
diff --git a/packages/bolt-connection/src/bolt/bolt-protocol-v5x5.js b/packages/bolt-connection/src/bolt/bolt-protocol-v5x5.js
@@ -147,7 +147,7 @@ export default class BoltProtocol extends BoltProtocolV5x4 {
       afterComplete,
       highRecordWatermark,
       lowRecordWatermark,
-      enrichMetadata: BoltProtocol._enrichMetadata
+      enrichMetadata: this._enrichMetadata
     })
 
     const flushRun = reactive
@@ -176,10 +176,11 @@ export default class BoltProtocol extends BoltProtocolV5x4 {
    * @param {object} metadata
    * @returns {object}
    */
-  static _enrichMetadata (metadata) {
+  _enrichMetadata (metadata) {
     if (Array.isArray(metadata.statuses)) {
       metadata.statuses = metadata.statuses.map(status => ({
         ...status,
+        description: status.neo4j_code != null ? status.status_description : status.description,
         diagnostic_record: status.diagnostic_record !== null ? { ...DEFAULT_DIAGNOSTIC_RECORD, ...status.diagnostic_record } : null
       }))
     }

diff --git a/packages/bolt-connection/src/bolt/bolt-protocol-v5x5.transformer.js b/packages/bolt-connection/src/bolt/bolt-protocol-v5x5.transformer.js
@@ -15,8 +15,8 @@
  * limitations under the License.
  */
 
-import v5x3 from './bolt-protocol-v5x3.transformer'
+import v5x4 from './bolt-protocol-v5x4.transformer'
 
 export default {
-  ...v5x3
+  ...v5x4
 }
diff --git a/packages/bolt-connection/src/bolt/bolt-protocol-v5x6.js b/packages/bolt-connection/src/bolt/bolt-protocol-v5x6.js
@@ -0,0 +1,61 @@
+/**
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [https://neo4j.com]
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import BoltProtocolV5x5 from './bolt-protocol-v5x5'
+
+import transformersFactories from './bolt-protocol-v5x5.transformer'
+import Transformer from './transformer'
+
+import { internal } from 'neo4j-driver-core'
+
+const {
+  constants: { BOLT_PROTOCOL_V5_6 }
+} = internal
+
+const DEFAULT_DIAGNOSTIC_RECORD = Object.freeze({
+  OPERATION: '',
+  OPERATION_CODE: '0',
+  CURRENT_SCHEMA: '/'
+})
+
+export default class BoltProtocol extends BoltProtocolV5x5 {
+  get version () {
+    return BOLT_PROTOCOL_V5_6
+  }
+
+  get transformer () {
+    if (this._transformer === undefined) {
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
+    }
+    return this._transformer
+  }
+
+  /**
+   *
+   * @param {object} metadata
+   * @returns {object}
+   */
+  _enrichMetadata (metadata) {
+    if (Array.isArray(metadata.statuses)) {
+      metadata.statuses = metadata.statuses.map(status => ({
+        ...status,
+        diagnostic_record: status.diagnostic_record !== null ? { ...DEFAULT_DIAGNOSTIC_RECORD, ...status.diagnostic_record } : null
+      }))
+    }
+
+    return metadata
+  }
+}
diff --git a/packages/bolt-connection/src/bolt/bolt-protocol-v5x6.transformer.js b/packages/bolt-connection/src/bolt/bolt-protocol-v5x6.transformer.js
@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [https://neo4j.com]
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import v5x5 from './bolt-protocol-v5x5.transformer'
+
+export default {
+  ...v5x5
+}
diff --git a/packages/bolt-connection/src/bolt/create.js b/packages/bolt-connection/src/bolt/create.js
@@ -30,6 +30,7 @@ import BoltProtocolV5x2 from './bolt-protocol-v5x2'
 import BoltProtocolV5x3 from './bolt-protocol-v5x3'
 import BoltProtocolV5x4 from './bolt-protocol-v5x4'
 import BoltProtocolV5x5 from './bolt-protocol-v5x5'
+import BoltProtocolV5x6 from './bolt-protocol-v5x6'
 // eslint-disable-next-line no-unused-vars
 import { Chunker, Dechunker } from '../channel'
 import ResponseHandler from './response-handler'
@@ -238,6 +239,14 @@ function createProtocol (
         log,
         onProtocolError,
         serversideRouting)
+    case 5.6:
+      return new BoltProtocolV5x6(server,
+        chunker,
+        packingConfig,
+        createResponseHandler,
+        log,
+        onProtocolError,
+        serversideRouting)
     default:
       throw newError('Unknown Bolt protocol version: ' + version)
   }

diff --git a/packages/bolt-connection/src/bolt/handshake.js b/packages/bolt-connection/src/bolt/handshake.js
@@ -76,7 +76,7 @@ function parseNegotiatedResponse (buffer, log) {
  */
 function newHandshakeBuffer () {
   return createHandshakeMessage([
-    [version(5, 5), version(5, 0)],
+    [version(5, 6), version(5, 0)],
     [version(4, 4), version(4, 2)],
     version(4, 1),
     version(3, 0)

diff --git a/packages/bolt-connection/test/bolt/__snapshots__/bolt-protocol-v5x6.test.js.snap b/packages/bolt-connection/test/bolt/__snapshots__/bolt-protocol-v5x6.test.js.snap
@@ -0,0 +1,61 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`#unit BoltProtocolV5x6 .packable() should resultant function not pack graph types (Node) 1`] = `"It is not allowed to pass nodes in query parameters, given: (c:a {a:"b"})"`;
+
+exports[`#unit BoltProtocolV5x6 .packable() should resultant function not pack graph types (Path) 1`] = `"It is not allowed to pass paths in query parameters, given: [object Object]"`;
+
+exports[`#unit BoltProtocolV5x6 .packable() should resultant function not pack graph types (Relationship) 1`] = `"It is not allowed to pass relationships in query parameters, given: (e)-[:a {b:"c"}]->(f)"`;
+
+exports[`#unit BoltProtocolV5x6 .packable() should resultant function not pack graph types (UnboundRelationship) 1`] = `"It is not allowed to pass unbound relationships in query parameters, given: -[:a {b:"c"}]->"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Date with less fields) 1`] = `"Wrong struct size for Date, expected 1 but was 0"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Date with more fields) 1`] = `"Wrong struct size for Date, expected 1 but was 2"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (DateTimeWithZoneId with less fields) 1`] = `"Wrong struct size for DateTimeWithZoneId, expected 3 but was 2"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (DateTimeWithZoneId with more fields) 1`] = `"Wrong struct size for DateTimeWithZoneId, expected 3 but was 4"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (DateTimeWithZoneOffset with less fields) 1`] = `"Wrong struct size for DateTimeWithZoneOffset, expected 3 but was 2"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (DateTimeWithZoneOffset with more fields) 1`] = `"Wrong struct size for DateTimeWithZoneOffset, expected 3 but was 4"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Duration with less fields) 1`] = `"Wrong struct size for Duration, expected 4 but was 3"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Duration with more fields) 1`] = `"Wrong struct size for Duration, expected 4 but was 5"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (LocalDateTime with less fields) 1`] = `"Wrong struct size for LocalDateTime, expected 2 but was 1"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (LocalDateTime with more fields) 1`] = `"Wrong struct size for LocalDateTime, expected 2 but was 3"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (LocalTime with less fields) 1`] = `"Wrong struct size for LocalTime, expected 1 but was 0"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (LocalTime with more fields) 1`] = `"Wrong struct size for LocalTime, expected 1 but was 2"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Node with less fields) 1`] = `"Wrong struct size for Node, expected 4 but was 3"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Node with more fields) 1`] = `"Wrong struct size for Node, expected 4 but was 5"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Path with less fields) 1`] = `"Wrong struct size for Path, expected 3 but was 2"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Path with more fields) 1`] = `"Wrong struct size for Path, expected 3 but was 4"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Point with less fields) 1`] = `"Wrong struct size for Point2D, expected 3 but was 2"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Point with more fields) 1`] = `"Wrong struct size for Point2D, expected 3 but was 4"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Point3D with less fields) 1`] = `"Wrong struct size for Point3D, expected 4 but was 3"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Point3D with more fields) 1`] = `"Wrong struct size for Point3D, expected 4 but was 5"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Relationship with less fields) 1`] = `"Wrong struct size for Relationship, expected 8 but was 5"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Relationship with more fields) 1`] = `"Wrong struct size for Relationship, expected 8 but was 9"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Time with less fields) 1`] = `"Wrong struct size for Time, expected 2 but was 1"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (Time with more fileds) 1`] = `"Wrong struct size for Time, expected 2 but was 3"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (UnboundRelationship with less fields) 1`] = `"Wrong struct size for UnboundRelationship, expected 4 but was 3"`;
+
+exports[`#unit BoltProtocolV5x6 .unpack() should not unpack with wrong size (UnboundRelationship with more fields) 1`] = `"Wrong struct size for UnboundRelationship, expected 4 but was 5"`;
diff --git a/packages/bolt-connection/test/bolt/bolt-protocol-v5x5.test.js b/packages/bolt-connection/test/bolt/bolt-protocol-v5x5.test.js
@@ -1176,18 +1176,20 @@ describe('#unit BoltProtocolV5x5', () => {
         mode: WRITE
       })
 
-      expect(observer._enrichMetadata).toBe(BoltProtocolV5x5._enrichMetadata)
+      expect(observer._enrichMetadata).toBe(protocol._enrichMetadata)
     })
 
     describe('BoltProtocolV5x5._enrichMetadata', () => {
+      const protocol = newProtocol()
+
       it('should handle empty metadata', () => {
-        const metadata = BoltProtocolV5x5._enrichMetadata({})
+        const metadata = protocol._enrichMetadata({})
 
         expect(metadata).toEqual({})
       })
 
       it('should handle metadata with random objects', () => {
-        const metadata = BoltProtocolV5x5._enrichMetadata({
+        const metadata = protocol._enrichMetadata({
           a: 1133,
           b: 345
         })
@@ -1199,7 +1201,7 @@ describe('#unit BoltProtocolV5x5', () => {
       })
 
       it('should handle metadata not change notifications ', () => {
-        const metadata = BoltProtocolV5x5._enrichMetadata({
+        const metadata = protocol._enrichMetadata({
           a: 1133,
           b: 345,
           notifications: [
@@ -1466,9 +1468,35 @@ describe('#unit BoltProtocolV5x5', () => {
             _classification: undefined,
             _position: undefined
           })
+        ],
+        [
+          [{
+            gql_status: '03N33',
+            status_description: 'info: description',
+            neo4j_code: 'Neo.Info.My.Code',
+            title: 'Mitt title',
+            diagnostic_record: {
+              _classification: 'SOME',
+              _severity: 'INFORMATION'
+            }
+          }],
+          [{
+            gql_status: '03N33',
+            status_description: 'info: description',
+            description: 'info: description',
+            neo4j_code: 'Neo.Info.My.Code',
+            title: 'Mitt title',
+            diagnostic_record: {
+              OPERATION: '',
+              OPERATION_CODE: '0',
+              CURRENT_SCHEMA: '/',
+              _classification: 'SOME',
+              _severity: 'INFORMATION'
+            }
+          }]
         ]
       ])('should handle statuses (%o) ', (statuses, expectedStatuses) => {
-        const metadata = BoltProtocolV5x5._enrichMetadata({
+        const metadata = protocol._enrichMetadata({
           a: 1133,
           b: 345,
           statuses