GQL errors and update to bolt protocol

.gitignore

@@ -19,3 +19,4 @@ coverage
 *.code-workspace
 /testkit/CAs
 /testkit/CustomCAs
+/testkit/firefox_profile/*

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

@@ -45,6 +45,12 @@ const {
   txConfig: { TxConfig }
 } = internal
 
+const DEFAULT_DIAGNOSTIC_RECORD = Object.freeze({
+  OPERATION: '',
+  OPERATION_CODE: '0',
+  CURRENT_SCHEMA: '/'
+})
+
 export default class BoltProtocol {
   /**
    * @callback CreateResponseHandler Creates the response handler
@@ -164,6 +170,13 @@ export default class BoltProtocol {
     return metadata
   }
 
+  enrichErrorMetadata (metadata) {
+    return {
+      ...metadata,
+      diagnostic_record: metadata.diagnostic_record !== null ? { ...DEFAULT_DIAGNOSTIC_RECORD, ...metadata.diagnostic_record } : null
+    }
+  }
+
   /**
    * Perform initialization and authentication of the underlying connection.
    * @param {Object} param

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

@@ -31,7 +31,7 @@ const DEFAULT_DIAGNOSTIC_RECORD = Object.freeze({
   CURRENT_SCHEMA: '/'
 })
 
-export default class BoltProtocol extends BoltProtocolV5x5 {
+export default class BoltProtocolV5x6 extends BoltProtocolV5x5 {
   get version () {
     return BOLT_PROTOCOL_V5_6
   }

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

@@ -0,0 +1,59 @@
+/**
+ * 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 BoltProtocolV5x6 from './bolt-protocol-v5x6'
+
+import transformersFactories from './bolt-protocol-v5x5.transformer'
+import Transformer from './transformer'
+
+import { internal } from 'neo4j-driver-core'
+
+const {
+  constants: { BOLT_PROTOCOL_V5_7 }
+} = internal
+
+const DEFAULT_DIAGNOSTIC_RECORD = Object.freeze({
+  OPERATION: '',
+  OPERATION_CODE: '0',
+  CURRENT_SCHEMA: '/'
+})
+
+export default class BoltProtocol extends BoltProtocolV5x6 {
+  get version () {
+    return BOLT_PROTOCOL_V5_7
+  }
+
+  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}
+   */
+  enrichErrorMetadata (metadata) {
+    return {
+      ...metadata,
+      cause: (metadata.cause !== null && metadata.cause !== undefined) ? this.enrichErrorMetadata(metadata.cause) : null,
+      code: metadata.neo4j_code,
+      diagnostic_record: metadata.diagnostic_record !== null ? { ...DEFAULT_DIAGNOSTIC_RECORD, ...metadata.diagnostic_record } : null
+    }
+  }
+}

packages/bolt-connection/src/bolt/bolt-protocol-v5x7.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 v5x6 from './bolt-protocol-v5x6.transformer'
+
+export default {
+  ...v5x6
+}

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

@@ -31,6 +31,7 @@ import BoltProtocolV5x3 from './bolt-protocol-v5x3'
 import BoltProtocolV5x4 from './bolt-protocol-v5x4'
 import BoltProtocolV5x5 from './bolt-protocol-v5x5'
 import BoltProtocolV5x6 from './bolt-protocol-v5x6'
+import BoltProtocolV5x7 from './bolt-protocol-v5x7'
 // eslint-disable-next-line no-unused-vars
 import { Chunker, Dechunker } from '../channel'
 import ResponseHandler from './response-handler'
@@ -64,6 +65,7 @@ export default function create ({
   const createResponseHandler = protocol => {
     const responseHandler = new ResponseHandler({
       transformMetadata: protocol.transformMetadata.bind(protocol),
+      enrichErrorMetadata: protocol.enrichErrorMetadata.bind(protocol),
       log,
       observer
     })
@@ -247,6 +249,14 @@ function createProtocol (
         log,
         onProtocolError,
         serversideRouting)
+    case 5.7:
+      return new BoltProtocolV5x7(server,
+        chunker,
+        packingConfig,
+        createResponseHandler,
+        log,
+        onProtocolError,
+        serversideRouting)
     default:
       throw newError('Unknown Bolt protocol version: ' + version)
   }

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

@@ -76,7 +76,7 @@ function parseNegotiatedResponse (buffer, log) {
  */
 function newHandshakeBuffer () {
   return createHandshakeMessage([
-    [version(5, 6), version(5, 0)],
+    [version(5, 7), version(5, 0)],
     [version(4, 4), version(4, 2)],
     version(4, 1),
     version(3, 0)

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

@@ -70,10 +70,11 @@ export default class ResponseHandler {
    * @param {Logger} log The logger
    * @param {ResponseHandler~Observer} observer Object which will be notified about errors
    */
-  constructor ({ transformMetadata, log, observer } = {}) {
+  constructor ({ transformMetadata, enrichErrorMetadata, log, observer } = {}) {
     this._pendingObservers = []
     this._log = log
     this._transformMetadata = transformMetadata || NO_OP_IDENTITY
+    this._enrichErrorMetadata = enrichErrorMetadata || NO_OP_IDENTITY
     this._observer = Object.assign(
       {
         onObserversCountChange: NO_OP,
@@ -115,11 +116,7 @@ export default class ResponseHandler {
           this._log.debug(`S: FAILURE ${json.stringify(msg)}`)
         }
         try {
-          const standardizedCode = _standardizeCode(payload.code)
-          const error = newError(payload.message, standardizedCode)
-          this._currentFailure = this._observer.onErrorApplyTransformation(
-            error
-          )
+          this._currentFailure = this._handleErrorPayload(this._enrichErrorMetadata(payload))
           this._currentObserver.onError(this._currentFailure)
         } finally {
           this._updateCurrentObserver()
@@ -196,6 +193,15 @@ export default class ResponseHandler {
   _resetFailure () {
     this._currentFailure = null
   }
+
+  _handleErrorPayload (payload) {
+    const standardizedCode = _standardizeCode(payload.code)
+    const cause = payload.cause != null ? this._handleErrorPayload(payload.cause) : undefined
+    const error = newError(payload.message, standardizedCode, cause, payload.gql_status, payload.description, payload.diagnostic_record)
+    return this._observer.onErrorApplyTransformation(
+      error
+    )
+  }
 }
 
 /**

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

@@ -48,13 +48,13 @@ describe('#unit Bolt', () => {
       const writtenBuffer = channel.written[0]
 
       const boltMagicPreamble = '60 60 b0 17'
-      const protocolVersion5x6to5x0 = '00 06 06 05'
+      const protocolVersion5x7to5x0 = '00 07 07 05'
       const protocolVersion4x4to4x2 = '00 02 04 04'
       const protocolVersion4x1 = '00 00 01 04'
       const protocolVersion3 = '00 00 00 03'
 
       expect(writtenBuffer.toHex()).toEqual(
-        `${boltMagicPreamble} ${protocolVersion5x6to5x0} ${protocolVersion4x4to4x2} ${protocolVersion4x1} ${protocolVersion3}`
+        `${boltMagicPreamble} ${protocolVersion5x7to5x0} ${protocolVersion4x4to4x2} ${protocolVersion4x1} ${protocolVersion3}`
       )
     })
 

packages/bolt-connection/test/bolt/response-handler.test.js

@@ -18,6 +18,7 @@
 import ResponseHandler from '../../src/bolt/response-handler'
 import { internal, newError } from 'neo4j-driver-core'
 
+/* eslint-disable camelcase */
 const {
   logger: { Logger }
 } = internal
@@ -69,8 +70,84 @@ describe('response-handler', () => {
       expect(receivedError.message).toBe(expectedError.message)
       expect(receivedError.code).toBe(expectedError.code)
     })
+
+    it('should correctly handle errors with gql data', () => {
+      const errorPayload = {
+        message: 'older message',
+        code: 'Neo.ClientError.Test.Kaboom',
+        gql_status: '13N37',
+        description: 'I made this error up, for fun and profit!',
+        diagnostic_record: { OPERATION: '', OPERATION_CODE: '0', CURRENT_SCHEMA: '/', _classification: 'CLIENT_ERROR' }
+      }
+      const observer = {
+        capturedErrors: [],
+        onFailure: error => observer.capturedErrors.push(error)
+      }
+      const responseHandler = new ResponseHandler({ observer, log: Logger.noOp() })
+      responseHandler._queueObserver({})
+
+      const errorMessage = {
+        signature: FAILURE,
+        fields: [errorPayload]
+      }
+      responseHandler.handleResponse(errorMessage)
+
+      expect(observer.capturedErrors.length).toBe(1)
+      const [receivedError] = observer.capturedErrors
+      expect(receivedError.code).toBe(errorPayload.code)
+      expect(receivedError.message).toBe(errorPayload.message)
+      expect(receivedError.gqlStatus).toBe(errorPayload.gql_status)
+      expect(receivedError.gqlStatusDescription).toBe(errorPayload.description)
+      expect(receivedError.classification).toBe(errorPayload.diagnostic_record._classification)
+    })
+
+    it('should correctly handle errors with gql data and nested causes', () => {
+      const errorPayload = {
+        message: 'old message',
+        code: 'Neo.ClientError.Test.Error',
+        gql_status: '13N37',
+        description: 'I made this error up, for fun and profit!',
+        diagnostic_record: { OPERATION: '', OPERATION_CODE: '0', CURRENT_SCHEMA: '/', _classification: 'CLIENT_ERROR', additional_thing: 5268 },
+        cause: {
+          message: 'old cause message',
+          gql_status: '13N38',
+          description: 'I made this error up, for fun and profit and reasons!',
+          diagnostic_record: { OPERATION: '', OPERATION_CODE: '2', CURRENT_SCHEMA: '/', _classification: 'DATABASE_ERROR', additional_thing: false }
+        }
+      }
+      const observer = {
+        capturedErrors: [],
+        onFailure: error => observer.capturedErrors.push(error)
+      }
+      const responseHandler = new ResponseHandler({ observer, log: Logger.noOp() })
+      responseHandler._queueObserver({})
+
+      const errorMessage = {
+        signature: FAILURE,
+        fields: [errorPayload]
+      }
+      responseHandler.handleResponse(errorMessage)
+
+      expect(observer.capturedErrors.length).toBe(1)
+      const [receivedError] = observer.capturedErrors
+      expect(receivedError.code).toBe(errorPayload.code)
+      expect(receivedError.message).toBe(errorPayload.message)
+      expect(receivedError.gqlStatus).toBe(errorPayload.gql_status)
+      expect(receivedError.gqlStatusDescription).toBe(errorPayload.description)
+      testDiagnosticRecord(receivedError.diagnosticRecord, errorPayload.diagnostic_record)
+      testDiagnosticRecord(receivedError.cause.diagnosticRecord, errorPayload.cause.diagnostic_record)
+      expect(receivedError.classification).toBe(errorPayload.diagnostic_record._classification)
+      expect(receivedError.cause.classification).toBe(errorPayload.cause.diagnostic_record._classification)
+    })
   })
 
+  function testDiagnosticRecord (diagnostic_record, expected_diagnostic_record) {
+    expect(diagnostic_record.OPERATION).toBe(expected_diagnostic_record.OPERATION)
+    expect(diagnostic_record.CURRENT_SCHEMA).toBe(expected_diagnostic_record.CURRENT_SCHEMA)
+    expect(diagnostic_record.OPERATION_CODE).toBe(expected_diagnostic_record.OPERATION_CODE)
+    expect(diagnostic_record.additional_thing).toBe(expected_diagnostic_record.additional_thing)
+  }
+
   it('should keep track of observers and notify onObserversCountChange()', () => {
     const observer = {
       onObserversCountChange: jest.fn()

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

@@ -371,7 +371,7 @@ describe('ChannelConnection', () => {
         expect(loggerFunction).toHaveBeenCalledWith(
           'error',
           `${connection} experienced a fatal error caused by Neo4jError: some error ` +
-            '({"code":"C","name":"Neo4jError","retriable":false})'
+            '({"code":"C","gqlStatus":"50N42","gqlStatusDescription":"error: general processing exception - unexpected error. some error","classification":"UNKNOWN","name":"Neo4jError","retriable":false})'
         )
       })
     })
@@ -419,7 +419,7 @@ describe('ChannelConnection', () => {
         expect(loggerFunction).toHaveBeenCalledWith(
           'error',
           `${connection} experienced a fatal error caused by Neo4jError: current failure ` +
-            '({"code":"ongoing","name":"Neo4jError","retriable":false})'
+            '({"code":"ongoing","gqlStatus":"50N42","gqlStatusDescription":"error: general processing exception - unexpected error. current failure","classification":"UNKNOWN","name":"Neo4jError","retriable":false})'
         )
       })
     })