@atlaskit/collab-provider 9.6.3 → 9.7.0

package/dist/esm/provider/index.js

@@ -45,24 +45,48 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      * @param data - Event data to emit to subscribers
      */
     _defineProperty(_assertThisInitialized(_this), "emitCallback", function (evt, data) {
-      // When the provider is initialized early, we want the editor state promise to resolve before emitting events
+      // When the provider is initialized early, we want to ensure the editor state exists after setup is called before emitting events
       // to ensure that it is ready to listen to the events fired by NCS
       if (_this.isPreinitializing) {
-        _this.getStatePromise.then(function () {
+        _this.onSetupPromise.then(function () {
           return _this.emit(evt, data);
         });
       } else {
         _this.emit(evt, data);
       }
     });
+    /**
+     * Wrapper to update document and metadata.
+     * Catches and logs any errors thrown by document service's updateDocument and updateMetadata methods and destroys the provider in case of errors.
+     * Passing the document, metadata, version (either from the initial draft or from collab service)
+     */
+    _defineProperty(_assertThisInitialized(_this), "updateDocumentAndMetadata", function (_ref) {
+      var doc = _ref.doc,
+        version = _ref.version,
+        metadata = _ref.metadata;
+      try {
+        _this.documentService.updateDocument({
+          doc: doc,
+          version: version,
+          metadata: metadata
+        });
+        _this.metadataService.updateMetadata(metadata);
+        _this.isProviderInitialized = true;
+      } catch (e) {
+        var _this$analyticsHelper;
+        (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(e, 'Failed to update with the init document, destroying provider');
+        // Stop events and connections to step us trying to talk to the backend with an invalid state.
+        _this.destroy();
+      }
+    });
     _defineProperty(_assertThisInitialized(_this), "initializeChannel", function () {
       _this.emit('connecting', {
         initial: true
       });
       var shouldInitialize = Boolean(_this.initialDraft) && !_this.isProviderInitialized;
-      _this.channel.on('connected', function (_ref) {
-        var sid = _ref.sid,
-          initialized = _ref.initialized;
+      _this.channel.on('connected', function (_ref2) {
+        var sid = _ref2.sid,
+          initialized = _ref2.initialized;
         _this.sessionId = sid;
         _this.emitCallback('connected', {
           sid: sid,
@@ -81,22 +105,24 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
               document = _this$initialDraft.document,
               version = _this$initialDraft.version,
               metadata = _this$initialDraft.metadata;
-            try {
-              // Initial document, version, metadata from initial draft
-              _this.documentService.updateDocument({
+            if (_this.isPreinitializing) {
+              // When the provider is initialized early, we wait until setup is called with a defined getState before the document is updated to ensure that the editor state exists
+              // The `isPreinitializing` check is an extra precaution behind a FF - if the state is already resolved, onSetupPromise will resolve immediately
+              _this.onSetupPromise.then(function () {
+                _this.updateDocumentAndMetadata({
+                  doc: document,
+                  version: version,
+                  metadata: metadata
+                });
+              });
+            } else {
+              _this.updateDocumentAndMetadata({
                 doc: document,
                 version: version,
                 metadata: metadata
               });
-            } catch (e) {
-              var _this$analyticsHelper;
-              (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(e, 'Failed to update the document on reconnect, destroying provider');
-              // Stop events and connections to step us trying to talk to the backend with an invalid state.
-              _this.destroy();
             }
-            _this.metadataService.updateMetadata(metadata);
           }
-          _this.isProviderInitialized = true;
         }
         // If already initialized, `connected` means reconnected
         if (initialized && _this.disconnectedAt &&
@@ -106,25 +132,16 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         }
         _this.participantsService.startInactiveRemover(_this.sessionId);
         _this.disconnectedAt = undefined;
-      }).on('init', function (_ref2) {
-        var doc = _ref2.doc,
-          version = _ref2.version,
-          metadata = _ref2.metadata;
+      }).on('init', function (_ref3) {
+        var doc = _ref3.doc,
+          version = _ref3.version,
+          metadata = _ref3.metadata;
         // Initial document and version
-        try {
-          _this.documentService.updateDocument({
-            doc: doc,
-            version: version,
-            metadata: metadata
-          });
-          _this.metadataService.updateMetadata(metadata);
-          _this.isProviderInitialized = true;
-        } catch (e) {
-          var _this$analyticsHelper2;
-          (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendErrorEvent(e, 'Failed to update with the init document, destroying provider');
-          // Stop events and connections to step us trying to talk to the backend with an invalid state.
-          _this.destroy();
-        }
+        _this.updateDocumentAndMetadata({
+          doc: doc,
+          version: version,
+          metadata: metadata
+        });
       }).on('restore', _this.documentService.onRestore).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
         return _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(_assertThisInitialized(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
@@ -150,20 +167,20 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       if (((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) === NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || ((_error$data2 = error.data) === null || _error$data2 === void 0 ? void 0 : _error$data2.code) === NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS) {
         _this.documentService.onStepRejectedError();
       } else {
-        var _this$analyticsHelper3;
-        (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error handled');
+        var _this$analyticsHelper2;
+        (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendErrorEvent(error, 'Error handled');
         var mappedError = errorCodeMapper(error);
         // Temporarily only emit errors to Confluence very intentionally because they will disconnect the collab provider
         if (mappedError) {
-          var _this$analyticsHelper4;
-          (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(mappedError, 'Error emitted');
+          var _this$analyticsHelper3;
+          (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(mappedError, 'Error emitted');
           _this.emitCallback('error', mappedError);
         }
       }
     });
     // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
-    _defineProperty(_assertThisInitialized(_this), "onDisconnected", function (_ref3) {
-      var reason = _ref3.reason;
+    _defineProperty(_assertThisInitialized(_this), "onDisconnected", function (_ref4) {
+      var reason = _ref4.reason;
       _this.disconnectedAt = Date.now();
       _this.participantsService.disconnect(reason, _this.sessionId);
     });
@@ -179,22 +196,25 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      * @throws {GetCurrentStateError} Something went wrong while returning the current state
      */
     _defineProperty(_assertThisInitialized(_this), "getCurrentState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-      var _this$analyticsHelper5;
+      var _this$analyticsHelper4;
       return _regeneratorRuntime.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
             _context.prev = 0;
-            return _context.abrupt("return", _this.documentService.getCurrentState());
-          case 4:
-            _context.prev = 4;
+            _context.next = 3;
+            return _this.documentService.getCurrentState();
+          case 3:
+            return _context.abrupt("return", _context.sent);
+          case 6:
+            _context.prev = 6;
             _context.t0 = _context["catch"](0);
-            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
+            (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
             throw new GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
-          case 8:
+          case 10:
           case "end":
             return _context.stop();
         }
-      }, _callee, null, [[0, 4]]);
+      }, _callee, null, [[0, 6]]);
     })));
     /**
      * Return the final acknowledged (by NCS) ADF version of the current draft document, together with it's title and the current step version.
@@ -202,7 +222,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
     _defineProperty(_assertThisInitialized(_this), "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
-      var _this$analyticsHelper6;
+      var _this$analyticsHelper5;
       return _regeneratorRuntime.wrap(function _callee2$(_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
@@ -214,7 +234,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           case 6:
             _context2.prev = 6;
             _context2.t0 = _context2["catch"](0);
-            (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
+            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
             throw new GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
           case 10:
           case "end":
@@ -250,8 +270,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this.documentService = new DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
     }, _this.onErrorHandled, _this.metadataService, _this.config.failedStepLimitBeforeCatchupOnPublish, _this.config.enableErrorOnFailedDocumentApply);
-    _this.getStatePromise = new Promise(function (resolve) {
-      _this.getStatePromiseResolve = resolve;
+    _this.onSetupPromise = new Promise(function (resolve) {
+      _this.resolveOnSetupPromise = resolve;
     });
     _this.namespaceService = new NamespaceService();
     return _this;
@@ -285,21 +305,17 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      */
   }, {
     key: "setup",
-    value: function setup(_ref6) {
-      var getState = _ref6.getState,
-        onSyncUpError = _ref6.onSyncUpError;
+    value: function setup(_ref7) {
+      var getState = _ref7.getState,
+        onSyncUpError = _ref7.onSyncUpError;
       this.checkForCookies();
       try {
-        // if setup is called with no state and the initial draft is already provided
+        // if setup is called with no getState 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();
-          }
           var collabPlugin = getState().plugins.find(function (p) {
             return p.key === 'collab$';
           });
@@ -312,14 +328,20 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
             onSyncUpError: onSyncUpError,
             clientId: this.clientId
           });
+
+          // if provider has already been initialized earlier, resolve the setup promise once setup has been called with
+          // a defined getState (ie editor state is ready) AND after documentService sets the editor state
+          if (this.isPreinitializing) {
+            this.resolveOnSetupPromise();
+          }
         }
         if (!this.isChannelInitialized) {
           this.initializeChannel();
           this.isChannelInitialized = true;
         }
       } catch (initError) {
-        var _this$analyticsHelper7;
-        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(initError, 'Error while initialising the provider');
+        var _this$analyticsHelper6;
+        (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.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);
       }
@@ -329,9 +351,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     key: "checkForCookies",
     value: function checkForCookies() {
       if (!global.navigator.cookieEnabled) {
-        var _this$analyticsHelper8;
+        var _this$analyticsHelper7;
         var initError = new ProviderInitialisationError('Cookies are not enabled. Please enable cookies to use collaborative editing.');
-        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
+        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
         throw new ProviderInitialisationError('Provider initialisation error - cookies disabled', initError);
       }
     }
@@ -369,8 +391,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         }
         this.documentService.send(_tr, _oldState, newState);
       } catch (error) {
-        var _this$analyticsHelper9;
-        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(error, 'Error while sending steps for a transaction');
+        var _this$analyticsHelper8;
+        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(error, 'Error while sending steps for a transaction');
         throw new SendTransactionError('Error while sending steps for a transaction', error);
       }
     }
@@ -398,9 +420,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           this.channel.broadcast('participant:telepointer', payload, callback);
         }
       } catch (error) {
-        var _this$analyticsHelper10;
+        var _this$analyticsHelper9;
         // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while sending message - telepointer');
+        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(error, 'Error while sending message - telepointer');
       }
     }
   }, {
@@ -439,8 +461,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         _get(_getPrototypeOf(Provider.prototype), "unsubscribeAll", this).call(this);
         this.channel.disconnect();
       } catch (error) {
-        var _this$analyticsHelper11;
-        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while shutting down the collab provider');
+        var _this$analyticsHelper10;
+        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while shutting down the collab provider');
         throw new DestroyError('Error while shutting down the collab provider', error);
       }
       this.clearTimers();
@@ -460,8 +482,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setTitle(title, broadcast);
       } catch (error) {
-        var _this$analyticsHelper12;
-        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while setting title');
+        var _this$analyticsHelper11;
+        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while setting title');
         throw new SetTitleError('Error while setting title', error);
       }
     }
@@ -479,8 +501,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setEditorWidth(editorWidth, broadcast);
       } catch (error) {
-        var _this$analyticsHelper13;
-        (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting editor width');
+        var _this$analyticsHelper12;
+        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while setting editor width');
         throw new SetEditorWidthError('Error while setting editor width', error);
       }
     }
@@ -496,8 +518,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setMetadata(metadata);
       } catch (error) {
-        var _this$analyticsHelper14;
-        (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendErrorEvent(error, 'Error while setting metadata');
+        var _this$analyticsHelper13;
+        (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting metadata');
         throw new SetMetadataError('Error while setting metadata', error);
       }
     }

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "9.6.3";
+export var version = "9.7.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/version.json

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

package/dist/types/helpers/const.d.ts

@@ -139,6 +139,7 @@ type DocumentInitSuccessAnalyticsEvent = {
         eventStatus: EVENT_STATUS.SUCCESS;
         latency?: number;
         resetReason?: string;
+        hasTitle: boolean;
     };
 };
 type UpdateParticipantsSuccessAnalyticsEvent = {

package/dist/types/provider/index.d.ts

@@ -29,8 +29,14 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
      * @param data - Event data to emit to subscribers
      */
     private readonly emitCallback;
-    private getStatePromise;
-    getStatePromiseResolve: (value: void | PromiseLike<void>) => void;
+    private onSetupPromise;
+    resolveOnSetupPromise: (value: void | PromiseLike<void>) => void;
+    /**
+     * Wrapper to update document and metadata.
+     * Catches and logs any errors thrown by document service's updateDocument and updateMetadata methods and destroys the provider in case of errors.
+     * Passing the document, metadata, version (either from the initial draft or from collab service)
+     */
+    private readonly updateDocumentAndMetadata;
     constructor(config: Config);
     private initializeChannel;
     private setUserId;

package/dist/types-ts4.5/helpers/const.d.ts

@@ -139,6 +139,7 @@ type DocumentInitSuccessAnalyticsEvent = {
         eventStatus: EVENT_STATUS.SUCCESS;
         latency?: number;
         resetReason?: string;
+        hasTitle: boolean;
     };
 };
 type UpdateParticipantsSuccessAnalyticsEvent = {

package/dist/types-ts4.5/provider/index.d.ts

@@ -29,8 +29,14 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
      * @param data - Event data to emit to subscribers
      */
     private readonly emitCallback;
-    private getStatePromise;
-    getStatePromiseResolve: (value: void | PromiseLike<void>) => void;
+    private onSetupPromise;
+    resolveOnSetupPromise: (value: void | PromiseLike<void>) => void;
+    /**
+     * Wrapper to update document and metadata.
+     * Catches and logs any errors thrown by document service's updateDocument and updateMetadata methods and destroys the provider in case of errors.
+     * Passing the document, metadata, version (either from the initial draft or from collab service)
+     */
+    private readonly updateDocumentAndMetadata;
     constructor(config: Config);
     private initializeChannel;
     private setUserId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.6.3",
+  "version": "9.7.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -487,11 +487,11 @@ export class Provider extends Emitter<CollabEvents> implements BaseEvents {
   // (undocumented)
   getParticipants: () => ProviderParticipant[];
   // (undocumented)
-  getStatePromiseResolve: (value: PromiseLike<void> | void) => void;
-  // (undocumented)
   getUnconfirmedSteps: () => readonly Step[] | undefined;
   // @deprecated
   initialize(getState: () => EditorState): this;
+  // (undocumented)
+  resolveOnSetupPromise: (value: PromiseLike<void> | void) => void;
   send(
     _tr: Transaction | null,
     _oldState: EditorState | null,