@atlaskit/collab-provider 9.0.1 → 9.2.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/collab-provider
 
+## 9.2.0
+
+### Minor Changes
+
+- [`ef726a72028`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ef726a72028) - adding provider catchup when initial draft timestamp exceeds stale timeout
+
+## 9.1.0
+
+### Minor Changes
+
+- [`2c0c19cc14b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2c0c19cc14b) - ESS-3609: add step commit status events for confl save indicator feature
+- [`470c3a7e8c6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/470c3a7e8c6) - ESS-3644: allow max steps retry param to be passed thru collab provider to allow getFinalAcknowledgeState to catch up sooner on publish
+
 ## 9.0.1
 
 ### Patch Changes

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

@@ -37,16 +37,19 @@ 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] : _provider.MAX_STEP_REJECTED_ERROR;
     (0, _classCallCheck2.default)(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     (0, _defineProperty2.default)(this, "stepRejectCounter", 0);
+    (0, _defineProperty2.default)(this, "aggressiveCatchup", false);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */
@@ -281,34 +284,37 @@ var DocumentService = /*#__PURE__*/function () {
       return _regenerator.default.wrap(function _callee3$(_context3) {
         while (1) switch (_context3.prev = _context3.next) {
           case 0:
-            _context3.prev = 0;
+            _this.aggressiveCatchup = true;
+            _context3.prev = 1;
             (0, _performance.startMeasure)(_performance.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 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
             (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.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 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
             (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.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]]);
     })));
     (0, _defineProperty2.default)(this, "updateDocument", function (_ref6) {
       var doc = _ref6.doc,
@@ -409,10 +415,17 @@ var DocumentService = /*#__PURE__*/function () {
       }, _callee4, null, [[1, 23]]);
     })));
     (0, _defineProperty2.default)(this, "onStepRejectedError", function () {
+      var _this$analyticsHelper20;
       _this.stepRejectCounter++;
       logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
-      if (_this.stepRejectCounter >= _provider.MAX_STEP_REJECTED_ERROR) {
+      (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO, {
+        count: _this.stepRejectCounter
+      });
+      var maxRetries = _this.aggressiveCatchup ? _this.failedStepsBeforeCatchupOnPublish : _provider.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(_provider.MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
+        (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(_const.EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO);
         _this.throttledCatchup();
       } else {
         // If committing steps failed try again automatically in 1s
@@ -432,6 +445,7 @@ var DocumentService = /*#__PURE__*/function () {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
+    this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
     this.stepQueue = new _stepQueueState.StepQueueState();
   }
   (0, _createClass2.default)(DocumentService, [{
@@ -483,9 +497,9 @@ 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();
         }
       }
@@ -550,7 +564,8 @@ var DocumentService = /*#__PURE__*/function () {
         version: version,
         onStepsAdded: this.onStepsAdded,
         onErrorHandled: this.onErrorHandled,
-        analyticsHelper: this.analyticsHelper
+        analyticsHelper: this.analyticsHelper,
+        emit: this.providerEmitCallback
       });
     }
   }]);

package/dist/cjs/helpers/const.js

@@ -16,6 +16,8 @@ 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;
 }({});
@@ -23,6 +25,7 @@ exports.EVENT_ACTION = EVENT_ACTION;
 var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";
+  EVENT_STATUS["INFO"] = "INFO";
   return EVENT_STATUS;
 }({});
 exports.EVENT_STATUS = EVENT_STATUS;

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

@@ -23,7 +23,8 @@ 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,
@@ -31,6 +32,10 @@ var commitStep = function commitStep(_ref) {
     });
   });
   var start = new Date().getTime();
+  emit('commit-status', {
+    status: 'attempt',
+    version: version
+  });
   try {
     broadcast('steps:commit', {
       steps: stepsWithClientAndUserId,
@@ -50,6 +55,10 @@ var commitStep = function commitStep(_ref) {
             return stepWithClientAndUserId.stepType;
           })
         });
+        emit('commit-status', {
+          status: 'success',
+          version: response.version
+        });
       } else if (response.type === _types.AcknowledgementResponseTypes.ERROR) {
         onErrorHandled(response.error);
         analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(_const.EVENT_ACTION.ADD_STEPS, _const.EVENT_STATUS.FAILURE, {
@@ -60,14 +69,26 @@ 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
+    });
   }
 };
 exports.commitStep = commitStep;

package/dist/cjs/provider/index.js

@@ -30,6 +30,7 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 var logger = (0, _utils.createLogger)('Provider', 'black');
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
+var PRELOAD_DRAFT_SYNC_PERIOD = 15 * 1000; // 15 seconds
 
 var MAX_STEP_REJECTED_ERROR = 15;
 exports.MAX_STEP_REJECTED_ERROR = MAX_STEP_REJECTED_ERROR;
@@ -75,20 +76,27 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           sid: sid,
           initial: !initialized
         });
-        // If initial draft is already present and the channel is initialized,
-        // fire the provider's init event with initial draft document and version
+
+        // Early initialization with initial draft passed via provider
         if (_this.initialDraft && initialized && !_this.isProviderInitialized) {
-          var _this$initialDraft = _this.initialDraft,
-            document = _this$initialDraft.document,
-            version = _this$initialDraft.version,
-            metadata = _this$initialDraft.metadata;
-          // Initial document, version, metadata from initial draft
-          _this.documentService.updateDocument({
-            doc: document,
-            version: version,
-            metadata: metadata
-          });
-          _this.metadataService.updateMetadata(metadata);
+          // Call catchup if the draft has become stale since being passed to provider
+          if (_this.isDraftTimestampStale()) {
+            _this.documentService.throttledCatchup();
+          }
+          // If the initial draft is already up to date, update the document with that of the initial draft
+          else {
+            var _this$initialDraft = _this.initialDraft,
+              document = _this$initialDraft.document,
+              version = _this$initialDraft.version,
+              metadata = _this$initialDraft.metadata;
+            // Initial document, version, metadata from initial draft
+            _this.documentService.updateDocument({
+              doc: document,
+              version: version,
+              metadata: metadata
+            });
+            _this.metadataService.updateMetadata(metadata);
+          }
           _this.isProviderInitialized = true;
         }
         // If already initialized, `connected` means reconnected
@@ -229,7 +237,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     _this.metadataService = new _metadataService.MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     _this.documentService = new _documentService.DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService);
+    }, _this.onErrorHandled, _this.metadataService, _this.config.failedStepLimitBeforeCatchupOnPublish);
     _this.getStatePromise = new Promise(function (resolve) {
       _this.getStatePromiseResolve = resolve;
     });
@@ -316,6 +324,21 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       }
     }
 
+    /**
+     * Checks the provider's initial draft timestamp to determine if it is stale.
+     * Returns true only if the time elapsed since the draft timestamp is greater than or
+     * equal to a predetermined timeout. Returns false in all other cases.
+     */
+  }, {
+    key: "isDraftTimestampStale",
+    value: function isDraftTimestampStale() {
+      var _this$initialDraft2;
+      if (!((_this$initialDraft2 = this.initialDraft) !== null && _this$initialDraft2 !== void 0 && _this$initialDraft2.timestamp)) {
+        return false;
+      }
+      return Date.now() - this.initialDraft.timestamp >= PRELOAD_DRAFT_SYNC_PERIOD;
+    }
+
     /**
      * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
      * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider

package/dist/cjs/version-wrapper.js

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

package/dist/cjs/version.json

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

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

@@ -24,14 +24,16 @@ export 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, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
+  constructor(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, failedStepsBeforeCatchupOnPublish = MAX_STEP_REJECTED_ERROR) {
     // 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
      */
@@ -236,6 +238,7 @@ export class DocumentService {
       }
     });
     _defineProperty(this, "getFinalAcknowledgedState", async () => {
+      this.aggressiveCatchup = true;
       try {
         var _this$analyticsHelper14;
         startMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
@@ -245,9 +248,11 @@ export class DocumentService {
         (_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 currentState;
       } catch (error) {
         var _this$analyticsHelper15, _this$analyticsHelper16;
+        this.aggressiveCatchup = false;
         const measure = 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: measure === null || measure === void 0 ? void 0 : measure.duration
@@ -332,10 +337,17 @@ export class DocumentService {
       }
     });
     _defineProperty(this, "onStepRejectedError", () => {
+      var _this$analyticsHelper20;
       this.stepRejectCounter++;
       logger(`Steps rejected (tries=${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
+      });
+      let 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=${this.stepRejectCounter}, limit=${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
@@ -353,6 +365,7 @@ export class DocumentService {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
+    this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
     this.stepQueue = new StepQueueState();
   }
   processQueue() {
@@ -398,9 +411,9 @@ export class DocumentService {
           setTimeout(() => this.sendStepsFromCurrentState(), 100);
         }
       } catch (error) {
-        var _this$analyticsHelper20;
+        var _this$analyticsHelper22;
         logger(`Processing steps failed with error: ${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();
       }
     }
@@ -459,7 +472,8 @@ export class DocumentService {
       version,
       onStepsAdded: this.onStepsAdded,
       onErrorHandled: this.onErrorHandled,
-      analyticsHelper: this.analyticsHelper
+      analyticsHelper: this.analyticsHelper,
+      emit: this.providerEmitCallback
     });
   }
 }

package/dist/es2019/helpers/const.js

@@ -10,12 +10,15 @@ export let 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 let EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";
+  EVENT_STATUS["INFO"] = "INFO";
   return EVENT_STATUS;
 }({});
 export let ADD_STEPS_TYPE = /*#__PURE__*/function (ADD_STEPS_TYPE) {

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

@@ -12,6 +12,7 @@ import { ParticipantsService } from '../participants/participants-service';
 import { errorCodeMapper } from '../errors/error-code-mapper';
 const logger = createLogger('Provider', 'black');
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
+const PRELOAD_DRAFT_SYNC_PERIOD = 15 * 1000; // 15 seconds
 
 export const MAX_STEP_REJECTED_ERROR = 15;
 export class Provider extends Emitter {
@@ -51,21 +52,28 @@ export class Provider extends Emitter {
           sid,
           initial: !initialized
         });
-        // If initial draft is already present and the channel is initialized,
-        // fire the provider's init event with initial draft document and version
+
+        // Early initialization with initial draft passed via provider
         if (this.initialDraft && initialized && !this.isProviderInitialized) {
-          const {
-            document,
-            version,
-            metadata
-          } = this.initialDraft;
-          // Initial document, version, metadata from initial draft
-          this.documentService.updateDocument({
-            doc: document,
-            version,
-            metadata
-          });
-          this.metadataService.updateMetadata(metadata);
+          // Call catchup if the draft has become stale since being passed to provider
+          if (this.isDraftTimestampStale()) {
+            this.documentService.throttledCatchup();
+          }
+          // If the initial draft is already up to date, update the document with that of the initial draft
+          else {
+            const {
+              document,
+              version,
+              metadata
+            } = this.initialDraft;
+            // Initial document, version, metadata from initial draft
+            this.documentService.updateDocument({
+              doc: document,
+              version,
+              metadata
+            });
+            this.metadataService.updateMetadata(metadata);
+          }
           this.isProviderInitialized = true;
         }
         // If already initialized, `connected` means reconnected
@@ -183,7 +191,7 @@ export class Provider extends Emitter {
     this.isPreinitializing = false;
     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;
     });
@@ -261,6 +269,19 @@ export class Provider extends Emitter {
     }
   }
 
+  /**
+   * Checks the provider's initial draft timestamp to determine if it is stale.
+   * Returns true only if the time elapsed since the draft timestamp is greater than or
+   * equal to a predetermined timeout. Returns false in all other cases.
+   */
+  isDraftTimestampStale() {
+    var _this$initialDraft;
+    if (!((_this$initialDraft = this.initialDraft) !== null && _this$initialDraft !== void 0 && _this$initialDraft.timestamp)) {
+      return false;
+    }
+    return Date.now() - this.initialDraft.timestamp >= PRELOAD_DRAFT_SYNC_PERIOD;
+  }
+
   /**
    * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
    * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider

package/dist/es2019/version-wrapper.js

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