@atlaskit/collab-provider 8.8.2 → 8.9.0

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

@@ -4,16 +4,27 @@ import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { telepointerFromStep } from './telepointers-helper';
 import { createParticipantFromPayload as enrichParticipant, PARTICIPANT_UPDATE_INTERVAL } from './participants-helper';
 import { ParticipantsState } from './participants-state';
+import { createLogger } from '../helpers/utils';
+const logger = createLogger('PresenceService', 'pink');
+const SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
+
+/**
+ * This service is responsible for handling presence and participant events, as well as sending them on to the editor or NCS.
+ * @param analyticsHelper Analytics helper instance
+ * @param participantsState Starts with no participants, only add this when testing
+ * @param emit Emit from the Provider class (to the editor)
+ * @param getUser Callback to get user data from the editor
+ * @param channelBroadcast Broadcast from the Channel class (to NCS)
+ * @param sendPresenceJoined Callback to Channel class
+ */
 export class ParticipantsService {
-  constructor(analyticsHelper, participantsState = new ParticipantsState()) {
+  constructor(analyticsHelper, participantsState = new ParticipantsState(), emit, getUser, channelBroadcast, sendPresenceJoined) {
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
      * @param payload Payload from incoming socket event
-     * @param getUser Function to get user data from confluence
-     * @param emit Function to execute emit from provider socket
      * @returns Awaitable Promise, due to getUser
      */
-    _defineProperty(this, "updateParticipant", async (payload, getUser, emit) => {
+    _defineProperty(this, "onParticipantUpdated", async payload => {
       const {
         userId
       } = payload;
@@ -30,11 +41,11 @@ export class ParticipantsService {
         {
           ...payload,
           userId
-        }, getUser);
+        }, this.getUser);
       } catch (error) {
         var _this$analyticsHelper;
         // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper = this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(error, 'enriching participant');
+        (_this$analyticsHelper = this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(error, 'Error while enriching participant');
       }
       if (!participant) {
         return;
@@ -46,28 +57,27 @@ export class ParticipantsService {
       }
       this.emitPresence({
         joined: [participant]
-      }, emit, 'handling participant updated event');
+      }, 'handling participant updated event');
     });
     /**
      * Called when a participant leaves the session.
-     *
      * We emit the `presence` event to update the active avatars in the editor.
      */
-    _defineProperty(this, "participantLeft", ({
+    _defineProperty(this, "onParticipantLeft", ({
       sessionId
-    }, emit) => {
+    }) => {
       this.participantsState.removeBySessionId(sessionId);
       this.emitPresence({
         left: [{
           sessionId
         }]
-      }, emit, 'participant leaving');
+      }, 'participant leaving');
     });
-    _defineProperty(this, "disconnect", (reason, sessionId, emit) => {
+    _defineProperty(this, "disconnect", (reason, sessionId) => {
       const left = this.participantsState.getParticipants();
       this.participantsState.clear();
       try {
-        emit('disconnected', {
+        this.emit('disconnected', {
           reason: disconnectedReasonMapper(reason),
           sid: sessionId
         });
@@ -79,7 +89,7 @@ export class ParticipantsService {
       if (left.length) {
         this.emitPresence({
           left
-        }, emit, 'emitting presence update on disconnect');
+        }, 'emitting presence update on disconnect');
       }
     });
     /**
@@ -91,7 +101,7 @@ export class ParticipantsService {
      * Called when we receive a telepointer update from another
      * participant.
      */
-    _defineProperty(this, "participantTelepointer", (payload, thisSessionId, getUser, emit) => {
+    _defineProperty(this, "onParticipantTelepointer", (payload, thisSessionId) => {
       const {
         sessionId,
         selection,
@@ -111,44 +121,43 @@ export class ParticipantsService {
         type: 'telepointer',
         selection,
         sessionId
-      }, emit, 'handling participant telepointer event');
+      }, 'handling participant telepointer event');
     });
     /**
      * Every 5 minutes (PARTICIPANT_UPDATE_INTERVAL), removes inactive participants and emits the update to other participants.
      * Needs to be kicked off in the Provider.
      * @param sessionId SessionId from provider's connection
-     * @param emit Function to execute emit from provider socket
      */
-    _defineProperty(this, "removeInactiveParticipants", (sessionId, emit) => {
+    _defineProperty(this, "startInactiveRemover", sessionId => {
       clearTimeout(this.participantUpdateTimeout);
       try {
-        this.filterInactive(sessionId, emit);
+        this.filterInactive(sessionId);
       } catch (err) {
         var _this$analyticsHelper3;
         (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(err, 'Failed filtering inactive participants');
       }
-      this.participantUpdateTimeout = window.setTimeout(() => this.removeInactiveParticipants(sessionId, emit), PARTICIPANT_UPDATE_INTERVAL);
+      this.participantUpdateTimeout = window.setTimeout(() => this.startInactiveRemover(sessionId), PARTICIPANT_UPDATE_INTERVAL);
     });
     /**
      * Keep list of participants up to date. Filter out inactive users etc.
      */
-    _defineProperty(this, "filterInactive", (sessionId, emit) => {
+    _defineProperty(this, "filterInactive", sessionId => {
       const now = Date.now();
       const left = this.participantsState.getParticipants().filter(p => p.sessionId !== sessionId && now - p.lastActive > PARTICIPANT_UPDATE_INTERVAL);
       left.forEach(p => this.participantsState.removeBySessionId(p.sessionId));
       left.length && this.emitPresence({
         left
-      }, emit, 'filtering inactive participants');
+      }, 'filtering inactive participants');
     });
     /**
      * Wrapper function to emit with error handling and analytics
      * @param data Data to emit
      * @param emit Emit function from Provider
      */
-    _defineProperty(this, "emitPresence", (data, emit, errorMessage) => {
+    _defineProperty(this, "emitPresence", (data, errorMessage) => {
       try {
         var _this$analyticsHelper4;
-        emit('presence', data);
+        this.emit('presence', data);
         (_this$analyticsHelper4 = this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendActionEvent(EVENT_ACTION.UPDATE_PARTICIPANTS, EVENT_STATUS.SUCCESS, {
           participants: this.participantsState.size()
         });
@@ -163,9 +172,9 @@ export class ParticipantsService {
      * @param data Data to emit
      * @param emit Emit function from Provider
      */
-    _defineProperty(this, "emitTelepointer", (data, emit, errorMessage) => {
+    _defineProperty(this, "emitTelepointer", (data, errorMessage) => {
       try {
-        emit('telepointer', data);
+        this.emit('telepointer', data);
       } catch (error) {
         var _this$analyticsHelper6;
         // We don't want to throw errors for Presence features as they tend to self-restore
@@ -178,19 +187,68 @@ export class ParticipantsService {
     _defineProperty(this, "clearTimers", () => {
       clearTimeout(this.participantUpdateTimeout);
     });
-    this.participantsState = participantsState;
+    _defineProperty(this, "sendPresence", payload => {
+      try {
+        clearTimeout(this.presenceUpdateTimeout);
+        this.channelBroadcast('participant:updated', payload);
+        this.presenceUpdateTimeout = window.setTimeout(() => this.sendPresence(payload), SEND_PRESENCE_INTERVAL);
+      } catch (error) {
+        var _this$analyticsHelper7;
+        // We don't want to throw errors for Presence features as they tend to self-restore
+        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(error, 'Error while sending presence');
+      }
+    });
+    /**
+     * Called when a participant joins the session.
+     *
+     * We keep track of participants internally, and emit the `presence` event to update
+     * the active avatars in the editor.
+     * This method will be triggered from backend to notify all participants to exchange presence
+     */
+    _defineProperty(this, "onPresenceJoined", payload => {
+      try {
+        logger('Participant joined with session: ', payload.sessionId);
+        // This expose existing users to the newly joined user
+        this.sendPresence(payload);
+      } catch (error) {
+        var _this$analyticsHelper8;
+        // We don't want to throw errors for Presence features as they tend to self-restore
+        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(error, 'Error while joining presence');
+      }
+    });
+    /**
+     * Called when the current user joins the session.
+     *
+     * This will send both a 'presence' event and a 'participant:updated' event.
+     * This updates both the avatars and the participants list.
+     */
+    _defineProperty(this, "onPresence", payload => {
+      try {
+        logger('onPresence userId: ', payload.userId);
+        this.sendPresence(payload);
+        this.sendPresenceJoined();
+      } catch (error) {
+        var _this$analyticsHelper9;
+        // We don't want to throw errors for Presence features as they tend to self-restore
+        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(error, 'Error while receiving presence');
+      }
+    });
     this.analyticsHelper = analyticsHelper;
+    this.participantsState = participantsState;
+    this.emit = emit;
+    this.getUser = getUser;
+    this.channelBroadcast = channelBroadcast;
+    this.sendPresenceJoined = sendPresenceJoined;
   }
   /**
    * Called on receiving steps, emits each step's telepointer
    * @param steps Steps to extract telepointers from
-   * @param emit Provider emit function
    */
-  emitTelepointersFromSteps(steps, emit) {
+  emitTelepointersFromSteps(steps) {
     steps.forEach(step => {
       const event = telepointerFromStep(this.participantsState.getParticipants(), step);
       if (event) {
-        this.emitTelepointer(event, emit, 'emitting telepointers from steps');
+        this.emitTelepointer(event, 'emitting telepointers from steps');
       }
     });
   }

package/dist/es2019/provider/index.js

@@ -4,14 +4,13 @@ import { Channel } from '../channel';
 import { createLogger } from '../helpers/utils';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import { telepointerCallback } from '../participants/telepointers-helper';
-import { ParticipantsService } from '../participants/participants-service';
 import { DestroyError, GetCurrentStateError, GetFinalAcknowledgedStateError, ProviderInitialisationError, SendTransactionError, SetEditorWidthError, SetMetadataError, SetTitleError, NCS_ERROR_CODE } from '../errors/error-types';
 import { MetadataService } from '../metadata/metadata-service';
 import { DocumentService } from '../document/document-service';
+import { NamespaceService } from '../namespace/namespace-service';
+import { ParticipantsService } from '../participants/participants-service';
 import { errorCodeMapper } from '../errors/error-code-mapper';
 const logger = createLogger('Provider', 'black');
-const SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
-
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
 export const MAX_STEP_REJECTED_ERROR = 15;
@@ -20,9 +19,24 @@ export class Provider extends Emitter {
     super();
     _defineProperty(this, "isChannelInitialized", false);
     _defineProperty(this, "isProviderInitialized", false);
-    // To keep track of the namespace event changes from the server.
-    _defineProperty(this, "isNamespaceLocked", false);
-    _defineProperty(this, "emitCallback", (evt, data) => this.emit(evt, data));
+    // isPreinitializating acts as a feature flag to determine when the provider has been initialized early
+    // and also contains the initial draft
+    _defineProperty(this, "isPreinitializing", false);
+    /**
+     * Wrapper for this.emit, it binds scope for callbacks and waits for initialising of the editor before emitting events.
+     * Waiting for the collab provider to become connected to the editor ensures the editor doesn't miss any events.
+     * @param evt - Event name to emit to subscribers
+     * @param data - Event data to emit to subscribers
+     */
+    _defineProperty(this, "emitCallback", (evt, data) => {
+      // When the provider is initialized early, we want the editor state promise to resolve before emitting events
+      // to ensure that it is ready to listen to the events fired by NCS
+      if (this.isPreinitializing) {
+        this.getStatePromise.then(() => this.emit(evt, data));
+      } else {
+        this.emit(evt, data);
+      }
+    });
     _defineProperty(this, "initializeChannel", () => {
       this.emit('connecting', {
         initial: true
@@ -33,7 +47,7 @@ export class Provider extends Emitter {
         initialized
       }) => {
         this.sessionId = sid;
-        this.emit('connected', {
+        this.emitCallback('connected', {
           sid,
           initial: !initialized
         });
@@ -60,7 +74,7 @@ export class Provider extends Emitter {
         Date.now() - this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
           this.documentService.throttledCatchup();
         }
-        this.startInactiveRemover();
+        this.participantsService.startInactiveRemover(this.sessionId);
         this.disconnectedAt = undefined;
       }).on('init', ({
         doc,
@@ -74,7 +88,8 @@ export class Provider extends Emitter {
           metadata
         });
         this.metadataService.updateMetadata(metadata);
-      }).on('restore', this.documentService.onRestore).on('steps:added', this.documentService.onStepsAdded).on('metadata:changed', this.metadataService.onMetadataChanged).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('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled).on('status', this.onNamespaceStatusChanged.bind(this)).connect(shouldInitialize);
+        this.isProviderInitialized = true;
+      }).on('restore', this.documentService.onRestore).on('steps:added', this.documentService.onStepsAdded).on('metadata:changed', this.metadataService.onMetadataChanged).on('participant:telepointer', payload => this.participantsService.onParticipantTelepointer(payload, this.sessionId)).on('presence:joined', this.participantsService.onPresenceJoined).on('presence', this.participantsService.onPresence).on('participant:left', this.participantsService.onParticipantLeft).on('participant:updated', this.participantsService.onParticipantUpdated).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled).on('status', this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
     });
     /**
      * @param {InternalError} error The error to handle
@@ -94,83 +109,16 @@ export class Provider extends Emitter {
         if (mappedError) {
           var _this$analyticsHelper2;
           (_this$analyticsHelper2 = this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendErrorEvent(mappedError, 'Error emitted');
-          this.emit('error', mappedError);
+          this.emitCallback('error', mappedError);
         }
       }
     });
-    _defineProperty(this, "sendPresence", () => {
-      try {
-        if (this.presenceUpdateTimeout) {
-          clearTimeout(this.presenceUpdateTimeout);
-        }
-        this.channel.broadcast('participant:updated', {
-          sessionId: this.sessionId,
-          userId: this.userId,
-          clientId: this.clientId
-        });
-        this.presenceUpdateTimeout = window.setTimeout(() => this.sendPresence(), SEND_PRESENCE_INTERVAL);
-      } catch (error) {
-        var _this$analyticsHelper3;
-        // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error while sending presence');
-      }
-    });
-    /**
-     * Called when a participant joins the session.
-     *
-     * We keep track of participants internally in this class, and emit the `presence` event to update
-     * the active avatars in the editor.
-     * This method will be triggered from backend to notify all participants to exchange presence
-     */
-    _defineProperty(this, "onPresenceJoined", ({
-      sessionId
-    }) => {
-      try {
-        logger('Participant joined with session: ', sessionId);
-        // This expose existing users to the newly joined user
-        this.sendPresence();
-      } catch (error) {
-        var _this$analyticsHelper4;
-        // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper4 = this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(error, 'Error while joining presence');
-      }
-    });
-    _defineProperty(this, "onPresence", ({
-      userId
-    }) => {
-      try {
-        logger('onPresence userId: ', userId);
-        this.userId = userId;
-        this.sendPresence();
-        this.channel.sendPresenceJoined();
-      } catch (error) {
-        var _this$analyticsHelper5;
-        // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(error, 'Error while receiving presence');
-      }
-    });
-    /**
-     * Called when a participant leaves the session.
-     *
-     * We emit the `presence` event to update the active avatars in the editor.
-     */
-    _defineProperty(this, "onParticipantLeft", data => this.participantsService.participantLeft(data, this.emitCallback));
-    _defineProperty(this, "startInactiveRemover", () => this.participantsService.removeInactiveParticipants(this.sessionId, this.emitCallback));
-    /**
-     * Called when we receive an update event from another participant.
-     */
-    _defineProperty(this, "onParticipantUpdated", data => this.participantsService.updateParticipant(data, this.config.getUser, this.emitCallback));
-    /**
-     * Called when we receive a telepointer update from another
-     * participant.
-     */
-    _defineProperty(this, "onParticipantTelepointer", data => this.participantsService.participantTelepointer(data, this.sessionId, this.config.getUser, this.emitCallback));
     // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
     _defineProperty(this, "onDisconnected", ({
       reason
     }) => {
       this.disconnectedAt = Date.now();
-      this.participantsService.disconnect(reason, this.sessionId, this.emitCallback);
+      this.participantsService.disconnect(reason, this.sessionId);
     });
     /**
      * Returns the documents metadata
@@ -187,8 +135,8 @@ export class Provider extends Emitter {
       try {
         return this.documentService.getCurrentState();
       } catch (error) {
-        var _this$analyticsHelper6;
-        (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(error, 'Error while returning ADF version of current draft document');
+        var _this$analyticsHelper3;
+        (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error while returning ADF version of current draft document');
         throw new GetCurrentStateError('Error while returning the current state of the draft document', error); // Reject the promise so the consumer can react to it failing
       }
     });
@@ -201,46 +149,14 @@ export class Provider extends Emitter {
       try {
         return this.documentService.getFinalAcknowledgedState();
       } catch (error) {
-        var _this$analyticsHelper7;
-        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
+        var _this$analyticsHelper4;
+        (_this$analyticsHelper4 = this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
         throw new GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', error); // Reject the promise so the consumer can react to it failing
       }
     });
     _defineProperty(this, "getUnconfirmedSteps", () => {
       return this.documentService.getUnconfirmedSteps();
     });
-    /**
-     * ESS-2916 namespace status event- lock/unlock
-     */
-    _defineProperty(this, "onNamespaceStatusChanged", async data => {
-      const {
-        isLocked,
-        waitTimeInMs,
-        timestamp
-      } = data;
-      const start = Date.now();
-      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
-        setTimeout(() => {
-          logger(`The namespace lock has expired`, {
-            waitTime: Date.now() - start,
-            timestamp
-          });
-          this.isNamespaceLocked = false;
-        }, waitTimeInMs);
-        return;
-      }
-      this.isNamespaceLocked = false;
-      logger(`The page lock has expired`);
-    });
     /**
      * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
      */
@@ -254,9 +170,14 @@ export class Provider extends Emitter {
     this.isChannelInitialized = false;
     this.initialDraft = this.config.initialDraft;
     this.isProviderInitialized = false;
-    this.participantsService = new ParticipantsService(this.analyticsHelper);
+    this.isPreinitializing = false;
+    this.participantsService = new ParticipantsService(this.analyticsHelper, undefined, this.emitCallback, this.config.getUser, this.channel.broadcast, this.channel.sendPresenceJoined);
     this.metadataService = new MetadataService(this.emitCallback, this.channel.sendMetadata);
     this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService);
+    this.getStatePromise = new Promise(resolve => {
+      this.getStatePromiseResolve = resolve;
+    });
+    this.namespaceService = new NamespaceService();
   }
   /**
    * Initialisation logic, called by Jira with a dummy getState function, deprecated in favour of the setup method which allows more configuration
@@ -271,10 +192,15 @@ export class Provider extends Emitter {
   }
 
   /**
-   * Initialisation logic, called by the editor in the collab-edit plugin
-   * @param {Object} parameters ...
-   * @param {Function} parameters.getState Function that returns the editor state, used to retrieve collab-edit properties and to interact with prosemirror-collab
-   * @param {SyncUpErrorFunction} parameters.onSyncUpError (Optional) Function that gets called when the sync of steps fails after retrying 30 times, used by Editor to log to analytics
+   * Initialisation logic, called by the editor in the collab-edit plugin.
+   *
+   * When getState is nullish and a initialDraft is provided the collab provider is in a state of pre-initialization,
+   * the provider starts to enable the connection to NCS, but the provider will not emit any events until this function
+   * is called again with a getState function, indicating that the editor is loaded and ready to receive the emits.
+   *
+   * @param {Object} options ...
+   * @param {Function} options.getState Function that returns the editor state, used to retrieve collab-edit properties and to interact with prosemirror-collab
+   * @param {SyncUpErrorFunction} options.onSyncUpError (Optional) Function that gets called when the sync of steps fails after retrying 30 times, used by Editor to log to analytics
    * @throws {ProviderInitialisationError} Something went wrong during provider initialisation
    */
   setup({
@@ -283,23 +209,34 @@ export class Provider extends Emitter {
   }) {
     this.checkForCookies();
     try {
-      const collabPlugin = getState().plugins.find(p => p.key === 'collab$');
-      if (collabPlugin === undefined) {
-        throw new ProviderInitialisationError('Collab provider attempted to initialise, but Editor state is missing collab plugin');
+      // if setup is called with no state and the initial draft is already provided
+      // set a flag to mark early provider setup
+      if (!getState && this.initialDraft) {
+        this.isPreinitializing = true;
+      }
+      if (getState) {
+        // if provider has already been initialized earlier, resolve the state once it is available
+        if (this.isPreinitializing) {
+          this.getStatePromiseResolve();
+        }
+        const collabPlugin = getState().plugins.find(p => p.key === 'collab$');
+        if (collabPlugin === undefined) {
+          throw new ProviderInitialisationError('Collab provider attempted to initialise, but Editor state is missing collab plugin');
+        }
+        this.clientId = collabPlugin.spec.config.clientID;
+        this.documentService.setup({
+          getState,
+          onSyncUpError,
+          clientId: this.clientId
+        });
       }
-      this.clientId = collabPlugin.spec.config.clientID;
-      this.documentService.setup({
-        getState,
-        onSyncUpError,
-        clientId: this.clientId
-      });
       if (!this.isChannelInitialized) {
         this.initializeChannel();
         this.isChannelInitialized = true;
       }
     } catch (initError) {
-      var _this$analyticsHelper8;
-      (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(initError, 'Error while initialising the provider');
+      var _this$analyticsHelper5;
+      (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(initError, 'Error while initialising the provider');
       // Throw error so consumers are aware the initialisation failed when initialising themselves
       throw new ProviderInitialisationError('Provider initialisation error', initError);
     }
@@ -307,9 +244,9 @@ export class Provider extends Emitter {
   }
   checkForCookies() {
     if (!global.navigator.cookieEnabled) {
-      var _this$analyticsHelper9;
+      var _this$analyticsHelper6;
       const initError = new ProviderInitialisationError('Cookies are not enabled. Please enable cookies to use collaborative editing.');
-      (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
+      (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
       throw new ProviderInitialisationError('Provider initialisation error - cookies disabled', initError);
     }
   }
@@ -324,14 +261,14 @@ export class Provider extends Emitter {
   send(_tr, _oldState, newState) {
     try {
       // Don't send steps while the document is locked (eg. when restoring the document)
-      if (this.isNamespaceLocked) {
+      if (this.namespaceService.getIsNamespaceLocked()) {
         logger('The document is temporary locked');
         return;
       }
       this.documentService.send(_tr, _oldState, newState);
     } catch (error) {
-      var _this$analyticsHelper10;
-      (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while sending steps for a transaction');
+      var _this$analyticsHelper7;
+      (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(error, 'Error while sending steps for a transaction');
       throw new SendTransactionError('Error while sending steps for a transaction', error);
     }
   }
@@ -356,9 +293,9 @@ export class Provider extends Emitter {
         this.channel.broadcast('participant:telepointer', payload, callback);
       }
     } catch (error) {
-      var _this$analyticsHelper11;
+      var _this$analyticsHelper8;
       // We don't want to throw errors for Presence features as they tend to self-restore
-      (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while sending message - telepointer');
+      (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(error, 'Error while sending message - telepointer');
     }
   }
   /**
@@ -390,8 +327,8 @@ export class Provider extends Emitter {
       super.unsubscribeAll();
       this.channel.disconnect();
     } catch (error) {
-      var _this$analyticsHelper12;
-      (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while shutting down the collab provider');
+      var _this$analyticsHelper9;
+      (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(error, 'Error while shutting down the collab provider');
       throw new DestroyError('Error while shutting down the collab provider', error);
     }
     this.clearTimers();
@@ -409,8 +346,8 @@ export class Provider extends Emitter {
     try {
       this.metadataService.setTitle(title, broadcast);
     } catch (error) {
-      var _this$analyticsHelper13;
-      (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting title');
+      var _this$analyticsHelper10;
+      (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while setting title');
       throw new SetTitleError('Error while setting title', error);
     }
   }
@@ -426,8 +363,8 @@ export class Provider extends Emitter {
     try {
       this.metadataService.setEditorWidth(editorWidth, broadcast);
     } catch (error) {
-      var _this$analyticsHelper14;
-      (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendErrorEvent(error, 'Error while setting editor width');
+      var _this$analyticsHelper11;
+      (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while setting editor width');
       throw new SetEditorWidthError('Error while setting editor width', error);
     }
   }
@@ -441,8 +378,8 @@ export class Provider extends Emitter {
     try {
       this.metadataService.setMetadata(metadata);
     } catch (error) {
-      var _this$analyticsHelper15;
-      (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendErrorEvent(error, 'Error while setting metadata');
+      var _this$analyticsHelper12;
+      (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while setting metadata');
       throw new SetMetadataError('Error while setting metadata', error);
     }
   }

package/dist/es2019/version-wrapper.js

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

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "8.8.2",
+	"version": "8.9.0",
 	"sideEffects": false
 }