@atlaskit/collab-provider 10.3.1 → 10.3.3

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

@@ -45,13 +45,20 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
    * @param onErrorHandled - Callback to handle
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
+   * @param getConnected - if the channel is currently connected
    */
-  function DocumentService(participantsService, analyticsHelper, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, isNameSpaceLocked) {
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/max-params
+  function DocumentService(participantsService, analyticsHelper, fetchCatchupv2, fetchReconcile,
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, isNameSpaceLocked) {
     var _this = this;
     var enableErrorOnFailedDocumentApply = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
     var options = arguments.length > 11 && arguments[11] !== undefined ? arguments[11] : {
       __livePage: false
     };
+    var getConnected = arguments.length > 12 ? arguments[12] : undefined;
     (0, _classCallCheck2.default)(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     (0, _defineProperty2.default)(this, "stepRejectCounter", 0);
@@ -61,8 +68,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      * @param reason - optional reason to attach.
      */
-    (0, _defineProperty2.default)(this, "throttledCatchupv2", (0, _throttle.default)(function (reason) {
-      return _this.catchupv2(reason);
+    (0, _defineProperty2.default)(this, "throttledCatchupv2", (0, _throttle.default)(function (reason, reconnectionMetadata) {
+      return _this.catchupv2(reason, reconnectionMetadata);
     }, CATCHUP_THROTTLE, {
       leading: false,
       // TODO: why shouldn't this be leading?
@@ -75,8 +82,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * @param reason - optional reason to attach.
      */
     (0, _defineProperty2.default)(this, "catchupv2", /*#__PURE__*/function () {
-      var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(reason) {
-        var start, _this$analyticsHelper, latency, _this$analyticsHelper2, _latency;
+      var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(reason, reconnectionMetadata) {
+        var start, _this$analyticsHelper2, latency, _this$analyticsHelper3, _latency;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -106,12 +113,21 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                 clientId: _this.clientId,
                 onStepsAdded: _this.onStepsAdded,
                 catchUpOutofSync: _this.catchUpOutofSync,
-                reason: reason
+                reason: reason,
+                onCatchupComplete: function onCatchupComplete(steps) {
+                  // We want to capture the number of steps made while offline vs. online
+                  if (reason === _const.CatchupEventReason.RECONNECTED) {
+                    var _this$analyticsHelper, _steps$length;
+                    (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 || _this$analyticsHelper.sendActionEvent(_const.EVENT_ACTION.RECONNECTION, _const.EVENT_STATUS.INFO, _objectSpread(_objectSpread({}, reconnectionMetadata), {}, {
+                      remoteStepsLength: (_steps$length = steps === null || steps === void 0 ? void 0 : steps.length) !== null && _steps$length !== void 0 ? _steps$length : 0
+                    }));
+                  }
+                }
               });
             case 11:
               _this.catchUpOutofSync = _context.sent;
               latency = new Date().getTime() - start;
-              (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 || _this$analyticsHelper.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.SUCCESS, {
+              (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 || _this$analyticsHelper2.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.SUCCESS, {
                 latency: latency
               });
               _context.next = 20;
@@ -120,7 +136,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
               _context.prev = 16;
               _context.t0 = _context["catch"](8);
               _latency = new Date().getTime() - start;
-              (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 || _this$analyticsHelper2.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.FAILURE, {
+              (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.FAILURE, {
                 latency: _latency
               });
             case 20:
@@ -136,7 +152,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           }
         }, _callee, null, [[8, 16, 20, 26]]);
       }));
-      return function (_x) {
+      return function (_x, _x2) {
         return _ref.apply(this, arguments);
       };
     }());
@@ -144,14 +160,16 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       var _this$getState;
       var state = (_this$getState = _this.getState) === null || _this$getState === void 0 ? void 0 : _this$getState.call(_this);
       if (!state) {
-        var _this$analyticsHelper3;
-        (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getCurrentPmVersion called without state');
+        var _this$analyticsHelper4;
+        (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getCurrentPmVersion called without state');
         return 0;
       }
       return _this.getVersionFromCollabState(state, 'collab-provider: getCurrentPmVersion');
     });
+    // Ignored via go/ees005
+    // eslint-disable-next-line require-await
     (0, _defineProperty2.default)(this, "getCurrentState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
-      var _this$getState2, _this$analyticsHelper5, _this$analyticsHelper4, state, adfDocument, version, currentState, measure, _this$analyticsHelper6, _this$analyticsHelper7, _measure;
+      var _this$getState2, _this$analyticsHelper6, _this$analyticsHelper5, state, adfDocument, version, currentState, measure, _this$analyticsHelper7, _this$analyticsHelper8, _measure;
       return _regenerator.default.wrap(function _callee2$(_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
@@ -160,8 +178,10 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
 
             // Convert ProseMirror document in Editor state to ADF document
             if (!((_this$getState2 = _this.getState) !== null && _this$getState2 !== void 0 && _this$getState2.call(_this))) {
-              (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendErrorEvent(new Error('Editor state is undefined'), 'getCurrentState called without state');
+              (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 || _this$analyticsHelper5.sendErrorEvent(new Error('Editor state is undefined'), 'getCurrentState called without state');
             }
+            // Ignored via go/ees005
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             state = _this.getState();
             adfDocument = new _editorJsonTransformer.JSONTransformer().encode(state.doc);
             version = _this.getVersionFromCollabState(state, 'collab-provider: getCurrentState');
@@ -171,7 +191,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
               stepVersion: version
             };
             measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
-            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 || _this$analyticsHelper5.sendActionEvent(_const.EVENT_ACTION.GET_CURRENT_STATE, _const.EVENT_STATUS.SUCCESS, {
+            (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 || _this$analyticsHelper6.sendActionEvent(_const.EVENT_ACTION.GET_CURRENT_STATE, _const.EVENT_STATUS.SUCCESS, {
               latency: measure === null || measure === void 0 ? void 0 : measure.duration
             });
             return _context2.abrupt("return", currentState);
@@ -179,10 +199,10 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             _context2.prev = 12;
             _context2.t0 = _context2["catch"](0);
             _measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.GET_CURRENT_STATE, _this.analyticsHelper);
-            (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 || _this$analyticsHelper6.sendActionEvent(_const.EVENT_ACTION.GET_CURRENT_STATE, _const.EVENT_STATUS.FAILURE, {
+            (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 || _this$analyticsHelper7.sendActionEvent(_const.EVENT_ACTION.GET_CURRENT_STATE, _const.EVENT_STATUS.FAILURE, {
               latency: _measure === null || _measure === void 0 ? void 0 : _measure.duration
             });
-            (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 || _this$analyticsHelper7.sendErrorEvent(_context2.t0, 'Error while returning ADF version of current draft document');
+            (_this$analyticsHelper8 = _this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 || _this$analyticsHelper8.sendErrorEvent(_context2.t0, 'Error while returning ADF version of current draft document');
             throw _context2.t0;
           case 18:
           case "end":
@@ -199,19 +219,23 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           var clientId = _ref3.clientId;
           return clientId;
         }));
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         if (!clientIds.has(_this.clientId)) {
           var userIds = new Set(steps.map(function (_ref4) {
             var userId = _ref4.userId;
             return userId;
           }));
+          // Ignored via go/ees005
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           if (userIds.has(_this.getUserId())) {
             return true;
           }
         }
         return false;
       } catch (err) {
-        var _this$analyticsHelper8;
-        (_this$analyticsHelper8 = _this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 || _this$analyticsHelper8.sendErrorEvent(err, 'Error while checking for new clientId for same userId in steps');
+        var _this$analyticsHelper9;
+        (_this$analyticsHelper9 = _this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 || _this$analyticsHelper9.sendErrorEvent(err, 'Error while checking for new clientId for same userId in steps');
         return false;
       }
     });
@@ -219,8 +243,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       var _this$getState3, _sendableSteps;
       var state = (_this$getState3 = _this.getState) === null || _this$getState3 === void 0 ? void 0 : _this$getState3.call(_this);
       if (!state) {
-        var _this$analyticsHelper9;
-        (_this$analyticsHelper9 = _this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 || _this$analyticsHelper9.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getUnconfirmedStepsOrigins called without state');
+        var _this$analyticsHelper10;
+        (_this$analyticsHelper10 = _this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 || _this$analyticsHelper10.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getUnconfirmedStepsOrigins called without state');
         return;
       }
       return (_sendableSteps = (0, _prosemirrorCollab.sendableSteps)(state)) === null || _sendableSteps === void 0 ? void 0 : _sendableSteps.origins;
@@ -229,8 +253,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       var _this$getState4, _sendableSteps2;
       var state = (_this$getState4 = _this.getState) === null || _this$getState4 === void 0 ? void 0 : _this$getState4.call(_this);
       if (!state) {
-        var _this$analyticsHelper10;
-        (_this$analyticsHelper10 = _this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 || _this$analyticsHelper10.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getUnconfirmedSteps called without state');
+        var _this$analyticsHelper11;
+        (_this$analyticsHelper11 = _this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 || _this$analyticsHelper11.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getUnconfirmedSteps called without state');
         return;
       }
       return (_sendableSteps2 = (0, _prosemirrorCollab.sendableSteps)(state)) === null || _sendableSteps2 === void 0 ? void 0 : _sendableSteps2.steps;
@@ -270,8 +294,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           return userId;
         }));
       } catch (stepsAddedError) {
-        var _this$analyticsHelper11;
-        (_this$analyticsHelper11 = _this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 || _this$analyticsHelper11.sendErrorEvent(stepsAddedError, 'Error while adding steps in the provider');
+        var _this$analyticsHelper12;
+        (_this$analyticsHelper12 = _this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 || _this$analyticsHelper12.sendErrorEvent(stepsAddedError, 'Error while adding steps in the provider');
         _this.onErrorHandled({
           message: 'Error while adding steps in the provider',
           data: {
@@ -285,7 +309,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
     (0, _defineProperty2.default)(this, "onRestore", /*#__PURE__*/function () {
       var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(_ref6) {
-        var doc, version, metadata, targetClientId, unconfirmedSteps, currentState, useReconcile, _this$analyticsHelper14, _this$analyticsHelper12, _this$analyticsHelper13, _this$analyticsHelper15, _this$analyticsHelper16;
+        var doc, version, metadata, targetClientId, unconfirmedSteps, currentState, useReconcile, _this$analyticsHelper15, _this$analyticsHelper13, _this$analyticsHelper14, _this$analyticsHelper16, _this$analyticsHelper17;
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
@@ -323,7 +347,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                 break;
               }
               _context3.prev = 12;
-              (_this$analyticsHelper12 = _this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 || _this$analyticsHelper12.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.INFO, {
+              (_this$analyticsHelper13 = _this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.INFO, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
                 clientId: _this.clientId,
@@ -338,7 +362,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             case 17:
               _context3.prev = 17;
               _context3.t0 = _context3["catch"](12);
-              (_this$analyticsHelper13 = _this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendErrorEvent(_context3.t0, "Error while onRestore with applyLocalSteps. Will fallback to fetchReconcile");
+              (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 || _this$analyticsHelper14.sendErrorEvent(_context3.t0, "Error while onRestore with applyLocalSteps. Will fallback to fetchReconcile");
               useReconcile = true;
               _context3.next = 23;
               return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-restore');
@@ -362,7 +386,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                 _this.applyLocalSteps(unconfirmedSteps);
               }
             case 31:
-              (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 || _this$analyticsHelper14.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.SUCCESS, {
+              (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 || _this$analyticsHelper15.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.SUCCESS, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
                 useReconcile: useReconcile,
@@ -375,14 +399,14 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             case 34:
               _context3.prev = 34;
               _context3.t1 = _context3["catch"](8);
-              (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 || _this$analyticsHelper15.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.FAILURE, {
+              (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 || _this$analyticsHelper16.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.FAILURE, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 useReconcile: useReconcile,
                 clientId: _this.clientId,
                 targetClientId: targetClientId,
                 triggeredByCatchup: targetClientId ? true : false
               });
-              (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 || _this$analyticsHelper16.sendErrorEvent(_context3.t1, "Error while reinitialising document. Use Reconcile: ".concat(useReconcile));
+              (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 || _this$analyticsHelper17.sendErrorEvent(_context3.t1, "Error while reinitialising document. Use Reconcile: ".concat(useReconcile));
               _this.onErrorHandled({
                 message: 'Caught error while trying to recover the document',
                 data: {
@@ -397,12 +421,12 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           }
         }, _callee3, null, [[8, 34], [12, 17]]);
       }));
-      return function (_x2) {
+      return function (_x3) {
         return _ref7.apply(this, arguments);
       };
     }());
     (0, _defineProperty2.default)(this, "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
-      var _this$analyticsHelper17, finalAcknowledgedState, currentState, reconcileResponse, measure, _this$analyticsHelper18, _this$analyticsHelper19, _measure2;
+      var _this$analyticsHelper18, finalAcknowledgedState, currentState, reconcileResponse, measure, _this$analyticsHelper19, _this$analyticsHelper20, _measure2;
       return _regenerator.default.wrap(function _callee4$(_context4) {
         while (1) switch (_context4.prev = _context4.next) {
           case 0:
@@ -437,7 +461,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             };
           case 20:
             measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-            (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 || _this$analyticsHelper17.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.SUCCESS, {
+            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 || _this$analyticsHelper18.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.SUCCESS, {
               latency: measure === null || measure === void 0 ? void 0 : measure.duration
             });
             _this.aggressiveCatchup = false;
@@ -447,10 +471,10 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             _context4.t1 = _context4["catch"](1);
             _this.aggressiveCatchup = false;
             _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 || _this$analyticsHelper18.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.FAILURE, {
+            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 || _this$analyticsHelper19.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.FAILURE, {
               latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration
             });
-            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 || _this$analyticsHelper19.sendErrorEvent(_context4.t1, 'Error while returning ADF version of the final draft document');
+            (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 || _this$analyticsHelper20.sendErrorEvent(_context4.t1, 'Error while returning ADF version of the final draft document');
             throw _context4.t1;
           case 33:
           case "end":
@@ -472,13 +496,15 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       } : {}));
       _this.updateDocumentAnalytics(doc, version);
     });
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     (0, _defineProperty2.default)(this, "updateDocumentAnalytics", function (doc, version) {
       var updatedVersion = _this.getCurrentPmVersion();
       var isDocContentValid = _this.validatePMJSONDocument(doc);
       // ESS-5023: only emit error event if updated client version is still behind server version
       // client version could become higher than server version due to user editing or plugin adding steps
       if (updatedVersion < version) {
-        var _doc$content, _this$analyticsHelper20;
+        var _doc$content, _this$analyticsHelper21;
         var error = new _customErrors.UpdateDocumentError('Failed to update the document', {
           newVersion: version,
           editorVersion: updatedVersion,
@@ -486,7 +512,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           docHasContent: (doc === null || doc === void 0 || (_doc$content = doc.content) === null || _doc$content === void 0 ? void 0 : _doc$content.length) >= 1,
           isDocContentValid: isDocContentValid
         });
-        (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 || _this$analyticsHelper20.sendErrorEvent(error, 'Failed to update the document in document service');
+        (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 || _this$analyticsHelper21.sendErrorEvent(error, 'Failed to update the document in document service');
         if (_this.enableErrorOnFailedDocumentApply) {
           _this.onErrorHandled({
             message: 'The provider failed to apply changes to the editor',
@@ -503,8 +529,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         }
         // Otherwise just fail silently for now
       } else {
-        var _this$analyticsHelper21, _doc$content2;
-        (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 || _this$analyticsHelper21.sendActionEvent(_const.EVENT_ACTION.UPDATE_DOCUMENT, _const.EVENT_STATUS.SUCCESS, {
+        var _this$analyticsHelper22, _doc$content2;
+        (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 || _this$analyticsHelper22.sendActionEvent(_const.EVENT_ACTION.UPDATE_DOCUMENT, _const.EVENT_STATUS.SUCCESS, {
           newVersion: version,
           editorVersion: updatedVersion,
           isDocTruthy: !!doc,
@@ -513,14 +539,20 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         });
       }
     });
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     (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$analyticsHelper22;
-          (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 || _this$analyticsHelper22.sendErrorEvent(new Error('Editor state is undefined'), 'validatePMJSONDocument called without state');
+          var _this$analyticsHelper23;
+          (_this$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 || _this$analyticsHelper23.sendErrorEvent(new Error('Editor state is undefined'), 'validatePMJSONDocument called without state');
         }
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         var state = _this.getState();
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         var content = (doc.content || []).map(function (child) {
           return state.schema.nodeFromJSON(child);
         });
@@ -541,7 +573,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 _callee5() {
-      var unconfirmedSteps, _this$getState6, _this$analyticsHelper24, count, unconfirmedTrs, lastTr, isLastTrConfirmed, _this$analyticsHelper23, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, state, version, unconfirmedStepsInfoUGCRemoved, error, measure, _this$analyticsHelper25, _this$analyticsHelper26, _measure3;
+      var unconfirmedSteps, _this$getState6, _this$analyticsHelper25, count, unconfirmedTrs, lastTr, isLastTrConfirmed, _this$analyticsHelper24, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, state, version, unconfirmedStepsInfoUGCRemoved, error, measure, _this$analyticsHelper26, _this$analyticsHelper27, _measure3;
       return _regenerator.default.wrap(function _callee5$(_context5) {
         while (1) switch (_context5.prev = _context5.next) {
           case 0:
@@ -560,7 +592,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$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 || _this$analyticsHelper23.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
+              (_this$analyticsHelper24 = _this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 || _this$analyticsHelper24.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
             }
           case 9:
             if (isLastTrConfirmed) {
@@ -585,6 +617,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
               break;
             }
             if (_this.onSyncUpError) {
+              // Ignored via go/ees005
+              // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
               state = _this.getState();
               version = _this.getVersionFromCollabState(state, 'collab-provider: commitUnconfirmedSteps');
               _this.onSyncUpError({
@@ -607,7 +641,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             break;
           case 22:
             measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper24 = _this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 || _this$analyticsHelper24.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.SUCCESS, {
+            (_this$analyticsHelper25 = _this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 || _this$analyticsHelper25.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
@@ -619,11 +653,11 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             _context5.prev = 26;
             _context5.t0 = _context5["catch"](1);
             _measure3 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper25 = _this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 || _this$analyticsHelper25.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
+            (_this$analyticsHelper26 = _this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 || _this$analyticsHelper26.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$analyticsHelper26 = _this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 || _this$analyticsHelper26.sendErrorEvent(_context5.t0, 'Error while committing unconfirmed steps');
+            (_this$analyticsHelper27 = _this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 || _this$analyticsHelper27.sendErrorEvent(_context5.t0, 'Error while committing unconfirmed steps');
             throw _context5.t0;
           case 32:
           case "end":
@@ -632,17 +666,17 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       }, _callee5, null, [[1, 26]]);
     })));
     (0, _defineProperty2.default)(this, "onStepRejectedError", function () {
-      var _this$analyticsHelper27;
+      var _this$analyticsHelper28;
       _this.stepRejectCounter++;
       logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
-      (_this$analyticsHelper27 = _this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 || _this$analyticsHelper27.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO, {
+      (_this$analyticsHelper28 = _this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 || _this$analyticsHelper28.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$analyticsHelper28;
+        var _this$analyticsHelper29;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(_provider.MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
-        (_this$analyticsHelper28 = _this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 || _this$analyticsHelper28.sendActionEvent(_const.EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO);
+        (_this$analyticsHelper29 = _this.analyticsHelper) === null || _this$analyticsHelper29 === void 0 || _this$analyticsHelper29.sendActionEvent(_const.EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO);
         _this.throttledCatchupv2(_const.CatchupEventReason.STEPS_REJECTED);
       } else {
         // If committing steps failed try again automatically in 1s
@@ -665,6 +699,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     this.isNameSpaceLocked = isNameSpaceLocked;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.options = options;
+    this.getConnected = getConnected;
     this.stepQueue = new _stepQueueState.StepQueueState();
     this.onErrorHandled = onErrorHandled;
   }
@@ -673,15 +708,15 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     value: function getVersionFromCollabState(state, resource) {
       var collabState = (0, _prosemirrorCollab.getCollabState)(state);
       if (!collabState) {
-        var _this$analyticsHelper29;
-        (_this$analyticsHelper29 = this.analyticsHelper) === null || _this$analyticsHelper29 === void 0 || _this$analyticsHelper29.sendErrorEvent(new Error('No collab state when calling ProseMirror function'), "".concat(resource, " called without collab state"));
+        var _this$analyticsHelper30;
+        (_this$analyticsHelper30 = this.analyticsHelper) === null || _this$analyticsHelper30 === void 0 || _this$analyticsHelper30.sendErrorEvent(new Error('No collab state when calling ProseMirror function'), "".concat(resource, " called without collab state"));
         return 0;
       }
 
       // This should not happen in usual, just add error event in case it happens
       if (collabState.version === undefined) {
-        var _this$analyticsHelper30;
-        (_this$analyticsHelper30 = this.analyticsHelper) === null || _this$analyticsHelper30 === void 0 || _this$analyticsHelper30.sendErrorEvent(new Error('Collab state missing version info when calling ProseMirror function'), "".concat(resource, " called with collab state missing version info"));
+        var _this$analyticsHelper31;
+        (_this$analyticsHelper31 = this.analyticsHelper) === null || _this$analyticsHelper31 === void 0 || _this$analyticsHelper31.sendErrorEvent(new Error('Collab state missing version info when calling ProseMirror function'), "".concat(resource, " called with collab state missing version info"));
         return 0;
       }
       return collabState.version;
@@ -697,9 +732,15 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       if (this.stepQueue.getQueue().length > 0) {
         var firstItem = this.stepQueue.shift();
         var currentVersion = this.getCurrentPmVersion();
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         var expectedVersion = currentVersion + firstItem.steps.length;
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         if (firstItem.version === expectedVersion) {
           logger("Applying data from queue!");
+          // Ignored via go/ees005
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           this.processSteps(firstItem);
           // recur
           this.processQueue();
@@ -729,17 +770,19 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           this.participantsService.emitTelepointersFromSteps(steps);
 
           // Resend local steps if none of the received steps originated with us!
+          // Ignored via go/ees005
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           if (clientIds.indexOf(this.clientId) === -1) {
             setTimeout(function () {
               return _this2.sendStepsFromCurrentState();
             }, 100);
           }
         } catch (error) {
-          var _this$analyticsHelper31;
+          var _this$analyticsHelper32;
           // ESS-6421: log if error processing steps when there are steps from the same userId but not the same clientId
           var userIdMatch = this.isStepsFromNewClientIdForSameUserId(steps);
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
-          (_this$analyticsHelper31 = this.analyticsHelper) === null || _this$analyticsHelper31 === void 0 || _this$analyticsHelper31.sendErrorEvent(error, userIdMatch ? "Error while processing steps with new clientId" : "Error while processing steps");
+          (_this$analyticsHelper32 = this.analyticsHelper) === null || _this$analyticsHelper32 === void 0 || _this$analyticsHelper32.sendErrorEvent(error, userIdMatch ? "Error while processing steps with new clientId" : "Error while processing steps");
           this.throttledCatchupv2(_const.CatchupEventReason.PROCESS_STEPS);
         }
       }
@@ -774,8 +817,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$analyticsHelper32;
-        (_this$analyticsHelper32 = this.analyticsHelper) === null || _this$analyticsHelper32 === void 0 || _this$analyticsHelper32.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
+        var _this$analyticsHelper33;
+        (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 || _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
         return;
       }
       this.send(null, null, state, sendAnalyticsEvent);
@@ -787,21 +830,29 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * Send steps from transaction to other participants
      * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
      */
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/max-params
     function send(_tr, _oldState, newState, sendAnalyticsEvent) {
       var unconfirmedStepsData = (0, _prosemirrorCollab.sendableSteps)(newState);
       var version = this.getVersionFromCollabState(newState, 'collab-provider: send');
 
       // Don't send any steps before we're ready.
-      if (!unconfirmedStepsData) {
-        return;
+      if ((0, _platformFeatureFlags.fg)('platform_editor_merge_unconfirmed_steps')) {
+        if (!unconfirmedStepsData || !this.getConnected()) {
+          return;
+        }
+      } else {
+        if (!unconfirmedStepsData) {
+          return;
+        }
       }
       var unconfirmedSteps = unconfirmedStepsData.steps;
       // sendAnalyticsEvent is only true when buffering is enabled,
       // 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$analyticsHelper33;
-        (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 || _this$analyticsHelper33.sendActionEvent(_const.EVENT_ACTION.HAS_UNCONFIRMED_STEPS, _const.EVENT_STATUS.INFO, {
+        var _this$analyticsHelper34;
+        (_this$analyticsHelper34 = this.analyticsHelper) === null || _this$analyticsHelper34 === void 0 || _this$analyticsHelper34.sendActionEvent(_const.EVENT_ACTION.HAS_UNCONFIRMED_STEPS, _const.EVENT_STATUS.INFO, {
           numUnconfirmedSteps: (unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) || 0
         });
       }
@@ -809,12 +860,28 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         return;
       }
 
+      // 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, _platformFeatureFlags.fg)('platform_editor_merge_unconfirmed_steps')) {
+        unconfirmedStepsData.steps.forEach(function (s) {
+          if (isLockable(s)) {
+            var _s$lockStep;
+            (_s$lockStep = s.lockStep) === null || _s$lockStep === void 0 || _s$lockStep.call(s);
+          }
+        });
+      }
+
       // Avoid reference issues using a
       // method outside of the provider
       // scope
       (0, _commitStep.commitStepQueue)({
         broadcast: this.broadcast,
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         userId: this.getUserId(),
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         clientId: this.clientId,
         steps: unconfirmedSteps,
         version: version,
@@ -826,4 +893,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       });
     }
   }]);
-}();
+}(); // Based on: packages/editor/editor-plugin-collab-edit/src/pm-plugins/mergeUnconfirmed.ts
+function isLockable(step) {
+  return (step === null || step === void 0 ? void 0 : step.lockStep) !== undefined;
+}

package/dist/cjs/emitter.js

@@ -9,6 +9,8 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _eventemitter = require("eventemitter2");
+// Ignored via go/ees005
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 var Emitter = exports.Emitter = /*#__PURE__*/function () {
   function Emitter() {
     (0, _classCallCheck2.default)(this, Emitter);
@@ -21,6 +23,8 @@ var Emitter = exports.Emitter = /*#__PURE__*/function () {
      * Emit events to subscribers
      */
     function emit(evt, data) {
+      // Ignored via go/ees005
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       this.eventEmitter.emit(evt, data);
       return this;
     }
@@ -31,6 +35,8 @@ var Emitter = exports.Emitter = /*#__PURE__*/function () {
   }, {
     key: "on",
     value: function on(evt, handler) {
+      // Ignored via go/ees005
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       this.eventEmitter.on(evt, handler);
       return this;
     }
@@ -41,6 +47,8 @@ var Emitter = exports.Emitter = /*#__PURE__*/function () {
   }, {
     key: "off",
     value: function off(evt, handler) {
+      // Ignored via go/ees005
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       this.eventEmitter.off(evt, handler);
       return this;
     }
@@ -51,6 +59,8 @@ var Emitter = exports.Emitter = /*#__PURE__*/function () {
   }, {
     key: "unsubscribeAll",
     value: function unsubscribeAll(evt) {
+      // Ignored via go/ees005
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       this.eventEmitter.removeAllListeners(evt);
       return this;
     }