@atlaskit/collab-provider 8.8.1 → 8.9.0

package/dist/cjs/provider/index.js

@@ -20,16 +20,15 @@ var _channel = require("../channel");
 var _utils = require("../helpers/utils");
 var _analyticsHelper = _interopRequireDefault(require("../analytics/analytics-helper"));
 var _telepointersHelper = require("../participants/telepointers-helper");
-var _participantsService = require("../participants/participants-service");
 var _errorTypes = require("../errors/error-types");
 var _metadataService = require("../metadata/metadata-service");
 var _documentService = require("../document/document-service");
+var _namespaceService = require("../namespace/namespace-service");
+var _participantsService = require("../participants/participants-service");
 var _errorCodeMapper = require("../errors/error-code-mapper");
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 var logger = (0, _utils.createLogger)('Provider', 'black');
-var SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
-
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
 var MAX_STEP_REJECTED_ERROR = 15;
@@ -43,10 +42,25 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     _this = _super.call(this);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isChannelInitialized", false);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isProviderInitialized", false);
-    // To keep track of the namespace event changes from the server.
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isNamespaceLocked", false);
+    // isPreinitializating acts as a feature flag to determine when the provider has been initialized early
+    // and also contains the initial draft
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isPreinitializing", false);
+    /**
+     * Wrapper for this.emit, it binds scope for callbacks and waits for initialising of the editor before emitting events.
+     * Waiting for the collab provider to become connected to the editor ensures the editor doesn't miss any events.
+     * @param evt - Event name to emit to subscribers
+     * @param data - Event data to emit to subscribers
+     */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "emitCallback", function (evt, data) {
-      return _this.emit(evt, data);
+      // When the provider is initialized early, we want the editor state promise to resolve before emitting events
+      // to ensure that it is ready to listen to the events fired by NCS
+      if (_this.isPreinitializing) {
+        _this.getStatePromise.then(function () {
+          return _this.emit(evt, data);
+        });
+      } else {
+        _this.emit(evt, data);
+      }
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "initializeChannel", function () {
       _this.emit('connecting', {
@@ -57,7 +71,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         var sid = _ref.sid,
           initialized = _ref.initialized;
         _this.sessionId = sid;
-        _this.emit('connected', {
+        _this.emitCallback('connected', {
           sid: sid,
           initial: !initialized
         });
@@ -83,7 +97,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         Date.now() - _this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
           _this.documentService.throttledCatchup();
         }
-        _this.startInactiveRemover();
+        _this.participantsService.startInactiveRemover(_this.sessionId);
         _this.disconnectedAt = undefined;
       }).on('init', function (_ref2) {
         var doc = _ref2.doc,
@@ -96,7 +110,10 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           metadata: metadata
         });
         _this.metadataService.updateMetadata(metadata);
-      }).on('restore', _this.documentService.onRestore).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', _this.onParticipantTelepointer.bind((0, _assertThisInitialized2.default)(_this))).on('presence:joined', _this.onPresenceJoined.bind((0, _assertThisInitialized2.default)(_this))).on('presence', _this.onPresence.bind((0, _assertThisInitialized2.default)(_this))).on('participant:left', _this.onParticipantLeft.bind((0, _assertThisInitialized2.default)(_this))).on('participant:updated', _this.onParticipantUpdated.bind((0, _assertThisInitialized2.default)(_this))).on('disconnect', _this.onDisconnected.bind((0, _assertThisInitialized2.default)(_this))).on('error', _this.onErrorHandled).on('status', _this.onNamespaceStatusChanged.bind((0, _assertThisInitialized2.default)(_this))).connect(shouldInitialize);
+        _this.isProviderInitialized = true;
+      }).on('restore', _this.documentService.onRestore).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
+        return _this.participantsService.onParticipantTelepointer(payload, _this.sessionId);
+      }).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind((0, _assertThisInitialized2.default)(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
     });
     /**
      * @param {InternalError} error The error to handle
@@ -116,90 +133,15 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         if (mappedError) {
           var _this$analyticsHelper2;
           (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendErrorEvent(mappedError, 'Error emitted');
-          _this.emit('error', mappedError);
+          _this.emitCallback('error', mappedError);
         }
       }
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "sendPresence", function () {
-      try {
-        if (_this.presenceUpdateTimeout) {
-          clearTimeout(_this.presenceUpdateTimeout);
-        }
-        _this.channel.broadcast('participant:updated', {
-          sessionId: _this.sessionId,
-          userId: _this.userId,
-          clientId: _this.clientId
-        });
-        _this.presenceUpdateTimeout = window.setTimeout(function () {
-          return _this.sendPresence();
-        }, SEND_PRESENCE_INTERVAL);
-      } catch (error) {
-        var _this$analyticsHelper3;
-        // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error while sending presence');
-      }
-    });
-    /**
-     * Called when a participant joins the session.
-     *
-     * We keep track of participants internally in this class, and emit the `presence` event to update
-     * the active avatars in the editor.
-     * This method will be triggered from backend to notify all participants to exchange presence
-     */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onPresenceJoined", function (_ref3) {
-      var sessionId = _ref3.sessionId;
-      try {
-        logger('Participant joined with session: ', sessionId);
-        // This expose existing users to the newly joined user
-        _this.sendPresence();
-      } catch (error) {
-        var _this$analyticsHelper4;
-        // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(error, 'Error while joining presence');
-      }
-    });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onPresence", function (_ref4) {
-      var userId = _ref4.userId;
-      try {
-        logger('onPresence userId: ', userId);
-        _this.userId = userId;
-        _this.sendPresence();
-        _this.channel.sendPresenceJoined();
-      } catch (error) {
-        var _this$analyticsHelper5;
-        // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(error, 'Error while receiving presence');
-      }
-    });
-    /**
-     * Called when a participant leaves the session.
-     *
-     * We emit the `presence` event to update the active avatars in the editor.
-     */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onParticipantLeft", function (data) {
-      return _this.participantsService.participantLeft(data, _this.emitCallback);
-    });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "startInactiveRemover", function () {
-      return _this.participantsService.removeInactiveParticipants(_this.sessionId, _this.emitCallback);
-    });
-    /**
-     * Called when we receive an update event from another participant.
-     */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onParticipantUpdated", function (data) {
-      return _this.participantsService.updateParticipant(data, _this.config.getUser, _this.emitCallback);
-    });
-    /**
-     * Called when we receive a telepointer update from another
-     * participant.
-     */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onParticipantTelepointer", function (data) {
-      return _this.participantsService.participantTelepointer(data, _this.sessionId, _this.config.getUser, _this.emitCallback);
-    });
     // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onDisconnected", function (_ref5) {
-      var reason = _ref5.reason;
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onDisconnected", function (_ref3) {
+      var reason = _ref3.reason;
       _this.disconnectedAt = Date.now();
-      _this.participantsService.disconnect(reason, _this.sessionId, _this.emitCallback);
+      _this.participantsService.disconnect(reason, _this.sessionId);
     });
     /**
      * Returns the documents metadata
@@ -213,7 +155,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
      * @throws {GetCurrentStateError} Something went wrong while returning the current state
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getCurrentState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-      var _this$analyticsHelper6;
+      var _this$analyticsHelper3;
       return _regenerator.default.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
@@ -222,7 +164,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           case 4:
             _context.prev = 4;
             _context.t0 = _context["catch"](0);
-            (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
+            (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
             throw new _errorTypes.GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
           case 8:
           case "end":
@@ -236,7 +178,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
-      var _this$analyticsHelper7;
+      var _this$analyticsHelper4;
       return _regenerator.default.wrap(function _callee2$(_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
@@ -245,7 +187,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           case 4:
             _context2.prev = 4;
             _context2.t0 = _context2["catch"](0);
-            (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
+            (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
             throw new _errorTypes.GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
           case 8:
           case "end":
@@ -256,51 +198,6 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getUnconfirmedSteps", function () {
       return _this.documentService.getUnconfirmedSteps();
     });
-    /**
-     * ESS-2916 namespace status event- lock/unlock
-     */
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onNamespaceStatusChanged", /*#__PURE__*/function () {
-      var _ref8 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(data) {
-        var isLocked, waitTimeInMs, timestamp, start;
-        return _regenerator.default.wrap(function _callee3$(_context3) {
-          while (1) switch (_context3.prev = _context3.next) {
-            case 0:
-              isLocked = data.isLocked, waitTimeInMs = data.waitTimeInMs, timestamp = data.timestamp;
-              start = Date.now();
-              logger("Received a namespace status changed event ", {
-                data: data
-              });
-              if (!(isLocked && waitTimeInMs)) {
-                _context3.next = 8;
-                break;
-              }
-              _this.isNamespaceLocked = true;
-              logger("Received a namespace status change event ", {
-                isLocked: isLocked
-              });
-
-              // To protect the collab editing process from locked out due to BE
-              setTimeout(function () {
-                logger("The namespace lock has expired", {
-                  waitTime: Date.now() - start,
-                  timestamp: timestamp
-                });
-                _this.isNamespaceLocked = false;
-              }, waitTimeInMs);
-              return _context3.abrupt("return");
-            case 8:
-              _this.isNamespaceLocked = false;
-              logger("The page lock has expired");
-            case 10:
-            case "end":
-              return _context3.stop();
-          }
-        }, _callee3);
-      }));
-      return function (_x) {
-        return _ref8.apply(this, arguments);
-      };
-    }());
     /**
      * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
      */
@@ -314,11 +211,16 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     _this.isChannelInitialized = false;
     _this.initialDraft = _this.config.initialDraft;
     _this.isProviderInitialized = false;
-    _this.participantsService = new _participantsService.ParticipantsService(_this.analyticsHelper);
+    _this.isPreinitializing = false;
+    _this.participantsService = new _participantsService.ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined);
     _this.metadataService = new _metadataService.MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     _this.documentService = new _documentService.DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
     }, _this.onErrorHandled, _this.metadataService);
+    _this.getStatePromise = new Promise(function (resolve) {
+      _this.getStatePromiseResolve = resolve;
+    });
+    _this.namespaceService = new _namespaceService.NamespaceService();
     return _this;
   }
   (0, _createClass2.default)(Provider, [{
@@ -337,38 +239,54 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     }
 
     /**
-     * Initialisation logic, called by the editor in the collab-edit plugin
-     * @param {Object} parameters ...
-     * @param {Function} parameters.getState Function that returns the editor state, used to retrieve collab-edit properties and to interact with prosemirror-collab
-     * @param {SyncUpErrorFunction} parameters.onSyncUpError (Optional) Function that gets called when the sync of steps fails after retrying 30 times, used by Editor to log to analytics
+     * Initialisation logic, called by the editor in the collab-edit plugin.
+     *
+     * When getState is nullish and a initialDraft is provided the collab provider is in a state of pre-initialization,
+     * the provider starts to enable the connection to NCS, but the provider will not emit any events until this function
+     * is called again with a getState function, indicating that the editor is loaded and ready to receive the emits.
+     *
+     * @param {Object} options ...
+     * @param {Function} options.getState Function that returns the editor state, used to retrieve collab-edit properties and to interact with prosemirror-collab
+     * @param {SyncUpErrorFunction} options.onSyncUpError (Optional) Function that gets called when the sync of steps fails after retrying 30 times, used by Editor to log to analytics
      * @throws {ProviderInitialisationError} Something went wrong during provider initialisation
      */
   }, {
     key: "setup",
-    value: function setup(_ref9) {
-      var getState = _ref9.getState,
-        onSyncUpError = _ref9.onSyncUpError;
+    value: function setup(_ref6) {
+      var getState = _ref6.getState,
+        onSyncUpError = _ref6.onSyncUpError;
       this.checkForCookies();
       try {
-        var collabPlugin = getState().plugins.find(function (p) {
-          return p.key === 'collab$';
-        });
-        if (collabPlugin === undefined) {
-          throw new _errorTypes.ProviderInitialisationError('Collab provider attempted to initialise, but Editor state is missing collab plugin');
+        // if setup is called with no state and the initial draft is already provided
+        // set a flag to mark early provider setup
+        if (!getState && this.initialDraft) {
+          this.isPreinitializing = true;
+        }
+        if (getState) {
+          // if provider has already been initialized earlier, resolve the state once it is available
+          if (this.isPreinitializing) {
+            this.getStatePromiseResolve();
+          }
+          var collabPlugin = getState().plugins.find(function (p) {
+            return p.key === 'collab$';
+          });
+          if (collabPlugin === undefined) {
+            throw new _errorTypes.ProviderInitialisationError('Collab provider attempted to initialise, but Editor state is missing collab plugin');
+          }
+          this.clientId = collabPlugin.spec.config.clientID;
+          this.documentService.setup({
+            getState: getState,
+            onSyncUpError: onSyncUpError,
+            clientId: this.clientId
+          });
         }
-        this.clientId = collabPlugin.spec.config.clientID;
-        this.documentService.setup({
-          getState: getState,
-          onSyncUpError: onSyncUpError,
-          clientId: this.clientId
-        });
         if (!this.isChannelInitialized) {
           this.initializeChannel();
           this.isChannelInitialized = true;
         }
       } catch (initError) {
-        var _this$analyticsHelper8;
-        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(initError, 'Error while initialising the provider');
+        var _this$analyticsHelper5;
+        (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(initError, 'Error while initialising the provider');
         // Throw error so consumers are aware the initialisation failed when initialising themselves
         throw new _errorTypes.ProviderInitialisationError('Provider initialisation error', initError);
       }
@@ -378,9 +296,9 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     key: "checkForCookies",
     value: function checkForCookies() {
       if (!global.navigator.cookieEnabled) {
-        var _this$analyticsHelper9;
+        var _this$analyticsHelper6;
         var initError = new _errorTypes.ProviderInitialisationError('Cookies are not enabled. Please enable cookies to use collaborative editing.');
-        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
+        (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
         throw new _errorTypes.ProviderInitialisationError('Provider initialisation error - cookies disabled', initError);
       }
     }
@@ -397,14 +315,14 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     value: function send(_tr, _oldState, newState) {
       try {
         // Don't send steps while the document is locked (eg. when restoring the document)
-        if (this.isNamespaceLocked) {
+        if (this.namespaceService.getIsNamespaceLocked()) {
           logger('The document is temporary locked');
           return;
         }
         this.documentService.send(_tr, _oldState, newState);
       } catch (error) {
-        var _this$analyticsHelper10;
-        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while sending steps for a transaction');
+        var _this$analyticsHelper7;
+        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(error, 'Error while sending steps for a transaction');
         throw new _errorTypes.SendTransactionError('Error while sending steps for a transaction', error);
       }
     }
@@ -432,9 +350,9 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           this.channel.broadcast('participant:telepointer', payload, callback);
         }
       } catch (error) {
-        var _this$analyticsHelper11;
+        var _this$analyticsHelper8;
         // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while sending message - telepointer');
+        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(error, 'Error while sending message - telepointer');
       }
     }
   }, {
@@ -473,8 +391,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         (0, _get2.default)((0, _getPrototypeOf2.default)(Provider.prototype), "unsubscribeAll", this).call(this);
         this.channel.disconnect();
       } catch (error) {
-        var _this$analyticsHelper12;
-        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while shutting down the collab provider');
+        var _this$analyticsHelper9;
+        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(error, 'Error while shutting down the collab provider');
         throw new _errorTypes.DestroyError('Error while shutting down the collab provider', error);
       }
       this.clearTimers();
@@ -494,8 +412,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setTitle(title, broadcast);
       } catch (error) {
-        var _this$analyticsHelper13;
-        (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting title');
+        var _this$analyticsHelper10;
+        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while setting title');
         throw new _errorTypes.SetTitleError('Error while setting title', error);
       }
     }
@@ -513,8 +431,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setEditorWidth(editorWidth, broadcast);
       } catch (error) {
-        var _this$analyticsHelper14;
-        (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendErrorEvent(error, 'Error while setting editor width');
+        var _this$analyticsHelper11;
+        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while setting editor width');
         throw new _errorTypes.SetEditorWidthError('Error while setting editor width', error);
       }
     }
@@ -530,8 +448,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setMetadata(metadata);
       } catch (error) {
-        var _this$analyticsHelper15;
-        (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendErrorEvent(error, 'Error while setting metadata');
+        var _this$analyticsHelper12;
+        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while setting metadata');
         throw new _errorTypes.SetMetadataError('Error while setting metadata', error);
       }
     }

package/dist/cjs/version-wrapper.js

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

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "8.8.1",
+	"version": "8.9.0",
 	"sideEffects": false
 }

package/dist/es2019/analytics/analytics-helper.js

@@ -29,18 +29,27 @@ const triggerAnalyticsEvent = (analyticsEvent, analyticsClient) => {
 
   if (analyticsEvent.eventAction === EVENT_ACTION.ERROR) {
     payload.nonPrivacySafeAttributes = analyticsEvent.nonPrivacySafeAttributes;
-  }
-
-  // Let the browser figure out
-  // when it should send those events
-  try {
-    const requestIdleCallbackFunction = window.requestIdleCallback;
-    const runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame;
-    runItLater(() => {
-      analyticsClient.sendOperationalEvent(payload);
-    });
-  } catch (error) {
-    // silently fail for now https://product-fabric.atlassian.net/browse/ESS-3112
+    try {
+      const requestIdleCallbackFunction = window.requestIdleCallback;
+      const runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame;
+      runItLater(() => {
+        analyticsClient.sendTrackEvent(payload);
+      });
+    } catch (error) {
+      // silently fail for now https://product-fabric.atlassian.net/browse/ESS-3112
+    }
+  } else {
+    // Let the browser figure out
+    // when it should send those events
+    try {
+      const requestIdleCallbackFunction = window.requestIdleCallback;
+      const runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame;
+      runItLater(() => {
+        analyticsClient.sendOperationalEvent(payload);
+      });
+    } catch (error) {
+      // silently fail for now https://product-fabric.atlassian.net/browse/ESS-3112
+    }
   }
 };
 export default class AnalyticsHelper {

package/dist/es2019/channel.js

@@ -308,10 +308,13 @@ export class Channel extends Emitter {
               // save token locally
               this.setToken(token);
               authData.token = token;
+            } else {
+              this.unsetToken();
+              authData.token = undefined;
             }
             cb(authData);
           } catch (error) {
-            var _err, _err$data, _err$data$meta;
+            var _data, _data$meta;
             // Pass the error back to the consumers so they can deal with exceptional cases themselves (eg. no permissions because the page was deleted)
             const authenticationError = {
               message: 'Insufficient editing permissions',
@@ -320,8 +323,7 @@ export class Channel extends Emitter {
                 code: INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR,
                 meta: {
                   originalError: error,
-                  // @ts-expect-error we know the error structure passed in this hack
-                  reason: (_err = err) === null || _err === void 0 ? void 0 : (_err$data = _err.data) === null || _err$data === void 0 ? void 0 : (_err$data$meta = _err$data.meta) === null || _err$data$meta === void 0 ? void 0 : _err$data$meta.reason // Should always be 'RESOURCE_DELETED' Temporary, until Confluence Cloud removes their hack
+                  reason: error === null || error === void 0 ? void 0 : (_data = error.data) === null || _data === void 0 ? void 0 : (_data$meta = _data.meta) === null || _data$meta === void 0 ? void 0 : _data$meta.reason // Should always be 'RESOURCE_DELETED' Temporary, until Confluence Cloud removes their hack
                   // https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/browse/next/packages/native-collab/src/fetchCollabPermissionToken.ts#37
                 }
               }

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

@@ -390,7 +390,7 @@ export class DocumentService {
         });
         // If steps can apply to local editor successfully, no need to accumulate the error counter.
         this.stepRejectCounter = 0;
-        this.participantsService.emitTelepointersFromSteps(steps, this.providerEmitCallback);
+        this.participantsService.emitTelepointersFromSteps(steps);
 
         // Resend local steps if none of the received steps originated with us!
         if (clientIds.indexOf(this.clientId) === -1) {

package/dist/es2019/errors/error-code-mapper.js

@@ -5,7 +5,7 @@ import { INTERNAL_ERROR_CODE, PROVIDER_ERROR_CODE } from './error-types';
  * Maps internal collab provider errors to an emitted error format
  */
 export const errorCodeMapper = error => {
-  var _error$data, _error$data2, _error$data3;
+  var _error$data, _error$data2, _error$data3, _error$data4;
   switch ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) {
     case NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED:
     case NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS:
@@ -88,7 +88,6 @@ export const errorCodeMapper = error => {
     case NCS_ERROR_CODE.NAMESPACE_NOT_FOUND:
     case NCS_ERROR_CODE.ERROR_MAPPING_ERROR:
     case NCS_ERROR_CODE.EMPTY_BROADCAST:
-    case INTERNAL_ERROR_CODE.CATCHUP_FAILED:
       return {
         code: PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
         message: 'Collab Provider experienced an unrecoverable error',
@@ -96,6 +95,14 @@ export const errorCodeMapper = error => {
         reason: (_error$data3 = error.data) === null || _error$data3 === void 0 ? void 0 : _error$data3.code,
         status: 500
       };
+    case INTERNAL_ERROR_CODE.CATCHUP_FAILED:
+      return {
+        code: PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
+        message: 'Collab Provider experienced an unrecoverable error',
+        recoverable: true,
+        reason: (_error$data4 = error.data) === null || _error$data4 === void 0 ? void 0 : _error$data4.code,
+        status: 500
+      };
     default:
       return;
   }

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

@@ -0,0 +1,48 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { createLogger } from '../helpers/utils';
+const logger = createLogger('Provider', 'orange');
+
+/**
+ * Allows us to keep track of any namespace changes from the server.
+ * @param isNamespaceLocked - whether the namespace is locked or not, defaults to false
+ */
+export class NamespaceService {
+  constructor(isNamespaceLocked = false) {
+    // Primitive values are always copied
+    _defineProperty(this, "getIsNamespaceLocked", () => this.isNamespaceLocked);
+    /**
+     * ESS-2916 namespace status event- lock/unlock
+     */
+    _defineProperty(this, "onNamespaceStatusChanged", async ({
+      isLocked,
+      waitTimeInMs,
+      timestamp
+    }) => {
+      const start = Date.now();
+      logger(`Received a namespace status changed event `, {
+        isLocked,
+        waitTimeInMs,
+        timestamp
+      });
+      if (isLocked && waitTimeInMs) {
+        this.isNamespaceLocked = true;
+        logger(`Received a namespace status change event `, {
+          isLocked
+        });
+
+        // To protect the collab editing process from locked out due to BE
+        setTimeout(() => {
+          logger(`The namespace lock has expired`, {
+            waitTime: Date.now() - start,
+            timestamp
+          });
+          this.isNamespaceLocked = false;
+        }, waitTimeInMs);
+        return;
+      }
+      this.isNamespaceLocked = false;
+      logger(`The page lock has expired`);
+    });
+    this.isNamespaceLocked = isNamespaceLocked;
+  }
+}

package/dist/es2019/participants/participants-helper.js

@@ -1,5 +1,7 @@
 export const PARTICIPANT_UPDATE_INTERVAL = 300 * 1000; // 300 seconds
 
+// Names are hard
+
 export const createParticipantFromPayload = async (payload, getUser) => {
   const {
     sessionId,