@atlaskit/collab-provider 9.17.3 → 9.17.4

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @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

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:
@@ -663,7 +665,6 @@ 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$analyticsHelper29;
@@ -672,7 +673,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         // 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/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.3";
+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;
       }
     });
@@ -561,7 +563,6 @@ 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$analyticsHelper29;
@@ -570,7 +571,7 @@ export class DocumentService {
       // 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/provider/commit-step.js

@@ -3,8 +3,109 @@ import throttle from 'lodash/throttle';
 import { ADD_STEPS_TYPE, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { AcknowledgementResponseTypes } from '../types';
 import { NCS_ERROR_CODE } from '../errors/error-types';
+import { createLogger } from '../helpers/utils';
 const SEND_STEPS_THROTTLE = 500; // 0.5 second
-
+const logger = createLogger('commit-step', 'black');
+let readyToCommit = true;
+export const commitStepQueue = ({
+  broadcast,
+  steps,
+  version,
+  userId,
+  clientId,
+  onStepsAdded,
+  onErrorHandled,
+  analyticsHelper,
+  emit
+}) => {
+  if (!readyToCommit) {
+    logger('Not ready to commit, skip');
+    return;
+  }
+  // Block other sending request, before ACK
+  readyToCommit = false;
+  const timer = setTimeout(() => {
+    readyToCommit = true;
+    logger('reset readyToCommit by timer');
+  }, 5000);
+  const stepsWithClientAndUserId = steps.map(step => ({
+    ...step.toJSON(),
+    clientId,
+    userId
+  }));
+  const start = new Date().getTime();
+  emit('commit-status', {
+    status: 'attempt',
+    version
+  });
+  try {
+    broadcast('steps:commit', {
+      steps: stepsWithClientAndUserId,
+      version,
+      userId
+    }, response => {
+      const latency = new Date().getTime() - start;
+      if (timer) {
+        clearTimeout(timer);
+        if (latency <= 400) {
+          setTimeout(() => {
+            readyToCommit = true;
+            logger('reset readyToCommit');
+          }, 100);
+        } else {
+          readyToCommit = true;
+          logger('reset readyToCommit');
+        }
+      }
+      if (response.type === 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 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.SUCCESS_10x_SAMPLED, {
+            type: ADD_STEPS_TYPE.ACCEPTED,
+            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, {
+          // 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 === NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || response.error.data.code === NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS ? ADD_STEPS_TYPE.REJECTED : ADD_STEPS_TYPE.ERROR,
+          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 commitStep = ({
   broadcast,
   steps,

package/dist/es2019/provider/index.js

@@ -227,6 +227,12 @@ export class Provider extends Emitter {
     this.metadataService = new MetadataService(this.emitCallback, this.channel.sendMetadata);
     this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.channel.fetchReconcile, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService, this.config.enableErrorOnFailedDocumentApply, getCollabProviderFeatureFlag('sendStepsQueueFF', this.config.featureFlags));
     this.namespaceService = new NamespaceService();
+    if (getCollabProviderFeatureFlag('sendStepsQueueFF', this.config.featureFlags)) {
+      this.sendStepsTimer = setInterval(() => {
+        logger('Intervally sendStepsFromCurrentState');
+        this.documentService.sendStepsFromCurrentState(true);
+      }, 5000);
+    }
   }
   /**
    * Initialisation logic, called by Jira with a dummy getState function, deprecated in favour of the setup method which allows more configuration
@@ -398,6 +404,12 @@ export class Provider extends Emitter {
     try {
       super.unsubscribeAll();
       this.channel.disconnect();
+      if (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 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while shutting down the collab provider');

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.17.3";
+export const version = "9.17.4";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -9,12 +9,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';
 var CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
@@ -36,11 +37,12 @@ export var 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] : getCollabProviderFeatureFlag('sendStepsQueueFF');
     _classCallCheck(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
@@ -105,7 +107,7 @@ export var 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:
@@ -656,7 +658,6 @@ export var 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$analyticsHelper29;
@@ -665,7 +666,7 @@ export var DocumentService = /*#__PURE__*/function () {
         // Avoid reference issues using a
         // method outside of the provider
         // scope
-        throttledCommitStep({
+        commitStepQueue({
           broadcast: this.broadcast,
           userId: this.getUserId(),
           clientId: this.clientId,

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

@@ -6,9 +6,11 @@ import throttle from 'lodash/throttle';
 import { ADD_STEPS_TYPE, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { AcknowledgementResponseTypes } from '../types';
 import { NCS_ERROR_CODE } from '../errors/error-types';
+import { createLogger } from '../helpers/utils';
 var SEND_STEPS_THROTTLE = 500; // 0.5 second
-
-export var commitStep = function commitStep(_ref) {
+var logger = createLogger('commit-step', 'black');
+var readyToCommit = true;
+export var commitStepQueue = function commitStepQueue(_ref) {
   var broadcast = _ref.broadcast,
     steps = _ref.steps,
     version = _ref.version,
@@ -18,6 +20,107 @@ export var 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 === 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(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.SUCCESS_10x_SAMPLED, {
+            type: ADD_STEPS_TYPE.ACCEPTED,
+            latency: latency,
+            stepType: countBy(stepsWithClientAndUserId, function (stepWithClientAndUserId) {
+              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 || analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, 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 === NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || response.error.data.code === NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS ? ADD_STEPS_TYPE.REJECTED : 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
+    });
+  }
+};
+export var 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/esm/provider/index.js

@@ -267,6 +267,12 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       return _this.userId;
     }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply, getCollabProviderFeatureFlag('sendStepsQueueFF', _this.config.featureFlags));
     _this.namespaceService = new NamespaceService();
+    if (getCollabProviderFeatureFlag('sendStepsQueueFF', _this.config.featureFlags)) {
+      _this.sendStepsTimer = setInterval(function () {
+        logger('Intervally sendStepsFromCurrentState');
+        _this.documentService.sendStepsFromCurrentState(true);
+      }, 5000);
+    }
     return _this;
   }
   _createClass(Provider, [{
@@ -461,6 +467,12 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         _get(_getPrototypeOf(Provider.prototype), "unsubscribeAll", this).call(this);
         this.channel.disconnect();
+        if (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/esm/version-wrapper.js

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

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

@@ -39,6 +39,7 @@ export declare class DocumentService {
      * @param onErrorHandled - Callback to handle
      * @param metadataService
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
+     * @param enableSendStepsQueue - Enable send steps queue.
      */
     constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchReconcile: (currentStateDoc: string) => Promise<ReconcileResponse>, 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, enableErrorOnFailedDocumentApply?: boolean, enableSendStepsQueue?: boolean);
     /**

package/dist/types/provider/commit-step.d.ts

@@ -1,9 +1,20 @@
 /// <reference types="lodash" />
-import { ChannelEvent, StepsPayload } from '../types';
+import type { ChannelEvent, StepsPayload } from '../types';
 import type { CollabCommitStatusEventPayload, CollabEvents } from '@atlaskit/editor-common/collab';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
-import AnalyticsHelper from '../analytics/analytics-helper';
+import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/error-types';
+export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
+    broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
+    steps: readonly ProseMirrorStep[];
+    version: number;
+    userId: string;
+    clientId: number | string;
+    onStepsAdded: (data: StepsPayload) => void;
+    onErrorHandled: (error: InternalError) => void;
+    analyticsHelper?: AnalyticsHelper | undefined;
+    emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
+}) => void;
 export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];

package/dist/types/provider/index.d.ts

@@ -21,6 +21,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private userId?;
     private presenceUpdateTimeout?;
     private disconnectedAt?;
+    private sendStepsTimer?;
     private readonly participantsService;
     private readonly metadataService;
     private readonly documentService;

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

@@ -39,6 +39,7 @@ export declare class DocumentService {
      * @param onErrorHandled - Callback to handle
      * @param metadataService
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
+     * @param enableSendStepsQueue - Enable send steps queue.
      */
     constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchReconcile: (currentStateDoc: string) => Promise<ReconcileResponse>, 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, enableErrorOnFailedDocumentApply?: boolean, enableSendStepsQueue?: boolean);
     /**

package/dist/types-ts4.5/provider/commit-step.d.ts

@@ -1,9 +1,20 @@
 /// <reference types="lodash" />
-import { ChannelEvent, StepsPayload } from '../types';
+import type { ChannelEvent, StepsPayload } from '../types';
 import type { CollabCommitStatusEventPayload, CollabEvents } from '@atlaskit/editor-common/collab';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
-import AnalyticsHelper from '../analytics/analytics-helper';
+import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/error-types';
+export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
+    broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
+    steps: readonly ProseMirrorStep[];
+    version: number;
+    userId: string;
+    clientId: number | string;
+    onStepsAdded: (data: StepsPayload) => void;
+    onErrorHandled: (error: InternalError) => void;
+    analyticsHelper?: AnalyticsHelper | undefined;
+    emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
+}) => void;
 export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], "timestamp">, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];

package/dist/types-ts4.5/provider/index.d.ts

@@ -21,6 +21,7 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
     private userId?;
     private presenceUpdateTimeout?;
     private disconnectedAt?;
+    private sendStepsTimer?;
     private readonly participantsService;
     private readonly metadataService;
     private readonly documentService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.17.3",
+  "version": "9.17.4",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,7 +36,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-common": "^76.23.0",
+    "@atlaskit/editor-common": "^76.24.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/prosemirror-collab": "^0.2.0",