@atlaskit/collab-provider 8.5.0 → 8.7.0

package/dist/cjs/document/document-service.js

@@ -14,11 +14,11 @@ var _const = require("../helpers/const");
 var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
 var _utils = require("../helpers/utils");
 var _throttle = _interopRequireDefault(require("lodash/throttle"));
+var _commitStep = require("../provider/commit-step");
 var _performance = require("../analytics/performance");
 var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
 var _provider = require("../provider");
 var _catchup = require("./catchup");
-var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 var _stepQueueState = require("./step-queue-state");
 var _errorTypes = require("../errors/error-types");
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -28,7 +28,7 @@ var CATCHUP_THROTTLE = 1 * 1000; // 1 second
 var noop = function noop() {};
 var logger = (0, _utils.createLogger)('documentService', 'black');
 var DocumentService = /*#__PURE__*/function () {
-  // Fires analytics to editor when collab editor cannot sync up
+  // ClientID is the unique ID for a prosemirror client. Used for step-rebasing.
 
   /**
    *
@@ -42,20 +42,14 @@ var DocumentService = /*#__PURE__*/function () {
    * @param getUserId - Callback to fetch the current user's ID
    * @param onErrorHandled - Callback to handle
    */
-  function DocumentService(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcastMetadata, broadcast, getUserId, onErrorHandled) {
+  function DocumentService(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
     (0, _classCallCheck2.default)(this, DocumentService);
+    // Fires analytics to editor when collab editor cannot sync up
     (0, _defineProperty2.default)(this, "stepRejectCounter", 0);
-    (0, _defineProperty2.default)(this, "metadata", {});
-    (0, _defineProperty2.default)(this, "onMetadataChanged", function (metadata) {
-      if (metadata !== undefined && !(0, _isEqual.default)(_this.metadata, metadata)) {
-        _this.metadata = metadata;
-        _this.providerEmitCallback('metadata:changed', metadata);
-      }
-    });
-    (0, _defineProperty2.default)(this, "getMetaData", function () {
-      return _this.metadata;
-    });
+    /**
+     * To prevent calling catchup to often, use lodash throttle to reduce the frequency
+     */
     (0, _defineProperty2.default)(this, "throttledCatchup", (0, _throttle.default)(function () {
       return _this.catchup();
     }, CATCHUP_THROTTLE, {
@@ -63,58 +57,62 @@ var DocumentService = /*#__PURE__*/function () {
       // TODO: why shouldn't this be leading?
       trailing: true
     }));
+    /**
+     * Called when:
+     *   * session established(offline -> online)
+     *   * try to accept steps but version is behind.
+     */
     (0, _defineProperty2.default)(this, "catchup", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
       var start, _this$analyticsHelper, latency, _this$analyticsHelper2, _this$analyticsHelper3, _latency;
       return _regenerator.default.wrap(function _callee$(_context) {
-        while (1) {
-          switch (_context.prev = _context.next) {
-            case 0:
-              start = new Date().getTime(); // if the queue is already paused, we are busy with something else, so don't proceed.
-              if (!_this.stepQueue.isPaused()) {
-                _context.next = 4;
-                break;
-              }
-              logger("Queue is paused. Aborting.");
-              return _context.abrupt("return");
-            case 4:
-              _this.stepQueue.pauseQueue();
-              _context.prev = 5;
-              _context.next = 8;
-              return (0, _catchup.catchup)({
-                getCurrentPmVersion: _this.getCurrentPmVersion,
-                fetchCatchup: _this.fetchCatchup,
-                getUnconfirmedSteps: _this.getUnconfirmedSteps,
-                filterQueue: _this.stepQueue.filterQueue,
-                updateDocumentWithMetadata: _this.updateDocumentWithMetadata,
-                applyLocalSteps: _this.applyLocalSteps
-              });
-            case 8:
-              latency = new Date().getTime() - start;
-              (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.SUCCESS, {
-                latency: latency
-              });
-              _context.next = 18;
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            start = new Date().getTime(); // if the queue is already paused, we are busy with something else, so don't proceed.
+            if (!_this.stepQueue.isPaused()) {
+              _context.next = 4;
               break;
-            case 12:
-              _context.prev = 12;
-              _context.t0 = _context["catch"](5);
-              _latency = new Date().getTime() - start;
-              (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.FAILURE, {
-                latency: _latency
-              });
-              (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(_context.t0, 'Error while catching up');
-              logger("Catch-Up Failed:", _context.t0.message);
-            case 18:
-              _context.prev = 18;
-              _this.stepQueue.resumeQueue();
-              _this.processQueue();
-              _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls commitStep which will either catchup on onStepsAdded or onErrorHandled
-              _this.stepRejectCounter = 0;
-              return _context.finish(18);
-            case 24:
-            case "end":
-              return _context.stop();
-          }
+            }
+            logger("Queue is paused. Aborting.");
+            return _context.abrupt("return");
+          case 4:
+            _this.stepQueue.pauseQueue();
+            _context.prev = 5;
+            _context.next = 8;
+            return (0, _catchup.catchup)({
+              getCurrentPmVersion: _this.getCurrentPmVersion,
+              fetchCatchup: _this.fetchCatchup,
+              getUnconfirmedSteps: _this.getUnconfirmedSteps,
+              filterQueue: _this.stepQueue.filterQueue,
+              applyLocalSteps: _this.applyLocalSteps,
+              updateDocument: _this.updateDocument,
+              updateMetadata: _this.metadataService.updateMetadata
+            });
+          case 8:
+            latency = new Date().getTime() - start;
+            (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.SUCCESS, {
+              latency: latency
+            });
+            _context.next = 18;
+            break;
+          case 12:
+            _context.prev = 12;
+            _context.t0 = _context["catch"](5);
+            _latency = new Date().getTime() - start;
+            (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.FAILURE, {
+              latency: _latency
+            });
+            (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(_context.t0, 'Error while catching up');
+            logger("Catch-Up Failed:", _context.t0.message);
+          case 18:
+            _context.prev = 18;
+            _this.stepQueue.resumeQueue();
+            _this.processQueue();
+            _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls commitStep which will either catchup on onStepsAdded or onErrorHandled
+            _this.stepRejectCounter = 0;
+            return _context.finish(18);
+          case 24:
+          case "end":
+            return _context.stop();
         }
       }, _callee, null, [[5, 12, 18, 24]]);
     })));
@@ -129,40 +127,38 @@ var DocumentService = /*#__PURE__*/function () {
       return (0, _prosemirrorCollab.getVersion)(state);
     });
     (0, _defineProperty2.default)(this, "getCurrentState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
-      var _this$metadata$title, _this$analyticsHelper5, state, adfDocument, currentState, measure, _this$analyticsHelper6, _this$analyticsHelper7, _measure;
+      var _this$analyticsHelper5, state, adfDocument, currentState, measure, _this$analyticsHelper6, _this$analyticsHelper7, _measure;
       return _regenerator.default.wrap(function _callee2$(_context2) {
-        while (1) {
-          switch (_context2.prev = _context2.next) {
-            case 0:
-              _context2.prev = 0;
-              (0, _performance.startMeasure)(_performance.MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
+        while (1) switch (_context2.prev = _context2.next) {
+          case 0:
+            _context2.prev = 0;
+            (0, _performance.startMeasure)(_performance.MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
 
-              // Convert ProseMirror document in Editor state to ADF document
-              state = _this.getState();
-              adfDocument = new _editorJsonTransformer.JSONTransformer().encode(state.doc);
-              currentState = {
-                content: adfDocument,
-                title: (_this$metadata$title = _this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
-                stepVersion: (0, _prosemirrorCollab.getVersion)(state)
-              };
-              measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
-              (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendActionEvent(_const.EVENT_ACTION.GET_CURRENT_STATE, _const.EVENT_STATUS.SUCCESS, {
-                latency: measure === null || measure === void 0 ? void 0 : measure.duration
-              });
-              return _context2.abrupt("return", currentState);
-            case 10:
-              _context2.prev = 10;
-              _context2.t0 = _context2["catch"](0);
-              _measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
-              (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(_const.EVENT_ACTION.GET_CURRENT_STATE, _const.EVENT_STATUS.FAILURE, {
-                latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration
-              });
-              (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(_context2.t0, 'Error while returning ADF version of current draft document');
-              throw _context2.t0;
-            case 16:
-            case "end":
-              return _context2.stop();
-          }
+            // Convert ProseMirror document in Editor state to ADF document
+            state = _this.getState();
+            adfDocument = new _editorJsonTransformer.JSONTransformer().encode(state.doc);
+            currentState = {
+              content: adfDocument,
+              title: _this.metadataService.getTitle(),
+              stepVersion: (0, _prosemirrorCollab.getVersion)(state)
+            };
+            measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
+            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendActionEvent(_const.EVENT_ACTION.GET_CURRENT_STATE, _const.EVENT_STATUS.SUCCESS, {
+              latency: measure === null || measure === void 0 ? void 0 : measure.duration
+            });
+            return _context2.abrupt("return", currentState);
+          case 10:
+            _context2.prev = 10;
+            _context2.t0 = _context2["catch"](0);
+            _measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
+            (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(_const.EVENT_ACTION.GET_CURRENT_STATE, _const.EVENT_STATUS.FAILURE, {
+              latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration
+            });
+            (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(_context2.t0, 'Error while returning ADF version of current draft document');
+            throw _context2.t0;
+          case 16:
+          case "end":
+            return _context2.stop();
         }
       }, _callee2, null, [[0, 10]]);
     })));
@@ -192,23 +188,9 @@ var DocumentService = /*#__PURE__*/function () {
         steps: steps
       });
     });
-    (0, _defineProperty2.default)(this, "updateDocumentWithMetadata", function (_ref3) {
-      var doc = _ref3.doc,
-        version = _ref3.version,
-        metadata = _ref3.metadata,
-        reserveCursor = _ref3.reserveCursor;
-      _this.providerEmitCallback('init', _objectSpread({
-        doc: doc,
-        version: version,
-        metadata: metadata
-      }, reserveCursor ? {
-        reserveCursor: reserveCursor
-      } : {}));
-      if (metadata && Object.keys(metadata).length > 0) {
-        _this.metadata = metadata;
-        _this.providerEmitCallback('metadata:changed', metadata);
-      }
-    });
+    /**
+     * Called when we receive steps from the service
+     */
     (0, _defineProperty2.default)(this, "onStepsAdded", function (data) {
       logger("Received steps", {
         steps: data.steps,
@@ -230,8 +212,8 @@ var DocumentService = /*#__PURE__*/function () {
           _this.stepQueue.queueSteps(data);
           _this.throttledCatchup();
         }
-        _this.participantsService.updateLastActive(data.steps.map(function (_ref4) {
-          var userId = _ref4.userId;
+        _this.participantsService.updateLastActive(data.steps.map(function (_ref3) {
+          var userId = _ref3.userId;
           return userId;
         }));
       } catch (stepsAddedError) {
@@ -247,10 +229,11 @@ var DocumentService = /*#__PURE__*/function () {
         });
       }
     });
-    (0, _defineProperty2.default)(this, "onRestore", function (_ref5) {
-      var doc = _ref5.doc,
-        version = _ref5.version,
-        metadata = _ref5.metadata;
+    // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
+    (0, _defineProperty2.default)(this, "onRestore", function (_ref4) {
+      var doc = _ref4.doc,
+        version = _ref4.version,
+        metadata = _ref4.metadata;
       // Preserve the unconfirmed steps to prevent data loss.
       var unconfirmedSteps = _this.getUnconfirmedSteps();
       try {
@@ -260,12 +243,14 @@ var DocumentService = /*#__PURE__*/function () {
         //  - Replace the version number, so editor is in sync with NCS server and can commit new changes.
         //  - Replace the metadata
         //  - Reserve the cursor position, in case a cursor jump.
-        _this.updateDocumentWithMetadata({
+
+        _this.updateDocument({
           doc: doc,
           version: version,
           metadata: metadata,
           reserveCursor: true
         });
+        _this.metadataService.updateMetadata(metadata);
 
         // Re-apply the unconfirmed steps, not 100% of them can be applied, if document is changed significantly.
         if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
@@ -293,135 +278,134 @@ var DocumentService = /*#__PURE__*/function () {
     (0, _defineProperty2.default)(this, "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
       var _this$analyticsHelper14, currentState, measure, _this$analyticsHelper15, _this$analyticsHelper16, _measure2;
       return _regenerator.default.wrap(function _callee3$(_context3) {
-        while (1) {
-          switch (_context3.prev = _context3.next) {
-            case 0:
-              _context3.prev = 0;
-              (0, _performance.startMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-              _context3.next = 4;
-              return _this.commitUnconfirmedSteps();
-            case 4:
-              _context3.next = 6;
-              return _this.getCurrentState();
-            case 6:
-              currentState = _context3.sent;
-              measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-              (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.SUCCESS, {
-                latency: measure === null || measure === void 0 ? void 0 : measure.duration
-              });
-              return _context3.abrupt("return", currentState);
-            case 12:
-              _context3.prev = 12;
-              _context3.t0 = _context3["catch"](0);
-              _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-              (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.FAILURE, {
-                latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration
-              });
-              (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
-              throw _context3.t0;
-            case 18:
-            case "end":
-              return _context3.stop();
-          }
+        while (1) switch (_context3.prev = _context3.next) {
+          case 0:
+            _context3.prev = 0;
+            (0, _performance.startMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
+            _context3.next = 4;
+            return _this.commitUnconfirmedSteps();
+          case 4:
+            _context3.next = 6;
+            return _this.getCurrentState();
+          case 6:
+            currentState = _context3.sent;
+            measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
+            (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.SUCCESS, {
+              latency: measure === null || measure === void 0 ? void 0 : measure.duration
+            });
+            return _context3.abrupt("return", currentState);
+          case 12:
+            _context3.prev = 12;
+            _context3.t0 = _context3["catch"](0);
+            _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
+            (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.FAILURE, {
+              latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration
+            });
+            (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
+            throw _context3.t0;
+          case 18:
+          case "end":
+            return _context3.stop();
         }
       }, _callee3, null, [[0, 12]]);
     })));
-    (0, _defineProperty2.default)(this, "commitUnconfirmedSteps", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
-      var unconfirmedSteps, _this$analyticsHelper18, _this$analyticsHelper19, measure;
-      return _regenerator.default.wrap(function _callee5$(_context5) {
-        while (1) {
-          switch (_context5.prev = _context5.next) {
-            case 0:
-              unconfirmedSteps = _this.getUnconfirmedSteps();
-              _context5.prev = 1;
-              if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
-                _context5.next = 4;
-                break;
-              }
-              return _context5.delegateYield( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
-                var _this$analyticsHelper17;
-                var count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, state, measure;
-                return _regenerator.default.wrap(function _callee4$(_context4) {
-                  while (1) {
-                    switch (_context4.prev = _context4.next) {
-                      case 0:
-                        (0, _performance.startMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-                        count = 0; // We use origins here as steps can be rebased. When steps are rebased a new step is created.
-                        // This means that we can not track if it has been removed from the unconfirmed array or not.
-                        // Origins points to the original transaction that the step was created in. This is never changed
-                        // and gets passed down when a step is rebased.
-                        unconfirmedTrs = _this.getUnconfirmedStepsOrigins();
-                        lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
-                        isLastTrConfirmed = false;
-                      case 5:
-                        if (isLastTrConfirmed) {
-                          _context4.next = 16;
-                          break;
-                        }
-                        _this.sendStepsFromCurrentState();
-                        _context4.next = 9;
-                        return (0, _utils.sleep)(1000);
-                      case 9:
-                        nextUnconfirmedSteps = _this.getUnconfirmedSteps();
-                        if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
-                          nextUnconfirmedTrs = _this.getUnconfirmedStepsOrigins();
-                          isLastTrConfirmed = !(nextUnconfirmedTrs !== null && nextUnconfirmedTrs !== void 0 && nextUnconfirmedTrs.some(function (tr) {
-                            return tr === lastTr;
-                          }));
-                        } else {
-                          isLastTrConfirmed = true;
-                        }
-                        if (!(!isLastTrConfirmed && count++ >= _const.ACK_MAX_TRY)) {
-                          _context4.next = 14;
-                          break;
-                        }
-                        if (_this.onSyncUpError) {
-                          state = _this.getState();
-                          _this.onSyncUpError({
-                            lengthOfUnconfirmedSteps: nextUnconfirmedSteps === null || nextUnconfirmedSteps === void 0 ? void 0 : nextUnconfirmedSteps.length,
-                            tries: count,
-                            maxRetries: _const.ACK_MAX_TRY,
-                            clientId: _this.clientId,
-                            version: (0, _prosemirrorCollab.getVersion)(state)
-                          });
-                        }
-                        throw new Error("Can't sync up with Collab Service");
-                      case 14:
-                        _context4.next = 5;
-                        break;
-                      case 16:
-                        measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-                        (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.SUCCESS, {
-                          latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-                          // upon success, emit the total number of unconfirmed steps we synced
-                          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
-                        });
-                      case 18:
-                      case "end":
-                        return _context4.stop();
-                    }
-                  }
-                }, _callee4);
-              })(), "t0", 4);
-            case 4:
-              _context5.next = 12;
+    (0, _defineProperty2.default)(this, "updateDocument", function (_ref6) {
+      var doc = _ref6.doc,
+        version = _ref6.version,
+        metadata = _ref6.metadata,
+        reserveCursor = _ref6.reserveCursor;
+      _this.providerEmitCallback('init', _objectSpread({
+        doc: doc,
+        version: version,
+        metadata: metadata
+      }, reserveCursor ? {
+        reserveCursor: reserveCursor
+      } : {}));
+    });
+    /**
+     * Commit the unconfirmed local steps to the back-end service
+     * @throws {Error} Couldn't sync the steps after retrying 30 times
+     */
+    (0, _defineProperty2.default)(this, "commitUnconfirmedSteps", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
+      var unconfirmedSteps, _this$analyticsHelper17, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, state, measure, _this$analyticsHelper18, _this$analyticsHelper19, _measure3;
+      return _regenerator.default.wrap(function _callee4$(_context4) {
+        while (1) switch (_context4.prev = _context4.next) {
+          case 0:
+            unconfirmedSteps = _this.getUnconfirmedSteps();
+            _context4.prev = 1;
+            if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
+              _context4.next = 21;
+              break;
+            }
+            (0, _performance.startMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
+            count = 0; // We use origins here as steps can be rebased. When steps are rebased a new step is created.
+            // This means that we can not track if it has been removed from the unconfirmed array or not.
+            // Origins points to the original transaction that the step was created in. This is never changed
+            // and gets passed down when a step is rebased.
+            unconfirmedTrs = _this.getUnconfirmedStepsOrigins();
+            lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
+            isLastTrConfirmed = false;
+          case 8:
+            if (isLastTrConfirmed) {
+              _context4.next = 19;
+              break;
+            }
+            _this.sendStepsFromCurrentState();
+            _context4.next = 12;
+            return (0, _utils.sleep)(1000);
+          case 12:
+            nextUnconfirmedSteps = _this.getUnconfirmedSteps();
+            if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
+              nextUnconfirmedTrs = _this.getUnconfirmedStepsOrigins();
+              isLastTrConfirmed = !(nextUnconfirmedTrs !== null && nextUnconfirmedTrs !== void 0 && nextUnconfirmedTrs.some(function (tr) {
+                return tr === lastTr;
+              }));
+            } else {
+              isLastTrConfirmed = true;
+            }
+            if (!(!isLastTrConfirmed && count++ >= _const.ACK_MAX_TRY)) {
+              _context4.next = 17;
               break;
-            case 6:
-              _context5.prev = 6;
-              _context5.t1 = _context5["catch"](1);
-              measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-              (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
-                latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-                numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+            }
+            if (_this.onSyncUpError) {
+              state = _this.getState();
+              _this.onSyncUpError({
+                lengthOfUnconfirmedSteps: nextUnconfirmedSteps === null || nextUnconfirmedSteps === void 0 ? void 0 : nextUnconfirmedSteps.length,
+                tries: count,
+                maxRetries: _const.ACK_MAX_TRY,
+                clientId: _this.clientId,
+                version: (0, _prosemirrorCollab.getVersion)(state)
               });
-              (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendErrorEvent(_context5.t1, 'Error while committing unconfirmed steps');
-              throw _context5.t1;
-            case 12:
-            case "end":
-              return _context5.stop();
-          }
+            }
+            throw new Error("Can't sync up with Collab Service");
+          case 17:
+            _context4.next = 8;
+            break;
+          case 19:
+            measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
+            (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.SUCCESS, {
+              latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+              // upon success, emit the total number of unconfirmed steps we synced
+              numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+            });
+          case 21:
+            _context4.next = 29;
+            break;
+          case 23:
+            _context4.prev = 23;
+            _context4.t0 = _context4["catch"](1);
+            _measure3 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
+            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
+              latency: _measure3 === null || _measure3 === void 0 ? void 0 : _measure3.duration,
+              numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+            });
+            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendErrorEvent(_context4.t0, 'Error while committing unconfirmed steps');
+            throw _context4.t0;
+          case 29:
+          case "end":
+            return _context4.stop();
         }
-      }, _callee5, null, [[1, 6]]);
+      }, _callee4, null, [[1, 23]]);
     })));
     (0, _defineProperty2.default)(this, "onStepRejectedError", function () {
       _this.stepRejectCounter++;
@@ -443,56 +427,13 @@ var DocumentService = /*#__PURE__*/function () {
     this.analyticsHelper = analyticsHelper;
     this.fetchCatchup = fetchCatchup;
     this.providerEmitCallback = providerEmitCallback;
-    this.broadcastMetadata = broadcastMetadata;
     this.broadcast = broadcast;
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
+    this.metadataService = metadataService;
     this.stepQueue = new _stepQueueState.StepQueueState();
   }
-
-  /**
-   * Called when a metadata is changed externally from other clients/backend.
-   */
   (0, _createClass2.default)(DocumentService, [{
-    key: "setTitle",
-    value: function setTitle(title, broadcast) {
-      if (broadcast) {
-        this.broadcastMetadata({
-          title: title
-        });
-      }
-      Object.assign(this.metadata, {
-        title: title
-      });
-    }
-  }, {
-    key: "setEditorWidth",
-    value: function setEditorWidth(editorWidth, broadcast) {
-      if (broadcast) {
-        this.broadcastMetadata({
-          editorWidth: editorWidth
-        });
-      }
-      Object.assign(this.metadata, {
-        editorWidth: editorWidth
-      });
-    }
-
-    /**
-     * Updates the local metadata and broadcasts the metadata to other clients/backend.
-     * @param metadata
-     */
-  }, {
-    key: "setMetadata",
-    value: function setMetadata(metadata) {
-      this.broadcastMetadata(metadata);
-      Object.assign(this.metadata, metadata);
-    }
-
-    /**
-     * To prevent calling catchup to often, use lodash throttle to reduce the frequency
-     */
-  }, {
     key: "processQueue",
     value: function processQueue() {
       if (this.stepQueue.isPaused()) {
@@ -600,7 +541,7 @@ var DocumentService = /*#__PURE__*/function () {
       // Avoid reference issues using a
       // method outside of the provider
       // scope
-      (0, _provider.throttledCommitStep)({
+      (0, _commitStep.throttledCommitStep)({
         broadcast: this.broadcast,
         userId: this.getUserId(),
         clientId: this.clientId,

package/dist/cjs/document/step-queue-state.js

@@ -23,6 +23,10 @@ var StepQueueState = /*#__PURE__*/function () {
     (0, _defineProperty2.default)(this, "filterQueue", function (condition) {
       _this.queue = _this.queue.filter(condition);
     });
+    /**
+     * Get whether the document service has stopped processing new steps whilst it carries out processes such as catchup.
+     * Exposed for testing
+     */
     (0, _defineProperty2.default)(this, "isPaused", function () {
       return _this.queuePaused;
     });