@atlaskit/collab-provider 10.3.1 → 10.3.3

package/dist/es2019/document/catchupv2.js

@@ -1,7 +1,11 @@
 import { createLogger } from '../helpers/utils';
 const logger = createLogger('Catchupv2', 'red');
 export const catchupv2 = async opt => {
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   let steps;
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   let metadata;
   const fromVersion = opt.getCurrentPmVersion();
   try {
@@ -16,6 +20,8 @@ export const catchupv2 = async opt => {
     throw error;
   }
   try {
+    var _opt$onCatchupComplet;
+    (_opt$onCatchupComplet = opt.onCatchupComplete) === null || _opt$onCatchupComplet === void 0 ? void 0 : _opt$onCatchupComplet.call(opt, steps);
     // skip onStepsAdded if steps are undefined or empty
     if (!steps || steps.length === 0) {
       opt.updateMetadata(metadata);
@@ -45,6 +51,9 @@ export const catchupv2 = async opt => {
  * @param clientId The ID of the currently connected session (one user can have multiple if theu have multiple tabs open)
  * @returns True if we're out of sync, false if not.
  */
-export const isOutOfSync = (fromVersion, currentVersion, steps, clientId) =>
+export const isOutOfSync = (fromVersion, currentVersion, steps, clientId
+// Ignored via go/ees005
+// eslint-disable-next-line @typescript-eslint/max-params
+) =>
 // If version number hasn't increased, and steps are not from our client, we're out of sync
 Boolean(fromVersion >= currentVersion && steps.some(step => step.clientId !== clientId));

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

@@ -32,10 +32,16 @@ export class DocumentService {
    * @param onErrorHandled - Callback to handle
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
+   * @param getConnected - if the channel is currently connected
    */
-  constructor(participantsService, analyticsHelper, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, isNameSpaceLocked, enableErrorOnFailedDocumentApply = false, options = {
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/max-params
+  constructor(participantsService, analyticsHelper, fetchCatchupv2, fetchReconcile,
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, isNameSpaceLocked, enableErrorOnFailedDocumentApply = false, options = {
     __livePage: false
-  }) {
+  }, getConnected) {
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
     _defineProperty(this, "aggressiveCatchup", false);
@@ -44,7 +50,7 @@ export class DocumentService {
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      * @param reason - optional reason to attach.
      */
-    _defineProperty(this, "throttledCatchupv2", throttle(reason => this.catchupv2(reason), CATCHUP_THROTTLE, {
+    _defineProperty(this, "throttledCatchupv2", throttle((reason, reconnectionMetadata) => this.catchupv2(reason, reconnectionMetadata), CATCHUP_THROTTLE, {
       leading: false,
       // TODO: why shouldn't this be leading?
       trailing: true
@@ -55,7 +61,7 @@ export class DocumentService {
      *   * try to accept steps but version is behind.
      * @param reason - optional reason to attach.
      */
-    _defineProperty(this, "catchupv2", async reason => {
+    _defineProperty(this, "catchupv2", async (reason, reconnectionMetadata) => {
       const start = new Date().getTime();
       // if the queue is already paused, we are busy with something else, so don't proceed.
       if (this.stepQueue.isPaused()) {
@@ -79,7 +85,7 @@ export class DocumentService {
       }
       this.stepQueue.pauseQueue();
       try {
-        var _this$analyticsHelper;
+        var _this$analyticsHelper2;
         /**
          * We have two options when out of sync:
          * - Check a boolean that ensures we reset the document next time we catchup
@@ -100,16 +106,26 @@ export class DocumentService {
           clientId: this.clientId,
           onStepsAdded: this.onStepsAdded,
           catchUpOutofSync: this.catchUpOutofSync,
-          reason
+          reason,
+          onCatchupComplete: steps => {
+            // We want to capture the number of steps made while offline vs. online
+            if (reason === CatchupEventReason.RECONNECTED) {
+              var _this$analyticsHelper, _steps$length;
+              (_this$analyticsHelper = this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendActionEvent(EVENT_ACTION.RECONNECTION, EVENT_STATUS.INFO, {
+                ...reconnectionMetadata,
+                remoteStepsLength: (_steps$length = steps === null || steps === void 0 ? void 0 : steps.length) !== null && _steps$length !== void 0 ? _steps$length : 0
+              });
+            }
+          }
         });
         const latency = new Date().getTime() - start;
-        (_this$analyticsHelper = this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {
+        (_this$analyticsHelper2 = this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {
           latency
         });
       } catch (error) {
-        var _this$analyticsHelper2;
+        var _this$analyticsHelper3;
         const latency = new Date().getTime() - start;
-        (_this$analyticsHelper2 = this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.FAILURE, {
+        (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.FAILURE, {
           latency
         });
       } finally {
@@ -123,22 +139,26 @@ export class DocumentService {
       var _this$getState;
       const 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 ? 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 ? 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
     _defineProperty(this, "getCurrentState", async () => {
       try {
-        var _this$getState2, _this$analyticsHelper5;
+        var _this$getState2, _this$analyticsHelper6;
         startMeasure(MEASURE_NAME.GET_CURRENT_STATE, this.analyticsHelper);
 
         // Convert ProseMirror document in Editor state to ADF document
         if (!((_this$getState2 = this.getState) !== null && _this$getState2 !== void 0 && _this$getState2.call(this))) {
-          var _this$analyticsHelper4;
-          (_this$analyticsHelper4 = this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(new Error('Editor state is undefined'), 'getCurrentState called without state');
+          var _this$analyticsHelper5;
+          (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? 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
         const state = this.getState();
         const adfDocument = new JSONTransformer().encode(state.doc);
         const version = this.getVersionFromCollabState(state, 'collab-provider: getCurrentState');
@@ -148,17 +168,17 @@ export class DocumentService {
           stepVersion: version
         };
         const measure = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, this.analyticsHelper);
-        (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, EVENT_STATUS.SUCCESS, {
+        (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, EVENT_STATUS.SUCCESS, {
           latency: measure === null || measure === void 0 ? void 0 : measure.duration
         });
         return currentState;
       } catch (error) {
-        var _this$analyticsHelper6, _this$analyticsHelper7;
+        var _this$analyticsHelper7, _this$analyticsHelper8;
         const measure = stopMeasure(MEASURE_NAME.GET_CURRENT_STATE, this.analyticsHelper);
-        (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, EVENT_STATUS.FAILURE, {
+        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendActionEvent(EVENT_ACTION.GET_CURRENT_STATE, EVENT_STATUS.FAILURE, {
           latency: measure === null || measure === void 0 ? void 0 : measure.duration
         });
-        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(error, 'Error while returning ADF version of current draft document');
+        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(error, 'Error while returning ADF version of current draft document');
         throw error; // Reject the promise so the consumer can react to it failing
       }
     });
@@ -170,18 +190,22 @@ export class DocumentService {
         const clientIds = new Set(steps.map(({
           clientId
         }) => clientId));
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         if (!clientIds.has(this.clientId)) {
           const userIds = new Set(steps.map(({
             userId
           }) => 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 ? 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 ? void 0 : _this$analyticsHelper9.sendErrorEvent(err, 'Error while checking for new clientId for same userId in steps');
         return false;
       }
     });
@@ -189,8 +213,8 @@ export class DocumentService {
       var _this$getState3, _sendableSteps;
       const 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 ? 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 ? void 0 : _this$analyticsHelper10.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getUnconfirmedStepsOrigins called without state');
         return;
       }
       return (_sendableSteps = sendableSteps(state)) === null || _sendableSteps === void 0 ? void 0 : _sendableSteps.origins;
@@ -199,8 +223,8 @@ export class DocumentService {
       var _this$getState4, _sendableSteps2;
       const 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 ? 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 ? void 0 : _this$analyticsHelper11.sendErrorEvent(new Error('No editor state when calling ProseMirror function'), 'getUnconfirmedSteps called without state');
         return;
       }
       return (_sendableSteps2 = sendableSteps(state)) === null || _sendableSteps2 === void 0 ? void 0 : _sendableSteps2.steps;
@@ -239,8 +263,8 @@ export class DocumentService {
           userId
         }) => userId));
       } catch (stepsAddedError) {
-        var _this$analyticsHelper11;
-        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? 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 ? void 0 : _this$analyticsHelper12.sendErrorEvent(stepsAddedError, 'Error while adding steps in the provider');
         this.onErrorHandled({
           message: 'Error while adding steps in the provider',
           data: {
@@ -267,7 +291,7 @@ export class DocumentService {
       const currentState = await this.getCurrentState();
       let useReconcile = Boolean((unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) && currentState && !targetClientId);
       try {
-        var _this$analyticsHelper14;
+        var _this$analyticsHelper15;
         // Reset the editor,
         //  - Replace the document, keep in sync with the server
         //  - Replace the version number, so editor is in sync with NCS server and can commit new changes.
@@ -283,8 +307,8 @@ export class DocumentService {
         this.metadataService.updateMetadata(metadata);
         if (fg('restore_localstep_fallback_reconcile')) {
           try {
-            var _this$analyticsHelper12;
-            (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.INFO, {
+            var _this$analyticsHelper13;
+            (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.INFO, {
               numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
               hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
               clientId: this.clientId,
@@ -295,8 +319,8 @@ export class DocumentService {
               this.applyLocalSteps(unconfirmedSteps);
             }
           } catch (applyLocalStepsError) {
-            var _this$analyticsHelper13;
-            (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(applyLocalStepsError, `Error while onRestore with applyLocalSteps. Will fallback to fetchReconcile`);
+            var _this$analyticsHelper14;
+            (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendErrorEvent(applyLocalStepsError, `Error while onRestore with applyLocalSteps. Will fallback to fetchReconcile`);
             useReconcile = true;
             await this.fetchReconcile(JSON.stringify(currentState.content), 'fe-restore');
           }
@@ -310,7 +334,7 @@ export class DocumentService {
             this.applyLocalSteps(unconfirmedSteps);
           }
         }
-        (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.SUCCESS, {
+        (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.SUCCESS, {
           numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
           hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
           useReconcile,
@@ -319,15 +343,15 @@ export class DocumentService {
           triggeredByCatchup: targetClientId ? true : false
         });
       } catch (restoreError) {
-        var _this$analyticsHelper15, _this$analyticsHelper16;
-        (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.FAILURE, {
+        var _this$analyticsHelper16, _this$analyticsHelper17;
+        (_this$analyticsHelper16 = this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.FAILURE, {
           numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
           useReconcile,
           clientId: this.clientId,
           targetClientId,
           triggeredByCatchup: targetClientId ? true : false
         });
-        (_this$analyticsHelper16 = this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendErrorEvent(restoreError, `Error while reinitialising document. Use Reconcile: ${useReconcile}`);
+        (_this$analyticsHelper17 = this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendErrorEvent(restoreError, `Error while reinitialising document. Use Reconcile: ${useReconcile}`);
         this.onErrorHandled({
           message: 'Caught error while trying to recover the document',
           data: {
@@ -341,7 +365,7 @@ export class DocumentService {
     _defineProperty(this, "getFinalAcknowledgedState", async () => {
       this.aggressiveCatchup = true;
       try {
-        var _this$analyticsHelper17;
+        var _this$analyticsHelper18;
         startMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
         let finalAcknowledgedState;
         try {
@@ -358,19 +382,19 @@ export class DocumentService {
           };
         }
         const measure = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
-        (_this$analyticsHelper17 = this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.SUCCESS, {
+        (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.SUCCESS, {
           latency: measure === null || measure === void 0 ? void 0 : measure.duration
         });
         this.aggressiveCatchup = false;
         return finalAcknowledgedState;
       } catch (error) {
-        var _this$analyticsHelper18, _this$analyticsHelper19;
+        var _this$analyticsHelper19, _this$analyticsHelper20;
         this.aggressiveCatchup = false;
         const measure = stopMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
-        (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.FAILURE, {
+        (_this$analyticsHelper19 = this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendActionEvent(EVENT_ACTION.PUBLISH_PAGE, EVENT_STATUS.FAILURE, {
           latency: measure === null || measure === void 0 ? void 0 : measure.duration
         });
-        (_this$analyticsHelper19 = this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
+        (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
         throw error; // Reject the promise so the consumer can react to it failing
       }
     });
@@ -390,13 +414,15 @@ export class DocumentService {
       });
       this.updateDocumentAnalytics(doc, version);
     });
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     _defineProperty(this, "updateDocumentAnalytics", (doc, version) => {
       const updatedVersion = this.getCurrentPmVersion();
       const 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;
         const error = new UpdateDocumentError('Failed to update the document', {
           newVersion: version,
           editorVersion: updatedVersion,
@@ -404,7 +430,7 @@ export class DocumentService {
           docHasContent: (doc === null || doc === void 0 ? void 0 : (_doc$content = doc.content) === null || _doc$content === void 0 ? void 0 : _doc$content.length) >= 1,
           isDocContentValid
         });
-        (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(error, 'Failed to update the document in document service');
+        (_this$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? 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',
@@ -421,8 +447,8 @@ export class DocumentService {
         }
         // Otherwise just fail silently for now
       } else {
-        var _this$analyticsHelper21, _doc$content2;
-        (_this$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.UPDATE_DOCUMENT, EVENT_STATUS.SUCCESS, {
+        var _this$analyticsHelper22, _doc$content2;
+        (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(EVENT_ACTION.UPDATE_DOCUMENT, EVENT_STATUS.SUCCESS, {
           newVersion: version,
           editorVersion: updatedVersion,
           isDocTruthy: !!doc,
@@ -431,14 +457,20 @@ export class DocumentService {
         });
       }
     });
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     _defineProperty(this, "validatePMJSONDocument", 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 ? 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 ? 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
         const state = this.getState();
+        // Ignored via go/ees005
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const content = (doc.content || []).map(child => state.schema.nodeFromJSON(child));
         return content.every(node => {
           try {
@@ -460,7 +492,7 @@ export class DocumentService {
       const unconfirmedSteps = this.getUnconfirmedSteps();
       try {
         if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
-          var _this$getState6, _this$analyticsHelper24;
+          var _this$getState6, _this$analyticsHelper25;
           startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
           let count = 0;
           // We use origins here as steps can be rebased. When steps are rebased a new step is created.
@@ -471,8 +503,8 @@ export class DocumentService {
           const lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
           let isLastTrConfirmed = false;
           if (!((_this$getState6 = this.getState) !== null && _this$getState6 !== void 0 && _this$getState6.call(this))) {
-            var _this$analyticsHelper23;
-            (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
+            var _this$analyticsHelper24;
+            (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
           }
           while (!isLastTrConfirmed) {
             this.sendStepsFromCurrentState();
@@ -487,6 +519,8 @@ export class DocumentService {
             if (!isLastTrConfirmed && count++ >= ACK_MAX_TRY) {
               var _this$getUnconfirmedS;
               if (this.onSyncUpError) {
+                // Ignored via go/ees005
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 const state = this.getState();
                 const version = this.getVersionFromCollabState(state, 'collab-provider: commitUnconfirmedSteps');
                 this.onSyncUpError({
@@ -505,35 +539,35 @@ export class DocumentService {
             }
           }
           const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-          (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
+          (_this$analyticsHelper25 = this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 ? void 0 : _this$analyticsHelper25.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
             // upon success, emit the total number of unconfirmed steps we synced
             numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
           });
         }
       } catch (error) {
-        var _this$analyticsHelper25, _this$analyticsHelper26;
+        var _this$analyticsHelper26, _this$analyticsHelper27;
         const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-        (_this$analyticsHelper25 = this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 ? void 0 : _this$analyticsHelper25.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
+        (_this$analyticsHelper26 = this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 ? void 0 : _this$analyticsHelper26.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
           latency: measure === null || measure === void 0 ? void 0 : measure.duration,
           numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
         });
-        (_this$analyticsHelper26 = this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 ? void 0 : _this$analyticsHelper26.sendErrorEvent(error, 'Error while committing unconfirmed steps');
+        (_this$analyticsHelper27 = this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 ? void 0 : _this$analyticsHelper27.sendErrorEvent(error, 'Error while committing unconfirmed steps');
         throw error;
       }
     });
     _defineProperty(this, "onStepRejectedError", () => {
-      var _this$analyticsHelper27;
+      var _this$analyticsHelper28;
       this.stepRejectCounter++;
       logger(`Steps rejected (tries=${this.stepRejectCounter})`);
-      (_this$analyticsHelper27 = this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 ? void 0 : _this$analyticsHelper27.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
+      (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 ? void 0 : _this$analyticsHelper28.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
         count: this.stepRejectCounter
       });
-      let maxRetries = this.aggressiveCatchup ? MAX_STEP_REJECTED_ERROR_AGGRESSIVE : MAX_STEP_REJECTED_ERROR;
+      const maxRetries = this.aggressiveCatchup ? MAX_STEP_REJECTED_ERROR_AGGRESSIVE : MAX_STEP_REJECTED_ERROR;
       if (this.stepRejectCounter >= maxRetries) {
-        var _this$analyticsHelper28;
+        var _this$analyticsHelper29;
         logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
-        (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 ? void 0 : _this$analyticsHelper28.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
+        (_this$analyticsHelper29 = this.analyticsHelper) === null || _this$analyticsHelper29 === void 0 ? void 0 : _this$analyticsHelper29.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
         this.throttledCatchupv2(CatchupEventReason.STEPS_REJECTED);
       } else {
         // If committing steps failed try again automatically in 1s
@@ -554,21 +588,22 @@ export class DocumentService {
     this.isNameSpaceLocked = isNameSpaceLocked;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.options = options;
+    this.getConnected = getConnected;
     this.stepQueue = new StepQueueState();
     this.onErrorHandled = onErrorHandled;
   }
   getVersionFromCollabState(state, resource) {
     const collabState = getCollabState(state);
     if (!collabState) {
-      var _this$analyticsHelper29;
-      (_this$analyticsHelper29 = this.analyticsHelper) === null || _this$analyticsHelper29 === void 0 ? void 0 : _this$analyticsHelper29.sendErrorEvent(new Error('No collab state when calling ProseMirror function'), `${resource} called without collab state`);
+      var _this$analyticsHelper30;
+      (_this$analyticsHelper30 = this.analyticsHelper) === null || _this$analyticsHelper30 === void 0 ? void 0 : _this$analyticsHelper30.sendErrorEvent(new Error('No collab state when calling ProseMirror function'), `${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 ? void 0 : _this$analyticsHelper30.sendErrorEvent(new Error('Collab state missing version info when calling ProseMirror function'), `${resource} called with collab state missing version info`);
+      var _this$analyticsHelper31;
+      (_this$analyticsHelper31 = this.analyticsHelper) === null || _this$analyticsHelper31 === void 0 ? void 0 : _this$analyticsHelper31.sendErrorEvent(new Error('Collab state missing version info when calling ProseMirror function'), `${resource} called with collab state missing version info`);
       return 0;
     }
     return collabState.version;
@@ -582,9 +617,15 @@ export class DocumentService {
     if (this.stepQueue.getQueue().length > 0) {
       const firstItem = this.stepQueue.shift();
       const currentVersion = this.getCurrentPmVersion();
+      // Ignored via go/ees005
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       const 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();
@@ -612,15 +653,17 @@ export class DocumentService {
         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(() => this.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
-        let userIdMatch = this.isStepsFromNewClientIdForSameUserId(steps);
+        const userIdMatch = this.isStepsFromNewClientIdForSameUserId(steps);
         logger(`Processing steps failed with error: ${error}. Triggering catch up call.`);
-        (_this$analyticsHelper31 = this.analyticsHelper) === null || _this$analyticsHelper31 === void 0 ? 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 ? void 0 : _this$analyticsHelper32.sendErrorEvent(error, userIdMatch ? `Error while processing steps with new clientId` : `Error while processing steps`);
         this.throttledCatchupv2(CatchupEventReason.PROCESS_STEPS);
       }
     }
@@ -650,8 +693,8 @@ export class DocumentService {
     var _this$getState7;
     const state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
     if (!state) {
-      var _this$analyticsHelper32;
-      (_this$analyticsHelper32 = this.analyticsHelper) === null || _this$analyticsHelper32 === void 0 ? 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 ? void 0 : _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
       return;
     }
     this.send(null, null, state, sendAnalyticsEvent);
@@ -660,21 +703,29 @@ export class DocumentService {
    * 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
   send(_tr, _oldState, newState, sendAnalyticsEvent) {
     const unconfirmedStepsData = sendableSteps(newState);
     const version = this.getVersionFromCollabState(newState, 'collab-provider: send');
 
     // Don't send any steps before we're ready.
-    if (!unconfirmedStepsData) {
-      return;
+    if (fg('platform_editor_merge_unconfirmed_steps')) {
+      if (!unconfirmedStepsData || !this.getConnected()) {
+        return;
+      }
+    } else {
+      if (!unconfirmedStepsData) {
+        return;
+      }
     }
     const 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 ? void 0 : _this$analyticsHelper33.sendActionEvent(EVENT_ACTION.HAS_UNCONFIRMED_STEPS, EVENT_STATUS.INFO, {
+      var _this$analyticsHelper34;
+      (_this$analyticsHelper34 = this.analyticsHelper) === null || _this$analyticsHelper34 === void 0 ? void 0 : _this$analyticsHelper34.sendActionEvent(EVENT_ACTION.HAS_UNCONFIRMED_STEPS, EVENT_STATUS.INFO, {
         numUnconfirmedSteps: (unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) || 0
       });
     }
@@ -682,12 +733,28 @@ export class DocumentService {
       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 (fg('platform_editor_merge_unconfirmed_steps')) {
+      unconfirmedStepsData.steps.forEach(s => {
+        if (isLockable(s)) {
+          var _s$lockStep;
+          (_s$lockStep = s.lockStep) === null || _s$lockStep === void 0 ? void 0 : _s$lockStep.call(s);
+        }
+      });
+    }
+
     // Avoid reference issues using a
     // method outside of the provider
     // scope
     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,
@@ -698,4 +765,10 @@ export class DocumentService {
       __livePage: this.options.__livePage
     });
   }
+}
+
+// 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/es2019/emitter.js

@@ -1,5 +1,8 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { EventEmitter2 } from 'eventemitter2';
+
+// Ignored via go/ees005
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export class Emitter {
   constructor() {
     _defineProperty(this, "eventEmitter", new EventEmitter2());
@@ -8,6 +11,8 @@ export class Emitter {
    * Emit events to subscribers
    */
   emit(evt, data) {
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     this.eventEmitter.emit(evt, data);
     return this;
   }
@@ -16,6 +21,8 @@ export class Emitter {
    * Subscribe to events emitted by this provider
    */
   on(evt, handler) {
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     this.eventEmitter.on(evt, handler);
     return this;
   }
@@ -24,6 +31,8 @@ export class Emitter {
    * Unsubscribe from events emitted by this provider
    */
   off(evt, handler) {
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     this.eventEmitter.off(evt, handler);
     return this;
   }
@@ -32,6 +41,8 @@ export class Emitter {
    * Unsubscribe from all events emitted by this provider.
    */
   unsubscribeAll(evt) {
+    // Ignored via go/ees005
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     this.eventEmitter.removeAllListeners(evt);
     return this;
   }