@atlaskit/collab-provider 8.0.1 → 8.2.0

package/dist/es2019/provider/index.js

@@ -1,5 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import { getVersion, sendableSteps } from 'prosemirror-collab';
+import { getVersion, sendableSteps } from '@atlaskit/prosemirror-collab';
 import throttle from 'lodash/throttle';
 import isEqual from 'lodash/isEqual';
 import countBy from 'lodash/countBy';
@@ -17,19 +17,12 @@ import { DisconnectReason, socketIOReasons } from '../disconnected-reason-mapper
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 const logger = createLogger('Provider', 'black');
 const PARTICIPANT_UPDATE_INTERVAL = 300 * 1000; // 300 seconds
-
 const SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
-
 const SEND_STEPS_THROTTLE = 500; // 0.5 second
-
 export const CATCHUP_THROTTLE = 1 * 1000; // 1 second
-
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
-
 const noop = () => {};
-
 export const MAX_STEP_REJECTED_ERROR = 15;
-
 const commitStep = ({
   channel,
   steps,
@@ -41,7 +34,8 @@ const commitStep = ({
   onStepsAdded,
   onErrorHandled
 }) => {
-  const stepsWithClientAndUserId = steps.map(step => ({ ...step.toJSON(),
+  const stepsWithClientAndUserId = steps.map(step => ({
+    ...step.toJSON(),
     clientId,
     userId
   }));
@@ -52,7 +46,6 @@ const commitStep = ({
     userId
   }, response => {
     const latency = new Date().getTime() - start;
-
     if (response.type === AcknowledgementResponseTypes.SUCCESS) {
       onStepsAdded({
         steps: stepsWithClientAndUserId,
@@ -71,7 +64,6 @@ const commitStep = ({
       triggerAnalyticsEvent(analyticStepEvent, analyticsClient);
     } else if (response.type === AcknowledgementResponseTypes.ERROR) {
       var _response$error, _response$error$data, _response$error2, _response$error2$data;
-
       onErrorHandled(response.error, true);
       triggerAnalyticsEvent({
         eventAction: EVENT_ACTION.ADD_STEPS,
@@ -102,41 +94,39 @@ const commitStep = ({
     }
   });
 };
-
 const throttledCommitStep = throttle(commitStep, SEND_STEPS_THROTTLE, {
   leading: false,
   trailing: true
 });
 export class Provider extends Emitter {
   // To keep track of the namespace event changes from the server.
+
   constructor(config) {
     super();
-
     _defineProperty(this, "participants", new Map());
-
     _defineProperty(this, "metadata", {});
-
     _defineProperty(this, "stepRejectCounter", 0);
-
     _defineProperty(this, "isChannelInitialized", false);
-
     _defineProperty(this, "isNamespaceLocked", false);
-
     _defineProperty(this, "initializeChannel", () => {
+      this.emit('connecting', {
+        initial: true
+      });
       this.channel.on('connected', ({
         sid,
         initialized
       }) => {
         this.sessionId = sid;
         this.emit('connected', {
-          sid
-        }); // If already initialized, `connected` means reconnected
-
-        if (initialized && this.disconnectedAt && // Offline longer than `OUT_OF_SYNC_PERIOD`
+          sid,
+          initial: !initialized
+        });
+        // If already initialized, `connected` means reconnected
+        if (initialized && this.disconnectedAt &&
+        // Offline longer than `OUT_OF_SYNC_PERIOD`
         Date.now() - this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
           this.throttledCatchup();
         }
-
         this.disconnectedAt = undefined;
       }).on('init', ({
         doc,
@@ -151,7 +141,6 @@ export class Provider extends Emitter {
         });
       }).on('restore', this.onRestore.bind(this)).on('steps:added', this.onStepsAdded.bind(this)).on('participant:telepointer', this.onParticipantTelepointer.bind(this)).on('presence:joined', this.onPresenceJoined.bind(this)).on('presence', this.onPresence.bind(this)).on('participant:left', this.onParticipantLeft.bind(this)).on('participant:updated', this.onParticipantUpdated.bind(this)).on('metadata:changed', this.onMetadataChanged.bind(this)).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled.bind(this)).on('status', this.onNamespaceStatusChanged.bind(this)).connect();
     });
-
     _defineProperty(this, "onRestore", ({
       doc,
       version,
@@ -162,12 +151,13 @@ export class Provider extends Emitter {
         steps: unconfirmedSteps
       } = this.getUnconfirmedSteps() || {
         steps: []
-      }; // Reset the editor,
+      };
+
+      // 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.
       //  - Replace the metadata
       //  - Reserve the cursor position, in case a cursor jump.
-
       this.updateDocumentWithMetadata({
         doc,
         version,
@@ -180,27 +170,24 @@ export class Provider extends Emitter {
           numUnconfirmedSteps: unconfirmedSteps.length,
           documentAri: this.config.documentAri
         }
-      }, this.analyticsClient); // Re-apply the unconfirmed steps, not 100% of them can be applied, if document is changed significantly.
+      }, this.analyticsClient);
 
+      // Re-apply the unconfirmed steps, not 100% of them can be applied, if document is changed significantly.
       if (unconfirmedSteps.length > 0) {
         this.applyLocalSteps(unconfirmedSteps);
       }
     });
-
     _defineProperty(this, "onStepsAdded", (data, disableAnalytics = false) => {
       logger(`Received steps`, {
         steps: data.steps,
         version: data.version
       });
-
       if (!data.steps) {
         logger(`No steps.. waiting..`);
         return;
       }
-
       const currentVersion = this.getCurrentPmVersion();
       const expectedVersion = currentVersion + data.steps.length;
-
       if (data.version === currentVersion) {
         logger(`Received steps we already have. Ignoring.`);
       } else if (data.version === expectedVersion) {
@@ -210,21 +197,17 @@ export class Provider extends Emitter {
         this.queueSteps(data);
         this.throttledCatchup();
       }
-
       this.updateParticipants([], data.steps.map(({
         userId
       }) => userId));
     });
-
     _defineProperty(this, "throttledCatchup", throttle(() => this.catchup(), CATCHUP_THROTTLE, {
       leading: false,
       trailing: true
     }));
-
     _defineProperty(this, "filterQueue", condition => {
       this.queue = this.queue.filter(condition);
     });
-
     _defineProperty(this, "updateDocumentWithMetadata", ({
       doc,
       version,
@@ -239,38 +222,31 @@ export class Provider extends Emitter {
           reserveCursor
         } : {})
       });
-
       if (metadata && Object.keys(metadata).length > 0) {
         this.metadata = metadata;
         this.emit('metadata:changed', metadata);
       }
     });
-
     _defineProperty(this, "applyLocalSteps", steps => {
-      // Re-aply local steps
+      // Re-apply local steps
       this.emit('local-steps', {
         steps
       });
     });
-
     _defineProperty(this, "getCurrentPmVersion", () => {
       return getVersion(this.getState());
     });
-
     _defineProperty(this, "getUnconfirmedSteps", () => {
       return sendableSteps(this.getState());
     });
-
     _defineProperty(this, "catchup", async () => {
-      const start = new Date().getTime(); // if the queue is already paused, we are busy with something else, so don't proceed.
-
+      const start = new Date().getTime();
+      // if the queue is already paused, we are busy with something else, so don't proceed.
       if (this.pauseQueue) {
         logger(`Queue is paused. Aborting.`);
         return;
       }
-
       this.pauseQueue = true;
-
       try {
         await catchup({
           getCurrentPmVersion: this.getCurrentPmVersion,
@@ -308,52 +284,54 @@ export class Provider extends Emitter {
         this.stepRejectCounter = 0;
       }
     });
-
     _defineProperty(this, "onErrorHandled", (error, disableAnalytics = false) => {
-      if (error !== null && error !== void 0 && error.data) {
-        // 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
-        if (error.data.code === 'HEAD_VERSION_UPDATE_FAILED' || error.data.code === 'VERSION_NUMBER_ALREADY_EXISTS') {
-          // TODO: Remove this analytics logic once we have validated the ack messages and aren't likely to go back to a generic error handler
-          if (!disableAnalytics) {
-            triggerAnalyticsEvent({
-              eventAction: EVENT_ACTION.ADD_STEPS,
-              attributes: {
-                eventStatus: EVENT_STATUS.FAILURE,
-                type: ADD_STEPS_TYPE.REJECTED,
-                error,
-                documentAri: this.config.documentAri
-              }
-            }, this.analyticsClient);
-          }
-
-          this.stepRejectCounter++;
-          logger(`Steps rejected (tries=${this.stepRejectCounter})`);
-
-          if (this.stepRejectCounter >= MAX_STEP_REJECTED_ERROR) {
-            logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
-            this.throttledCatchup();
-          }
+      var _error$data, _error$data2;
+      // 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
+      if (((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) === 'HEAD_VERSION_UPDATE_FAILED' || ((_error$data2 = error.data) === null || _error$data2 === void 0 ? void 0 : _error$data2.code) === 'VERSION_NUMBER_ALREADY_EXISTS') {
+        // TODO: Remove this analytics logic once we have validated the ack messages and aren't likely to go back to a generic error handler
+        if (!disableAnalytics) {
+          triggerAnalyticsEvent({
+            eventAction: EVENT_ACTION.ADD_STEPS,
+            attributes: {
+              eventStatus: EVENT_STATUS.FAILURE,
+              type: ADD_STEPS_TYPE.REJECTED,
+              error,
+              documentAri: this.config.documentAri
+            }
+          }, this.analyticsClient);
         }
-
-        const errorToEmit = errorCodeMapper(error);
-
-        if (errorToEmit) {
-          this.emit('error', errorToEmit);
+        this.stepRejectCounter++;
+        logger(`Steps rejected (tries=${this.stepRejectCounter})`);
+        if (this.stepRejectCounter >= MAX_STEP_REJECTED_ERROR) {
+          logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
+          this.throttledCatchup();
+        }
+      } else {
+        const mappedError = errorCodeMapper(error);
+        // TODO: Remove this analytics logic once we have validated the ack messages and aren't likely to go back to a generic error handler
+        if (!disableAnalytics) {
+          triggerAnalyticsEvent({
+            eventAction: EVENT_ACTION.ERROR,
+            attributes: {
+              documentAri: this.config.documentAri,
+              mappedError
+            },
+            nonPrivacySafeAttributes: {
+              error
+            }
+          }, this.analyticsClient);
         }
+        this.emit('error', mappedError);
+        logger('Error from collab service', error);
       }
-
-      logger('Error from collab service', error);
     });
-
     _defineProperty(this, "queue", []);
-
     _defineProperty(this, "sendPresence", () => {
       if (this.presenceUpdateTimeout) {
         clearTimeout(this.presenceUpdateTimeout);
       }
-
       this.channel.broadcast('participant:updated', {
         sessionId: this.sessionId,
         userId: this.userId,
@@ -361,15 +339,14 @@ export class Provider extends Emitter {
       });
       this.presenceUpdateTimeout = window.setTimeout(() => this.sendPresence(), SEND_PRESENCE_INTERVAL);
     });
-
     _defineProperty(this, "onPresenceJoined", ({
       sessionId
     }) => {
-      logger('Participant joined with session: ', sessionId); // This expose existing users to the newly joined user
+      logger('Participant joined with session: ', sessionId);
 
+      // This expose existing users to the newly joined user
       this.sendPresence();
     });
-
     _defineProperty(this, "onPresence", ({
       userId
     }) => {
@@ -378,14 +355,12 @@ export class Provider extends Emitter {
       this.sendPresence();
       this.channel.sendPresenceJoined();
     });
-
     _defineProperty(this, "onMetadataChanged", metadata => {
       if (metadata !== undefined && !isEqual(this.metadata, metadata)) {
         this.metadata = metadata;
         this.emit('metadata:changed', metadata);
       }
     });
-
     _defineProperty(this, "onParticipantLeft", ({
       sessionId
     }) => {
@@ -397,7 +372,6 @@ export class Provider extends Emitter {
         }]
       });
     });
-
     _defineProperty(this, "onParticipantUpdated", ({
       sessionId,
       timestamp,
@@ -411,7 +385,6 @@ export class Provider extends Emitter {
         clientId
       });
     });
-
     _defineProperty(this, "onParticipantTelepointer", ({
       sessionId,
       timestamp,
@@ -422,14 +395,14 @@ export class Provider extends Emitter {
       if (sessionId === this.sessionId) {
         return;
       }
+      const participant = this.participants.get(sessionId);
 
-      const participant = this.participants.get(sessionId); // Ignore old telepointer events
-
+      // Ignore old telepointer events
       if (participant && participant.lastActive > timestamp) {
         return;
-      } // Set last active
-
+      }
 
+      // Set last active
       this.updateParticipant({
         sessionId,
         timestamp,
@@ -442,7 +415,6 @@ export class Provider extends Emitter {
         sessionId
       });
     });
-
     _defineProperty(this, "updateParticipant", async ({
       sessionId,
       timestamp,
@@ -453,7 +425,6 @@ export class Provider extends Emitter {
         // If userId does not exsit, does nothing here to prevent duplication.
         return;
       }
-
       const {
         getUser
       } = this.config;
@@ -463,14 +434,12 @@ export class Provider extends Emitter {
         avatar = ''
       } = await (getUser ? getUser(userId) : getParticipant(userId));
       const isNewParticipant = !this.participants.has(sessionId);
-
       if (isNewParticipant) {
         logger('new Participant updated', {
           name,
           avatar
         });
       }
-
       this.participants.set(sessionId, {
         name,
         email,
@@ -479,31 +448,30 @@ export class Provider extends Emitter {
         lastActive: timestamp,
         userId,
         clientId
-      }); // Collab-plugin expects an array of users that joined.
+      });
 
+      // Collab-plugin expects an array of users that joined.
       this.updateParticipants(isNewParticipant ? [this.participants.get(sessionId)] : []);
     });
-
     _defineProperty(this, "updateParticipants", (joined = [], userIds = []) => {
       if (this.participantUpdateTimeout) {
         clearTimeout(this.participantUpdateTimeout);
       }
-
       const now = new Date().getTime();
       Array.from(this.participants.values()).forEach(p => {
         if (userIds.indexOf(p.userId) !== -1) {
-          this.participants.set(p.sessionId, { ...p,
+          this.participants.set(p.sessionId, {
+            ...p,
             lastActive: now
           });
         }
-      }); // Filter out participants that's been inactive for more than 5 minutes.
+      });
 
+      // Filter out participants that's been inactive for more than 5 minutes.
       const left = Array.from(this.participants.values()).filter(p => p.sessionId !== this.sessionId && now - p.lastActive > PARTICIPANT_UPDATE_INTERVAL);
       left.forEach(p => this.participants.delete(p.sessionId));
-
       if (joined.length || left.length) {
         var _this$participants$si;
-
         triggerAnalyticsEvent({
           eventAction: EVENT_ACTION.UPDATE_PARTICIPANTS,
           attributes: {
@@ -511,7 +479,8 @@ export class Provider extends Emitter {
             documentAri: this.config.documentAri
           }
         }, this.analyticsClient);
-        this.emit('presence', { ...(joined.length ? {
+        this.emit('presence', {
+          ...(joined.length ? {
             joined
           } : {}),
           ...(left.length ? {
@@ -519,32 +488,24 @@ export class Provider extends Emitter {
           } : {})
         });
       }
-
       this.participantUpdateTimeout = window.setTimeout(() => this.updateParticipants(), PARTICIPANT_UPDATE_INTERVAL);
     });
-
     _defineProperty(this, "disconnectedReasonMapper", reason => {
       switch (reason) {
         case socketIOReasons.IO_CLIENT_DISCONNECT:
           return DisconnectReason.CLIENT_DISCONNECT;
-
         case socketIOReasons.IO_SERVER_DISCONNECT:
           return DisconnectReason.SERVER_DISCONNECT;
-
         case socketIOReasons.TRANSPORT_CLOSED:
           return DisconnectReason.SOCKET_CLOSED;
-
         case socketIOReasons.TRANSPORT_ERROR:
           return DisconnectReason.SOCKET_ERROR;
-
         case socketIOReasons.PING_TIMEOUT:
           return DisconnectReason.SOCKET_TIMEOUT;
-
         default:
           return DisconnectReason.UNKNOWN_DISCONNECT;
       }
     });
-
     _defineProperty(this, "onDisconnected", ({
       reason
     }) => {
@@ -555,43 +516,36 @@ export class Provider extends Emitter {
         reason: this.disconnectedReasonMapper(reason),
         sid: this.sessionId
       });
-
       if (left.length) {
         this.emit('presence', {
           left
         });
       }
     });
-
     _defineProperty(this, "getFinalAcknowledgedState", async () => {
       var _this$metadata$title;
-
       const maxAttemptsToSync = ACK_MAX_TRY;
       let count = 0;
       let unconfirmedState = this.getUnconfirmedSteps();
-
       if (unconfirmedState && unconfirmedState.steps.length) {
-        startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS); // We use origins here as steps can be rebased. When steps are rebased a new step is created.
+        startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
+        // We use origins here as steps can be rebased. When steps are rebased a new step is created.
         // This means that we can not track if it has been removed from the unconfirmed array or not.
         // Origins points to the original transaction that the step was created in. This is never changed
         // and gets passed down when a step is rebased.
-
         const unconfirmedTrs = unconfirmedState.origins;
         const lastTr = unconfirmedTrs[unconfirmedTrs.length - 1];
         let isLastTrConfirmed = false;
-
         while (!isLastTrConfirmed) {
           this.sendStepsFromCurrentState();
           await sleep(1000);
           const nextUnconfirmedState = this.getUnconfirmedSteps();
-
           if (nextUnconfirmedState && nextUnconfirmedState.steps.length) {
             const nextUnconfirmedTrs = nextUnconfirmedState.origins;
             isLastTrConfirmed = !nextUnconfirmedTrs.some(tr => tr === lastTr);
           } else {
             isLastTrConfirmed = true;
           }
-
           if (!isLastTrConfirmed && count++ >= maxAttemptsToSync) {
             if (this.onSyncUpError) {
               const state = this.getState();
@@ -603,7 +557,6 @@ export class Provider extends Emitter {
                 version: getVersion(state)
               });
             }
-
             const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
             triggerAnalyticsEvent({
               eventAction: EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS,
@@ -618,7 +571,6 @@ export class Provider extends Emitter {
             throw new Error("Can't sync up with Collab Service");
           }
         }
-
         const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS);
         triggerAnalyticsEvent({
           eventAction: EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS,
@@ -631,11 +583,9 @@ export class Provider extends Emitter {
           }
         }, this.analyticsClient);
       }
-
-      const state = this.getState(); // Convert ProseMirror document in Editor state to ADF document
-
+      const state = this.getState();
+      // Convert ProseMirror document in Editor state to ADF document
       let adfDocument;
-
       try {
         startMeasure(MEASURE_NAME.CONVERT_PM_TO_ADF);
         adfDocument = new JSONTransformer().encode(state.doc);
@@ -661,14 +611,12 @@ export class Provider extends Emitter {
         }, this.analyticsClient);
         logger(`Error when converting PM document to ADF: `, error);
       }
-
       return {
         content: adfDocument,
         title: (_this$metadata$title = this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
         stepVersion: getVersion(state)
       };
     });
-
     _defineProperty(this, "onNamespaceStatusChanged", async data => {
       const {
         isLocked,
@@ -679,13 +627,13 @@ export class Provider extends Emitter {
       logger(`Received a namespace status changed event `, {
         data
       });
-
       if (isLocked && waitTimeInMs) {
         this.isNamespaceLocked = true;
         logger(`Received a namespace status change event `, {
           isLocked
-        }); // To protect the collab editing process from locked out due to BE
+        });
 
+        // To protect the collab editing process from locked out due to BE
         setTimeout(() => {
           logger(`The namespace lock has expired`, {
             waitTime: Date.now() - start,
@@ -695,20 +643,16 @@ export class Provider extends Emitter {
         }, waitTimeInMs);
         return;
       }
-
       this.isNamespaceLocked = false;
       logger(`The page lock has expired`);
     });
-
     this.config = config;
     this.channel = new Channel(config);
     this.isChannelInitialized = false;
-
     if (config.analyticsClient) {
       this.analyticsClient = config.analyticsClient;
     }
   }
-
   /**
    * Called by collab plugin in editor when it's ready to
    * initialize a collab session.
@@ -718,22 +662,34 @@ export class Provider extends Emitter {
       getState
     });
   }
-
   setup({
     getState,
     onSyncUpError
   }) {
-    this.getState = getState;
-    this.onSyncUpError = onSyncUpError || noop;
-    this.clientId = getState().plugins.find(p => p.key === 'collab$').spec.config.clientID;
-
-    if (!this.isChannelInitialized) {
-      this.initializeChannel();
-      this.isChannelInitialized = true;
+    try {
+      this.getState = getState;
+      this.onSyncUpError = onSyncUpError || noop;
+      this.clientId = getState().plugins.find(p => p.key === 'collab$').spec.config.clientID;
+      if (!this.isChannelInitialized) {
+        this.initializeChannel();
+        this.isChannelInitialized = true;
+      }
+    } catch (initError) {
+      triggerAnalyticsEvent({
+        eventAction: EVENT_ACTION.ERROR,
+        attributes: {
+          attemptedAction: EVENT_ACTION.INIT_PROVIDER,
+          documentAri: this.config.documentAri
+        },
+        nonPrivacySafeAttributes: {
+          error: initError
+        }
+      }, this.analyticsClient);
+      throw initError;
     }
-
     return this;
   }
+
   /**
    * We can use this function to throttle/delay
    * Any send steps operation
@@ -741,46 +697,40 @@ export class Provider extends Emitter {
    * The getState function will return the current EditorState
    * from the EditorView.
    */
-
-
   sendStepsFromCurrentState() {
     const state = this.getState && this.getState();
-
     if (!state) {
       return;
     }
-
     this.send(null, null, state);
   }
+
   /**
    * 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
    */
-
-
   send(_tr, _oldState, newState) {
     const sendable = sendableSteps(newState);
-    const version = getVersion(newState); // Don't send any steps before we're ready.
+    const version = getVersion(newState);
 
+    // Don't send any steps before we're ready.
     if (!sendable) {
       return;
     }
-
     if (this.isNamespaceLocked) {
       logger('The document is temporary locked');
       return;
     }
-
     const {
       steps
     } = sendable;
-
     if (!steps || !steps.length) {
       return;
-    } // Avoid reference issues using a
+    }
+
+    // Avoid reference issues using a
     // method outside of the provider
     // scope
-
-
     throttledCommitStep({
       channel: this.channel,
       userId: this.userId,
@@ -792,44 +742,39 @@ export class Provider extends Emitter {
       onStepsAdded: this.onStepsAdded.bind(this),
       onErrorHandled: this.onErrorHandled.bind(this)
     });
-  } // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
+  }
 
+  // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
 
   queueSteps(data) {
     logger(`Queueing data for version "${data.version}".`);
     const orderedQueue = [...this.queue, data].sort((a, b) => a.version > b.version ? 1 : -1);
     this.queue = orderedQueue;
   }
-
   processQueue() {
     if (this.pauseQueue) {
       logger(`Queue is paused. Aborting.`);
       return;
     }
-
     logger(`Looking for processable data.`);
-
     if (this.queue.length > 0) {
       const firstItem = this.queue.shift();
       const currentVersion = this.getCurrentPmVersion();
       const expectedVersion = currentVersion + firstItem.steps.length;
-
       if (firstItem.version === expectedVersion) {
         logger(`Applying data from queue!`);
-        this.processSteps(firstItem); // recur
-
+        this.processSteps(firstItem);
+        // recur
         this.processQueue();
       }
     }
   }
-
   processSteps(data, disableAnalytics = false) {
     const {
       version,
       steps
     } = data;
     logger(`Processing data. Version "${version}".`);
-
     if (steps !== null && steps !== void 0 && steps.length) {
       const clientIds = steps.map(({
         clientId
@@ -838,10 +783,10 @@ export class Provider extends Emitter {
         json: steps,
         version,
         userIds: clientIds
-      }); // If steps can apply to local editor successfully, no need to accumulate the error counter.
-
-      this.stepRejectCounter = 0; // TODO: Remove this analytics logic after we've validated the ack call-backs
-
+      });
+      // If steps can apply to local editor successfully, no need to accumulate the error counter.
+      this.stepRejectCounter = 0;
+      // TODO: Remove this analytics logic after we've validated the ack call-backs
       if (!disableAnalytics && clientIds.indexOf(this.clientId) >= 0) {
         let analyticStepEvent = {
           eventAction: EVENT_ACTION.ADD_STEPS,
@@ -854,24 +799,22 @@ export class Provider extends Emitter {
         analyticStepEvent.attributes.stepType = countBy(steps, step => step.stepType);
         triggerAnalyticsEvent(analyticStepEvent, this.analyticsClient);
       }
+      this.emitTelepointersFromSteps(steps);
 
-      this.emitTelepointersFromSteps(steps); // Resend local steps if none of the received steps originated with us!
-
+      // Resend local steps if none of the received steps originated with us!
       if (clientIds.indexOf(this.clientId) === -1) {
         setTimeout(() => this.sendStepsFromCurrentState(), 100);
       }
     }
   }
+
   /**
    * Send messages, such as telepointers, to other participants.
    */
-
-
   sendMessage(data) {
     if (!data) {
       return;
     }
-
     const {
       type,
       ...rest
@@ -881,7 +824,6 @@ export class Provider extends Emitter {
       sessionId,
       clientId
     } = this;
-
     switch (type) {
       case 'telepointer':
         const telepointerExperience = new UFOExperience('collab-provider.telepointer', {
@@ -925,11 +867,9 @@ export class Provider extends Emitter {
         break;
     }
   }
-
   emitTelepointersFromSteps(steps) {
     steps.forEach(step => {
       const [participant] = Array.from(this.participants.values()).filter(p => p.clientId === step.clientId);
-
       if (participant) {
         const {
           stepType,
@@ -940,7 +880,6 @@ export class Provider extends Emitter {
           }
         } = step;
         const [node] = slice.content;
-
         if (stepType === 'replace' && to === from && slice.content.length === 1 && node.type === 'text' && node.text.length === 1) {
           this.emit('telepointer', {
             sessionId: participant.sessionId,
@@ -955,44 +894,36 @@ export class Provider extends Emitter {
       }
     });
   }
-
   destroy() {
     return this.disconnect();
   }
-
   disconnect() {
     return this.unsubscribeAll();
   }
-
   setTitle(title, broadcast) {
     if (broadcast) {
       this.channel.sendMetadata({
         title
       });
     }
-
     Object.assign(this.metadata, {
       title
     });
   }
-
   setEditorWidth(editorWidth, broadcast) {
     if (broadcast) {
       this.channel.sendMetadata({
         editorWidth
       });
     }
-
     Object.assign(this.metadata, {
       editorWidth
     });
   }
-
   setMetadata(metadata) {
     this.channel.sendMetadata(metadata);
     Object.assign(this.metadata, metadata);
   }
-
   /**
    * Unsubscribe from all events emitted by this provider.
    */
@@ -1001,9 +932,8 @@ export class Provider extends Emitter {
     this.channel.disconnect();
     return this;
   }
+
   /**
    * ESS-2916 namespace status event- lock/unlock
    */
-
-
 }