@atlaskit/collab-provider 9.0.0 → 9.1.0

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

@@ -18,7 +18,7 @@ const SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
  * @param sendPresenceJoined Callback to Channel class
  */
 export class ParticipantsService {
-  constructor(analyticsHelper, participantsState = new ParticipantsState(), emit, getUser, channelBroadcast, sendPresenceJoined) {
+  constructor(analyticsHelper, participantsState = new ParticipantsState(), emit, getUser, channelBroadcast, sendPresenceJoined, getPresenceData, setUserId) {
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
      * @param payload Payload from incoming socket event
@@ -187,11 +187,12 @@ export class ParticipantsService {
     _defineProperty(this, "clearTimers", () => {
       clearTimeout(this.participantUpdateTimeout);
     });
-    _defineProperty(this, "sendPresence", payload => {
+    _defineProperty(this, "sendPresence", () => {
       try {
         clearTimeout(this.presenceUpdateTimeout);
-        this.channelBroadcast('participant:updated', payload);
-        this.presenceUpdateTimeout = window.setTimeout(() => this.sendPresence(payload), SEND_PRESENCE_INTERVAL);
+        const data = this.getPresenceData();
+        this.channelBroadcast('participant:updated', data);
+        this.presenceUpdateTimeout = window.setTimeout(() => this.sendPresence(), SEND_PRESENCE_INTERVAL);
       } catch (error) {
         var _this$analyticsHelper7;
         // We don't want to throw errors for Presence features as they tend to self-restore
@@ -209,7 +210,7 @@ export class ParticipantsService {
       try {
         logger('Participant joined with session: ', payload.sessionId);
         // This expose existing users to the newly joined user
-        this.sendPresence(payload);
+        this.sendPresence();
       } catch (error) {
         var _this$analyticsHelper8;
         // We don't want to throw errors for Presence features as they tend to self-restore
@@ -225,7 +226,8 @@ export class ParticipantsService {
     _defineProperty(this, "onPresence", payload => {
       try {
         logger('onPresence userId: ', payload.userId);
-        this.sendPresence(payload);
+        this.setUserId(payload.userId);
+        this.sendPresence();
         this.sendPresenceJoined();
       } catch (error) {
         var _this$analyticsHelper9;
@@ -239,6 +241,8 @@ export class ParticipantsService {
     this.getUser = getUser;
     this.channelBroadcast = channelBroadcast;
     this.sendPresenceJoined = sendPresenceJoined;
+    this.getPresenceData = getPresenceData;
+    this.setUserId = setUserId;
   }
   /**
    * Called on receiving steps, emits each step's telepointer

package/dist/es2019/provider/commit-step.js

@@ -13,7 +13,8 @@ export const commitStep = ({
   clientId,
   onStepsAdded,
   onErrorHandled,
-  analyticsHelper
+  analyticsHelper,
+  emit
 }) => {
   const stepsWithClientAndUserId = steps.map(step => ({
     ...step.toJSON(),
@@ -21,6 +22,10 @@ export const commitStep = ({
     userId
   }));
   const start = new Date().getTime();
+  emit('commit-status', {
+    status: 'attempt',
+    version
+  });
   try {
     broadcast('steps:commit', {
       steps: stepsWithClientAndUserId,
@@ -38,6 +43,10 @@ export const commitStep = ({
           latency,
           stepType: countBy(stepsWithClientAndUserId, stepWithClientAndUserId => stepWithClientAndUserId.stepType)
         });
+        emit('commit-status', {
+          status: 'success',
+          version: response.version
+        });
       } else if (response.type === AcknowledgementResponseTypes.ERROR) {
         onErrorHandled(response.error);
         analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.FAILURE, {
@@ -48,14 +57,26 @@ export const commitStep = ({
           latency
         });
         analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(response.error, 'Error while adding steps - Acknowledgement Error');
+        emit('commit-status', {
+          status: 'failure',
+          version
+        });
       } else {
         analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(
         // @ts-expect-error We didn't type the invalid type case
         new Error(`Response type: ${(response === null || response === void 0 ? void 0 : response.type) || 'No response type'}`), 'Error while adding steps - Invalid Acknowledgement');
+        emit('commit-status', {
+          status: 'failure',
+          version
+        });
       }
     });
   } catch (error) {
     analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(error, 'Error while adding steps - Broadcast threw exception');
+    emit('commit-status', {
+      status: 'failure',
+      version
+    });
   }
 };
 export const throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {

package/dist/es2019/provider/index.js

@@ -91,6 +91,16 @@ export class Provider extends Emitter {
         this.isProviderInitialized = true;
       }).on('restore', this.documentService.onRestore).on('steps:added', this.documentService.onStepsAdded).on('metadata:changed', this.metadataService.onMetadataChanged).on('participant:telepointer', payload => this.participantsService.onParticipantTelepointer(payload, this.sessionId)).on('presence:joined', this.participantsService.onPresenceJoined).on('presence', this.participantsService.onPresence).on('participant:left', this.participantsService.onParticipantLeft).on('participant:updated', this.participantsService.onParticipantUpdated).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled).on('status', this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
     });
+    _defineProperty(this, "setUserId", id => {
+      this.userId = id;
+    });
+    _defineProperty(this, "getPresenceData", () => {
+      return {
+        sessionId: this.sessionId,
+        userId: this.userId,
+        clientId: this.clientId
+      };
+    });
     /**
      * @param {InternalError} error The error to handle
      */
@@ -147,7 +157,7 @@ export class Provider extends Emitter {
      */
     _defineProperty(this, "getFinalAcknowledgedState", async () => {
       try {
-        return this.documentService.getFinalAcknowledgedState();
+        return await this.documentService.getFinalAcknowledgedState();
       } catch (error) {
         var _this$analyticsHelper4;
         (_this$analyticsHelper4 = this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
@@ -171,9 +181,9 @@ export class Provider extends Emitter {
     this.initialDraft = this.config.initialDraft;
     this.isProviderInitialized = false;
     this.isPreinitializing = false;
-    this.participantsService = new ParticipantsService(this.analyticsHelper, undefined, this.emitCallback, this.config.getUser, this.channel.broadcast, this.channel.sendPresenceJoined);
+    this.participantsService = new ParticipantsService(this.analyticsHelper, undefined, this.emitCallback, this.config.getUser, this.channel.broadcast, this.channel.sendPresenceJoined, this.getPresenceData, this.setUserId);
     this.metadataService = new MetadataService(this.emitCallback, this.channel.sendMetadata);
-    this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService);
+    this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService, this.config.failedStepLimitBeforeCatchupOnPublish);
     this.getStatePromise = new Promise(resolve => {
       this.getStatePromiseResolve = resolve;
     });

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.0.0";
+export const version = "9.1.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": "9.0.0",
+	"version": "9.1.0",
 	"sideEffects": false
 }

package/dist/esm/channel.js

@@ -343,6 +343,12 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       }
       _this.socket.emit('metadata', metadata);
     });
+    _defineProperty(_assertThisInitialized(_this), "sendPresenceJoined", function () {
+      if (!_this.connected || !_this.socket) {
+        return;
+      }
+      _this.socket.emit('presence:joined');
+    });
     _defineProperty(_assertThisInitialized(_this), "onOnlineHandler", function () {
       // Force an immediate reconnect, the socket must first be closed to reset reconnection delay logic
       if (!_this.connected) {
@@ -559,14 +565,6 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       // Fired upon a reconnection attempt error (from Socket.IO Manager)
       this.socket.io.on('reconnect_error', this.onReconnectError);
     }
-  }, {
-    key: "sendPresenceJoined",
-    value: function sendPresenceJoined() {
-      if (!this.connected || !this.socket) {
-        return;
-      }
-      this.socket.emit('presence:joined');
-    }
   }, {
     key: "disconnect",
     value: function disconnect() {

package/dist/esm/document/catchup.js

@@ -3,6 +3,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { createLogger } from '../helpers/utils';
 import { StepMap, Mapping } from 'prosemirror-transform';
 var logger = createLogger('Catchup', 'red');
@@ -34,7 +35,7 @@ export function rebaseSteps(steps, mapping) {
 }
 export var catchup = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(opt) {
-    var _yield$opt$fetchCatch, doc, serverStepMaps, serverVersion, metadata, currentPmVersion, unconfirmedSteps, _unconfirmedSteps, stepMaps, mapping, newUnconfirmedSteps;
+    var _yield$opt$fetchCatch, doc, serverStepMaps, serverVersion, metadata, currentPmVersion, unconfirmedSteps, _unconfirmedSteps, stepMaps, mapping, newUnconfirmedSteps, _opt$analyticsHelper;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
@@ -112,6 +113,12 @@ export var catchup = /*#__PURE__*/function () {
                 mapping = new Mapping(stepMaps);
                 logger("".concat(_unconfirmedSteps.length, " unconfirmed steps before rebased: ").concat(JSON.stringify(_unconfirmedSteps)));
                 newUnconfirmedSteps = rebaseSteps(_unconfirmedSteps, mapping);
+                if ((newUnconfirmedSteps === null || newUnconfirmedSteps === void 0 ? void 0 : newUnconfirmedSteps.length) < _unconfirmedSteps.length) {
+                  // Log the dropped steps after rebase
+                  (_opt$analyticsHelper = opt.analyticsHelper) === null || _opt$analyticsHelper === void 0 ? void 0 : _opt$analyticsHelper.sendActionEvent(EVENT_ACTION.DROPPED_STEPS, EVENT_STATUS.SUCCESS, {
+                    numOfDroppedSteps: _unconfirmedSteps.length - (newUnconfirmedSteps === null || newUnconfirmedSteps === void 0 ? void 0 : newUnconfirmedSteps.length)
+                  });
+                }
                 logger("Re-aply ".concat(newUnconfirmedSteps.length, " mapped unconfirmed steps: ").concat(JSON.stringify(newUnconfirmedSteps)));
                 // Re-apply local steps
                 opt.applyLocalSteps(newUnconfirmedSteps);

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

@@ -30,16 +30,19 @@ export var DocumentService = /*#__PURE__*/function () {
    * @param analyticsHelper - Helper for analytics events
    * @param fetchCatchup - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
    * @param providerEmitCallback - Callback for emitting events to listeners on the provider
-   * @param broadcastMetadata - Callback for broadcasting metadata changes to other clients
    * @param broadcast - Callback for broadcasting events to other clients
    * @param getUserId - Callback to fetch the current user's ID
    * @param onErrorHandled - Callback to handle
+   * @param metadataService
+   * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
    */
   function DocumentService(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
+    var failedStepsBeforeCatchupOnPublish = arguments.length > 8 && arguments[8] !== undefined ? arguments[8] : MAX_STEP_REJECTED_ERROR;
     _classCallCheck(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
+    _defineProperty(this, "aggressiveCatchup", false);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */
@@ -78,7 +81,8 @@ export var DocumentService = /*#__PURE__*/function () {
               filterQueue: _this.stepQueue.filterQueue,
               applyLocalSteps: _this.applyLocalSteps,
               updateDocument: _this.updateDocument,
-              updateMetadata: _this.metadataService.updateMetadata
+              updateMetadata: _this.metadataService.updateMetadata,
+              analyticsHelper: _this.analyticsHelper
             });
           case 8:
             latency = new Date().getTime() - start;
@@ -273,34 +277,37 @@ export var DocumentService = /*#__PURE__*/function () {
       return _regeneratorRuntime.wrap(function _callee3$(_context3) {
         while (1) switch (_context3.prev = _context3.next) {
           case 0:
-            _context3.prev = 0;
+            _this.aggressiveCatchup = true;
+            _context3.prev = 1;
             startMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-            _context3.next = 4;
+            _context3.next = 5;
             return _this.commitUnconfirmedSteps();
-          case 4:
-            _context3.next = 6;
+          case 5:
+            _context3.next = 7;
             return _this.getCurrentState();
-          case 6:
+          case 7:
             currentState = _context3.sent;
             measure = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
             (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.SUCCESS, {
               latency: measure === null || measure === void 0 ? void 0 : measure.duration
             });
+            _this.aggressiveCatchup = false;
             return _context3.abrupt("return", currentState);
-          case 12:
-            _context3.prev = 12;
-            _context3.t0 = _context3["catch"](0);
+          case 14:
+            _context3.prev = 14;
+            _context3.t0 = _context3["catch"](1);
+            _this.aggressiveCatchup = false;
             _measure2 = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
             (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.FAILURE, {
               latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration
             });
             (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
             throw _context3.t0;
-          case 18:
+          case 21:
           case "end":
             return _context3.stop();
         }
-      }, _callee3, null, [[0, 12]]);
+      }, _callee3, null, [[1, 14]]);
     })));
     _defineProperty(this, "updateDocument", function (_ref6) {
       var doc = _ref6.doc,
@@ -345,7 +352,7 @@ export var DocumentService = /*#__PURE__*/function () {
             }
             _this.sendStepsFromCurrentState();
             _context4.next = 12;
-            return sleep(1000);
+            return sleep(500);
           case 12:
             nextUnconfirmedSteps = _this.getUnconfirmedSteps();
             if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
@@ -401,10 +408,17 @@ export var DocumentService = /*#__PURE__*/function () {
       }, _callee4, null, [[1, 23]]);
     })));
     _defineProperty(this, "onStepRejectedError", function () {
+      var _this$analyticsHelper20;
       _this.stepRejectCounter++;
       logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
-      if (_this.stepRejectCounter >= MAX_STEP_REJECTED_ERROR) {
+      (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
+        count: _this.stepRejectCounter
+      });
+      var maxRetries = _this.aggressiveCatchup ? _this.failedStepsBeforeCatchupOnPublish : MAX_STEP_REJECTED_ERROR;
+      if (_this.stepRejectCounter >= maxRetries) {
+        var _this$analyticsHelper21;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
+        (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
         _this.throttledCatchup();
       } else {
         // If committing steps failed try again automatically in 1s
@@ -424,6 +438,7 @@ export var DocumentService = /*#__PURE__*/function () {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
+    this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
     this.stepQueue = new StepQueueState();
   }
   _createClass(DocumentService, [{
@@ -475,9 +490,9 @@ export var DocumentService = /*#__PURE__*/function () {
             }, 100);
           }
         } catch (error) {
-          var _this$analyticsHelper20;
+          var _this$analyticsHelper22;
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
-          (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(error, 'Error while processing steps');
+          (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendErrorEvent(error, 'Error while processing steps');
           this.throttledCatchup();
         }
       }
@@ -542,7 +557,8 @@ export var DocumentService = /*#__PURE__*/function () {
         version: version,
         onStepsAdded: this.onStepsAdded,
         onErrorHandled: this.onErrorHandled,
-        analyticsHelper: this.analyticsHelper
+        analyticsHelper: this.analyticsHelper,
+        emit: this.providerEmitCallback
       });
     }
   }]);

package/dist/esm/helpers/const.js

@@ -10,11 +10,15 @@ export var EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["PUBLISH_PAGE"] = "publishPage";
   EVENT_ACTION["GET_CURRENT_STATE"] = "getCurrentState";
   EVENT_ACTION["INVALIDATE_TOKEN"] = "invalidateToken";
+  EVENT_ACTION["SEND_STEPS_RETRY"] = "sendStepsRetry";
+  EVENT_ACTION["CATCHUP_AFTER_MAX_SEND_STEPS_RETRY"] = "catchupAfterMaxSendStepsRetry";
+  EVENT_ACTION["DROPPED_STEPS"] = "droppedStepInCatchup";
   return EVENT_ACTION;
 }({});
 export var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";
+  EVENT_STATUS["INFO"] = "INFO";
   return EVENT_STATUS;
 }({});
 export var ADD_STEPS_TYPE = /*#__PURE__*/function (ADD_STEPS_TYPE) {
@@ -23,5 +27,5 @@ export var ADD_STEPS_TYPE = /*#__PURE__*/function (ADD_STEPS_TYPE) {
   ADD_STEPS_TYPE["ERROR"] = "ERROR";
   return ADD_STEPS_TYPE;
 }({});
-export var ACK_MAX_TRY = 30;
+export var ACK_MAX_TRY = 60;
 export var CONFLUENCE = 'confluence';

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

@@ -31,6 +31,8 @@ export var ParticipantsService = /*#__PURE__*/function () {
     var getUser = arguments.length > 3 ? arguments[3] : undefined;
     var channelBroadcast = arguments.length > 4 ? arguments[4] : undefined;
     var sendPresenceJoined = arguments.length > 5 ? arguments[5] : undefined;
+    var getPresenceData = arguments.length > 6 ? arguments[6] : undefined;
+    var setUserId = arguments.length > 7 ? arguments[7] : undefined;
     _classCallCheck(this, ParticipantsService);
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
@@ -227,12 +229,13 @@ export var ParticipantsService = /*#__PURE__*/function () {
     _defineProperty(this, "clearTimers", function () {
       clearTimeout(_this.participantUpdateTimeout);
     });
-    _defineProperty(this, "sendPresence", function (payload) {
+    _defineProperty(this, "sendPresence", function () {
       try {
         clearTimeout(_this.presenceUpdateTimeout);
-        _this.channelBroadcast('participant:updated', payload);
+        var _data = _this.getPresenceData();
+        _this.channelBroadcast('participant:updated', _data);
         _this.presenceUpdateTimeout = window.setTimeout(function () {
-          return _this.sendPresence(payload);
+          return _this.sendPresence();
         }, SEND_PRESENCE_INTERVAL);
       } catch (error) {
         var _this$analyticsHelper7;
@@ -251,7 +254,7 @@ export var ParticipantsService = /*#__PURE__*/function () {
       try {
         logger('Participant joined with session: ', payload.sessionId);
         // This expose existing users to the newly joined user
-        _this.sendPresence(payload);
+        _this.sendPresence();
       } catch (error) {
         var _this$analyticsHelper8;
         // We don't want to throw errors for Presence features as they tend to self-restore
@@ -267,7 +270,8 @@ export var ParticipantsService = /*#__PURE__*/function () {
     _defineProperty(this, "onPresence", function (payload) {
       try {
         logger('onPresence userId: ', payload.userId);
-        _this.sendPresence(payload);
+        _this.setUserId(payload.userId);
+        _this.sendPresence();
         _this.sendPresenceJoined();
       } catch (error) {
         var _this$analyticsHelper9;
@@ -281,6 +285,8 @@ export var ParticipantsService = /*#__PURE__*/function () {
     this.getUser = getUser;
     this.channelBroadcast = channelBroadcast;
     this.sendPresenceJoined = sendPresenceJoined;
+    this.getPresenceData = getPresenceData;
+    this.setUserId = setUserId;
   }
   _createClass(ParticipantsService, [{
     key: "emitTelepointersFromSteps",

package/dist/esm/provider/commit-step.js

@@ -16,7 +16,8 @@ export var commitStep = function commitStep(_ref) {
     clientId = _ref.clientId,
     onStepsAdded = _ref.onStepsAdded,
     onErrorHandled = _ref.onErrorHandled,
-    analyticsHelper = _ref.analyticsHelper;
+    analyticsHelper = _ref.analyticsHelper,
+    emit = _ref.emit;
   var stepsWithClientAndUserId = steps.map(function (step) {
     return _objectSpread(_objectSpread({}, step.toJSON()), {}, {
       clientId: clientId,
@@ -24,6 +25,10 @@ export var commitStep = function commitStep(_ref) {
     });
   });
   var start = new Date().getTime();
+  emit('commit-status', {
+    status: 'attempt',
+    version: version
+  });
   try {
     broadcast('steps:commit', {
       steps: stepsWithClientAndUserId,
@@ -43,6 +48,10 @@ export var commitStep = function commitStep(_ref) {
             return stepWithClientAndUserId.stepType;
           })
         });
+        emit('commit-status', {
+          status: 'success',
+          version: response.version
+        });
       } else if (response.type === AcknowledgementResponseTypes.ERROR) {
         onErrorHandled(response.error);
         analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.FAILURE, {
@@ -53,14 +62,26 @@ export var commitStep = function commitStep(_ref) {
           latency: latency
         });
         analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(response.error, 'Error while adding steps - Acknowledgement Error');
+        emit('commit-status', {
+          status: 'failure',
+          version: version
+        });
       } else {
         analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(
         // @ts-expect-error We didn't type the invalid type case
         new Error("Response type: ".concat((response === null || response === void 0 ? void 0 : response.type) || 'No response type')), 'Error while adding steps - Invalid Acknowledgement');
+        emit('commit-status', {
+          status: 'failure',
+          version: version
+        });
       }
     });
   } catch (error) {
     analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendErrorEvent(error, 'Error while adding steps - Broadcast threw exception');
+    emit('commit-status', {
+      status: 'failure',
+      version: version
+    });
   }
 };
 export var throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {

package/dist/esm/provider/index.js

@@ -107,6 +107,16 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         return _this.participantsService.onParticipantTelepointer(payload, _this.sessionId);
       }).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind(_assertThisInitialized(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
     });
+    _defineProperty(_assertThisInitialized(_this), "setUserId", function (id) {
+      _this.userId = id;
+    });
+    _defineProperty(_assertThisInitialized(_this), "getPresenceData", function () {
+      return {
+        sessionId: _this.sessionId,
+        userId: _this.userId,
+        clientId: _this.clientId
+      };
+    });
     /**
      * @param {InternalError} error The error to handle
      */
@@ -175,17 +185,20 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
             _context2.prev = 0;
-            return _context2.abrupt("return", _this.documentService.getFinalAcknowledgedState());
-          case 4:
-            _context2.prev = 4;
+            _context2.next = 3;
+            return _this.documentService.getFinalAcknowledgedState();
+          case 3:
+            return _context2.abrupt("return", _context2.sent);
+          case 6:
+            _context2.prev = 6;
             _context2.t0 = _context2["catch"](0);
             (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
             throw new GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
-          case 8:
+          case 10:
           case "end":
             return _context2.stop();
         }
-      }, _callee2, null, [[0, 4]]);
+      }, _callee2, null, [[0, 6]]);
     })));
     _defineProperty(_assertThisInitialized(_this), "getUnconfirmedSteps", function () {
       return _this.documentService.getUnconfirmedSteps();
@@ -204,11 +217,11 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this.initialDraft = _this.config.initialDraft;
     _this.isProviderInitialized = false;
     _this.isPreinitializing = false;
-    _this.participantsService = new ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined);
+    _this.participantsService = new ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId);
     _this.metadataService = new MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     _this.documentService = new DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService);
+    }, _this.onErrorHandled, _this.metadataService, _this.config.failedStepLimitBeforeCatchupOnPublish);
     _this.getStatePromise = new Promise(function (resolve) {
       _this.getStatePromiseResolve = resolve;
     });

package/dist/esm/version-wrapper.js

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

package/dist/esm/version.json

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

package/dist/types/channel.d.ts

@@ -41,7 +41,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
      * @throws {NotConnectedError} Channel not connected
      */
     sendMetadata: (metadata: Metadata) => void;
-    sendPresenceJoined(): void;
+    sendPresenceJoined: () => void;
     onOnlineHandler: () => void;
     disconnect(): void;
 }

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

@@ -16,10 +16,12 @@ export declare class DocumentService {
     private getUserId;
     private onErrorHandled;
     private metadataService;
+    private failedStepsBeforeCatchupOnPublish;
     private getState;
     private onSyncUpError?;
     private stepQueue;
     private stepRejectCounter;
+    private aggressiveCatchup;
     private clientId?;
     /**
      *
@@ -28,12 +30,13 @@ export declare class DocumentService {
      * @param analyticsHelper - Helper for analytics events
      * @param fetchCatchup - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
      * @param providerEmitCallback - Callback for emitting events to listeners on the provider
-     * @param broadcastMetadata - Callback for broadcasting metadata changes to other clients
      * @param broadcast - Callback for broadcasting events to other clients
      * @param getUserId - Callback to fetch the current user's ID
      * @param onErrorHandled - Callback to handle
+     * @param metadataService
+     * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService);
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, failedStepsBeforeCatchupOnPublish?: number);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */