@atlaskit/collab-provider 9.26.1 → 9.26.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.26.3
+
+### Patch Changes
+
+- [#91887](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/91887) [`232026623493`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/232026623493) - Add out of sync detection and correction for catchup
+
+## 9.26.2
+
+### Patch Changes
+
+- [#90942](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/90942) [`30e989b2e4bb`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/30e989b2e4bb) - catchupV2 is a noop when document is locked
+
 ## 9.26.1
 
 ### Patch Changes

package/dist/cjs/channel.js

@@ -328,7 +328,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
       };
     }());
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "fetchCatchupv2", /*#__PURE__*/function () {
-      var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(fromVersion, clientId) {
+      var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(fromVersion, clientId, catchUpOutofSync) {
         var _yield$utils$requestS2, steps, metadata, errorNotFound, errorCatchupv2;
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
@@ -339,7 +339,8 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
               _context3.t2 = "document/".concat(encodeURIComponent(_this.config.documentAri), "/catchupv2");
               _context3.t3 = {
                 version: fromVersion,
-                clientId: clientId
+                clientId: clientId,
+                catchUpOutofSync: catchUpOutofSync
               };
               _context3.t4 = _objectSpread;
               _context3.t5 = _objectSpread;
@@ -419,7 +420,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
           }
         }, _callee3, null, [[0, 31]]);
       }));
-      return function (_x3, _x4) {
+      return function (_x3, _x4, _x5) {
         return _ref3.apply(this, arguments);
       };
     }());
@@ -492,7 +493,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
           }
         }, _callee4, null, [[0, 30]]);
       }));
-      return function (_x5, _x6) {
+      return function (_x6, _x7) {
         return _ref4.apply(this, arguments);
       };
     }());
@@ -627,7 +628,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
               }
             }, _callee5, null, [[1, 9]]);
           }));
-          return function auth(_x7) {
+          return function auth(_x8) {
             return _ref5.apply(this, arguments);
           };
         }();
@@ -652,7 +653,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
               }
             }, _callee6);
           }));
-          return function auth(_x8) {
+          return function auth(_x9) {
             return _ref6.apply(this, arguments);
           };
         }();
@@ -739,7 +740,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
             }
           }, _callee7);
         }));
-        return function (_x9) {
+        return function (_x10) {
           return _ref9.apply(this, arguments);
         };
       }());

package/dist/cjs/document/catchupv2.js

@@ -8,6 +8,9 @@ exports.catchupv2 = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _utils = require("../helpers/utils");
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 var logger = (0, _utils.createLogger)('Catchupv2', 'red');
 var catchupv2 = exports.catchupv2 = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(opt) {
@@ -18,7 +21,7 @@ var catchupv2 = exports.catchupv2 = /*#__PURE__*/function () {
           fromVersion = opt.getCurrentPmVersion();
           _context.prev = 1;
           _context.next = 4;
-          return opt.fetchCatchupv2(fromVersion, opt.clientId);
+          return opt.fetchCatchupv2(fromVersion, opt.clientId, opt.catchUpOutofSync);
         case 4:
           _yield$opt$fetchCatch = _context.sent;
           steps = _yield$opt$fetchCatch.steps;
@@ -40,21 +43,43 @@ var catchupv2 = exports.catchupv2 = /*#__PURE__*/function () {
           };
           opt.onStepsAdded(stepsPayload);
           opt.updateMetadata(metadata);
-          _context.next = 26;
-          break;
-        case 21:
-          _context.prev = 21;
+          return _context.abrupt("return", Boolean(opt.clientId && isOutOfSync(fromVersion, opt.getCurrentPmVersion(), steps, opt.clientId)));
+        case 22:
+          _context.prev = 22;
           _context.t1 = _context["catch"](14);
           (_opt$analyticsHelper2 = opt.analyticsHelper) === null || _opt$analyticsHelper2 === void 0 || _opt$analyticsHelper2.sendErrorEvent(_context.t1, 'Failed to apply catchupv2 result in the editor');
           logger("Apply catchupv2 steps failed:", _context.t1.message);
           throw _context.t1;
-        case 26:
+        case 27:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[1, 9], [14, 21]]);
+    }, _callee, null, [[1, 9], [14, 22]]);
   }));
   return function catchupv2(_x) {
     return _ref.apply(this, arguments);
   };
-}();
+}();
+var isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId) {
+  return (
+    // If version number hasn't increased, and steps are not from our client, we're out of sync
+    Boolean(fromVersion >= currentVersion && checkForeignSteps(steps, clientId))
+  );
+};
+var checkForeignSteps = function checkForeignSteps(steps, clientId) {
+  var _iterator = _createForOfIteratorHelper(steps),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var step = _step.value;
+      if (step.clientId !== clientId) {
+        return true;
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return false;
+};

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

@@ -47,17 +47,18 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
-  function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
+  function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, isNameSpaceLocked) {
     var _this = this;
-    var enableErrorOnFailedDocumentApply = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
-    var reconcileOnRecovery = arguments.length > 11 && arguments[11] !== undefined ? arguments[11] : false;
-    var options = arguments.length > 12 && arguments[12] !== undefined ? arguments[12] : {
+    var enableErrorOnFailedDocumentApply = arguments.length > 11 && arguments[11] !== undefined ? arguments[11] : false;
+    var reconcileOnRecovery = arguments.length > 12 && arguments[12] !== undefined ? arguments[12] : false;
+    var options = arguments.length > 13 && arguments[13] !== undefined ? arguments[13] : {
       __livePage: false
     };
     (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, "aggressiveCatchup", false);
+    (0, _defineProperty2.default)(this, "catchUpOutofSync", false);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */
@@ -155,43 +156,52 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             logger("Queue is paused. Aborting.");
             return _context2.abrupt("return");
           case 4:
+            if (!_this.isNameSpaceLocked()) {
+              _context2.next = 7;
+              break;
+            }
+            logger("catchupv2: Document is locked. Aborting.");
+            return _context2.abrupt("return");
+          case 7:
             _this.stepQueue.pauseQueue();
-            _context2.prev = 5;
-            _context2.next = 8;
+            _context2.prev = 8;
+            _context2.next = 11;
             return (0, _catchupv.catchupv2)({
               getCurrentPmVersion: _this.getCurrentPmVersion,
               fetchCatchupv2: _this.fetchCatchupv2,
               updateMetadata: _this.metadataService.updateMetadata,
               analyticsHelper: _this.analyticsHelper,
               clientId: _this.clientId,
-              onStepsAdded: _this.onStepsAdded
+              onStepsAdded: _this.onStepsAdded,
+              catchUpOutofSync: _this.catchUpOutofSync
             });
-          case 8:
+          case 11:
+            _this.catchUpOutofSync = _context2.sent;
             latency = new Date().getTime() - start;
             (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.SUCCESS, {
               latency: latency
             });
-            _context2.next = 16;
+            _context2.next = 20;
             break;
-          case 12:
-            _context2.prev = 12;
-            _context2.t0 = _context2["catch"](5);
+          case 16:
+            _context2.prev = 16;
+            _context2.t0 = _context2["catch"](8);
             _latency2 = new Date().getTime() - start;
             (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.FAILURE, {
               latency: _latency2
             });
-          case 16:
-            _context2.prev = 16;
+          case 20:
+            _context2.prev = 20;
             _this.stepQueue.resumeQueue();
             _this.processQueue();
             _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls throttledCommitStep which will either catchup on onStepsAdded or onErrorHandled
             _this.stepRejectCounter = 0;
-            return _context2.finish(16);
-          case 22:
+            return _context2.finish(20);
+          case 26:
           case "end":
             return _context2.stop();
         }
-      }, _callee2, null, [[5, 12, 16, 22]]);
+      }, _callee2, null, [[8, 16, 20, 26]]);
     })));
     (0, _defineProperty2.default)(this, "getCurrentPmVersion", function () {
       var _this$getState;
@@ -653,6 +663,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
+    this.isNameSpaceLocked = isNameSpaceLocked;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.reconcileOnRecovery = reconcileOnRecovery;
     this.options = options;

package/dist/cjs/provider/index.js

@@ -274,12 +274,12 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     _this.participantsService = new _participantsService.ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId);
     _this.metadataService = new _metadataService.MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     var reconcileOnRecovery = (0, _featureFlags.getCollabProviderFeatureFlag)('reconcileOnRecovery', _this.config.featureFlags);
+    _this.namespaceService = new _namespaceService.NamespaceService();
     _this.documentService = new _documentService.DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.channel.fetchCatchupv2, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
+    }, _this.onErrorHandled, _this.metadataService, _this.namespaceService.getIsNamespaceLocked.bind(_this.namespaceService), _this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
       __livePage: _this.config.__livePage || false
     });
-    _this.namespaceService = new _namespaceService.NamespaceService();
     _this.api = new _api.Api(config, _this.documentService, _this.channel);
     _this.sendStepsTimer = setInterval(function () {
       logger('Intervally sendStepsFromCurrentState');

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "9.26.1";
+var version = exports.version = "9.26.3";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/channel.js

@@ -215,7 +215,7 @@ export class Channel extends Emitter {
         throw error;
       }
     });
-    _defineProperty(this, "fetchCatchupv2", async (fromVersion, clientId) => {
+    _defineProperty(this, "fetchCatchupv2", async (fromVersion, clientId, catchUpOutofSync) => {
       try {
         const {
           steps,
@@ -224,7 +224,8 @@ export class Channel extends Emitter {
           path: `document/${encodeURIComponent(this.config.documentAri)}/catchupv2`,
           queryParams: {
             version: fromVersion,
-            clientId: clientId
+            clientId: clientId,
+            catchUpOutofSync
           },
           requestInit: {
             headers: {

package/dist/es2019/document/catchupv2.js

@@ -8,7 +8,7 @@ export const catchupv2 = async opt => {
     ({
       steps,
       metadata
-    } = await opt.fetchCatchupv2(fromVersion, opt.clientId));
+    } = await opt.fetchCatchupv2(fromVersion, opt.clientId, opt.catchUpOutofSync));
   } catch (error) {
     var _opt$analyticsHelper;
     (_opt$analyticsHelper = opt.analyticsHelper) === null || _opt$analyticsHelper === void 0 ? void 0 : _opt$analyticsHelper.sendErrorEvent(error, 'Error while fetching catchupv2 from server');
@@ -23,10 +23,22 @@ export const catchupv2 = async opt => {
     };
     opt.onStepsAdded(stepsPayload);
     opt.updateMetadata(metadata);
+    return Boolean(opt.clientId && isOutOfSync(fromVersion, opt.getCurrentPmVersion(), steps, opt.clientId));
   } catch (error) {
     var _opt$analyticsHelper2;
     (_opt$analyticsHelper2 = opt.analyticsHelper) === null || _opt$analyticsHelper2 === void 0 ? void 0 : _opt$analyticsHelper2.sendErrorEvent(error, 'Failed to apply catchupv2 result in the editor');
     logger(`Apply catchupv2 steps failed:`, error.message);
     throw error;
   }
+};
+const isOutOfSync = (fromVersion, currentVersion, steps, clientId) =>
+// If version number hasn't increased, and steps are not from our client, we're out of sync
+Boolean(fromVersion >= currentVersion && checkForeignSteps(steps, clientId));
+const checkForeignSteps = (steps, clientId) => {
+  for (const step of steps) {
+    if (step.clientId !== clientId) {
+      return true;
+    }
+  }
+  return false;
 };

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

@@ -34,12 +34,13 @@ export class DocumentService {
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
-  constructor(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, enableErrorOnFailedDocumentApply = false, reconcileOnRecovery = false, options = {
+  constructor(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, isNameSpaceLocked, enableErrorOnFailedDocumentApply = false, reconcileOnRecovery = false, options = {
     __livePage: false
   }) {
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
     _defineProperty(this, "aggressiveCatchup", false);
+    _defineProperty(this, "catchUpOutofSync", false);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */
@@ -111,16 +112,32 @@ export class DocumentService {
         logger(`Queue is paused. Aborting.`);
         return;
       }
+
+      /**
+       * If the database is in a transitionary state (i.e locked),
+       * it likely that another user may already be in the process of catching up.
+       *
+       * If multiple users are trying to catch up at the same time, it can lead to
+       * the database being stuck in a transitionary state due to duplicated page recovery requests.
+       * We don't wanna be stuck in a transitionary state as that will cause issues with
+       * content reconciliation and other operations.
+       */
+      // check if the document is locked -> noop
+      if (this.isNameSpaceLocked()) {
+        logger(`catchupv2: Document is locked. Aborting.`);
+        return;
+      }
       this.stepQueue.pauseQueue();
       try {
         var _this$analyticsHelper3;
-        await catchupv2({
+        this.catchUpOutofSync = await catchupv2({
           getCurrentPmVersion: this.getCurrentPmVersion,
           fetchCatchupv2: this.fetchCatchupv2,
           updateMetadata: this.metadataService.updateMetadata,
           analyticsHelper: this.analyticsHelper,
           clientId: this.clientId,
-          onStepsAdded: this.onStepsAdded
+          onStepsAdded: this.onStepsAdded,
+          catchUpOutofSync: this.catchUpOutofSync
         });
         const latency = new Date().getTime() - start;
         (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {
@@ -517,6 +534,7 @@ export class DocumentService {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
+    this.isNameSpaceLocked = isNameSpaceLocked;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.reconcileOnRecovery = reconcileOnRecovery;
     this.options = options;

package/dist/es2019/provider/index.js

@@ -229,10 +229,10 @@ export class Provider extends Emitter {
     this.participantsService = new ParticipantsService(this.analyticsHelper, undefined, this.emitCallback, this.config.getUser, this.channel.broadcast, this.channel.sendPresenceJoined, this.getPresenceData, this.setUserId);
     this.metadataService = new MetadataService(this.emitCallback, this.channel.sendMetadata);
     const reconcileOnRecovery = getCollabProviderFeatureFlag('reconcileOnRecovery', this.config.featureFlags);
-    this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.channel.fetchCatchupv2, this.channel.fetchReconcile, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService, this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
+    this.namespaceService = new NamespaceService();
+    this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.channel.fetchCatchupv2, this.channel.fetchReconcile, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService, this.namespaceService.getIsNamespaceLocked.bind(this.namespaceService), this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
       __livePage: this.config.__livePage || false
     });
-    this.namespaceService = new NamespaceService();
     this.api = new Api(config, this.documentService, this.channel);
     this.sendStepsTimer = setInterval(() => {
       logger('Intervally sendStepsFromCurrentState');

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.26.1";
+export const version = "9.26.3";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/channel.js

@@ -321,7 +321,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       };
     }());
     _defineProperty(_assertThisInitialized(_this), "fetchCatchupv2", /*#__PURE__*/function () {
-      var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(fromVersion, clientId) {
+      var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(fromVersion, clientId, catchUpOutofSync) {
         var _yield$utils$requestS2, steps, metadata, errorNotFound, errorCatchupv2;
         return _regeneratorRuntime.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
@@ -332,7 +332,8 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
               _context3.t2 = "document/".concat(encodeURIComponent(_this.config.documentAri), "/catchupv2");
               _context3.t3 = {
                 version: fromVersion,
-                clientId: clientId
+                clientId: clientId,
+                catchUpOutofSync: catchUpOutofSync
               };
               _context3.t4 = _objectSpread;
               _context3.t5 = _objectSpread;
@@ -412,7 +413,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
           }
         }, _callee3, null, [[0, 31]]);
       }));
-      return function (_x3, _x4) {
+      return function (_x3, _x4, _x5) {
         return _ref3.apply(this, arguments);
       };
     }());
@@ -485,7 +486,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
           }
         }, _callee4, null, [[0, 30]]);
       }));
-      return function (_x5, _x6) {
+      return function (_x6, _x7) {
         return _ref4.apply(this, arguments);
       };
     }());
@@ -620,7 +621,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
               }
             }, _callee5, null, [[1, 9]]);
           }));
-          return function auth(_x7) {
+          return function auth(_x8) {
             return _ref5.apply(this, arguments);
           };
         }();
@@ -645,7 +646,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
               }
             }, _callee6);
           }));
-          return function auth(_x8) {
+          return function auth(_x9) {
             return _ref6.apply(this, arguments);
           };
         }();
@@ -732,7 +733,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
             }
           }, _callee7);
         }));
-        return function (_x9) {
+        return function (_x10) {
           return _ref9.apply(this, arguments);
         };
       }());

package/dist/esm/document/catchupv2.js

@@ -1,4 +1,7 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { createLogger } from '../helpers/utils';
 var logger = createLogger('Catchupv2', 'red');
@@ -11,7 +14,7 @@ export var catchupv2 = /*#__PURE__*/function () {
           fromVersion = opt.getCurrentPmVersion();
           _context.prev = 1;
           _context.next = 4;
-          return opt.fetchCatchupv2(fromVersion, opt.clientId);
+          return opt.fetchCatchupv2(fromVersion, opt.clientId, opt.catchUpOutofSync);
         case 4:
           _yield$opt$fetchCatch = _context.sent;
           steps = _yield$opt$fetchCatch.steps;
@@ -33,21 +36,43 @@ export var catchupv2 = /*#__PURE__*/function () {
           };
           opt.onStepsAdded(stepsPayload);
           opt.updateMetadata(metadata);
-          _context.next = 26;
-          break;
-        case 21:
-          _context.prev = 21;
+          return _context.abrupt("return", Boolean(opt.clientId && isOutOfSync(fromVersion, opt.getCurrentPmVersion(), steps, opt.clientId)));
+        case 22:
+          _context.prev = 22;
           _context.t1 = _context["catch"](14);
           (_opt$analyticsHelper2 = opt.analyticsHelper) === null || _opt$analyticsHelper2 === void 0 || _opt$analyticsHelper2.sendErrorEvent(_context.t1, 'Failed to apply catchupv2 result in the editor');
           logger("Apply catchupv2 steps failed:", _context.t1.message);
           throw _context.t1;
-        case 26:
+        case 27:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[1, 9], [14, 21]]);
+    }, _callee, null, [[1, 9], [14, 22]]);
   }));
   return function catchupv2(_x) {
     return _ref.apply(this, arguments);
   };
-}();
+}();
+var isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId) {
+  return (
+    // If version number hasn't increased, and steps are not from our client, we're out of sync
+    Boolean(fromVersion >= currentVersion && checkForeignSteps(steps, clientId))
+  );
+};
+var checkForeignSteps = function checkForeignSteps(steps, clientId) {
+  var _iterator = _createForOfIteratorHelper(steps),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var step = _step.value;
+      if (step.clientId !== clientId) {
+        return true;
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return false;
+};

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

@@ -40,17 +40,18 @@ export var DocumentService = /*#__PURE__*/function () {
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
-  function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
+  function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, isNameSpaceLocked) {
     var _this = this;
-    var enableErrorOnFailedDocumentApply = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
-    var reconcileOnRecovery = arguments.length > 11 && arguments[11] !== undefined ? arguments[11] : false;
-    var options = arguments.length > 12 && arguments[12] !== undefined ? arguments[12] : {
+    var enableErrorOnFailedDocumentApply = arguments.length > 11 && arguments[11] !== undefined ? arguments[11] : false;
+    var reconcileOnRecovery = arguments.length > 12 && arguments[12] !== undefined ? arguments[12] : false;
+    var options = arguments.length > 13 && arguments[13] !== undefined ? arguments[13] : {
       __livePage: false
     };
     _classCallCheck(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
     _defineProperty(this, "aggressiveCatchup", false);
+    _defineProperty(this, "catchUpOutofSync", false);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */
@@ -148,43 +149,52 @@ export var DocumentService = /*#__PURE__*/function () {
             logger("Queue is paused. Aborting.");
             return _context2.abrupt("return");
           case 4:
+            if (!_this.isNameSpaceLocked()) {
+              _context2.next = 7;
+              break;
+            }
+            logger("catchupv2: Document is locked. Aborting.");
+            return _context2.abrupt("return");
+          case 7:
             _this.stepQueue.pauseQueue();
-            _context2.prev = 5;
-            _context2.next = 8;
+            _context2.prev = 8;
+            _context2.next = 11;
             return catchupv2({
               getCurrentPmVersion: _this.getCurrentPmVersion,
               fetchCatchupv2: _this.fetchCatchupv2,
               updateMetadata: _this.metadataService.updateMetadata,
               analyticsHelper: _this.analyticsHelper,
               clientId: _this.clientId,
-              onStepsAdded: _this.onStepsAdded
+              onStepsAdded: _this.onStepsAdded,
+              catchUpOutofSync: _this.catchUpOutofSync
             });
-          case 8:
+          case 11:
+            _this.catchUpOutofSync = _context2.sent;
             latency = new Date().getTime() - start;
             (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {
               latency: latency
             });
-            _context2.next = 16;
+            _context2.next = 20;
             break;
-          case 12:
-            _context2.prev = 12;
-            _context2.t0 = _context2["catch"](5);
+          case 16:
+            _context2.prev = 16;
+            _context2.t0 = _context2["catch"](8);
             _latency2 = new Date().getTime() - start;
             (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.FAILURE, {
               latency: _latency2
             });
-          case 16:
-            _context2.prev = 16;
+          case 20:
+            _context2.prev = 20;
             _this.stepQueue.resumeQueue();
             _this.processQueue();
             _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls throttledCommitStep which will either catchup on onStepsAdded or onErrorHandled
             _this.stepRejectCounter = 0;
-            return _context2.finish(16);
-          case 22:
+            return _context2.finish(20);
+          case 26:
           case "end":
             return _context2.stop();
         }
-      }, _callee2, null, [[5, 12, 16, 22]]);
+      }, _callee2, null, [[8, 16, 20, 26]]);
     })));
     _defineProperty(this, "getCurrentPmVersion", function () {
       var _this$getState;
@@ -646,6 +656,7 @@ export var DocumentService = /*#__PURE__*/function () {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
+    this.isNameSpaceLocked = isNameSpaceLocked;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.reconcileOnRecovery = reconcileOnRecovery;
     this.options = options;

package/dist/esm/provider/index.js

@@ -267,12 +267,12 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this.participantsService = new ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId);
     _this.metadataService = new MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     var reconcileOnRecovery = getCollabProviderFeatureFlag('reconcileOnRecovery', _this.config.featureFlags);
+    _this.namespaceService = new NamespaceService();
     _this.documentService = new DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.channel.fetchCatchupv2, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
+    }, _this.onErrorHandled, _this.metadataService, _this.namespaceService.getIsNamespaceLocked.bind(_this.namespaceService), _this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
       __livePage: _this.config.__livePage || false
     });
-    _this.namespaceService = new NamespaceService();
     _this.api = new Api(config, _this.documentService, _this.channel);
     _this.sendStepsTimer = setInterval(function () {
       logger('Intervally sendStepsFromCurrentState');

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "9.26.1";
+export var version = "9.26.3";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/types/channel.d.ts

@@ -39,7 +39,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
     private onConnect;
     private onReceiveData;
     fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>;
-    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined) => Promise<Catchupv2Response>;
+    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean | undefined) => Promise<Catchupv2Response>;
     fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>;
     /**
      * Send message to the back-end service over the channel. Timestamp will be added server side.

package/dist/types/document/catchupv2.d.ts

@@ -1,2 +1,2 @@
 import type { Catchupv2Options } from '../types';
-export declare const catchupv2: (opt: Catchupv2Options) => Promise<void>;
+export declare const catchupv2: (opt: Catchupv2Options) => Promise<boolean>;

package/dist/types/document/document-service.d.ts

@@ -19,6 +19,7 @@ export declare class DocumentService {
     private getUserId;
     private onErrorHandled;
     private metadataService;
+    private isNameSpaceLocked;
     private enableErrorOnFailedDocumentApply;
     private reconcileOnRecovery;
     private options;
@@ -27,6 +28,7 @@ export declare class DocumentService {
     private stepQueue;
     private stepRejectCounter;
     private aggressiveCatchup;
+    private catchUpOutofSync;
     private clientId?;
     /**
      *
@@ -43,7 +45,7 @@ export declare class DocumentService {
      * @param metadataService
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, enableErrorOnFailedDocumentApply?: boolean, reconcileOnRecovery?: boolean, options?: {
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, isNameSpaceLocked: () => boolean, enableErrorOnFailedDocumentApply?: boolean, reconcileOnRecovery?: boolean, options?: {
         __livePage: boolean;
     });
     /**

package/dist/types/types.d.ts

@@ -209,11 +209,12 @@ export interface CatchupOptions {
 }
 export interface Catchupv2Options {
     getCurrentPmVersion: () => number;
-    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined) => Promise<Catchupv2Response>;
+    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean) => Promise<Catchupv2Response>;
     updateMetadata: (metadata: Metadata | undefined) => void;
     analyticsHelper: AnalyticsHelper | undefined;
     clientId: number | string | undefined;
     onStepsAdded: (data: StepsPayload) => void;
+    catchUpOutofSync: boolean;
 }
 export type ProductInformation = {
     product: string;

package/dist/types-ts4.5/channel.d.ts

@@ -39,7 +39,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
     private onConnect;
     private onReceiveData;
     fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>;
-    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined) => Promise<Catchupv2Response>;
+    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean | undefined) => Promise<Catchupv2Response>;
     fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>;
     /**
      * Send message to the back-end service over the channel. Timestamp will be added server side.

package/dist/types-ts4.5/document/catchupv2.d.ts

@@ -1,2 +1,2 @@
 import type { Catchupv2Options } from '../types';
-export declare const catchupv2: (opt: Catchupv2Options) => Promise<void>;
+export declare const catchupv2: (opt: Catchupv2Options) => Promise<boolean>;

package/dist/types-ts4.5/document/document-service.d.ts

@@ -19,6 +19,7 @@ export declare class DocumentService {
     private getUserId;
     private onErrorHandled;
     private metadataService;
+    private isNameSpaceLocked;
     private enableErrorOnFailedDocumentApply;
     private reconcileOnRecovery;
     private options;
@@ -27,6 +28,7 @@ export declare class DocumentService {
     private stepQueue;
     private stepRejectCounter;
     private aggressiveCatchup;
+    private catchUpOutofSync;
     private clientId?;
     /**
      *
@@ -43,7 +45,7 @@ export declare class DocumentService {
      * @param metadataService
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, enableErrorOnFailedDocumentApply?: boolean, reconcileOnRecovery?: boolean, options?: {
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, isNameSpaceLocked: () => boolean, enableErrorOnFailedDocumentApply?: boolean, reconcileOnRecovery?: boolean, options?: {
         __livePage: boolean;
     });
     /**

package/dist/types-ts4.5/types.d.ts

@@ -209,11 +209,12 @@ export interface CatchupOptions {
 }
 export interface Catchupv2Options {
     getCurrentPmVersion: () => number;
-    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined) => Promise<Catchupv2Response>;
+    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean) => Promise<Catchupv2Response>;
     updateMetadata: (metadata: Metadata | undefined) => void;
     analyticsHelper: AnalyticsHelper | undefined;
     clientId: number | string | undefined;
     onStepsAdded: (data: StepsPayload) => void;
+    catchUpOutofSync: boolean;
 }
 export type ProductInformation = {
     product: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.26.1",
+  "version": "9.26.3",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -39,7 +39,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.9.0",
-    "@atlaskit/editor-common": "^78.28.0",
+    "@atlaskit/editor-common": "^78.29.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "3.0.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",