@atlaskit/collab-provider 7.6.3 → 8.0.0

package/dist/cjs/provider/index.js

@@ -39,8 +39,12 @@ var _throttle = _interopRequireDefault(require("lodash/throttle"));
 
 var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 
+var _countBy = _interopRequireDefault(require("lodash/countBy"));
+
 var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
 
+var _ufo = require("@atlaskit/ufo");
+
 var _emitter = require("../emitter");
 
 var _channel = require("../channel");
@@ -55,6 +59,8 @@ var _catchup = require("./catchup");
 
 var _errorCodeMapper = require("../error-code-mapper");
 
+var _types = require("../types");
+
 var _disconnectedReasonMapper = require("../disconnected-reason-mapper");
 
 var _performance = require("../analytics/performance");
@@ -91,17 +97,74 @@ var commitStep = function commitStep(_ref) {
       steps = _ref.steps,
       version = _ref.version,
       userId = _ref.userId,
-      clientId = _ref.clientId;
+      clientId = _ref.clientId,
+      documentAri = _ref.documentAri,
+      analyticsClient = _ref.analyticsClient,
+      onStepsAdded = _ref.onStepsAdded,
+      onErrorHandled = _ref.onErrorHandled;
   var stepsWithClientAndUserId = steps.map(function (step) {
     return _objectSpread(_objectSpread({}, step.toJSON()), {}, {
       clientId: clientId,
       userId: userId
     });
   });
+  var start = new Date().getTime();
   channel.broadcast('steps:commit', {
     steps: stepsWithClientAndUserId,
     version: version,
     userId: userId
+  }, function (response) {
+    var latency = new Date().getTime() - start;
+
+    if (response.type === _types.AcknowledgementResponseTypes.SUCCESS) {
+      onStepsAdded({
+        steps: stepsWithClientAndUserId,
+        version: response.version
+      }, true);
+      var analyticStepEvent = {
+        eventAction: _const.EVENT_ACTION.ADD_STEPS,
+        attributes: {
+          eventStatus: _const.EVENT_STATUS.SUCCESS,
+          type: _const.ADD_STEPS_TYPE.ACCEPTED,
+          documentAri: documentAri,
+          latency: latency
+        }
+      };
+      analyticStepEvent.attributes.stepType = (0, _countBy.default)(stepsWithClientAndUserId, function (stepWithClientAndUserId) {
+        return stepWithClientAndUserId.stepType;
+      });
+      (0, _analytics.triggerAnalyticsEvent)(analyticStepEvent, analyticsClient);
+    } else if (response.type === _types.AcknowledgementResponseTypes.ERROR) {
+      var _response$error, _response$error$data, _response$error2, _response$error2$data;
+
+      onErrorHandled(response.error, true);
+      (0, _analytics.triggerAnalyticsEvent)({
+        eventAction: _const.EVENT_ACTION.ADD_STEPS,
+        attributes: {
+          eventStatus: _const.EVENT_STATUS.FAILURE,
+          // User tried committing steps but they were rejected because:
+          // - HEAD_VERSION_UPDATE_FAILED: the collab service's latest stored step tail version didn't correspond to the head version of the first step submitted
+          // - VERSION_NUMBER_ALREADY_EXISTS: while storing the steps there was a conflict meaning someone else wrote steps into the database more quickly
+          type: ((_response$error = response.error) === null || _response$error === void 0 ? void 0 : (_response$error$data = _response$error.data) === null || _response$error$data === void 0 ? void 0 : _response$error$data.code) === 'HEAD_VERSION_UPDATE_FAILED' || ((_response$error2 = response.error) === null || _response$error2 === void 0 ? void 0 : (_response$error2$data = _response$error2.data) === null || _response$error2$data === void 0 ? void 0 : _response$error2$data.code) === 'VERSION_NUMBER_ALREADY_EXISTS' ? _const.ADD_STEPS_TYPE.REJECTED : _const.ADD_STEPS_TYPE.ERROR,
+          documentAri: documentAri,
+          latency: latency,
+          error: response.error
+        }
+      }, analyticsClient);
+    } else {
+      (0, _analytics.triggerAnalyticsEvent)({
+        eventAction: _const.EVENT_ACTION.ADD_STEPS,
+        attributes: {
+          eventStatus: _const.EVENT_STATUS.FAILURE,
+          type: _const.ADD_STEPS_TYPE.ERROR,
+          documentAri: documentAri,
+          latency: latency,
+          error: {
+            message: 'Invalid Acknowledgement'
+          }
+        }
+      }, analyticsClient);
+    }
   });
 };
 
@@ -115,6 +178,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 +188,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,9 +217,45 @@ 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;
+
+      // Preserve the unconfirmed steps to prevent data loss.
+      var _ref5 = _this.getUnconfirmedSteps() || {
+        steps: []
+      },
+          unconfirmedSteps = _ref5.steps; // Reset the editor,
+      //  - Replace the document, keep in sync with the server
+      //  - Replace the version number, so editor is in sync with NCS server and can commit new changes.
+      //  - Replace the metadata
+      //  - Reserve the cursor position, in case a cursor jump.
+
+
+      _this.updateDocumentWithMetadata({
+        doc: doc,
+        version: version,
+        metadata: metadata,
+        reserveCursor: true
+      });
+
+      (0, _analytics.triggerAnalyticsEvent)({
+        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) {
+      var disableAnalytics = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
       logger("Received steps", {
         steps: data.steps,
         version: data.version
@@ -172,7 +273,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       if (data.version === currentVersion) {
         logger("Received steps we already have. Ignoring.");
       } else if (data.version === expectedVersion) {
-        _this.processSteps(data);
+        _this.processSteps(data, disableAnalytics);
       } else if (data.version > expectedVersion) {
         logger("Version too high. Expected \"".concat(expectedVersion, "\" but got \"").concat(data.version, ". Current local version is ").concat(currentVersion, "."));
 
@@ -181,8 +282,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;
       }));
     });
@@ -192,14 +293,14 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       leading: false,
       trailing: true
     }));
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "fitlerQueue", function (condition) {
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "filterQueue", 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,
@@ -215,7 +316,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         _this.emit('metadata:changed', metadata);
       }
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "applyLocalsteps", function (steps) {
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "applyLocalSteps", function (steps) {
       // Re-aply local steps
       _this.emit('local-steps', {
         steps: steps
@@ -228,13 +329,13 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       return (0, _prosemirrorCollab.sendableSteps)(_this.getState());
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "catchup", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-      var measure, _measure;
+      var start, latency, _latency;
 
       return _regenerator.default.wrap(function _callee$(_context) {
         while (1) {
           switch (_context.prev = _context.next) {
             case 0:
-              (0, _performance.startMeasure)(_performance.MEASURE_NAME.CALLING_CATCHUP_API); // if the queue is already paused, we are busy with something else, so don't proceed.
+              start = new Date().getTime(); // if the queue is already paused, we are busy with something else, so don't proceed.
 
               if (!_this.pauseQueue) {
                 _context.next = 4;
@@ -252,18 +353,18 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                 getCurrentPmVersion: _this.getCurrentPmVersion,
                 fetchCatchup: _this.channel.fetchCatchup.bind(_this.channel),
                 getUnconfirmedSteps: _this.getUnconfirmedSteps,
-                fitlerQueue: _this.fitlerQueue,
+                filterQueue: _this.filterQueue,
                 updateDocumentWithMetadata: _this.updateDocumentWithMetadata,
-                applyLocalsteps: _this.applyLocalsteps
+                applyLocalSteps: _this.applyLocalSteps
               });
 
             case 8:
-              measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CALLING_CATCHUP_API);
-              (0, _analytics.triggerCollabAnalyticsEvent)({
+              latency = new Date().getTime() - start;
+              (0, _analytics.triggerAnalyticsEvent)({
                 eventAction: _const.EVENT_ACTION.CATCHUP,
                 attributes: {
                   eventStatus: _const.EVENT_STATUS.SUCCESS,
-                  latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+                  latency: latency,
                   documentAri: _this.config.documentAri
                 }
               }, _this.analyticsClient);
@@ -273,13 +374,13 @@ var Provider = /*#__PURE__*/function (_Emitter) {
             case 12:
               _context.prev = 12;
               _context.t0 = _context["catch"](5);
-              _measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CALLING_CATCHUP_API);
-              (0, _analytics.triggerCollabAnalyticsEvent)({
+              _latency = new Date().getTime() - start;
+              (0, _analytics.triggerAnalyticsEvent)({
                 eventAction: _const.EVENT_ACTION.CATCHUP,
                 attributes: {
                   eventStatus: _const.EVENT_STATUS.FAILURE,
                   error: _context.t0,
-                  latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration,
+                  latency: _latency,
                   documentAri: _this.config.documentAri
                 }
               }, _this.analyticsClient);
@@ -304,27 +405,34 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       }, _callee, null, [[5, 12, 17, 23]]);
     })));
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onErrorHandled", function (error) {
-      if (error && error.data) {
+      var disableAnalytics = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+
+      if (error !== null && error !== void 0 && error.data) {
+        // User tried committing steps but they were rejected because:
+        // HEAD_VERSION_UPDATE_FAILED: the collab service's latest stored step tail version didn't correspond to the head version of the first step submitted
+        // VERSION_NUMBER_ALREADY_EXISTS: while storing the steps there was a conflict meaning someone else wrote steps into the database more quickly
         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,
-              latency: measure === null || measure === void 0 ? void 0 : measure.duration
-            }
-          }, _this.analyticsClient);
-          _this.stepRejectCounter++;
-        }
+          // TODO: Remove this analytics logic once we have validated the ack messages and aren't likely to go back to a generic error handler
+          if (!disableAnalytics) {
+            (0, _analytics.triggerAnalyticsEvent)({
+              eventAction: _const.EVENT_ACTION.ADD_STEPS,
+              attributes: {
+                eventStatus: _const.EVENT_STATUS.FAILURE,
+                type: _const.ADD_STEPS_TYPE.REJECTED,
+                error: error,
+                documentAri: _this.config.documentAri
+              }
+            }, _this.analyticsClient);
+          }
 
-        logger("The stepRejectCounter(\"".concat(_this.stepRejectCounter, "\")"));
+          _this.stepRejectCounter++;
+          logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
 
-        if (_this.stepRejectCounter >= MAX_STEP_REJECTED_ERROR) {
-          logger("The stepRejected(\"".concat(_this.stepRejectCounter, "\") exceed maximun(\"").concat(MAX_STEP_REJECTED_ERROR, "\"), trigger catch"));
+          if (_this.stepRejectCounter >= MAX_STEP_REJECTED_ERROR) {
+            logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
 
-          _this.throttledCatchup();
+            _this.throttledCatchup();
+          }
         }
 
         var errorToEmit = (0, _errorCodeMapper.errorCodeMapper)(error);
@@ -334,7 +442,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         }
       }
 
-      logger("Error from collab service", error);
+      logger('Error from collab service', error);
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "queue", []);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "sendPresence", function () {
@@ -352,14 +460,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 +482,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 +494,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 +507,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 +540,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 +600,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 () {
@@ -522,7 +630,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       if (joined.length || left.length) {
         var _this$participants$si;
 
-        (0, _analytics.triggerCollabAnalyticsEvent)({
+        (0, _analytics.triggerAnalyticsEvent)({
           eventAction: _const.EVENT_ACTION.UPDATE_PARTICIPANTS,
           attributes: {
             participants: (_this$participants$si = _this.participants.size) !== null && _this$participants$si !== void 0 ? _this$participants$si : 1,
@@ -562,8 +670,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());
 
@@ -583,7 +691,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, _measure3;
+      var maxAttemptsToSync, count, unconfirmedState, state, adfDocument, measure, _measure2;
 
       return _regenerator.default.wrap(function _callee4$(_context4) {
         while (1) {
@@ -599,7 +707,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
               }
 
               return _context4.delegateYield( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
-                var unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedState, nextUnconfirmedTrs, _state, _measure2, measure;
+                var unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedState, nextUnconfirmedTrs, _state, _measure, measure;
 
                 return _regenerator.default.wrap(function _callee3$(_context3) {
                   while (1) {
@@ -654,13 +762,15 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                           });
                         }
 
-                        _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
-                        (0, _analytics.triggerCollabAnalyticsEvent)({
+                        _measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
+                        (0, _analytics.triggerAnalyticsEvent)({
                           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
+                            latency: _measure === null || _measure === void 0 ? void 0 : _measure.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");
@@ -671,12 +781,14 @@ var Provider = /*#__PURE__*/function (_Emitter) {
 
                       case 17:
                         measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
-                        (0, _analytics.triggerCollabAnalyticsEvent)({
+                        (0, _analytics.triggerAnalyticsEvent)({
                           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
+                            documentAri: _this.config.documentAri,
+                            // upon success, emit the total number of unconfirmed steps we synced
+                            numUnconfirmedSteps: unconfirmedState.steps.length
                           }
                         }, _this.analyticsClient);
 
@@ -695,7 +807,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                 (0, _performance.startMeasure)(_performance.MEASURE_NAME.CONVERT_PM_TO_ADF);
                 adfDocument = new _editorJsonTransformer.JSONTransformer().encode(state.doc);
                 measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CONVERT_PM_TO_ADF);
-                (0, _analytics.triggerCollabAnalyticsEvent)({
+                (0, _analytics.triggerAnalyticsEvent)({
                   eventAction: _const.EVENT_ACTION.CONVERT_PM_TO_ADF,
                   attributes: {
                     eventStatus: _const.EVENT_STATUS.SUCCESS,
@@ -704,12 +816,12 @@ var Provider = /*#__PURE__*/function (_Emitter) {
                   }
                 }, _this.analyticsClient);
               } catch (error) {
-                _measure3 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CONVERT_PM_TO_ADF);
-                (0, _analytics.triggerCollabAnalyticsEvent)({
+                _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CONVERT_PM_TO_ADF);
+                (0, _analytics.triggerAnalyticsEvent)({
                   eventAction: _const.EVENT_ACTION.CONVERT_PM_TO_ADF,
                   attributes: {
                     eventStatus: _const.EVENT_STATUS.FAILURE,
-                    latency: _measure3 === null || _measure3 === void 0 ? void 0 : _measure3.duration,
+                    latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration,
                     error: error,
                     documentAri: _this.config.documentAri
                   }
@@ -730,6 +842,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 +915,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,27 +964,32 @@ 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;
-      }
-
-      (0, _performance.startMeasure)(_performance.MEASURE_NAME.ADD_STEPS); // Avoid reference issues using a
+      } // Avoid reference issues using a
       // method outside of the provider
       // scope
 
+
       throttledCommitStep({
         channel: this.channel,
         userId: this.userId,
         clientId: this.clientId,
         steps: steps,
-        version: version
+        version: version,
+        documentAri: this.config.documentAri,
+        analyticsClient: this.analyticsClient,
+        onStepsAdded: this.onStepsAdded.bind(this),
+        onErrorHandled: this.onErrorHandled.bind(this)
       });
-    }
-    /**
-     * 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",
@@ -863,13 +1028,14 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     value: function processSteps(data) {
       var _this2 = this;
 
+      var disableAnalytics = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
       var version = data.version,
           steps = data.steps;
       logger("Processing data. Version \"".concat(version, "\"."));
 
-      if (steps && steps.length) {
-        var clientIds = steps.map(function (_ref17) {
-          var clientId = _ref17.clientId;
+      if (steps !== null && steps !== void 0 && steps.length) {
+        var clientIds = steps.map(function (_ref20) {
+          var clientId = _ref20.clientId;
           return clientId;
         });
         this.emit('data', {
@@ -878,16 +1044,23 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           userIds: clientIds
         }); // 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,
-            latency: measure === null || measure === void 0 ? void 0 : measure.duration
-          }
-        }, this.analyticsClient);
+        this.stepRejectCounter = 0; // TODO: Remove this analytics logic after we've validated the ack call-backs
+
+        if (!disableAnalytics && clientIds.indexOf(this.clientId) >= 0) {
+          var analyticStepEvent = {
+            eventAction: _const.EVENT_ACTION.ADD_STEPS,
+            attributes: {
+              eventStatus: _const.EVENT_STATUS.SUCCESS,
+              type: _const.ADD_STEPS_TYPE.ACCEPTED,
+              documentAri: this.config.documentAri
+            }
+          };
+          analyticStepEvent.attributes.stepType = (0, _countBy.default)(steps, function (step) {
+            return step.stepType;
+          });
+          (0, _analytics.triggerAnalyticsEvent)(analyticStepEvent, this.analyticsClient);
+        }
+
         this.emitTelepointersFromSteps(steps); // Resend local steps if none of the received steps originated with us!
 
         if (clientIds.indexOf(this.clientId) === -1) {
@@ -916,12 +1089,39 @@ var Provider = /*#__PURE__*/function (_Emitter) {
 
       switch (type) {
         case 'telepointer':
+          var telepointerExperience = new _ufo.UFOExperience('collab-provider.telepointer', {
+            type: _ufo.ExperienceTypes.Operation,
+            performanceType: _ufo.ExperiencePerformanceTypes.Custom,
+            performanceConfig: {
+              histogram: (0, _defineProperty2.default)({}, _ufo.ExperiencePerformanceTypes.Custom, {
+                duration: '250_500_1000_1500_2000_3000_4000'
+              })
+            }
+          });
+          telepointerExperience.addMetadata({
+            documentAri: this.config.documentAri
+          });
+          telepointerExperience.start();
           var selection = rest.selection;
           this.channel.broadcast('participant:telepointer', {
             selection: selection,
             userId: userId,
             sessionId: sessionId,
             clientId: clientId
+          }, function (response) {
+            if (response.type === _types.AcknowledgementResponseTypes.SUCCESS) {
+              telepointerExperience.success();
+            } else if (response.type === _types.AcknowledgementResponseTypes.ERROR) {
+              var errorMessage = response.error;
+              telepointerExperience.addMetadata({
+                error: errorMessage
+              });
+              logger('Error from collab service with telepointer broadcast', errorMessage);
+              telepointerExperience.failure();
+            } else {
+              // Abort if invalid ACK sent
+              telepointerExperience.abort();
+            }
           });
           break;
       }
@@ -939,14 +1139,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 +1218,10 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       this.channel.disconnect();
       return this;
     }
+    /**
+     * ESS-2916 namespace status event- lock/unlock
+     */
+
   }]);
   return Provider;
 }(_emitter.Emitter);