@atlaskit/collab-provider 10.20.2 → 10.20.3

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/collab-provider
 
+## 10.20.3
+
+### Patch Changes
+
+- [#173357](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/173357)
+  [`f17a667b25b42`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f17a667b25b42) -
+  enable merging of prosemirror steps for single player sessions
+- Updated dependencies
+
 ## 10.20.2
 
 ### Patch Changes

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

@@ -16,10 +16,12 @@ var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
 var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _const = require("../helpers/const");
 var _performance = require("../analytics/performance");
 var _internalErrors = require("../errors/internal-errors");
 var _utils = require("../helpers/utils");
+var _participantsService = require("../participants/participants-service");
 var _provider = require("../provider");
 var _commitStep = require("../provider/commit-step");
 var _customErrors = require("../errors/custom-errors");
@@ -807,6 +809,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     this.getConnected = getConnected;
     this.stepQueue = new _stepQueueState.StepQueueState();
     this.onErrorHandled = onErrorHandled;
+    this.commitStepService = new _commitStep.CommitStepService(this.broadcast, this.analyticsHelper, this.providerEmitCallback, this.onErrorHandled);
   }
   return (0, _createClass2.default)(DocumentService, [{
     key: "getVersionFromCollabState",
@@ -1000,8 +1003,9 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       var version = this.getVersionFromCollabState(newState, 'collab-provider: send');
 
       // Don't send any steps before we're ready.
-      if ((0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true)) {
-        if (!unconfirmedStepsData || !this.getConnected()) {
+      if ((0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true) || (0, _expValEquals.expValEquals)('platform_editor_enable_single_player_step_merging', 'isEnabled', true)) {
+        var enableStepsMergingForSinglePlayer = (0, _expValEquals.expValEquals)('platform_editor_enable_single_player_step_merging', 'isEnabled', true) && !this.commitStepService.getReadyToCommitStatus() && this.participantsService.getCollabMode() === _participantsService.SINGLE_COLLAB_MODE;
+        if (!unconfirmedStepsData || !this.getConnected() || enableStepsMergingForSinglePlayer) {
           return;
         }
       } else {
@@ -1043,7 +1047,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       // If we are going to commit unconfirmed steps
       // we need to lock them to ensure they don't get
       // mutated in: `packages/editor/editor-plugin-collab-edit/src/pm-plugins/mergeUnconfirmed.ts`
-      if ((0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true)) {
+      if ((0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true) || (0, _expValEquals.expValEquals)('platform_editor_enable_single_player_step_merging', 'isEnabled', true)) {
         unconfirmedStepsData.origins.forEach(function (origin) {
           if (origin instanceof _state.Transaction) {
             return origin.setMeta('mergeIsLocked', true);
@@ -1061,8 +1065,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       // Avoid reference issues using a
       // method outside of the provider
       // scope
-      (0, _commitStep.commitStepQueue)({
-        broadcast: this.broadcast,
+      this.commitStepService.commitStepQueue({
         // Ignored via go/ees005
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         userId: this.getUserId(),
@@ -1072,9 +1075,6 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         steps: unconfirmedSteps,
         version: version,
         onStepsAdded: this.onStepsAdded,
-        onErrorHandled: this.onErrorHandled,
-        analyticsHelper: this.analyticsHelper,
-        emit: this.providerEmitCallback,
         __livePage: this.options.__livePage,
         hasRecovered: this.hasRecovered,
         collabMode: this.participantsService.getCollabMode(),

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

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ParticipantsService = void 0;
+exports.SINGLE_COLLAB_MODE = exports.ParticipantsService = exports.MULTI_COLLAB_MODE = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -22,6 +22,8 @@ var logger = (0, _utils.createLogger)('PresenceService', 'pink');
 var SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
 var DEFAULT_FETCH_USERS_INTERVAL = 500; // 0.5 second
 var UNIDENTIFIED = 'unidentified';
+var SINGLE_COLLAB_MODE = exports.SINGLE_COLLAB_MODE = 'single';
+var MULTI_COLLAB_MODE = exports.MULTI_COLLAB_MODE = 'collab';
 
 /**
  * This service is responsible for handling presence and participant events, as well as sending them on to the editor or NCS.
@@ -660,7 +662,7 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
       return _this.participantsState.getAIProviderParticipants();
     });
     (0, _defineProperty2.default)(this, "getCollabMode", function () {
-      return _this.participantsState.size() > 1 ? 'collab' : 'single';
+      return _this.participantsState.size() > 1 ? MULTI_COLLAB_MODE : SINGLE_COLLAB_MODE;
     });
     this.analyticsHelper = analyticsHelper;
     this.participantsState = participantsState;

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

@@ -4,8 +4,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.readyToCommit = exports.lastBroadcastRequestAcked = exports.commitStepQueue = exports.RESET_READYTOCOMMIT_INTERVAL_MS = void 0;
+exports.RESET_READYTOCOMMIT_INTERVAL_MS = exports.CommitStepService = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _countBy = _interopRequireDefault(require("lodash/countBy"));
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _featureGateJsClient = _interopRequireDefault(require("@atlaskit/feature-gate-js-client"));
@@ -16,200 +18,233 @@ 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 logger = (0, _utils.createLogger)('commit-step', 'black');
-var readyToCommit = exports.readyToCommit = true;
-var lastBroadcastRequestAcked = exports.lastBroadcastRequestAcked = true;
 var RESET_READYTOCOMMIT_INTERVAL_MS = exports.RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
-var commitStepQueue = exports.commitStepQueue = function commitStepQueue(_ref) {
-  var broadcast = _ref.broadcast,
-    steps = _ref.steps,
-    version = _ref.version,
-    userId = _ref.userId,
-    clientId = _ref.clientId,
-    onStepsAdded = _ref.onStepsAdded,
-    onErrorHandled = _ref.onErrorHandled,
-    analyticsHelper = _ref.analyticsHelper,
-    emit = _ref.emit,
-    __livePage = _ref.__livePage,
-    hasRecovered = _ref.hasRecovered,
-    collabMode = _ref.collabMode,
-    reason = _ref.reason,
-    numberOfStepCommitsSent = _ref.numberOfStepCommitsSent,
-    setNumberOfCommitsSent = _ref.setNumberOfCommitsSent;
-  // this timer is for waiting to send the next batch in between acks from the BE
-  var commitWaitTimer;
-  // if publishing and not waiting for an ACK, then clear the commit timer and proceed, skipping the timer
-  if (reason === 'publish' && lastBroadcastRequestAcked) {
-    if ((0, _platformFeatureFlags.fg)('skip_collab_provider_delay_on_publish')) {
-      clearTimeout(commitWaitTimer);
-      exports.readyToCommit = readyToCommit = true;
-    } // no-op if fg is turned off
-  }
-  if (!readyToCommit) {
-    logger('Not ready to commit, skip');
-    return;
+var CommitStepService = exports.CommitStepService = /*#__PURE__*/function () {
+  /**
+   * @param broadcast - Callback for broadcasting events to other clients
+   * @param analyticsHelper - Helper for analytics events
+   * @param emit - Callback for emitting events to listeners on the provider
+   * @param onErrorHandled - Callback to handle
+   */
+  function CommitStepService(broadcast, analyticsHelper,
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  emit, onErrorHandled) {
+    (0, _classCallCheck2.default)(this, CommitStepService);
+    this.broadcast = broadcast;
+    this.analyticsHelper = analyticsHelper;
+    this.emit = emit;
+    this.onErrorHandled = onErrorHandled;
+    this.readyToCommit = true;
+    this.lastBroadcastRequestAcked = true;
   }
-  // Block other sending request, before ACK
-  exports.readyToCommit = readyToCommit = false;
-  exports.lastBroadcastRequestAcked = lastBroadcastRequestAcked = false;
+  return (0, _createClass2.default)(CommitStepService, [{
+    key: "commitStepQueue",
+    value: function commitStepQueue(_ref) {
+      var _this = this;
+      var steps = _ref.steps,
+        version = _ref.version,
+        userId = _ref.userId,
+        clientId = _ref.clientId,
+        onStepsAdded = _ref.onStepsAdded,
+        __livePage = _ref.__livePage,
+        hasRecovered = _ref.hasRecovered,
+        collabMode = _ref.collabMode,
+        reason = _ref.reason,
+        numberOfStepCommitsSent = _ref.numberOfStepCommitsSent,
+        setNumberOfCommitsSent = _ref.setNumberOfCommitsSent;
+      // this timer is for waiting to send the next batch in between acks from the BE
+      var commitWaitTimer;
+      // if publishing and not waiting for an ACK, then clear the commit timer and proceed, skipping the timer
+      if (reason === 'publish' && this.lastBroadcastRequestAcked) {
+        if ((0, _platformFeatureFlags.fg)('skip_collab_provider_delay_on_publish')) {
+          clearTimeout(commitWaitTimer);
+          this.readyToCommit = true;
+        } // no-op if fg is turned off
+      }
+      if (!this.readyToCommit) {
+        logger('Not ready to commit, skip');
+        return;
+      }
+      // Block other sending request, before ACK
+      this.readyToCommit = false;
+      this.lastBroadcastRequestAcked = false;
 
-  // this timer is a fallback for if an ACK from BE is lost - stop the queue from getting indefinitely locked
-  var fallbackTimer = setTimeout(function () {
-    exports.readyToCommit = readyToCommit = true;
-    exports.lastBroadcastRequestAcked = lastBroadcastRequestAcked = true;
-    logger('reset readyToCommit by timer');
-  }, RESET_READYTOCOMMIT_INTERVAL_MS);
-  var stepsWithClientAndUserId = steps.map(function (step) {
-    return _objectSpread(_objectSpread({}, step.toJSON()), {}, {
-      clientId: clientId,
-      userId: userId
-    });
-  });
+      // this timer is a fallback for if an ACK from BE is lost - stop the queue from getting indefinitely locked
+      var fallbackTimer = setTimeout(function () {
+        _this.readyToCommit = true;
+        _this.lastBroadcastRequestAcked = true;
+        logger('reset readyToCommit by timer');
+      }, RESET_READYTOCOMMIT_INTERVAL_MS);
+      var stepsWithClientAndUserId = steps.map(function (step) {
+        return _objectSpread(_objectSpread({}, step.toJSON()), {}, {
+          clientId: clientId,
+          userId: userId
+        });
+      });
 
-  // Mutate steps to ignore expand expand/collapse changes in live pages
-  // This is expected to be a temporary divergence from standard editor behaviour
-  // and will be removed in Q4 when editor and live view pages align on a single
-  // behaviour for expands.
-  // While not recommended by the Editor content services team, this has been discussed
-  // as being low risk as the expand change via a setAttrs step;
-  // - doesn't impact any indexes,
-  // - is setup for last write wins,
-  // - and is just a boolean -- so no real risk of data loss.
-  if (__livePage) {
-    stepsWithClientAndUserId = stepsWithClientAndUserId.map(function (step) {
-      if (isExpandChangeStep(step)) {
-        // The title is also updated via this step, which we do want to send to the server.
-        // so we strip out the __expanded attribute from the step.
-        return _objectSpread(_objectSpread({}, step), {}, {
-          attrs: {
-            title: step.attrs.title
+      // Mutate steps to ignore expand expand/collapse changes in live pages
+      // This is expected to be a temporary divergence from standard editor behaviour
+      // and will be removed in Q4 when editor and live view pages align on a single
+      // behaviour for expands.
+      // While not recommended by the Editor content services team, this has been discussed
+      // as being low risk as the expand change via a setAttrs step;
+      // - doesn't impact any indexes,
+      // - is setup for last write wins,
+      // - and is just a boolean -- so no real risk of data loss.
+      if (__livePage) {
+        stepsWithClientAndUserId = stepsWithClientAndUserId.map(function (step) {
+          if (_this.isExpandChangeStep(step)) {
+            // The title is also updated via this step, which we do want to send to the server.
+            // so we strip out the __expanded attribute from the step.
+            return _objectSpread(_objectSpread({}, step), {}, {
+              attrs: {
+                title: step.attrs.title
+              }
+            });
           }
+          return step;
         });
       }
-      return step;
-    });
-  }
 
-  // tag unconfirmed steps sent after page has been recovered during client's editing session
-  if (hasRecovered) {
-    stepsWithClientAndUserId = stepsWithClientAndUserId.map(function (step) {
-      step.metadata = _objectSpread(_objectSpread({}, step.metadata), {}, {
-        unconfirmedStepAfterRecovery: true
+      // tag unconfirmed steps sent after page has been recovered during client's editing session
+      if (hasRecovered) {
+        stepsWithClientAndUserId = stepsWithClientAndUserId.map(function (step) {
+          step.metadata = _objectSpread(_objectSpread({}, step.metadata), {}, {
+            unconfirmedStepAfterRecovery: true
+          });
+          return step;
+        });
+      }
+      var start = new Date().getTime();
+      var ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG = 'Error while adding steps - Invalid Acknowledgement';
+      var ADD_STEPS_BROADCAST_ERROR_MSG = 'Error while adding steps - Broadcast threw exception';
+      this.emit('commit-status', {
+        status: 'attempt',
+        version: version
       });
-      return step;
-    });
-  }
-  var start = new Date().getTime();
-  var ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG = 'Error while adding steps - Invalid Acknowledgement';
-  var ADD_STEPS_BROADCAST_ERROR_MSG = 'Error while adding steps - Broadcast threw exception';
-  emit('commit-status', {
-    status: 'attempt',
-    version: version
-  });
-  try {
-    var _FeatureGates$getExpe;
-    var n = (_FeatureGates$getExpe = _featureGateJsClient.default.getExperimentValue('platform_editor_step_validation_on_connect', 'steps', 0)) !== null && _FeatureGates$getExpe !== void 0 ? _FeatureGates$getExpe : 0;
-    var isExperimentEnabled = n > 0;
-    // skip validation if FG is on and we have already sent n steps, or if FG is off
-    var skipValidation = isExperimentEnabled ? numberOfStepCommitsSent >= n : true;
-    broadcast('steps:commit', {
-      collabMode: collabMode,
-      steps: stepsWithClientAndUserId,
-      version: version,
-      userId: userId,
-      skipValidation: skipValidation
-    }, function (response) {
-      exports.lastBroadcastRequestAcked = lastBroadcastRequestAcked = true;
-      var latency = new Date().getTime() - start;
-      // this most closely replicates the BE ack delay behaviour. 500ms hardcoded + 180ms network delay (tested on hello)
-      // more context: https://hello.atlassian.net/wiki/spaces/CEPS/pages/5020556010/Spike+Moving+BE+delay+to+the+FE
-      // to be switched over to backpressure delay sent from the BE in https://hello.jira.atlassian.cloud/browse/CEPS-1030
-      var delay = latency < 680 ? 680 - latency : 1;
-      if (response.delay) {
-        delay = response.delay;
-      } // if backpressure delay is sent, overwrite it
-
-      clearTimeout(fallbackTimer); // clear the fallback timer, ack was successfully sent/recieved
-      commitWaitTimer = setTimeout(function () {
-        // unlock the queue after waiting for delay
-        exports.readyToCommit = readyToCommit = true;
-        logger('reset readyToCommit');
-      }, delay);
-      if (response.type === _types.AcknowledgementResponseTypes.SUCCESS) {
-        onStepsAdded({
+      try {
+        var _FeatureGates$getExpe;
+        var n = (_FeatureGates$getExpe = _featureGateJsClient.default.getExperimentValue('platform_editor_step_validation_on_connect', 'steps', 0)) !== null && _FeatureGates$getExpe !== void 0 ? _FeatureGates$getExpe : 0;
+        var isExperimentEnabled = n > 0;
+        // skip validation if FG is on and we have already sent n steps, or if FG is off
+        var skipValidation = isExperimentEnabled ? numberOfStepCommitsSent >= n : true;
+        this.broadcast('steps:commit', {
+          collabMode: collabMode,
           steps: stepsWithClientAndUserId,
-          version: response.version
-        });
-        sendSuccessAnalytics(latency, stepsWithClientAndUserId, analyticsHelper);
-        emit('commit-status', {
-          status: 'success',
-          version: response.version
-        });
-      } else if (response.type === _types.AcknowledgementResponseTypes.ERROR) {
-        onErrorHandled(response.error);
-        sendFailureAnalytics(response, latency, analyticsHelper);
-        emit('commit-status', {
-          status: 'failure',
-          version: version
+          version: version,
+          userId: userId,
+          skipValidation: skipValidation
+        }, function (response) {
+          _this.lastBroadcastRequestAcked = true;
+          var latency = new Date().getTime() - start;
+          // this most closely replicates the BE ack delay behaviour. 500ms hardcoded + 180ms network delay (tested on hello)
+          // more context: https://hello.atlassian.net/wiki/spaces/CEPS/pages/5020556010/Spike+Moving+BE+delay+to+the+FE
+          // to be switched over to backpressure delay sent from the BE in https://hello.jira.atlassian.cloud/browse/CEPS-1030
+          var delay = latency < 680 ? 680 - latency : 1;
+          if (response.delay) {
+            delay = response.delay;
+          } // if backpressure delay is sent, overwrite it
+
+          clearTimeout(fallbackTimer); // clear the fallback timer, ack was successfully sent/recieved
+          commitWaitTimer = setTimeout(function () {
+            // unlock the queue after waiting for delay
+            _this.readyToCommit = true;
+            logger('reset readyToCommit');
+          }, delay);
+          if (response.type === _types.AcknowledgementResponseTypes.SUCCESS) {
+            onStepsAdded({
+              steps: stepsWithClientAndUserId,
+              version: response.version
+            });
+            _this.sendSuccessAnalytics(latency, stepsWithClientAndUserId);
+            _this.emit('commit-status', {
+              status: 'success',
+              version: response.version
+            });
+          } else if (response.type === _types.AcknowledgementResponseTypes.ERROR) {
+            _this.onErrorHandled(response.error);
+            _this.sendFailureAnalytics(response, latency);
+            _this.emit('commit-status', {
+              status: 'failure',
+              version: version
+            });
+            // eslint-disable-next-line no-console
+            console.error(ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG);
+          } else {
+            var _this$analyticsHelper;
+            (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 || _this$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')), ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG);
+            _this.emit('commit-status', {
+              status: 'failure',
+              version: version
+            });
+            // eslint-disable-next-line no-console
+            console.error(ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG);
+          }
         });
-        // eslint-disable-next-line no-console
-        console.error(ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG);
-      } 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')), ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG);
-        emit('commit-status', {
+        if (isExperimentEnabled && numberOfStepCommitsSent < n) {
+          setNumberOfCommitsSent(numberOfStepCommitsSent + 1);
+        }
+      } catch (error) {
+        var _this$analyticsHelper2;
+        // if the broadcast failed for any reason, we shouldn't keep the queue locked as the BE has not recieved any message
+        this.readyToCommit = true;
+        (_this$analyticsHelper2 = this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 || _this$analyticsHelper2.sendErrorEvent(error, ADD_STEPS_BROADCAST_ERROR_MSG);
+        this.emit('commit-status', {
           status: 'failure',
           version: version
         });
         // eslint-disable-next-line no-console
-        console.error(ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG);
+        console.error(ADD_STEPS_BROADCAST_ERROR_MSG);
       }
-    });
-    if (isExperimentEnabled && numberOfStepCommitsSent < n) {
-      setNumberOfCommitsSent(numberOfStepCommitsSent + 1);
     }
-  } catch (error) {
-    // if the broadcast failed for any reason, we shouldn't keep the queue locked as the BE has not recieved any message
-    exports.readyToCommit = readyToCommit = true;
-    analyticsHelper === null || analyticsHelper === void 0 || analyticsHelper.sendErrorEvent(error, ADD_STEPS_BROADCAST_ERROR_MSG);
-    emit('commit-status', {
-      status: 'failure',
-      version: version
-    });
-    // eslint-disable-next-line no-console
-    console.error(ADD_STEPS_BROADCAST_ERROR_MSG);
-  }
-};
-function isExpandChangeStep(step) {
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  if (step.stepType === 'setAttrs' && '__expanded' in step.attrs) {
-    return true;
-  }
-  return false;
-}
-function sendSuccessAnalytics(latency, stepsWithClientAndUserId, analyticsHelper) {
-  // 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,
+  }, {
+    key: "isExpandChangeStep",
+    value: function isExpandChangeStep(step) {
       // Ignored via go/ees005
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      function (stepWithClientAndUserId) {
-        return stepWithClientAndUserId.stepType;
-      })
-    });
-  }
-}
-function sendFailureAnalytics(response, latency, analyticsHelper) {
-  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 === _ncsErrors.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || response.error.data.code === _ncsErrors.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');
-}
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      if (step.stepType === 'setAttrs' && '__expanded' in step.attrs) {
+        return true;
+      }
+      return false;
+    }
+  }, {
+    key: "sendSuccessAnalytics",
+    value: function sendSuccessAnalytics(latency, stepsWithClientAndUserId) {
+      // Sample only 10% of add steps events to avoid overwhelming the analytics
+      if (Math.random() < 0.1) {
+        var _this$analyticsHelper3;
+        (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.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,
+          // Ignored via go/ees005
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          function (stepWithClientAndUserId) {
+            return stepWithClientAndUserId.stepType;
+          })
+        });
+      }
+    }
+  }, {
+    key: "sendFailureAnalytics",
+    value: function sendFailureAnalytics(response, latency) {
+      var _this$analyticsHelper4, _this$analyticsHelper5;
+      (_this$analyticsHelper4 = this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.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 === _ncsErrors.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || response.error.data.code === _ncsErrors.NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS ? _const.ADD_STEPS_TYPE.REJECTED : _const.ADD_STEPS_TYPE.ERROR,
+        latency: latency
+      });
+      (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 || _this$analyticsHelper5.sendErrorEvent(response.error, 'Error while adding steps - Acknowledgement Error');
+    }
+  }, {
+    key: "getReadyToCommitStatus",
+    value: function getReadyToCommitStatus() {
+      return this.readyToCommit;
+    }
+  }]);
+}();

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 = "10.20.1";
+var version = exports.version = "10.20.2";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -5,12 +5,14 @@ import { getCollabState, sendableSteps } from '@atlaskit/prosemirror-collab';
 import { Transaction } from '@atlaskit/editor-prosemirror/state';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 import { INTERNAL_ERROR_CODE } from '../errors/internal-errors';
 import { createLogger, getDocAdfWithObfuscationFromJSON, getObfuscatedSteps, getStepUGCFreeDetails, sleep } from '../helpers/utils';
+import { SINGLE_COLLAB_MODE } from '../participants/participants-service';
 import { MAX_STEP_REJECTED_ERROR, MAX_STEP_REJECTED_ERROR_AGGRESSIVE } from '../provider';
-import { commitStepQueue } from '../provider/commit-step';
+import { CommitStepService } from '../provider/commit-step';
 import { CantSyncUpError, UpdateDocumentError } from '../errors/custom-errors';
 import { catchupv2 } from './catchupv2';
 import { StepQueueState } from './step-queue-state';
@@ -694,6 +696,7 @@ export class DocumentService {
     this.getConnected = getConnected;
     this.stepQueue = new StepQueueState();
     this.onErrorHandled = onErrorHandled;
+    this.commitStepService = new CommitStepService(this.broadcast, this.analyticsHelper, this.providerEmitCallback, this.onErrorHandled);
   }
   getVersionFromCollabState(state, resource) {
     const collabState = getCollabState(state);
@@ -867,8 +870,9 @@ export class DocumentService {
     const version = this.getVersionFromCollabState(newState, 'collab-provider: send');
 
     // Don't send any steps before we're ready.
-    if (editorExperiment('platform_editor_offline_editing_web', true)) {
-      if (!unconfirmedStepsData || !this.getConnected()) {
+    if (editorExperiment('platform_editor_offline_editing_web', true) || expValEquals('platform_editor_enable_single_player_step_merging', 'isEnabled', true)) {
+      const enableStepsMergingForSinglePlayer = expValEquals('platform_editor_enable_single_player_step_merging', 'isEnabled', true) && !this.commitStepService.getReadyToCommitStatus() && this.participantsService.getCollabMode() === SINGLE_COLLAB_MODE;
+      if (!unconfirmedStepsData || !this.getConnected() || enableStepsMergingForSinglePlayer) {
         return;
       }
     } else {
@@ -910,7 +914,7 @@ export class DocumentService {
     // If we are going to commit unconfirmed steps
     // we need to lock them to ensure they don't get
     // mutated in: `packages/editor/editor-plugin-collab-edit/src/pm-plugins/mergeUnconfirmed.ts`
-    if (editorExperiment('platform_editor_offline_editing_web', true)) {
+    if (editorExperiment('platform_editor_offline_editing_web', true) || expValEquals('platform_editor_enable_single_player_step_merging', 'isEnabled', true)) {
       unconfirmedStepsData.origins.forEach(origin => {
         if (origin instanceof Transaction) {
           return origin.setMeta('mergeIsLocked', true);
@@ -928,8 +932,7 @@ export class DocumentService {
     // Avoid reference issues using a
     // method outside of the provider
     // scope
-    commitStepQueue({
-      broadcast: this.broadcast,
+    this.commitStepService.commitStepQueue({
       // Ignored via go/ees005
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       userId: this.getUserId(),
@@ -939,9 +942,6 @@ export class DocumentService {
       steps: unconfirmedSteps,
       version,
       onStepsAdded: this.onStepsAdded,
-      onErrorHandled: this.onErrorHandled,
-      analyticsHelper: this.analyticsHelper,
-      emit: this.providerEmitCallback,
       __livePage: this.options.__livePage,
       hasRecovered: this.hasRecovered,
       collabMode: this.participantsService.getCollabMode(),

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

@@ -9,6 +9,8 @@ const logger = createLogger('PresenceService', 'pink');
 const SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
 const DEFAULT_FETCH_USERS_INTERVAL = 500; // 0.5 second
 const UNIDENTIFIED = 'unidentified';
+export const SINGLE_COLLAB_MODE = 'single';
+export const MULTI_COLLAB_MODE = 'collab';
 
 /**
  * This service is responsible for handling presence and participant events, as well as sending them on to the editor or NCS.
@@ -532,7 +534,7 @@ export class ParticipantsService {
       return this.participantsState.getAIProviderParticipants();
     });
     _defineProperty(this, "getCollabMode", () => {
-      return this.participantsState.size() > 1 ? 'collab' : 'single';
+      return this.participantsState.size() > 1 ? MULTI_COLLAB_MODE : SINGLE_COLLAB_MODE;
     });
     this.analyticsHelper = analyticsHelper;
     this.participantsState = participantsState;