Introduce GqlStatusObject support as notifications to ResultSummary

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

@@ -0,0 +1,189 @@
+/**
+ * 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 BoltProtocolV5x4 from './bolt-protocol-v5x4'
+
+import transformersFactories from './bolt-protocol-v5x5.transformer'
+import Transformer from './transformer'
+import RequestMessage from './request-message'
+import { LoginObserver, ResultStreamObserver } from './stream-observers'
+
+import { internal } from 'neo4j-driver-core'
+
+const {
+  constants: { BOLT_PROTOCOL_V5_5, FETCH_ALL }
+} = internal
+
+const DEFAULT_DIAGNOSTIC_RECORD = Object.freeze({
+  OPERATION: '',
+  OPERATION_CODE: '0',
+  CURRENT_SCHEMA: '/'
+})
+
+export default class BoltProtocol extends BoltProtocolV5x4 {
+  get version () {
+    return BOLT_PROTOCOL_V5_5
+  }
+
+  get transformer () {
+    if (this._transformer === undefined) {
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
+    }
+    return this._transformer
+  }
+
+  /**
+   * Initialize a connection with the server
+   *
+   * @param {Object} args The params
+   * @param {string} args.userAgent The user agent
+   * @param {any} args.authToken The auth token
+   * @param {NotificationFilter} args.notificationFilter The notification filters.
+   * @param {function(error)} args.onError On error callback
+   * @param {function(onComplete)} args.onComplete On complete callback
+   * @returns {LoginObserver} The Login observer
+   */
+  initialize ({ userAgent, boltAgent, authToken, notificationFilter, onError, onComplete } = {}) {
+    const state = {}
+    const observer = new LoginObserver({
+      onError: error => this._onLoginError(error, onError),
+      onCompleted: metadata => {
+        state.metadata = metadata
+        return this._onLoginCompleted(metadata)
+      }
+    })
+
+    this.write(
+      RequestMessage.hello5x5(userAgent, boltAgent, notificationFilter, this._serversideRouting),
+      observer,
+      false
+    )
+
+    return this.logon({
+      authToken,
+      onComplete: metadata => onComplete({ ...metadata, ...state.metadata }),
+      onError,
+      flush: true
+    })
+  }
+
+  beginTransaction ({
+    bookmarks,
+    txConfig,
+    database,
+    mode,
+    impersonatedUser,
+    notificationFilter,
+    beforeError,
+    afterError,
+    beforeComplete,
+    afterComplete
+  } = {}) {
+    const observer = new ResultStreamObserver({
+      server: this._server,
+      beforeError,
+      afterError,
+      beforeComplete,
+      afterComplete
+    })
+    observer.prepareToHandleSingleResponse()
+
+    this.write(
+      RequestMessage.begin5x5({ bookmarks, txConfig, database, mode, impersonatedUser, notificationFilter }),
+      observer,
+      true
+    )
+
+    return observer
+  }
+
+  run (
+    query,
+    parameters,
+    {
+      bookmarks,
+      txConfig,
+      database,
+      mode,
+      impersonatedUser,
+      notificationFilter,
+      beforeKeys,
+      afterKeys,
+      beforeError,
+      afterError,
+      beforeComplete,
+      afterComplete,
+      flush = true,
+      reactive = false,
+      fetchSize = FETCH_ALL,
+      highRecordWatermark = Number.MAX_VALUE,
+      lowRecordWatermark = Number.MAX_VALUE
+    } = {}
+  ) {
+    const observer = new ResultStreamObserver({
+      server: this._server,
+      reactive,
+      fetchSize,
+      moreFunction: this._requestMore.bind(this),
+      discardFunction: this._requestDiscard.bind(this),
+      beforeKeys,
+      afterKeys,
+      beforeError,
+      afterError,
+      beforeComplete,
+      afterComplete,
+      highRecordWatermark,
+      lowRecordWatermark,
+      enrichMetadata: BoltProtocol._enrichMetadata
+    })
+
+    const flushRun = reactive
+    this.write(
+      RequestMessage.runWithMetadata5x5(query, parameters, {
+        bookmarks,
+        txConfig,
+        database,
+        mode,
+        impersonatedUser,
+        notificationFilter
+      }),
+      observer,
+      flushRun && flush
+    )
+
+    if (!reactive) {
+      this.write(RequestMessage.pull({ n: fetchSize }), observer, flush)
+    }
+
+    return observer
+  }
+
+  /**
+   *
+   * @param {object} metadata
+   * @returns {object}
+   */
+  static _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
+  }
+}

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

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

@@ -29,6 +29,7 @@ import BoltProtocolV5x1 from './bolt-protocol-v5x1'
 import BoltProtocolV5x2 from './bolt-protocol-v5x2'
 import BoltProtocolV5x3 from './bolt-protocol-v5x3'
 import BoltProtocolV5x4 from './bolt-protocol-v5x4'
+import BoltProtocolV5x5 from './bolt-protocol-v5x5'
 // eslint-disable-next-line no-unused-vars
 import { Chunker, Dechunker } from '../channel'
 import ResponseHandler from './response-handler'
@@ -229,6 +230,14 @@ function createProtocol (
         log,
         onProtocolError,
         serversideRouting)
+    case 5.5:
+      return new BoltProtocolV5x5(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, 4), version(5, 0)],
+    [version(5, 5), version(5, 0)],
     [version(4, 4), version(4, 2)],
     version(4, 1),
     version(3, 0)