@atlaskit/collab-provider 8.4.0 → 8.6.0

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

@@ -0,0 +1,579 @@
+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 { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { getVersion, sendableSteps } from '@atlaskit/prosemirror-collab';
+import { createLogger, sleep } from '../helpers/utils';
+import throttle from 'lodash/throttle';
+import { throttledCommitStep } from '../provider/commit-step';
+import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
+import { JSONTransformer } from '@atlaskit/editor-json-transformer';
+import { MAX_STEP_REJECTED_ERROR } from '../provider';
+import { catchup } from './catchup';
+import { StepQueueState } from './step-queue-state';
+import { INTERNAL_ERROR_CODE } from '../errors/error-types';
+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.
+
+  /**
+   *
+   * @param participantsService - The participants service, used when users are detected active when making changes to the document
+   * and to emit their telepointers from steps they add
+   * @param analyticsHelper - Helper for analytics events
+   * @param fetchCatchup - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
+   * @param providerEmitCallback - Callback for emitting events to listeners on the provider
+   * @param broadcastMetadata - Callback for broadcasting metadata changes to other clients
+   * @param broadcast - Callback for broadcasting events to other clients
+   * @param getUserId - Callback to fetch the current user's ID
+   * @param onErrorHandled - Callback to handle
+   */
+  function DocumentService(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
+    var _this = this;
+    _classCallCheck(this, DocumentService);
+    _defineProperty(this, "stepRejectCounter", 0);
+    _defineProperty(this, "throttledCatchup", throttle(function () {
+      return _this.catchup();
+    }, CATCHUP_THROTTLE, {
+      leading: false,
+      // TODO: why shouldn't this be leading?
+      trailing: true
+    }));
+    _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;
+              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]]);
+    })));
+    _defineProperty(this, "getCurrentPmVersion", function () {
+      var _this$getState;
+      var state = (_this$getState = _this.getState) === null || _this$getState === void 0 ? void 0 : _this$getState.call(_this);
+      if (!state) {
+        var _this$analyticsHelper4;
+        (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getCurrentPmVersion called without state');
+        return 0;
+      }
+      return getVersion(state);
+    });
+    _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);
+
+              // 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]]);
+    })));
+    _defineProperty(this, "getUnconfirmedStepsOrigins", function () {
+      var _this$getState2, _sendableSteps;
+      var state = (_this$getState2 = _this.getState) === null || _this$getState2 === void 0 ? void 0 : _this$getState2.call(_this);
+      if (!state) {
+        var _this$analyticsHelper8;
+        (_this$analyticsHelper8 = _this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getUnconfirmedStepsOrigins called without state');
+        return;
+      }
+      return (_sendableSteps = sendableSteps(state)) === null || _sendableSteps === void 0 ? void 0 : _sendableSteps.origins;
+    });
+    _defineProperty(this, "getUnconfirmedSteps", function () {
+      var _this$getState3, _sendableSteps2;
+      var state = (_this$getState3 = _this.getState) === null || _this$getState3 === void 0 ? void 0 : _this$getState3.call(_this);
+      if (!state) {
+        var _this$analyticsHelper9;
+        (_this$analyticsHelper9 = _this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getUnconfirmedSteps called without state');
+        return;
+      }
+      return (_sendableSteps2 = sendableSteps(state)) === null || _sendableSteps2 === void 0 ? void 0 : _sendableSteps2.steps;
+    });
+    _defineProperty(this, "applyLocalSteps", function (steps) {
+      // Re-apply local steps
+      _this.providerEmitCallback('local-steps', {
+        steps: steps
+      });
+    });
+    _defineProperty(this, "onStepsAdded", function (data) {
+      logger("Received steps", {
+        steps: data.steps,
+        version: data.version
+      });
+      if (!data.steps) {
+        logger("No steps.. waiting..");
+        return;
+      }
+      try {
+        var currentVersion = _this.getCurrentPmVersion();
+        var expectedVersion = currentVersion + data.steps.length;
+        if (data.version <= currentVersion) {
+          logger("Received steps we already have. Ignoring.");
+        } else if (data.version === expectedVersion) {
+          _this.processSteps(data);
+        } else if (data.version > expectedVersion) {
+          logger("Version too high. Expected \"".concat(expectedVersion, "\" but got \"").concat(data.version, ". Current local version is ").concat(currentVersion, "."));
+          _this.stepQueue.queueSteps(data);
+          _this.throttledCatchup();
+        }
+        _this.participantsService.updateLastActive(data.steps.map(function (_ref3) {
+          var userId = _ref3.userId;
+          return userId;
+        }));
+      } catch (stepsAddedError) {
+        var _this$analyticsHelper10;
+        (_this$analyticsHelper10 = _this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(stepsAddedError, 'Error while adding steps in the provider');
+        _this.onErrorHandled({
+          message: 'Error while adding steps in the provider',
+          data: {
+            status: 500,
+            // Meaningless, remove when we review error structure
+            code: INTERNAL_ERROR_CODE.ADD_STEPS_ERROR
+          }
+        });
+      }
+    });
+    _defineProperty(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 {
+        var _this$analyticsHelper11;
+        // Reset the editor,
+        //  - Replace the document, keep in sync with the server
+        //  - 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.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) {
+          _this.applyLocalSteps(unconfirmedSteps);
+        }
+        (_this$analyticsHelper11 = _this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.SUCCESS, {
+          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+        });
+      } catch (restoreError) {
+        var _this$analyticsHelper12, _this$analyticsHelper13;
+        (_this$analyticsHelper12 = _this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.FAILURE, {
+          numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+        });
+        (_this$analyticsHelper13 = _this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(restoreError, 'Error while reinitialising document');
+        _this.onErrorHandled({
+          message: 'Caught error while trying to recover the document',
+          data: {
+            status: 500,
+            // Meaningless, remove when we review error structure
+            code: INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR
+          }
+        });
+      }
+    });
+    _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();
+          }
+        }
+      }, _callee3, null, [[0, 12]]);
+    })));
+    _defineProperty(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
+      } : {}));
+    });
+    _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;
+              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
+              });
+              (_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();
+          }
+        }
+      }, _callee5, null, [[1, 6]]);
+    })));
+    _defineProperty(this, "onStepRejectedError", function () {
+      _this.stepRejectCounter++;
+      logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
+      if (_this.stepRejectCounter >= MAX_STEP_REJECTED_ERROR) {
+        logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
+        _this.throttledCatchup();
+      } else {
+        // If committing steps failed try again automatically in 1s
+        // This makes it more likely that unconfirmed steps trigger a catch-up
+        // within 15s even if there is no one editing actively (or draft sync polling)
+        // reducing the risk of data loss at the expense of step commits
+        setTimeout(function () {
+          return _this.sendStepsFromCurrentState();
+        }, 1000);
+      }
+    });
+    this.participantsService = participantsService;
+    this.analyticsHelper = analyticsHelper;
+    this.fetchCatchup = fetchCatchup;
+    this.providerEmitCallback = providerEmitCallback;
+    this.broadcast = broadcast;
+    this.getUserId = getUserId;
+    this.onErrorHandled = onErrorHandled;
+    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() {
+      if (this.stepQueue.isPaused()) {
+        logger("Queue is paused. Aborting.");
+        return;
+      }
+      logger("Looking for processable data.");
+      if (this.stepQueue.getQueue().length > 0) {
+        var firstItem = this.stepQueue.shift();
+        var currentVersion = this.getCurrentPmVersion();
+        var expectedVersion = currentVersion + firstItem.steps.length;
+        if (firstItem.version === expectedVersion) {
+          logger("Applying data from queue!");
+          this.processSteps(firstItem);
+          // recur
+          this.processQueue();
+        }
+      }
+    }
+  }, {
+    key: "processSteps",
+    value: function processSteps(data) {
+      var _this2 = this;
+      var version = data.version,
+        steps = data.steps;
+      logger("Processing data. Version \"".concat(version, "\"."));
+      if (steps !== null && steps !== void 0 && steps.length) {
+        try {
+          var clientIds = steps.map(function (_ref8) {
+            var clientId = _ref8.clientId;
+            return clientId;
+          });
+          this.providerEmitCallback('data', {
+            json: steps,
+            version: version,
+            userIds: clientIds
+          });
+          // If steps can apply to local editor successfully, no need to accumulate the error counter.
+          this.stepRejectCounter = 0;
+          this.participantsService.emitTelepointersFromSteps(steps, this.providerEmitCallback);
+
+          // Resend local steps if none of the received steps originated with us!
+          if (clientIds.indexOf(this.clientId) === -1) {
+            setTimeout(function () {
+              return _this2.sendStepsFromCurrentState();
+            }, 100);
+          }
+        } catch (error) {
+          var _this$analyticsHelper20;
+          logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
+          (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(error, 'Error while processing steps');
+          this.throttledCatchup();
+        }
+      }
+    }
+
+    /**
+     * 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) {
+      var getState = _ref9.getState,
+        onSyncUpError = _ref9.onSyncUpError,
+        clientId = _ref9.clientId;
+      this.getState = getState;
+      this.onSyncUpError = onSyncUpError || noop;
+      this.clientId = clientId;
+      return this;
+    }
+
+    /**
+     * We can use this function to throttle/delay
+     * Any send steps operation
+     *
+     * The getState function will return the current EditorState
+     * from the EditorView.
+     */
+  }, {
+    key: "sendStepsFromCurrentState",
+    value: function sendStepsFromCurrentState() {
+      var _this$getState4;
+      var state = (_this$getState4 = this.getState) === null || _this$getState4 === void 0 ? void 0 : _this$getState4.call(this);
+      if (!state) {
+        return;
+      }
+      this.send(null, null, state);
+    }
+  }, {
+    key: "send",
+    value:
+    /**
+     * Send steps from transaction to other participants
+     * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
+     */
+    function send(_tr, _oldState, newState) {
+      var unconfirmedStepsData = sendableSteps(newState);
+      var version = getVersion(newState);
+
+      // Don't send any steps before we're ready.
+      if (!unconfirmedStepsData) {
+        return;
+      }
+      var unconfirmedSteps = unconfirmedStepsData.steps;
+      if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
+        return;
+      }
+
+      // Avoid reference issues using a
+      // method outside of the provider
+      // scope
+      throttledCommitStep({
+        broadcast: this.broadcast,
+        userId: this.getUserId(),
+        clientId: this.clientId,
+        steps: unconfirmedSteps,
+        version: version,
+        onStepsAdded: this.onStepsAdded,
+        onErrorHandled: this.onErrorHandled,
+        analyticsHelper: this.analyticsHelper
+      });
+    }
+  }]);
+  return DocumentService;
+}();

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

@@ -0,0 +1,48 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { createLogger } from '../helpers/utils';
+var logger = createLogger('documentService-queue', 'black');
+export var StepQueueState = /*#__PURE__*/function () {
+  function StepQueueState() {
+    var _this = this;
+    _classCallCheck(this, StepQueueState);
+    _defineProperty(this, "queuePaused", false);
+    _defineProperty(this, "queue", []);
+    _defineProperty(this, "getQueue", function () {
+      return _this.queue;
+    });
+    _defineProperty(this, "filterQueue", function (condition) {
+      _this.queue = _this.queue.filter(condition);
+    });
+    _defineProperty(this, "isPaused", function () {
+      return _this.queuePaused;
+    });
+    _defineProperty(this, "pauseQueue", function () {
+      _this.queuePaused = true;
+    });
+    _defineProperty(this, "resumeQueue", function () {
+      _this.queuePaused = false;
+    });
+    _defineProperty(this, "shift", function () {
+      return _this.queue.shift();
+    });
+  }
+  _createClass(StepQueueState, [{
+    key: "queueSteps",
+    value: function queueSteps(data) {
+      logger("Queueing data for version \"".concat(data.version, "\"."));
+      var orderedQueue = [].concat(_toConsumableArray(this.queue), [data]).sort(function (a, b) {
+        return a.version > b.version ? 1 : -1;
+      });
+      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;
+}();