@atlaskit/collab-provider 9.17.2 → 9.17.4

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/collab-provider
 
+## 9.17.4
+
+### Patch Changes
+
+- [#57317](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/57317) [`d989b4568594`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/d989b4568594) - ESS-4149: Add send steps queue under FF
+- Updated dependencies
+
+## 9.17.3
+
+### Patch Changes
+
+- [#56940](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/56940) [`e862ee8c3290`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e862ee8c3290) - Add success analytics for updating document
+- [#57024](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/57024) [`4807b15145e2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4807b15145e2) - Update commented link for update document action
+
 ## 9.17.2
 
 ### Patch Changes

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

@@ -20,6 +20,7 @@ var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
 var _provider = require("../provider");
 var _catchup = require("./catchup");
 var _stepQueueState = require("./step-queue-state");
+var _featureFlags = require("../feature-flags");
 var _errorTypes = require("../errors/error-types");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -43,11 +44,12 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
    * @param onErrorHandled - Callback to handle
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
+   * @param enableSendStepsQueue - Enable send steps queue.
    */
   function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
     var enableErrorOnFailedDocumentApply = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : false;
-    var enableSendStepsQueue = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
+    var enableSendStepsQueue = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : (0, _featureFlags.getCollabProviderFeatureFlag)('sendStepsQueueFF');
     (0, _classCallCheck2.default)(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     (0, _defineProperty2.default)(this, "stepRejectCounter", 0);
@@ -112,7 +114,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             _context.prev = 16;
             _this.stepQueue.resumeQueue();
             _this.processQueue();
-            _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls commitStep which will either catchup on onStepsAdded or onErrorHandled
+            _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls throttledCommitStep which will either catchup on onStepsAdded or onErrorHandled
             _this.stepRejectCounter = 0;
             return _context.finish(16);
           case 22:
@@ -353,10 +355,13 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       }, reserveCursor ? {
         reserveCursor: reserveCursor
       } : {}));
+      _this.updateDocumentAnalytics(doc, version);
+    });
+    (0, _defineProperty2.default)(this, "updateDocumentAnalytics", function (doc, version) {
       var updatedVersion = _this.getCurrentPmVersion();
+      var isDocContentValid = _this.validatePMJSONDocument(doc);
       if (_this.getCurrentPmVersion() !== version) {
         var _doc$content, _this$analyticsHelper17;
-        var isDocContentValid = _this.validatePMJSONDocument(doc);
         var _error = new _errorTypes.UpdateDocumentError('Failed to update the document', {
           newVersion: version,
           editorVersion: updatedVersion,
@@ -380,14 +385,23 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           throw _error;
         }
         // Otherwise just fail silently for now
+      } else {
+        var _this$analyticsHelper18, _doc$content2;
+        (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 || _this$analyticsHelper18.sendActionEvent(_const.EVENT_ACTION.UPDATE_DOCUMENT, _const.EVENT_STATUS.SUCCESS, {
+          newVersion: version,
+          editorVersion: updatedVersion,
+          isDocTruthy: !!doc,
+          docHasContent: (doc === null || doc === void 0 || (_doc$content2 = doc.content) === null || _doc$content2 === void 0 ? void 0 : _doc$content2.length) >= 1,
+          isDocContentValid: isDocContentValid
+        });
       }
     });
     (0, _defineProperty2.default)(this, "validatePMJSONDocument", function (doc) {
       try {
         var _this$getState5;
         if (!((_this$getState5 = _this.getState) !== null && _this$getState5 !== void 0 && _this$getState5.call(_this))) {
-          var _this$analyticsHelper18;
-          (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 || _this$analyticsHelper18.sendErrorEvent(new Error('Editor state is undefined'), 'validatePMJSONDocument called without state');
+          var _this$analyticsHelper19;
+          (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 || _this$analyticsHelper19.sendErrorEvent(new Error('Editor state is undefined'), 'validatePMJSONDocument called without state');
         }
         var state = _this.getState();
         var content = (doc.content || []).map(function (child) {
@@ -410,7 +424,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * @throws {Error} Couldn't sync the steps after retrying 30 times
      */
     (0, _defineProperty2.default)(this, "commitUnconfirmedSteps", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
-      var unconfirmedSteps, _this$getState6, _this$analyticsHelper20, count, unconfirmedTrs, lastTr, isLastTrConfirmed, _this$analyticsHelper19, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, state, unconfirmedStepsInfoUGCRemoved, _error2, measure, _this$analyticsHelper21, _this$analyticsHelper22, _measure3;
+      var unconfirmedSteps, _this$getState6, _this$analyticsHelper21, count, unconfirmedTrs, lastTr, isLastTrConfirmed, _this$analyticsHelper20, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, state, unconfirmedStepsInfoUGCRemoved, _error2, measure, _this$analyticsHelper22, _this$analyticsHelper23, _measure3;
       return _regenerator.default.wrap(function _callee4$(_context4) {
         while (1) switch (_context4.prev = _context4.next) {
           case 0:
@@ -429,7 +443,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
             isLastTrConfirmed = false;
             if (!((_this$getState6 = _this.getState) !== null && _this$getState6 !== void 0 && _this$getState6.call(_this))) {
-              (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 || _this$analyticsHelper19.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
+              (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 || _this$analyticsHelper20.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
             }
           case 9:
             if (isLastTrConfirmed) {
@@ -475,7 +489,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             break;
           case 22:
             measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 || _this$analyticsHelper20.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.SUCCESS, {
+            (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 || _this$analyticsHelper21.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.SUCCESS, {
               latency: measure === null || measure === void 0 ? void 0 : measure.duration,
               // upon success, emit the total number of unconfirmed steps we synced
               numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
@@ -487,11 +501,11 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             _context4.prev = 26;
             _context4.t0 = _context4["catch"](1);
             _measure3 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 || _this$analyticsHelper21.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
+            (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 || _this$analyticsHelper22.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
               latency: _measure3 === null || _measure3 === void 0 ? void 0 : _measure3.duration,
               numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
             });
-            (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 || _this$analyticsHelper22.sendErrorEvent(_context4.t0, 'Error while committing unconfirmed steps');
+            (_this$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 || _this$analyticsHelper23.sendErrorEvent(_context4.t0, 'Error while committing unconfirmed steps');
             throw _context4.t0;
           case 32:
           case "end":
@@ -500,17 +514,17 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       }, _callee4, null, [[1, 26]]);
     })));
     (0, _defineProperty2.default)(this, "onStepRejectedError", function () {
-      var _this$analyticsHelper23;
+      var _this$analyticsHelper24;
       _this.stepRejectCounter++;
       logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
-      (_this$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 || _this$analyticsHelper23.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO, {
+      (_this$analyticsHelper24 = _this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 || _this$analyticsHelper24.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO, {
         count: _this.stepRejectCounter
       });
       var maxRetries = _this.aggressiveCatchup ? _provider.MAX_STEP_REJECTED_ERROR_AGGRESSIVE : _provider.MAX_STEP_REJECTED_ERROR;
       if (_this.stepRejectCounter >= maxRetries) {
-        var _this$analyticsHelper24;
+        var _this$analyticsHelper25;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(_provider.MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
-        (_this$analyticsHelper24 = _this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 || _this$analyticsHelper24.sendActionEvent(_const.EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO);
+        (_this$analyticsHelper25 = _this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 || _this$analyticsHelper25.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
@@ -584,9 +598,9 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             }, 100);
           }
         } catch (error) {
-          var _this$analyticsHelper25;
+          var _this$analyticsHelper26;
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
-          (_this$analyticsHelper25 = this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 || _this$analyticsHelper25.sendErrorEvent(error, 'Error while processing steps');
+          (_this$analyticsHelper26 = this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 || _this$analyticsHelper26.sendErrorEvent(error, 'Error while processing steps');
           this.throttledCatchup();
         }
       }
@@ -616,8 +630,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       var _this$getState7;
       var state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
       if (!state) {
-        var _this$analyticsHelper26;
-        (_this$analyticsHelper26 = this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 || _this$analyticsHelper26.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
+        var _this$analyticsHelper27;
+        (_this$analyticsHelper27 = this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 || _this$analyticsHelper27.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
         return;
       }
       this.send(null, null, state, sendAnalyticsEvent);
@@ -642,8 +656,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       // to ensure that analytics events with the number of unconfirmed steps is only
       // sent once on connection (as opposed to on every step)
       if (sendAnalyticsEvent) {
-        var _this$analyticsHelper27;
-        (_this$analyticsHelper27 = this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 || _this$analyticsHelper27.sendActionEvent(_const.EVENT_ACTION.HAS_UNCONFIRMED_STEPS, _const.EVENT_STATUS.INFO, {
+        var _this$analyticsHelper28;
+        (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 || _this$analyticsHelper28.sendActionEvent(_const.EVENT_ACTION.HAS_UNCONFIRMED_STEPS, _const.EVENT_STATUS.INFO, {
           numUnconfirmedSteps: (unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) || 0
         });
       }
@@ -651,16 +665,15 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         return;
       }
       if (this.enableSendStepsQueue) {
-        // This is where we would call the sendStepsQueue instead of throttledCommitStep
         // Only send 1% of events to avoid useless logging
         if (Math.random() < 0.01) {
-          var _this$analyticsHelper28;
-          (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 || _this$analyticsHelper28.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_QUEUE, _const.EVENT_STATUS.INFO);
+          var _this$analyticsHelper29;
+          (_this$analyticsHelper29 = this.analyticsHelper) === null || _this$analyticsHelper29 === void 0 || _this$analyticsHelper29.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_QUEUE, _const.EVENT_STATUS.INFO);
         }
         // Avoid reference issues using a
         // method outside of the provider
         // scope
-        (0, _commitStep.throttledCommitStep)({
+        (0, _commitStep.commitStepQueue)({
           broadcast: this.broadcast,
           userId: this.getUserId(),
           clientId: this.clientId,

package/dist/cjs/helpers/const.js

@@ -10,6 +10,7 @@ var EVENT_ACTION = exports.EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["DOCUMENT_INIT"] = "documentInit";
   EVENT_ACTION["ADD_STEPS"] = "addSteps";
   EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
+  EVENT_ACTION["UPDATE_DOCUMENT"] = "updateDocument";
   EVENT_ACTION["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
   EVENT_ACTION["REINITIALISE_DOCUMENT"] = "reinitialiseDocument";
   EVENT_ACTION["ERROR"] = "error";

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

@@ -4,18 +4,20 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.throttledCommitStep = exports.commitStep = void 0;
+exports.throttledCommitStep = exports.commitStepQueue = exports.commitStep = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _countBy = _interopRequireDefault(require("lodash/countBy"));
 var _throttle = _interopRequireDefault(require("lodash/throttle"));
 var _const = require("../helpers/const");
 var _types = require("../types");
 var _errorTypes = require("../errors/error-types");
+var _utils = require("../helpers/utils");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var SEND_STEPS_THROTTLE = 500; // 0.5 second
-
-var commitStep = exports.commitStep = function commitStep(_ref) {
+var logger = (0, _utils.createLogger)('commit-step', 'black');
+var readyToCommit = true;
+var commitStepQueue = exports.commitStepQueue = function commitStepQueue(_ref) {
   var broadcast = _ref.broadcast,
     steps = _ref.steps,
     version = _ref.version,
@@ -25,6 +27,107 @@ var commitStep = exports.commitStep = function commitStep(_ref) {
     onErrorHandled = _ref.onErrorHandled,
     analyticsHelper = _ref.analyticsHelper,
     emit = _ref.emit;
+  if (!readyToCommit) {
+    logger('Not ready to commit, skip');
+    return;
+  }
+  // Block other sending request, before ACK
+  readyToCommit = false;
+  var timer = setTimeout(function () {
+    readyToCommit = true;
+    logger('reset readyToCommit by timer');
+  }, 5000);
+  var stepsWithClientAndUserId = steps.map(function (step) {
+    return _objectSpread(_objectSpread({}, step.toJSON()), {}, {
+      clientId: clientId,
+      userId: userId
+    });
+  });
+  var start = new Date().getTime();
+  emit('commit-status', {
+    status: 'attempt',
+    version: version
+  });
+  try {
+    broadcast('steps:commit', {
+      steps: stepsWithClientAndUserId,
+      version: version,
+      userId: userId
+    }, function (response) {
+      var latency = new Date().getTime() - start;
+      if (timer) {
+        clearTimeout(timer);
+        if (latency <= 400) {
+          setTimeout(function () {
+            readyToCommit = true;
+            logger('reset readyToCommit');
+          }, 100);
+        } else {
+          readyToCommit = true;
+          logger('reset readyToCommit');
+        }
+      }
+      if (response.type === _types.AcknowledgementResponseTypes.SUCCESS) {
+        onStepsAdded({
+          steps: stepsWithClientAndUserId,
+          version: response.version
+        });
+        // Sample only 10% of add steps events to avoid overwhelming the analytics
+        if (Math.random() < 0.1) {
+          analyticsHelper === null || analyticsHelper === void 0 || analyticsHelper.sendActionEvent(_const.EVENT_ACTION.ADD_STEPS, _const.EVENT_STATUS.SUCCESS_10x_SAMPLED, {
+            type: _const.ADD_STEPS_TYPE.ACCEPTED,
+            latency: latency,
+            stepType: (0, _countBy.default)(stepsWithClientAndUserId, function (stepWithClientAndUserId) {
+              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 || analyticsHelper.sendActionEvent(_const.EVENT_ACTION.ADD_STEPS, _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.data.code === _errorTypes.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || response.error.data.code === _errorTypes.NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS ? _const.ADD_STEPS_TYPE.REJECTED : _const.ADD_STEPS_TYPE.ERROR,
+          latency: latency
+        });
+        analyticsHelper === null || analyticsHelper === 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 || 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 || analyticsHelper.sendErrorEvent(error, 'Error while adding steps - Broadcast threw exception');
+    emit('commit-status', {
+      status: 'failure',
+      version: version
+    });
+  }
+};
+var commitStep = exports.commitStep = function commitStep(_ref2) {
+  var broadcast = _ref2.broadcast,
+    steps = _ref2.steps,
+    version = _ref2.version,
+    userId = _ref2.userId,
+    clientId = _ref2.clientId,
+    onStepsAdded = _ref2.onStepsAdded,
+    onErrorHandled = _ref2.onErrorHandled,
+    analyticsHelper = _ref2.analyticsHelper,
+    emit = _ref2.emit;
   var stepsWithClientAndUserId = steps.map(function (step) {
     return _objectSpread(_objectSpread({}, step.toJSON()), {}, {
       clientId: clientId,

package/dist/cjs/provider/index.js

@@ -274,6 +274,12 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       return _this.userId;
     }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply, (0, _featureFlags.getCollabProviderFeatureFlag)('sendStepsQueueFF', _this.config.featureFlags));
     _this.namespaceService = new _namespaceService.NamespaceService();
+    if ((0, _featureFlags.getCollabProviderFeatureFlag)('sendStepsQueueFF', _this.config.featureFlags)) {
+      _this.sendStepsTimer = setInterval(function () {
+        logger('Intervally sendStepsFromCurrentState');
+        _this.documentService.sendStepsFromCurrentState(true);
+      }, 5000);
+    }
     return _this;
   }
   (0, _createClass2.default)(Provider, [{
@@ -468,6 +474,12 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       try {
         (0, _get2.default)((0, _getPrototypeOf2.default)(Provider.prototype), "unsubscribeAll", this).call(this);
         this.channel.disconnect();
+        if ((0, _featureFlags.getCollabProviderFeatureFlag)('sendStepsQueueFF', this.config.featureFlags)) {
+          if (this.sendStepsTimer) {
+            clearInterval(this.sendStepsTimer);
+            this.sendStepsTimer = undefined;
+          }
+        }
       } catch (error) {
         var _this$analyticsHelper11;
         (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 || _this$analyticsHelper11.sendErrorEvent(error, 'Error while shutting down the collab provider');

package/dist/cjs/version-wrapper.js

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

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

@@ -3,12 +3,13 @@ import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { getVersion, sendableSteps } from '@atlaskit/prosemirror-collab';
 import { createLogger, getStepUGCFreeDetails, sleep } from '../helpers/utils';
 import throttle from 'lodash/throttle';
-import { throttledCommitStep } from '../provider/commit-step';
+import { throttledCommitStep, commitStepQueue } from '../provider/commit-step';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
 import { MAX_STEP_REJECTED_ERROR, MAX_STEP_REJECTED_ERROR_AGGRESSIVE } from '../provider';
 import { catchup } from './catchup';
 import { StepQueueState } from './step-queue-state';
+import { getCollabProviderFeatureFlag } from '../feature-flags';
 import { CantSyncUpError, INTERNAL_ERROR_CODE, UpdateDocumentError } from '../errors/error-types';
 const CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
@@ -30,8 +31,9 @@ export class DocumentService {
    * @param onErrorHandled - Callback to handle
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
+   * @param enableSendStepsQueue - Enable send steps queue.
    */
-  constructor(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, enableErrorOnFailedDocumentApply = false, enableSendStepsQueue = false) {
+  constructor(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, enableErrorOnFailedDocumentApply = false, enableSendStepsQueue = getCollabProviderFeatureFlag('sendStepsQueueFF')) {
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
     _defineProperty(this, "aggressiveCatchup", false);
@@ -82,7 +84,7 @@ export class DocumentService {
       } finally {
         this.stepQueue.resumeQueue();
         this.processQueue();
-        this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls commitStep which will either catchup on onStepsAdded or onErrorHandled
+        this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls throttledCommitStep which will either catchup on onStepsAdded or onErrorHandled
         this.stepRejectCounter = 0;
       }
     });
@@ -292,10 +294,13 @@ export class DocumentService {
           reserveCursor
         } : {})
       });
+      this.updateDocumentAnalytics(doc, version);
+    });
+    _defineProperty(this, "updateDocumentAnalytics", (doc, version) => {
       const updatedVersion = this.getCurrentPmVersion();
+      const isDocContentValid = this.validatePMJSONDocument(doc);
       if (this.getCurrentPmVersion() !== version) {
         var _doc$content, _this$analyticsHelper17;
-        const isDocContentValid = this.validatePMJSONDocument(doc);
         const error = new UpdateDocumentError('Failed to update the document', {
           newVersion: version,
           editorVersion: updatedVersion,
@@ -319,14 +324,23 @@ export class DocumentService {
           throw error;
         }
         // Otherwise just fail silently for now
+      } else {
+        var _this$analyticsHelper18, _doc$content2;
+        (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.UPDATE_DOCUMENT, EVENT_STATUS.SUCCESS, {
+          newVersion: version,
+          editorVersion: updatedVersion,
+          isDocTruthy: !!doc,
+          docHasContent: (doc === null || doc === void 0 ? void 0 : (_doc$content2 = doc.content) === null || _doc$content2 === void 0 ? void 0 : _doc$content2.length) >= 1,
+          isDocContentValid
+        });
       }
     });
     _defineProperty(this, "validatePMJSONDocument", doc => {
       try {
         var _this$getState5;
         if (!((_this$getState5 = this.getState) !== null && _this$getState5 !== void 0 && _this$getState5.call(this))) {
-          var _this$analyticsHelper18;
-          (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendErrorEvent(new Error('Editor state is undefined'), 'validatePMJSONDocument called without state');
+          var _this$analyticsHelper19;
+          (_this$analyticsHelper19 = this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendErrorEvent(new Error('Editor state is undefined'), 'validatePMJSONDocument called without state');
         }
         const state = this.getState();
         const content = (doc.content || []).map(child => state.schema.nodeFromJSON(child));
@@ -350,7 +364,7 @@ export class DocumentService {
       const unconfirmedSteps = this.getUnconfirmedSteps();
       try {
         if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
-          var _this$getState6, _this$analyticsHelper20;
+          var _this$getState6, _this$analyticsHelper21;
           startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
           let count = 0;
           // We use origins here as steps can be rebased. When steps are rebased a new step is created.
@@ -361,8 +375,8 @@ export class DocumentService {
           const lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
           let isLastTrConfirmed = false;
           if (!((_this$getState6 = this.getState) !== null && _this$getState6 !== void 0 && _this$getState6.call(this))) {
-            var _this$analyticsHelper19;
-            (_this$analyticsHelper19 = this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
+            var _this$analyticsHelper20;
+            (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
           }
           while (!isLastTrConfirmed) {
             this.sendStepsFromCurrentState();
@@ -394,35 +408,35 @@ export class DocumentService {
             }
           }
           const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-          (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
+          (_this$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
             // upon success, emit the total number of unconfirmed steps we synced
             numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
           });
         }
       } catch (error) {
-        var _this$analyticsHelper21, _this$analyticsHelper22;
+        var _this$analyticsHelper22, _this$analyticsHelper23;
         const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-        (_this$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
+        (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
           latency: measure === null || measure === void 0 ? void 0 : measure.duration,
           numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
         });
-        (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendErrorEvent(error, 'Error while committing unconfirmed steps');
+        (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendErrorEvent(error, 'Error while committing unconfirmed steps');
         throw error;
       }
     });
     _defineProperty(this, "onStepRejectedError", () => {
-      var _this$analyticsHelper23;
+      var _this$analyticsHelper24;
       this.stepRejectCounter++;
       logger(`Steps rejected (tries=${this.stepRejectCounter})`);
-      (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
+      (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
         count: this.stepRejectCounter
       });
       let maxRetries = this.aggressiveCatchup ? MAX_STEP_REJECTED_ERROR_AGGRESSIVE : MAX_STEP_REJECTED_ERROR;
       if (this.stepRejectCounter >= maxRetries) {
-        var _this$analyticsHelper24;
+        var _this$analyticsHelper25;
         logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
-        (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
+        (_this$analyticsHelper25 = this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 ? void 0 : _this$analyticsHelper25.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
         this.throttledCatchup();
       } else {
         // If committing steps failed try again automatically in 1s
@@ -488,9 +502,9 @@ export class DocumentService {
           setTimeout(() => this.sendStepsFromCurrentState(), 100);
         }
       } catch (error) {
-        var _this$analyticsHelper25;
+        var _this$analyticsHelper26;
         logger(`Processing steps failed with error: ${error}. Triggering catch up call.`);
-        (_this$analyticsHelper25 = this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 ? void 0 : _this$analyticsHelper25.sendErrorEvent(error, 'Error while processing steps');
+        (_this$analyticsHelper26 = this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 ? void 0 : _this$analyticsHelper26.sendErrorEvent(error, 'Error while processing steps');
         this.throttledCatchup();
       }
     }
@@ -517,8 +531,8 @@ export class DocumentService {
     var _this$getState7;
     const state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
     if (!state) {
-      var _this$analyticsHelper26;
-      (_this$analyticsHelper26 = this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 ? void 0 : _this$analyticsHelper26.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
+      var _this$analyticsHelper27;
+      (_this$analyticsHelper27 = this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 ? void 0 : _this$analyticsHelper27.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
       return;
     }
     this.send(null, null, state, sendAnalyticsEvent);
@@ -540,8 +554,8 @@ export class DocumentService {
     // to ensure that analytics events with the number of unconfirmed steps is only
     // sent once on connection (as opposed to on every step)
     if (sendAnalyticsEvent) {
-      var _this$analyticsHelper27;
-      (_this$analyticsHelper27 = this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 ? void 0 : _this$analyticsHelper27.sendActionEvent(EVENT_ACTION.HAS_UNCONFIRMED_STEPS, EVENT_STATUS.INFO, {
+      var _this$analyticsHelper28;
+      (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 ? void 0 : _this$analyticsHelper28.sendActionEvent(EVENT_ACTION.HAS_UNCONFIRMED_STEPS, EVENT_STATUS.INFO, {
         numUnconfirmedSteps: (unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) || 0
       });
     }
@@ -549,16 +563,15 @@ export class DocumentService {
       return;
     }
     if (this.enableSendStepsQueue) {
-      // This is where we would call the sendStepsQueue instead of throttledCommitStep
       // Only send 1% of events to avoid useless logging
       if (Math.random() < 0.01) {
-        var _this$analyticsHelper28;
-        (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 ? void 0 : _this$analyticsHelper28.sendActionEvent(EVENT_ACTION.SEND_STEPS_QUEUE, EVENT_STATUS.INFO);
+        var _this$analyticsHelper29;
+        (_this$analyticsHelper29 = this.analyticsHelper) === null || _this$analyticsHelper29 === void 0 ? void 0 : _this$analyticsHelper29.sendActionEvent(EVENT_ACTION.SEND_STEPS_QUEUE, EVENT_STATUS.INFO);
       }
       // Avoid reference issues using a
       // method outside of the provider
       // scope
-      throttledCommitStep({
+      commitStepQueue({
         broadcast: this.broadcast,
         userId: this.getUserId(),
         clientId: this.clientId,

package/dist/es2019/helpers/const.js

@@ -4,6 +4,7 @@ export let EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["DOCUMENT_INIT"] = "documentInit";
   EVENT_ACTION["ADD_STEPS"] = "addSteps";
   EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
+  EVENT_ACTION["UPDATE_DOCUMENT"] = "updateDocument";
   EVENT_ACTION["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
   EVENT_ACTION["REINITIALISE_DOCUMENT"] = "reinitialiseDocument";
   EVENT_ACTION["ERROR"] = "error";