@atlaskit/collab-provider 8.6.0 → 8.8.0

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

@@ -1,11 +1,10 @@
-import _typeof from "@babel/runtime/helpers/typeof";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator.return && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) { keys.push(key); } return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, catch: function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { getVersion, sendableSteps } from '@atlaskit/prosemirror-collab';
 import { createLogger, sleep } from '../helpers/utils';
@@ -22,8 +21,6 @@ var CATCHUP_THROTTLE = 1 * 1000; // 1 second
 var noop = function noop() {};
 var logger = createLogger('documentService', 'black');
 export 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.
 
   /**
@@ -41,7 +38,11 @@ export var DocumentService = /*#__PURE__*/function () {
   function DocumentService(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
     _classCallCheck(this, DocumentService);
+    // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
+    /**
+     * To prevent calling catchup to often, use lodash throttle to reduce the frequency
+     */
     _defineProperty(this, "throttledCatchup", throttle(function () {
       return _this.catchup();
     }, CATCHUP_THROTTLE, {
@@ -49,59 +50,62 @@ export var DocumentService = /*#__PURE__*/function () {
       // TODO: why shouldn't this be leading?
       trailing: true
     }));
-    _defineProperty(this, "catchup", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
+    /**
+     * Called when:
+     *   * session established(offline -> online)
+     *   * try to accept steps but version is behind.
+     */
+    _defineProperty(this, "catchup", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
       var start, _this$analyticsHelper, latency, _this$analyticsHelper2, _this$analyticsHelper3, _latency;
-      return _regeneratorRuntime().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 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(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {
-                latency: latency
-              });
-              _context.next = 18;
+      return _regeneratorRuntime.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;
-            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(EVENT_ACTION.CATCHUP, 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 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(EVENT_ACTION.CATCHUP, 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(EVENT_ACTION.CATCHUP, 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]]);
     })));
@@ -115,41 +119,39 @@ export var DocumentService = /*#__PURE__*/function () {
       }
       return getVersion(state);
     });
-    _defineProperty(this, "getCurrentState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
+    _defineProperty(this, "getCurrentState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
       var _this$analyticsHelper5, state, adfDocument, currentState, measure, _this$analyticsHelper6, _this$analyticsHelper7, _measure;
-      return _regeneratorRuntime().wrap(function _callee2$(_context2) {
-        while (1) {
-          switch (_context2.prev = _context2.next) {
-            case 0:
-              _context2.prev = 0;
-              startMeasure(MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
+      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
+          case 0:
+            _context2.prev = 0;
+            startMeasure(MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
 
-              // Convert ProseMirror document in Editor state to ADF document
-              state = _this.getState();
-              adfDocument = new JSONTransformer().encode(state.doc);
-              currentState = {
-                content: adfDocument,
-                title: _this.metadataService.getTitle(),
-                stepVersion: getVersion(state)
-              };
-              measure = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
-              (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, 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 = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
-              (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, 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 JSONTransformer().encode(state.doc);
+            currentState = {
+              content: adfDocument,
+              title: _this.metadataService.getTitle(),
+              stepVersion: getVersion(state)
+            };
+            measure = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
+            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, 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 = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
+            (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, 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]]);
     })));
@@ -179,6 +181,9 @@ export var DocumentService = /*#__PURE__*/function () {
         steps: steps
       });
     });
+    /**
+     * Called when we receive steps from the service
+     */
     _defineProperty(this, "onStepsAdded", function (data) {
       logger("Received steps", {
         steps: data.steps,
@@ -217,6 +222,7 @@ export var DocumentService = /*#__PURE__*/function () {
         });
       }
     });
+    // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
     _defineProperty(this, "onRestore", function (_ref4) {
       var doc = _ref4.doc,
         version = _ref4.version,
@@ -262,39 +268,37 @@ export var DocumentService = /*#__PURE__*/function () {
         });
       }
     });
-    _defineProperty(this, "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3() {
+    _defineProperty(this, "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
       var _this$analyticsHelper14, currentState, measure, _this$analyticsHelper15, _this$analyticsHelper16, _measure2;
-      return _regeneratorRuntime().wrap(function _callee3$(_context3) {
-        while (1) {
-          switch (_context3.prev = _context3.next) {
-            case 0:
-              _context3.prev = 0;
-              startMeasure(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 = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-              (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, 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 = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-              (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, 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();
-          }
+      return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+        while (1) switch (_context3.prev = _context3.next) {
+          case 0:
+            _context3.prev = 0;
+            startMeasure(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 = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
+            (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, 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 = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
+            (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, 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]]);
     })));
@@ -311,102 +315,90 @@ export var DocumentService = /*#__PURE__*/function () {
         reserveCursor: reserveCursor
       } : {}));
     });
-    _defineProperty(this, "commitUnconfirmedSteps", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5() {
-      var unconfirmedSteps, _this$analyticsHelper18, _this$analyticsHelper19, measure;
-      return _regeneratorRuntime().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__*/_regeneratorRuntime().mark(function _callee4() {
-                var _this$analyticsHelper17;
-                var count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, state, measure;
-                return _regeneratorRuntime().wrap(function _callee4$(_context4) {
-                  while (1) {
-                    switch (_context4.prev = _context4.next) {
-                      case 0:
-                        startMeasure(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 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++ >= 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: ACK_MAX_TRY,
-                            clientId: _this.clientId,
-                            version: getVersion(state)
-                          });
-                        }
-                        throw new Error("Can't sync up with Collab Service");
-                      case 14:
-                        _context4.next = 5;
-                        break;
-                      case 16:
-                        measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-                        (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, 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;
+    /**
+     * Commit the unconfirmed local steps to the back-end service
+     * @throws {Error} Couldn't sync the steps after retrying 30 times
+     */
+    _defineProperty(this, "commitUnconfirmedSteps", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4() {
+      var unconfirmedSteps, _this$analyticsHelper17, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, state, measure, _this$analyticsHelper18, _this$analyticsHelper19, _measure3;
+      return _regeneratorRuntime.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;
+            }
+            startMeasure(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 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++ >= ACK_MAX_TRY)) {
+              _context4.next = 17;
               break;
-            case 6:
-              _context5.prev = 6;
-              _context5.t1 = _context5["catch"](1);
-              measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-              (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, 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: ACK_MAX_TRY,
+                clientId: _this.clientId,
+                version: 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 = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
+            (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, 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 = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
+            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, 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]]);
     })));
     _defineProperty(this, "onStepRejectedError", function () {
       _this.stepRejectCounter++;
@@ -434,16 +426,6 @@ export var DocumentService = /*#__PURE__*/function () {
     this.metadataService = metadataService;
     this.stepQueue = new StepQueueState();
   }
-
-  /**
-   * To prevent calling catchup to often, use lodash throttle to reduce the frequency
-   */
-
-  /**
-   * Called when:
-   *   * session established(offline -> online)
-   *   * try to accept steps but version is behind.
-   */
   _createClass(DocumentService, [{
     key: "processQueue",
     value: function processQueue() {
@@ -500,17 +482,6 @@ export var DocumentService = /*#__PURE__*/function () {
         }
       }
     }
-
-    /**
-     * Called when we receive steps from the service
-     */
-
-    // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
-
-    /**
-     * Commit the unconfirmed local steps to the back-end service
-     * @throws {Error} Couldn't sync the steps after retrying 30 times
-     */
   }, {
     key: "setup",
     value: function setup(_ref9) {

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

@@ -16,6 +16,10 @@ export var StepQueueState = /*#__PURE__*/function () {
     _defineProperty(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
+     */
     _defineProperty(this, "isPaused", function () {
       return _this.queuePaused;
     });
@@ -38,11 +42,6 @@ export var StepQueueState = /*#__PURE__*/function () {
       });
       this.queue = orderedQueue;
     }
-
-    /**
-     * Get whether the document service has stopped processing new steps whilst it carries out processes such as catchup.
-     * Exposed for testing
-     */
   }]);
   return StepQueueState;
 }();