neo4j-driver 4.4.3 → 5.0.0-alpha01

package/lib/driver.js

@@ -91,7 +91,7 @@ var Driver = /*#__PURE__*/function (_CoreDriver) {
           bookmarkOrBookmarks: bookmarks,
           database: database,
           impersonatedUser: impersonatedUser,
-          reactive: true,
+          reactive: false,
           fetchSize: validateFetchSizeValue(fetchSize, this._config.fetchSize)
         }),
         config: this._config

package/lib/result-rx.js

@@ -7,6 +7,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
@@ -57,7 +61,8 @@ var RxResult = /*#__PURE__*/function () {
     this._keys = replayedResult.pipe((0, _operators.flatMap)(function (r) {
       return (0, _rxjs.from)(r.keys());
     }), (0, _operators.publishReplay)(1), (0, _operators.refCount)());
-    this._records = new _rxjs.Subject();
+    this._records = undefined;
+    this._controls = new StreamControl();
     this._summary = new _rxjs.ReplaySubject();
     this._state = States.READY;
   }
@@ -92,7 +97,7 @@ var RxResult = /*#__PURE__*/function () {
     value: function records() {
       var _this = this;
 
-      return this._result.pipe((0, _operators.flatMap)(function (result) {
+      var result = this._result.pipe((0, _operators.flatMap)(function (result) {
         return new _rxjs.Observable(function (recordsObserver) {
           return _this._startStreaming({
             result: result,
@@ -100,6 +105,12 @@ var RxResult = /*#__PURE__*/function () {
           });
         });
       }));
+
+      result.push = function () {
+        return _this._push();
+      };
+
+      return result;
     }
     /**
      * Returns an observable that exposes a single item of {@link ResultSummary} that is generated by
@@ -125,11 +136,53 @@ var RxResult = /*#__PURE__*/function () {
         });
       }));
     }
+    /**
+     * Pauses the automatic streaming of records.
+     *
+     * This method provides a way of controll the flow of records
+     *
+     * @experimental
+     */
+
+  }, {
+    key: "pause",
+    value: function pause() {
+      this._controls.pause();
+    }
+    /**
+     * Resumes the automatic streaming of records.
+     *
+     * This method won't need to be called in normal stream operation. It only applies to the case when the stream is paused.
+     *
+     * This method is method won't start the consuming records if the ${@link records()} stream didn't get subscribed.
+     * @experimental
+     * @returns {Promise<void>} - A promise that resolves when the stream is resumed.
+     */
+
+  }, {
+    key: "resume",
+    value: function resume() {
+      return this._controls.resume();
+    }
+    /**
+     * Pushes the next record to the stream.
+     *
+     * This method automatic pause the auto-streaming of records and then push next record to the stream.
+     *
+     * For returning the automatic streaming of records, use {@link resume} method.
+     *
+     * @experimental
+     * @returns {Promise<void>} - A promise that resolves when the push is completed.
+     */
+
+  }, {
+    key: "push",
+    value: function push() {
+      return this._controls.push();
+    }
   }, {
     key: "_startStreaming",
     value: function _startStreaming() {
-      var _this3 = this;
-
       var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
           result = _ref.result,
           _ref$recordsObserver = _ref.recordsObserver,
@@ -146,8 +199,12 @@ var RxResult = /*#__PURE__*/function () {
       if (this._state < States.STREAMING) {
         this._state = States.STREAMING;
 
+        this._setupRecordsStream(result);
+
         if (recordsObserver) {
           subscriptions.push(this._records.subscribe(recordsObserver));
+        } else {
+          result._cancel();
         }
 
         subscriptions.push({
@@ -157,32 +214,6 @@ var RxResult = /*#__PURE__*/function () {
             }
           }
         });
-
-        if (this._records.observers.length === 0) {
-          result._cancel();
-        }
-
-        result.subscribe({
-          onNext: function onNext(record) {
-            _this3._records.next(record);
-          },
-          onCompleted: function onCompleted(summary) {
-            _this3._records.complete();
-
-            _this3._summary.next(summary);
-
-            _this3._summary.complete();
-
-            _this3._state = States.COMPLETED;
-          },
-          onError: function onError(err) {
-            _this3._records.error(err);
-
-            _this3._summary.error(err);
-
-            _this3._state = States.COMPLETED;
-          }
-        });
       } else if (recordsObserver) {
         recordsObserver.error((0, _neo4jDriverCore.newError)('Streaming has already started/consumed with a previous records or summary subscription.'));
       }
@@ -193,8 +224,269 @@ var RxResult = /*#__PURE__*/function () {
         });
       };
     }
+  }, {
+    key: "_setupRecordsStream",
+    value: function _setupRecordsStream(result) {
+      var _this3 = this;
+
+      if (this._records) {
+        return this._records;
+      }
+
+      this._records = createFullyControlledSubject(result[Symbol.asyncIterator](), {
+        complete: function () {
+          var _complete = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+            return _regenerator["default"].wrap(function _callee$(_context) {
+              while (1) {
+                switch (_context.prev = _context.next) {
+                  case 0:
+                    _this3._state = States.COMPLETED;
+                    _context.t0 = _this3._summary;
+                    _context.next = 4;
+                    return result.summary();
+
+                  case 4:
+                    _context.t1 = _context.sent;
+
+                    _context.t0.next.call(_context.t0, _context.t1);
+
+                    _this3._summary.complete();
+
+                  case 7:
+                  case "end":
+                    return _context.stop();
+                }
+              }
+            }, _callee);
+          }));
+
+          function complete() {
+            return _complete.apply(this, arguments);
+          }
+
+          return complete;
+        }(),
+        error: function error(_error) {
+          _this3._state = States.COMPLETED;
+
+          _this3._summary.error(_error);
+        }
+      }, this._controls);
+      return this._records;
+    }
   }]);
   return RxResult;
 }();
 
-exports["default"] = RxResult;
+exports["default"] = RxResult;
+
+function createFullyControlledSubject(iterator, completeObserver) {
+  var streamControl = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : new StreamControl();
+  var subject = new _rxjs.Subject();
+
+  var pushNextValue = /*#__PURE__*/function () {
+    var _ref2 = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3(result) {
+      var _yield$result, done, value;
+
+      return _regenerator["default"].wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.prev = 0;
+              streamControl.pushing = true;
+              _context3.next = 4;
+              return result;
+
+            case 4:
+              _yield$result = _context3.sent;
+              done = _yield$result.done;
+              value = _yield$result.value;
+
+              if (done) {
+                subject.complete();
+                completeObserver.complete();
+              } else {
+                subject.next(value);
+
+                if (!streamControl.paused) {
+                  setImmediate( /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
+                    return _regenerator["default"].wrap(function _callee2$(_context2) {
+                      while (1) {
+                        switch (_context2.prev = _context2.next) {
+                          case 0:
+                            _context2.next = 2;
+                            return pushNextValue(iterator.next());
+
+                          case 2:
+                            return _context2.abrupt("return", _context2.sent);
+
+                          case 3:
+                          case "end":
+                            return _context2.stop();
+                        }
+                      }
+                    }, _callee2);
+                  })));
+                }
+              }
+
+              _context3.next = 14;
+              break;
+
+            case 10:
+              _context3.prev = 10;
+              _context3.t0 = _context3["catch"](0);
+              subject.error(_context3.t0);
+              completeObserver.error(_context3.t0);
+
+            case 14:
+              _context3.prev = 14;
+              streamControl.pushing = false;
+              return _context3.finish(14);
+
+            case 17:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3, null, [[0, 10, 14, 17]]);
+    }));
+
+    return function pushNextValue(_x) {
+      return _ref2.apply(this, arguments);
+    };
+  }();
+
+  function push(_x2) {
+    return _push.apply(this, arguments);
+  }
+
+  function _push() {
+    _push = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee4(value) {
+      return _regenerator["default"].wrap(function _callee4$(_context4) {
+        while (1) {
+          switch (_context4.prev = _context4.next) {
+            case 0:
+              _context4.next = 2;
+              return pushNextValue(iterator.next(value));
+
+            case 2:
+            case "end":
+              return _context4.stop();
+          }
+        }
+      }, _callee4);
+    }));
+    return _push.apply(this, arguments);
+  }
+
+  streamControl.pusher = push;
+  push();
+  return subject;
+}
+
+var StreamControl = /*#__PURE__*/function () {
+  function StreamControl() {
+    var push = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee5() {
+      return _regenerator["default"].wrap(function _callee5$(_context5) {
+        while (1) {
+          switch (_context5.prev = _context5.next) {
+            case 0:
+            case "end":
+              return _context5.stop();
+          }
+        }
+      }, _callee5);
+    }));
+    (0, _classCallCheck2["default"])(this, StreamControl);
+    this._paused = false;
+    this._pushing = false;
+    this._push = push;
+  }
+
+  (0, _createClass2["default"])(StreamControl, [{
+    key: "pause",
+    value: function pause() {
+      this._paused = true;
+    }
+  }, {
+    key: "paused",
+    get: function get() {
+      return this._paused;
+    }
+  }, {
+    key: "pushing",
+    set: function set(pushing) {
+      this._pushing = pushing;
+    }
+  }, {
+    key: "resume",
+    value: function () {
+      var _resume = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee6() {
+        var wasPaused;
+        return _regenerator["default"].wrap(function _callee6$(_context6) {
+          while (1) {
+            switch (_context6.prev = _context6.next) {
+              case 0:
+                wasPaused = this._paused;
+                this._paused = false;
+
+                if (!(wasPaused && !this._pushing)) {
+                  _context6.next = 5;
+                  break;
+                }
+
+                _context6.next = 5;
+                return this._push();
+
+              case 5:
+              case "end":
+                return _context6.stop();
+            }
+          }
+        }, _callee6, this);
+      }));
+
+      function resume() {
+        return _resume.apply(this, arguments);
+      }
+
+      return resume;
+    }()
+  }, {
+    key: "push",
+    value: function () {
+      var _push2 = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee7() {
+        return _regenerator["default"].wrap(function _callee7$(_context7) {
+          while (1) {
+            switch (_context7.prev = _context7.next) {
+              case 0:
+                this.pause();
+                _context7.next = 3;
+                return this._push();
+
+              case 3:
+                return _context7.abrupt("return", _context7.sent);
+
+              case 4:
+              case "end":
+                return _context7.stop();
+            }
+          }
+        }, _callee7, this);
+      }));
+
+      function push() {
+        return _push2.apply(this, arguments);
+      }
+
+      return push;
+    }()
+  }, {
+    key: "pusher",
+    set: function set(push) {
+      this._push = push;
+    }
+  }]);
+  return StreamControl;
+}();

package/lib/session-rx.js

@@ -156,21 +156,40 @@ var RxSession = /*#__PURE__*/function () {
       });
     }
     /**
-     * Returns the bookmark received following the last successfully completed query, which is executed
+     * Returns the bookmarks received following the last successfully completed query, which is executed
      * either in an {@link RxTransaction} obtained from this session instance or directly through one of
      * the {@link RxSession#run} method of this session instance.
      *
-     * If no bookmark was received or if this transaction was rolled back, the bookmark value will not be
+     * If no bookmarks were received or if this transaction was rolled back, the bookmarks value will not be
      * changed.
      *
+     * @deprecated This method will be removed in 6.0 version. Please, use {@link RxSession#lastBookmarks} instead.
+     *
      * @public
-     * @returns {string}
+     * @returns {string[]}
      */
 
   }, {
     key: "lastBookmark",
     value: function lastBookmark() {
-      return this._session.lastBookmark();
+      return this.lastBookmarks();
+    }
+    /**
+     * Returns the bookmarks received following the last successfully completed query, which is executed
+     * either in an {@link RxTransaction} obtained from this session instance or directly through one of
+     * the {@link RxSession#run} method of this session instance.
+     *
+     * If no bookmarks were received or if this transaction was rolled back, the bookmarks value will not be
+     * changed.
+     *
+     * @public
+     * @returns {string[]}
+     */
+
+  }, {
+    key: "lastBookmarks",
+    value: function lastBookmarks() {
+      return this._session.lastBookmarks();
     }
     /**
      * @private

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neo4j-driver",
-  "version": "4.4.3",
+  "version": "5.0.0-alpha01",
   "description": "Connect to Neo4j 3.5.0 and up from JavaScript",
   "author": "Neo4j",
   "license": "Apache-2.0",
@@ -111,9 +111,9 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.5.5",
-    "neo4j-driver-bolt-connection": "^4.4.3",
-    "neo4j-driver-core": "^4.4.3",
+    "neo4j-driver-bolt-connection": "^5.0.0-alpha01",
+    "neo4j-driver-core": "^5.0.0-alpha01",
     "rxjs": "^6.6.3"
   },
-  "gitHead": "ef025439564ead9bec658e1458e8b421ac165fc0"
+  "gitHead": "fd5ab41489e1ac9ca562100a056663f4cadbb7da"
 }

package/types/result-rx.d.ts

@@ -25,6 +25,12 @@ declare interface RxResult {
   records(): Observable<Record>
 
   consume(): Observable<ResultSummary>
+
+  pause(): void
+
+  resume(): Promise<void>
+
+  push(): Promise<void>
 }
 
 export default RxResult

package/types/session-rx.d.ts

@@ -33,6 +33,7 @@ declare interface RxSession {
 
   beginTransaction(config?: TransactionConfig): Observable<RxTransaction>
 
+  lastBookmarks(): string[]
   lastBookmark(): string[]
 
   readTransaction<T>(