@atlaskit/collab-provider 7.6.2 → 7.7.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @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
+
+- [`1a64a3e3e53`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1a64a3e3e53) - ESS-2591 Reduce initial re-connection delay and increase randomization factor for socket io connections.
+- [`ee8ac15d730`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ee8ac15d730) - ESS-1363 add packageVersion to analytic events
+- [`29292da81d7`](https://bitbucket.org/atlassian/atlassian-frontend/commits/29292da81d7) - Increased the limits for the collab sync on returning the document to the consumer
+- [`e06f8ba062f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e06f8ba062f) - Disable collab provider transport closing on the beforeunload event.
+- Updated dependencies
+
 ## 7.6.2
 
 ### Patch Changes

package/dist/cjs/analytics/index.js

@@ -11,6 +11,8 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 
 var _const = require("../helpers/const");
 
+var _versionWrapper = require("../version-wrapper");
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -43,7 +45,8 @@ var triggerCollabAnalyticsEvent = function triggerCollabAnalyticsEvent(analytics
     actionSubject: _const.EVENT_SUBJECT,
     source: 'unknown',
     attributes: _objectSpread({
-      packageName: _const.ATTRIBUTES_PACKAGE,
+      packageName: _versionWrapper.name,
+      packageVersion: _versionWrapper.version,
       collabService: _const.COLLAB_SERVICE.NCS
     }, analyticsEvent.attributes)
   };

package/dist/cjs/analytics/performance.js

@@ -15,6 +15,8 @@ exports.MEASURE_NAME = MEASURE_NAME;
   MEASURE_NAME["SOCKET_CONNECT"] = "socketConnect";
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
   MEASURE_NAME["CONVERT_PM_TO_ADF"] = "convertPMToADF";
+  MEASURE_NAME["ADD_STEPS"] = "addSteps";
+  MEASURE_NAME["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
 })(MEASURE_NAME || (exports.MEASURE_NAME = MEASURE_NAME = {}));
 
 var isPerformanceAPIAvailable = function isPerformanceAPIAvailable() {

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/config.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.SOCKET_IO_OPTIONS = void 0;
 var SOCKET_IO_OPTIONS = {
   RECONNECTION_DELAY_MAX: 128 * 1000,
-  RECONNECTION_DELAY: 1000,
-  RANDOMIZATION_FACTOR: 0.1
+  RECONNECTION_DELAY: 200,
+  RANDOMIZATION_FACTOR: 0.5
 };
 exports.SOCKET_IO_OPTIONS = SOCKET_IO_OPTIONS;

package/dist/cjs/helpers/const.js

@@ -3,9 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.EVENT_SUBJECT = exports.EVENT_STATUS = exports.EVENT_ACTION = exports.COLLAB_SERVICE = exports.ATTRIBUTES_PACKAGE = exports.ACK_MAX_TRY = void 0;
-var ATTRIBUTES_PACKAGE = 'collabProvider';
-exports.ATTRIBUTES_PACKAGE = ATTRIBUTES_PACKAGE;
+exports.EVENT_SUBJECT = exports.EVENT_STATUS = exports.EVENT_ACTION = exports.COLLAB_SERVICE = exports.ACK_MAX_TRY = void 0;
 var EVENT_SUBJECT = 'collab';
 exports.EVENT_SUBJECT = EVENT_SUBJECT;
 var COLLAB_SERVICE;
@@ -26,6 +24,8 @@ exports.EVENT_ACTION = EVENT_ACTION;
   EVENT_ACTION["ADD_STEPS"] = "addSteps";
   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;
@@ -36,5 +36,5 @@ exports.EVENT_STATUS = EVENT_STATUS;
   EVENT_STATUS["FAILURE"] = "FAILURE";
 })(EVENT_STATUS || (exports.EVENT_STATUS = EVENT_STATUS = {}));
 
-var ACK_MAX_TRY = 10;
+var ACK_MAX_TRY = 30;
 exports.ACK_MAX_TRY = ACK_MAX_TRY;

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,
@@ -306,12 +343,14 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onErrorHandled", function (error) {
       if (error && error.data) {
         if (error.data.code === 'HEAD_VERSION_UPDATE_FAILED' || error.data.code === 'VERSION_NUMBER_ALREADY_EXISTS') {
+          var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.ADD_STEPS);
           (0, _analytics.triggerCollabAnalyticsEvent)({
             eventAction: _const.EVENT_ACTION.ADD_STEPS,
             attributes: {
               eventStatus: _const.EVENT_STATUS.FAILURE,
               error: error,
-              documentAri: _this.config.documentAri
+              documentAri: _this.config.documentAri,
+              latency: measure === null || measure === void 0 ? void 0 : measure.duration
             }
           }, _this.analyticsClient);
           _this.stepRejectCounter++;
@@ -350,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;
 
@@ -372,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);
@@ -384,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,
@@ -397,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;
@@ -430,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;
@@ -490,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 () {
@@ -560,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());
 
@@ -581,7 +620,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
       var _this$metadata$title;
 
-      var maxAttemptsToSync, count, unconfirmedState, state, adfDocument, measure, _measure2;
+      var maxAttemptsToSync, count, unconfirmedState, state, adfDocument, measure, _measure3;
 
       return _regenerator.default.wrap(function _callee4$(_context4) {
         while (1) {
@@ -597,32 +636,33 @@ var Provider = /*#__PURE__*/function (_Emitter) {
               }
 
               return _context4.delegateYield( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
-                var unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedState, nextUnconfirmedTrs, _state;
+                var unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedState, nextUnconfirmedTrs, _state, _measure2, measure;
 
                 return _regenerator.default.wrap(function _callee3$(_context3) {
                   while (1) {
                     switch (_context3.prev = _context3.next) {
                       case 0:
-                        // We use origins here as steps can be rebased. When steps are rebased a new step is created.
+                        (0, _performance.startMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS); // We use origins here as steps can be rebased. When steps are rebased a new step is created.
                         // This means that we can not track if it has been removed from the unconfirmed array or not.
                         // Origins points to the original transaction that the step was created in. This is never changed
                         // and gets passed down when a step is rebased.
+
                         unconfirmedTrs = unconfirmedState.origins;
                         lastTr = unconfirmedTrs[unconfirmedTrs.length - 1];
                         isLastTrConfirmed = false;
 
-                      case 3:
+                      case 4:
                         if (isLastTrConfirmed) {
-                          _context3.next = 14;
+                          _context3.next = 17;
                           break;
                         }
 
                         _this.sendStepsFromCurrentState();
 
-                        _context3.next = 7;
-                        return (0, _utils.sleep)(500);
+                        _context3.next = 8;
+                        return (0, _utils.sleep)(1000);
 
-                      case 7:
+                      case 8:
                         nextUnconfirmedState = _this.getUnconfirmedSteps();
 
                         if (nextUnconfirmedState && nextUnconfirmedState.steps.length) {
@@ -635,7 +675,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                         }
 
                         if (!(!isLastTrConfirmed && count++ >= maxAttemptsToSync)) {
-                          _context3.next = 12;
+                          _context3.next = 15;
                           break;
                         }
 
@@ -651,13 +691,37 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                           });
                         }
 
-                        throw new Error("Can't syncup with Collab Service");
-
-                      case 12:
-                        _context3.next = 3;
+                        _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
+                        (0, _analytics.triggerCollabAnalyticsEvent)({
+                          eventAction: _const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS,
+                          attributes: {
+                            eventStatus: _const.EVENT_STATUS.FAILURE,
+                            latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration,
+                            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");
+
+                      case 15:
+                        _context3.next = 4;
                         break;
 
-                      case 14:
+                      case 17:
+                        measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
+                        (0, _analytics.triggerCollabAnalyticsEvent)({
+                          eventAction: _const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS,
+                          attributes: {
+                            eventStatus: _const.EVENT_STATUS.SUCCESS,
+                            latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+                            documentAri: _this.config.documentAri,
+                            // upon success, emit the total number of unconfirmed steps we synced
+                            numUnconfirmedSteps: unconfirmedState.steps.length
+                          }
+                        }, _this.analyticsClient);
+
+                      case 19:
                       case "end":
                         return _context3.stop();
                     }
@@ -681,12 +745,12 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                   }
                 }, _this.analyticsClient);
               } catch (error) {
-                _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CONVERT_PM_TO_ADF);
+                _measure3 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CONVERT_PM_TO_ADF);
                 (0, _analytics.triggerCollabAnalyticsEvent)({
                   eventAction: _const.EVENT_ACTION.CONVERT_PM_TO_ADF,
                   attributes: {
                     eventStatus: _const.EVENT_STATUS.FAILURE,
-                    latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration,
+                    latency: _measure3 === null || _measure3 === void 0 ? void 0 : _measure3.duration,
                     error: error,
                     documentAri: _this.config.documentAri
                   }
@@ -707,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;
@@ -732,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) {
@@ -781,15 +893,21 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         return;
       }
 
+      if (this.isNamespaceLocked) {
+        logger('The document is temporary locked');
+        return;
+      }
+
       var steps = sendable.steps;
 
       if (!steps || !steps.length) {
         return;
-      } // Avoid reference issues using a
+      }
+
+      (0, _performance.startMeasure)(_performance.MEASURE_NAME.ADD_STEPS); // Avoid reference issues using a
       // method outside of the provider
       // scope
 
-
       throttledCommitStep({
         channel: this.channel,
         userId: this.userId,
@@ -797,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",
@@ -844,22 +959,24 @@ 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', {
           json: steps,
           version: version,
           userIds: clientIds
-        }); // If steps can apply to local editor sucessfully, no need to accumulate the error counter.
+        }); // If steps can apply to local editor successfully, no need to accumulate the error counter.
 
         this.stepRejectCounter = 0;
+        var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.ADD_STEPS);
         (0, _analytics.triggerCollabAnalyticsEvent)({
           eventAction: _const.EVENT_ACTION.ADD_STEPS,
           attributes: {
             eventStatus: _const.EVENT_STATUS.SUCCESS,
-            documentAri: this.config.documentAri
+            documentAri: this.config.documentAri,
+            latency: measure === null || measure === void 0 ? void 0 : measure.duration
           }
         }, this.analyticsClient);
         this.emitTelepointersFromSteps(steps); // Resend local steps if none of the received steps originated with us!
@@ -913,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];
@@ -992,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/socket-io-provider.js

@@ -31,6 +31,7 @@ function createSocketIOSocket(url, auth, productInfo) {
     reconnectionDelayMax: _config.SOCKET_IO_OPTIONS.RECONNECTION_DELAY_MAX,
     reconnectionDelay: _config.SOCKET_IO_OPTIONS.RECONNECTION_DELAY,
     randomizationFactor: _config.SOCKET_IO_OPTIONS.RANDOMIZATION_FACTOR,
+    closeOnBeforeunload: false,
     withCredentials: true,
     transports: ['polling', 'websocket'],
     path: "/".concat(pathname.split('/')[1], "/socket.io"),

package/dist/cjs/version-wrapper.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.version = exports.nextMajorVersion = exports.name = void 0;
+var name = "@atlaskit/collab-provider";
+exports.name = name;
+var version = "7.7.0";
+exports.version = version;
+
+var nextMajorVersion = function nextMajorVersion() {
+  return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
+};
+
+exports.nextMajorVersion = nextMajorVersion;

package/dist/cjs/version.json

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