@atlaskit/collab-provider 7.6.3 → 7.7.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 7.7.0
+
+### Minor Changes
+
+- [`fa0da169cce`](https://bitbucket.org/atlassian/atlassian-frontend/commits/fa0da169cce) - Introducing namespace status update: lock & unlock events
+- [`eaada7441d0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/eaada7441d0) - ESS-2853 Add metrics for page recovery events
+- [`6319cd08784`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6319cd08784) - add page restoration event handler
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 7.6.3
 
 ### Patch Changes

package/dist/cjs/channel.js

@@ -117,6 +117,19 @@ var Channel = /*#__PURE__*/function (_Emitter) {
             userId: userId,
             metadata: metadata
           });
+        } else {
+          // Page is been just restored, need to fix all the participants as well.
+          var _doc = data.doc,
+              _version = data.version,
+              _userId = data.userId,
+              _metadata = data.metadata;
+
+          _this.emit('restore', {
+            doc: _doc,
+            version: _version,
+            userId: _userId,
+            metadata: _metadata
+          });
         }
       } else {
         _this.emit('steps:added', data);
@@ -215,6 +228,10 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       });
       this.socket.on('metadata:changed', function (payload) {
         _this2.emit('metadata:changed', payload);
+      }); // ESS-2916 namespace status event - lock/unlock
+
+      this.socket.on('status', function (data) {
+        _this2.emit('status', data);
       });
       this.socket.on('disconnect', /*#__PURE__*/function () {
         var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(reason) {

package/dist/cjs/helpers/const.js

@@ -25,6 +25,7 @@ exports.EVENT_ACTION = EVENT_ACTION;
   EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
   EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
   EVENT_ACTION["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
+  EVENT_ACTION["REINITIALISE_DOCUMENT"] = "reinitialiseDocument";
 })(EVENT_ACTION || (exports.EVENT_ACTION = EVENT_ACTION = {}));
 
 var EVENT_STATUS;

package/dist/cjs/provider/index.js

@@ -115,6 +115,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
 
   var _super = _createSuper(Provider);
 
+  // To keep track of the namespace event changes from the server.
   function Provider(config) {
     var _this;
 
@@ -124,6 +125,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "metadata", {});
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "stepRejectCounter", 0);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isChannelInitialized", false);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isNamespaceLocked", false);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "initializeChannel", function () {
       _this.channel.on('connected', function (_ref2) {
         var sid = _ref2.sid,
@@ -152,7 +154,42 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           version: version,
           metadata: metadata
         });
-      }).on('steps:added', _this.onStepsAdded.bind((0, _assertThisInitialized2.default)(_this))).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('metadata:changed', _this.onMetadataChanged.bind((0, _assertThisInitialized2.default)(_this))).on('disconnect', _this.onDisconnected.bind((0, _assertThisInitialized2.default)(_this))).on('error', _this.onErrorHandled.bind((0, _assertThisInitialized2.default)(_this))).connect();
+      }).on('restore', _this.onRestore.bind((0, _assertThisInitialized2.default)(_this))).on('steps:added', _this.onStepsAdded.bind((0, _assertThisInitialized2.default)(_this))).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('metadata:changed', _this.onMetadataChanged.bind((0, _assertThisInitialized2.default)(_this))).on('disconnect', _this.onDisconnected.bind((0, _assertThisInitialized2.default)(_this))).on('error', _this.onErrorHandled.bind((0, _assertThisInitialized2.default)(_this))).on('status', _this.onNamespaceStatusChanged.bind((0, _assertThisInitialized2.default)(_this))).connect();
+    });
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onRestore", function (_ref4) {
+      var doc = _ref4.doc,
+          version = _ref4.version,
+          metadata = _ref4.metadata;
+
+      // Preseve the unconfirmed steps to prevent data loss.
+      var _ref5 = _this.getUnconfirmedSteps() || {
+        steps: []
+      },
+          unconfirmedSteps = _ref5.steps; // Reset the editor,
+      //  - Repalce the document, keep in sync with the server
+      //  - Repalce the version number, so editor is in sync with NCS server and can commit new changes.
+      //  - Repalce the metadata
+      //  - Reserve the cursore position, in case a cursor jump.
+
+
+      _this.updateDocumentWithMetadata({
+        doc: doc,
+        version: version,
+        metadata: metadata,
+        reserveCursor: true
+      });
+
+      (0, _analytics.triggerCollabAnalyticsEvent)({
+        eventAction: _const.EVENT_ACTION.REINITIALISE_DOCUMENT,
+        attributes: {
+          numUnconfirmedSteps: unconfirmedSteps.length,
+          documentAri: _this.config.documentAri
+        }
+      }, _this.analyticsClient); // Re-apply the unconfirmed steps, not 100% of them can be applied, if document is changed significantly.
+
+      if (unconfirmedSteps.length > 0) {
+        _this.applyLocalsteps(unconfirmedSteps);
+      }
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onStepsAdded", function (data) {
       logger("Received steps", {
@@ -181,8 +218,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         _this.throttledCatchup();
       }
 
-      _this.updateParticipants([], data.steps.map(function (_ref4) {
-        var userId = _ref4.userId;
+      _this.updateParticipants([], data.steps.map(function (_ref6) {
+        var userId = _ref6.userId;
         return userId;
       }));
     });
@@ -195,11 +232,11 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "fitlerQueue", function (condition) {
       _this.queue = _this.queue.filter(condition);
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "updateDocumentWithMetadata", function (_ref5) {
-      var doc = _ref5.doc,
-          version = _ref5.version,
-          metadata = _ref5.metadata,
-          reserveCursor = _ref5.reserveCursor;
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "updateDocumentWithMetadata", function (_ref7) {
+      var doc = _ref7.doc,
+          version = _ref7.version,
+          metadata = _ref7.metadata,
+          reserveCursor = _ref7.reserveCursor;
 
       _this.emit('init', _objectSpread({
         doc: doc,
@@ -352,14 +389,14 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         return _this.sendPresence();
       }, SEND_PRESENCE_INTERVAL);
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onPresenceJoined", function (_ref7) {
-      var sessionId = _ref7.sessionId;
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onPresenceJoined", function (_ref9) {
+      var sessionId = _ref9.sessionId;
       logger('Participant joined with session: ', sessionId); // This expose existing users to the newly joined user
 
       _this.sendPresence();
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onPresence", function (_ref8) {
-      var userId = _ref8.userId;
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onPresence", function (_ref10) {
+      var userId = _ref10.userId;
       logger('onPresence userId: ', userId);
       _this.userId = userId;
 
@@ -374,8 +411,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         _this.emit('metadata:changed', metadata);
       }
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onParticipantLeft", function (_ref9) {
-      var sessionId = _ref9.sessionId;
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onParticipantLeft", function (_ref11) {
+      var sessionId = _ref11.sessionId;
       logger("Participant left");
 
       _this.participants.delete(sessionId);
@@ -386,11 +423,11 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         }]
       });
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onParticipantUpdated", function (_ref10) {
-      var sessionId = _ref10.sessionId,
-          timestamp = _ref10.timestamp,
-          userId = _ref10.userId,
-          clientId = _ref10.clientId;
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onParticipantUpdated", function (_ref12) {
+      var sessionId = _ref12.sessionId,
+          timestamp = _ref12.timestamp,
+          userId = _ref12.userId,
+          clientId = _ref12.clientId;
 
       _this.updateParticipant({
         sessionId: sessionId,
@@ -399,12 +436,12 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         clientId: clientId
       });
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onParticipantTelepointer", function (_ref11) {
-      var sessionId = _ref11.sessionId,
-          timestamp = _ref11.timestamp,
-          selection = _ref11.selection,
-          userId = _ref11.userId,
-          clientId = _ref11.clientId;
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onParticipantTelepointer", function (_ref13) {
+      var sessionId = _ref13.sessionId,
+          timestamp = _ref13.timestamp,
+          selection = _ref13.selection,
+          userId = _ref13.userId,
+          clientId = _ref13.clientId;
 
       if (sessionId === _this.sessionId) {
         return;
@@ -432,14 +469,14 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       });
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "updateParticipant", /*#__PURE__*/function () {
-      var _ref13 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(_ref12) {
+      var _ref15 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(_ref14) {
         var sessionId, timestamp, userId, clientId, getUser, _yield, _yield$name, name, _yield$email, email, _yield$avatar, avatar, isNewParticipant;
 
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) {
             switch (_context2.prev = _context2.next) {
               case 0:
-                sessionId = _ref12.sessionId, timestamp = _ref12.timestamp, userId = _ref12.userId, clientId = _ref12.clientId;
+                sessionId = _ref14.sessionId, timestamp = _ref14.timestamp, userId = _ref14.userId, clientId = _ref14.clientId;
 
                 if (userId) {
                   _context2.next = 3;
@@ -492,7 +529,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       }));
 
       return function (_x) {
-        return _ref13.apply(this, arguments);
+        return _ref15.apply(this, arguments);
       };
     }());
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "updateParticipants", function () {
@@ -562,8 +599,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           return _disconnectedReasonMapper.DisconnectReason.UNKNOWN_DISCONNECT;
       }
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onDisconnected", function (_ref14) {
-      var reason = _ref14.reason;
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onDisconnected", function (_ref16) {
+      var reason = _ref16.reason;
       _this.disconnectedAt = Date.now();
       var left = Array.from(_this.participants.values());
 
@@ -660,7 +697,9 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                           attributes: {
                             eventStatus: _const.EVENT_STATUS.FAILURE,
                             latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration,
-                            documentAri: _this.config.documentAri
+                            documentAri: _this.config.documentAri,
+                            // upon failure, emit the number of unconfirmed steps we attempted to sync
+                            numUnconfirmedSteps: nextUnconfirmedState === null || nextUnconfirmedState === void 0 ? void 0 : nextUnconfirmedState.steps.length
                           }
                         }, _this.analyticsClient);
                         throw new Error("Can't sync up with Collab Service");
@@ -676,7 +715,9 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                           attributes: {
                             eventStatus: _const.EVENT_STATUS.SUCCESS,
                             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-                            documentAri: _this.config.documentAri
+                            documentAri: _this.config.documentAri,
+                            // upon success, emit the total number of unconfirmed steps we synced
+                            numUnconfirmedSteps: unconfirmedState.steps.length
                           }
                         }, _this.analyticsClient);
 
@@ -730,6 +771,54 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         }
       }, _callee4);
     })));
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onNamespaceStatusChanged", /*#__PURE__*/function () {
+      var _ref18 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(data) {
+        var isLocked, waitTimeInMs, timestamp, start;
+        return _regenerator.default.wrap(function _callee5$(_context5) {
+          while (1) {
+            switch (_context5.prev = _context5.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)) {
+                  _context5.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 _context5.abrupt("return");
+
+              case 8:
+                _this.isNamespaceLocked = false;
+                logger("The page lock has expired");
+
+              case 10:
+              case "end":
+                return _context5.stop();
+            }
+          }
+        }, _callee5);
+      }));
+
+      return function (_x2) {
+        return _ref18.apply(this, arguments);
+      };
+    }());
     _this.config = config;
     _this.channel = new _channel.Channel(config);
     _this.isChannelInitialized = false;
@@ -755,9 +844,9 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     }
   }, {
     key: "setup",
-    value: function setup(_ref16) {
-      var getState = _ref16.getState,
-          onSyncUpError = _ref16.onSyncUpError;
+    value: function setup(_ref19) {
+      var getState = _ref19.getState,
+          onSyncUpError = _ref19.onSyncUpError;
       this.getState = getState;
       this.onSyncUpError = onSyncUpError || noop;
       this.clientId = getState().plugins.find(function (p) {
@@ -804,6 +893,11 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         return;
       }
 
+      if (this.isNamespaceLocked) {
+        logger('The document is temporary locked');
+        return;
+      }
+
       var steps = sendable.steps;
 
       if (!steps || !steps.length) {
@@ -821,10 +915,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         steps: steps,
         version: version
       });
-    }
-    /**
-     * 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.
 
   }, {
     key: "queueSteps",
@@ -868,8 +959,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       logger("Processing data. Version \"".concat(version, "\"."));
 
       if (steps && steps.length) {
-        var clientIds = steps.map(function (_ref17) {
-          var clientId = _ref17.clientId;
+        var clientIds = steps.map(function (_ref20) {
+          var clientId = _ref20.clientId;
           return clientId;
         });
         this.emit('data', {
@@ -939,14 +1030,14 @@ var Provider = /*#__PURE__*/function (_Emitter) {
             participant = _Array$from$filter2[0];
 
         if (participant) {
-          var _ref18 = step,
-              stepType = _ref18.stepType,
-              to = _ref18.to,
-              from = _ref18.from,
-              _ref18$slice = _ref18.slice,
-              slice = _ref18$slice === void 0 ? {
+          var _ref21 = step,
+              stepType = _ref21.stepType,
+              to = _ref21.to,
+              from = _ref21.from,
+              _ref21$slice = _ref21.slice,
+              slice = _ref21$slice === void 0 ? {
             content: []
-          } : _ref18$slice;
+          } : _ref21$slice;
 
           var _slice$content = (0, _slicedToArray2.default)(slice.content, 1),
               node = _slice$content[0];
@@ -1018,6 +1109,10 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       this.channel.disconnect();
       return this;
     }
+    /**
+     * ESS-2916 namespace status event- lock/unlock
+     */
+
   }]);
   return Provider;
 }(_emitter.Emitter);

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 = "7.6.3";
+var version = "7.7.0";
 exports.version = version;
 
 var nextMajorVersion = function nextMajorVersion() {

package/dist/cjs/version.json

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

package/dist/es2019/channel.js

@@ -71,6 +71,20 @@ export class Channel extends Emitter {
             userId,
             metadata
           });
+        } else {
+          // Page is been just restored, need to fix all the participants as well.
+          const {
+            doc,
+            version,
+            userId,
+            metadata
+          } = data;
+          this.emit('restore', {
+            doc,
+            version,
+            userId,
+            metadata
+          });
         }
       } else {
         this.emit('steps:added', data);
@@ -169,6 +183,10 @@ export class Channel extends Emitter {
     });
     this.socket.on('metadata:changed', payload => {
       this.emit('metadata:changed', payload);
+    }); // ESS-2916 namespace status event - lock/unlock
+
+    this.socket.on('status', data => {
+      this.emit('status', data);
     });
     this.socket.on('disconnect', async reason => {
       this.connected = false;

package/dist/es2019/helpers/const.js

@@ -16,6 +16,7 @@ export let EVENT_ACTION;
   EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
   EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
   EVENT_ACTION["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
+  EVENT_ACTION["REINITIALISE_DOCUMENT"] = "reinitialiseDocument";
 })(EVENT_ACTION || (EVENT_ACTION = {}));
 
 export let EVENT_STATUS;

package/dist/es2019/provider/index.js

@@ -50,6 +50,7 @@ const throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {
   trailing: true
 });
 export class Provider extends Emitter {
+  // To keep track of the namespace event changes from the server.
   constructor(config) {
     super();
 
@@ -61,6 +62,8 @@ export class Provider extends Emitter {
 
     _defineProperty(this, "isChannelInitialized", false);
 
+    _defineProperty(this, "isNamespaceLocked", false);
+
     _defineProperty(this, "initializeChannel", () => {
       this.channel.on('connected', ({
         sid,
@@ -88,7 +91,42 @@ export class Provider extends Emitter {
           version,
           metadata
         });
-      }).on('steps:added', this.onStepsAdded.bind(this)).on('participant:telepointer', this.onParticipantTelepointer.bind(this)).on('presence:joined', this.onPresenceJoined.bind(this)).on('presence', this.onPresence.bind(this)).on('participant:left', this.onParticipantLeft.bind(this)).on('participant:updated', this.onParticipantUpdated.bind(this)).on('metadata:changed', this.onMetadataChanged.bind(this)).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled.bind(this)).connect();
+      }).on('restore', this.onRestore.bind(this)).on('steps:added', this.onStepsAdded.bind(this)).on('participant:telepointer', this.onParticipantTelepointer.bind(this)).on('presence:joined', this.onPresenceJoined.bind(this)).on('presence', this.onPresence.bind(this)).on('participant:left', this.onParticipantLeft.bind(this)).on('participant:updated', this.onParticipantUpdated.bind(this)).on('metadata:changed', this.onMetadataChanged.bind(this)).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled.bind(this)).on('status', this.onNamespaceStatusChanged.bind(this)).connect();
+    });
+
+    _defineProperty(this, "onRestore", ({
+      doc,
+      version,
+      metadata
+    }) => {
+      // Preseve the unconfirmed steps to prevent data loss.
+      const {
+        steps: unconfirmedSteps
+      } = this.getUnconfirmedSteps() || {
+        steps: []
+      }; // Reset the editor,
+      //  - Repalce the document, keep in sync with the server
+      //  - Repalce the version number, so editor is in sync with NCS server and can commit new changes.
+      //  - Repalce the metadata
+      //  - Reserve the cursore position, in case a cursor jump.
+
+      this.updateDocumentWithMetadata({
+        doc,
+        version,
+        metadata,
+        reserveCursor: true
+      });
+      triggerCollabAnalyticsEvent({
+        eventAction: EVENT_ACTION.REINITIALISE_DOCUMENT,
+        attributes: {
+          numUnconfirmedSteps: unconfirmedSteps.length,
+          documentAri: this.config.documentAri
+        }
+      }, this.analyticsClient); // Re-apply the unconfirmed steps, not 100% of them can be applied, if document is changed significantly.
+
+      if (unconfirmedSteps.length > 0) {
+        this.applyLocalsteps(unconfirmedSteps);
+      }
     });
 
     _defineProperty(this, "onStepsAdded", data => {
@@ -509,7 +547,9 @@ export class Provider extends Emitter {
               attributes: {
                 eventStatus: EVENT_STATUS.FAILURE,
                 latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-                documentAri: this.config.documentAri
+                documentAri: this.config.documentAri,
+                // upon failure, emit the number of unconfirmed steps we attempted to sync
+                numUnconfirmedSteps: nextUnconfirmedState === null || nextUnconfirmedState === void 0 ? void 0 : nextUnconfirmedState.steps.length
               }
             }, this.analyticsClient);
             throw new Error("Can't sync up with Collab Service");
@@ -522,7 +562,9 @@ export class Provider extends Emitter {
           attributes: {
             eventStatus: EVENT_STATUS.SUCCESS,
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-            documentAri: this.config.documentAri
+            documentAri: this.config.documentAri,
+            // upon success, emit the total number of unconfirmed steps we synced
+            numUnconfirmedSteps: unconfirmedState.steps.length
           }
         }, this.analyticsClient);
       }
@@ -564,6 +606,37 @@ export class Provider extends Emitter {
       };
     });
 
+    _defineProperty(this, "onNamespaceStatusChanged", async data => {
+      const {
+        isLocked,
+        waitTimeInMs,
+        timestamp
+      } = data;
+      const start = Date.now();
+      logger(`Received a namespace status changed event `, {
+        data
+      });
+
+      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.config = config;
     this.channel = new Channel(config);
     this.isChannelInitialized = false;
@@ -629,6 +702,11 @@ export class Provider extends Emitter {
       return;
     }
 
+    if (this.isNamespaceLocked) {
+      logger('The document is temporary locked');
+      return;
+    }
+
     const {
       steps
     } = sendable;
@@ -648,10 +726,7 @@ export class Provider extends Emitter {
       steps,
       version
     });
-  }
-  /**
-   * 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.
 
 
   queueSteps(data) {
@@ -826,5 +901,9 @@ export class Provider extends Emitter {
     this.channel.disconnect();
     return this;
   }
+  /**
+   * ESS-2916 namespace status event- lock/unlock
+   */
+
 
 }

package/dist/es2019/version-wrapper.js

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

package/dist/es2019/version.json

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

package/dist/esm/channel.js

@@ -102,6 +102,19 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
             userId: userId,
             metadata: metadata
           });
+        } else {
+          // Page is been just restored, need to fix all the participants as well.
+          var _doc = data.doc,
+              _version = data.version,
+              _userId = data.userId,
+              _metadata = data.metadata;
+
+          _this.emit('restore', {
+            doc: _doc,
+            version: _version,
+            userId: _userId,
+            metadata: _metadata
+          });
         }
       } else {
         _this.emit('steps:added', data);
@@ -201,6 +214,10 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       });
       this.socket.on('metadata:changed', function (payload) {
         _this2.emit('metadata:changed', payload);
+      }); // ESS-2916 namespace status event - lock/unlock
+
+      this.socket.on('status', function (data) {
+        _this2.emit('status', data);
       });
       this.socket.on('disconnect', /*#__PURE__*/function () {
         var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(reason) {

package/dist/esm/helpers/const.js

@@ -16,6 +16,7 @@ export var EVENT_ACTION;
   EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
   EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
   EVENT_ACTION["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
+  EVENT_ACTION["REINITIALISE_DOCUMENT"] = "reinitialiseDocument";
 })(EVENT_ACTION || (EVENT_ACTION = {}));
 
 export var EVENT_STATUS;