@atlaskit/collab-provider 9.3.1 → 9.5.0

package/dist/es2019/analytics/analytics-helper.js

@@ -1,6 +1,7 @@
 import { EVENT_ACTION } from '../helpers/const';
 import { name as packageName, version as packageVersion } from '../version-wrapper';
 import { network } from '../connectivity/singleton';
+import { CustomError } from '../errors/error-types';
 const EVENT_SUBJECT = 'collab';
 var COLLAB_SERVICE = /*#__PURE__*/function (COLLAB_SERVICE) {
   COLLAB_SERVICE["NCS"] = "ncs";
@@ -59,12 +60,17 @@ export default class AnalyticsHelper {
     this.getAnalyticsClient = getAnalyticsClient;
   }
   sendErrorEvent(error, errorMessage) {
+    let errorExtraAttributes = {};
+    if (error instanceof CustomError) {
+      errorExtraAttributes = error.getExtraErrorEventAttributes() || {};
+    }
     const errorAnalyticsEvent = {
       eventAction: EVENT_ACTION.ERROR,
       attributes: {
         documentAri: this.documentAri,
         errorMessage,
-        errorName: error instanceof Error ? error.name : undefined
+        errorName: error instanceof Error ? error.name : undefined,
+        ...errorExtraAttributes
       },
       nonPrivacySafeAttributes: {
         error

package/dist/es2019/channel.js

@@ -295,14 +295,15 @@ export class Channel extends Emitter {
       cacheToken
     } = this.config;
     let auth;
-    const authData = {
-      // The initialized status. If false, BE will send document, otherwise not.
-      initialized: this.initialized,
-      // ESS-1009 Allow to opt-in into 404 response
-      need404: this.config.need404
-    };
     if (permissionTokenRefresh) {
       auth = async cb => {
+        // Rebuild authData to ensure values are current
+        const authData = {
+          // The initialized status. If false, BE will send document, otherwise not.
+          initialized: this.initialized,
+          // ESS-1009 Allow to opt-in into 404 response
+          need404: this.config.need404
+        };
         // use the cached token if caching in enabled and token valid
         if (cacheToken && this.token) {
           authData.token = this.token;
@@ -340,7 +341,12 @@ export class Channel extends Emitter {
         }
       };
     } else {
-      auth = authData;
+      auth = {
+        // The initialized status. If false, BE will send document, otherwise not.
+        initialized: this.initialized,
+        // ESS-1009 Allow to opt-in into 404 response
+        need404: this.config.need404
+      };
     }
     this.socket = createSocket(`${url}/session/${documentAri}`, auth, this.config.productInfo);
 

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

@@ -9,7 +9,7 @@ import { JSONTransformer } from '@atlaskit/editor-json-transformer';
 import { MAX_STEP_REJECTED_ERROR } from '../provider';
 import { catchup } from './catchup';
 import { StepQueueState } from './step-queue-state';
-import { INTERNAL_ERROR_CODE } from '../errors/error-types';
+import { INTERNAL_ERROR_CODE, UpdateDocumentError } from '../errors/error-types';
 const CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
 const noop = () => {};
@@ -29,8 +29,9 @@ export class DocumentService {
    * @param onErrorHandled - Callback to handle
    * @param metadataService
    * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
+   * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
-  constructor(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, failedStepsBeforeCatchupOnPublish = MAX_STEP_REJECTED_ERROR) {
+  constructor(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, failedStepsBeforeCatchupOnPublish = MAX_STEP_REJECTED_ERROR, enableErrorOnFailedDocumentApply = false) {
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
     _defineProperty(this, "aggressiveCatchup", false);
@@ -275,6 +276,50 @@ export class DocumentService {
           reserveCursor
         } : {})
       });
+      const updatedVersion = this.getCurrentPmVersion();
+      if (this.getCurrentPmVersion() !== version) {
+        var _doc$content, _this$analyticsHelper17;
+        const isDocContentValid = this.validatePMJSONDocument(doc);
+        const error = new UpdateDocumentError('Failed to update the document', {
+          newVersion: version,
+          editorVersion: updatedVersion,
+          isDocTruthy: !!doc,
+          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$analyticsHelper17 = this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.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',
+            data: {
+              code: INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR,
+              meta: {
+                newVersion: version,
+                editorVersion: updatedVersion
+              },
+              status: 500
+            }
+          });
+          throw error;
+        }
+        // Otherwise just fail silently for now
+      }
+    });
+    _defineProperty(this, "validatePMJSONDocument", doc => {
+      try {
+        const state = this.getState();
+        const content = (doc.content || []).map(child => state.schema.nodeFromJSON(child));
+        return content.every(node => {
+          try {
+            node.check(); // this will throw an error if the node is invalid
+          } catch (error) {
+            return false;
+          }
+          return true;
+        });
+      } catch (e) {
+        return false;
+      }
     });
     /**
      * Commit the unconfirmed local steps to the back-end service
@@ -284,7 +329,7 @@ export class DocumentService {
       const unconfirmedSteps = this.getUnconfirmedSteps();
       try {
         if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
-          var _this$analyticsHelper18;
+          var _this$analyticsHelper19;
           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.
@@ -305,7 +350,7 @@ export class DocumentService {
               isLastTrConfirmed = true;
             }
             if (!isLastTrConfirmed && count++ >= ACK_MAX_TRY) {
-              var _this$getUnconfirmedS, _this$analyticsHelper17;
+              var _this$getUnconfirmedS, _this$analyticsHelper18;
               if (this.onSyncUpError) {
                 const state = this.getState();
                 this.onSyncUpError({
@@ -317,42 +362,42 @@ export class DocumentService {
                 });
               }
               const unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(step => getStepUGCFreeDetails(step));
-              (_this$analyticsHelper17 = this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendErrorEvent({
+              (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendErrorEvent({
                 unconfirmedStepsInfo: unconfirmedStepsInfoUGCRemoved
               }, "Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached");
               throw new Error("Can't sync up with Collab Service");
             }
           }
           const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-          (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
+          (_this$analyticsHelper19 = this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.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$analyticsHelper19, _this$analyticsHelper20;
+        var _this$analyticsHelper20, _this$analyticsHelper21;
         const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-        (_this$analyticsHelper19 = this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
+        (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.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$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(error, 'Error while committing unconfirmed steps');
+        (_this$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendErrorEvent(error, 'Error while committing unconfirmed steps');
         throw error;
       }
     });
     _defineProperty(this, "onStepRejectedError", () => {
-      var _this$analyticsHelper21;
+      var _this$analyticsHelper22;
       this.stepRejectCounter++;
       logger(`Steps rejected (tries=${this.stepRejectCounter})`);
-      (_this$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
+      (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
         count: this.stepRejectCounter
       });
       let maxRetries = this.aggressiveCatchup ? this.failedStepsBeforeCatchupOnPublish : MAX_STEP_REJECTED_ERROR;
       if (this.stepRejectCounter >= maxRetries) {
-        var _this$analyticsHelper22;
+        var _this$analyticsHelper23;
         logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
-        (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
+        (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
         this.throttledCatchup();
       } else {
         // If committing steps failed try again automatically in 1s
@@ -371,6 +416,7 @@ export class DocumentService {
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
     this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
+    this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.stepQueue = new StepQueueState();
   }
   processQueue() {
@@ -416,9 +462,9 @@ export class DocumentService {
           setTimeout(() => this.sendStepsFromCurrentState(), 100);
         }
       } catch (error) {
-        var _this$analyticsHelper23;
+        var _this$analyticsHelper24;
         logger(`Processing steps failed with error: ${error}. Triggering catch up call.`);
-        (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendErrorEvent(error, 'Error while processing steps');
+        (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.sendErrorEvent(error, 'Error while processing steps');
         this.throttledCatchup();
       }
     }

package/dist/es2019/errors/error-code-mapper.js

@@ -67,6 +67,13 @@ export const errorCodeMapper = error => {
         recoverable: false,
         status: 500
       };
+    case INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR:
+      return {
+        code: PROVIDER_ERROR_CODE.DOCUMENT_UPDATE_ERROR,
+        message: 'The provider failed to apply changes to the editor',
+        recoverable: false,
+        status: 500
+      };
     case INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE:
       return {
         code: PROVIDER_ERROR_CODE.NETWORK_ISSUE,

package/dist/es2019/errors/error-types.js

@@ -1,5 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 // Internal error codes (generated by collab provider)
+
 export let INTERNAL_ERROR_CODE = /*#__PURE__*/function (INTERNAL_ERROR_CODE) {
   INTERNAL_ERROR_CODE["TOKEN_PERMISSION_ERROR"] = "TOKEN_PERMISSION_ERROR";
   INTERNAL_ERROR_CODE["RECONNECTION_NETWORK_ISSUE"] = "RECONNECTION_NETWORK_ISSUE";
@@ -9,8 +10,10 @@ export let INTERNAL_ERROR_CODE = /*#__PURE__*/function (INTERNAL_ERROR_CODE) {
   INTERNAL_ERROR_CODE["CATCHUP_FAILED"] = "CATCHUP_FAILED";
   INTERNAL_ERROR_CODE["DOCUMENT_RESTORE_ERROR"] = "DOCUMENT_RESTORE_ERROR";
   INTERNAL_ERROR_CODE["ADD_STEPS_ERROR"] = "ADD_STEPS_ERROR";
+  INTERNAL_ERROR_CODE["DOCUMENT_UPDATE_ERROR"] = "DOCUMENT_UPDATE_ERROR";
   return INTERNAL_ERROR_CODE;
 }({});
+
 // NCS error coded (generated by NCS)
 export let NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
   NCS_ERROR_CODE["HEAD_VERSION_UPDATE_FAILED"] = "HEAD_VERSION_UPDATE_FAILED";
@@ -42,6 +45,10 @@ export let NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
 // - Less common back-end errors
 // Provider Errors
 // Channel Errors
+/**
+ * When we try to apply state updates to the editor, if that fails to apply the user can enter an invalid state where no
+ * changes can be saved to NCS.
+ */
 /**
  * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
  */
@@ -57,6 +64,7 @@ export let PROVIDER_ERROR_CODE = /*#__PURE__*/function (PROVIDER_ERROR_CODE) {
   PROVIDER_ERROR_CODE["NETWORK_ISSUE"] = "NETWORK_ISSUE";
   PROVIDER_ERROR_CODE["INVALID_PROVIDER_CONFIGURATION"] = "INVALID_PROVIDER_CONFIGURATION";
   PROVIDER_ERROR_CODE["INTERNAL_SERVICE_ERROR"] = "INTERNAL_SERVICE_ERROR";
+  PROVIDER_ERROR_CODE["DOCUMENT_UPDATE_ERROR"] = "DOCUMENT_UPDATE_ERROR";
   return PROVIDER_ERROR_CODE;
 }({});
 
@@ -154,12 +162,16 @@ export let PROVIDER_ERROR_CODE = /*#__PURE__*/function (PROVIDER_ERROR_CODE) {
  * A union of all possible provider errors that can be emitted back to the editor.
  */
 // Custom Errors
-class CustomError extends Error {
-  constructor(message, error) {
+export class CustomError extends Error {
+  constructor(message, error, extraEventAttributes) {
     super(message);
+    _defineProperty(this, "getExtraErrorEventAttributes", () => this.extraEventAttributes);
     if (typeof (error === null || error === void 0 ? void 0 : error.message) === 'string') {
       this.message = error.message;
     }
+    if (extraEventAttributes) {
+      this.extraEventAttributes = extraEventAttributes;
+    }
   }
   toJSON() {
     return {
@@ -227,4 +239,10 @@ export class GetFinalAcknowledgedStateError extends CustomError {
     super(...args);
     _defineProperty(this, "name", 'GetFinalAcknowledgedStateError');
   }
+}
+export class UpdateDocumentError extends CustomError {
+  constructor(message, extraAttributes) {
+    super(message, undefined, extraAttributes);
+    _defineProperty(this, "name", 'UpdateDocumentError');
+  }
 }

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

@@ -13,6 +13,7 @@ export const createParticipantFromPayload = async (payload, getUser) => {
   const participant = {
     name: (user === null || user === void 0 ? void 0 : user.name) || '',
     avatar: (user === null || user === void 0 ? void 0 : user.avatar) || '',
+    email: (user === null || user === void 0 ? void 0 : user.email) || '',
     sessionId,
     lastActive: timestamp,
     userId,

package/dist/es2019/provider/index.js

@@ -66,12 +66,19 @@ export class Provider extends Emitter {
               version,
               metadata
             } = this.initialDraft;
-            // Initial document, version, metadata from initial draft
-            this.documentService.updateDocument({
-              doc: document,
-              version,
-              metadata
-            });
+            try {
+              // Initial document, version, metadata from initial draft
+              this.documentService.updateDocument({
+                doc: document,
+                version,
+                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;
@@ -90,13 +97,20 @@ export class Provider extends Emitter {
         metadata
       }) => {
         // Initial document and version
-        this.documentService.updateDocument({
-          doc,
-          version,
-          metadata
-        });
-        this.metadataService.updateMetadata(metadata);
-        this.isProviderInitialized = true;
+        try {
+          this.documentService.updateDocument({
+            doc,
+            version,
+            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();
+        }
       }).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);
     });
     _defineProperty(this, "setUserId", id => {
@@ -120,13 +134,13 @@ export class Provider extends 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$analyticsHelper;
-        (_this$analyticsHelper = this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(error, 'Error handled');
+        var _this$analyticsHelper3;
+        (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error handled');
         const mappedError = errorCodeMapper(error);
         // Temporarily only emit errors to Confluence very intentionally because they will disconnect the collab provider
         if (mappedError) {
-          var _this$analyticsHelper2;
-          (_this$analyticsHelper2 = this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendErrorEvent(mappedError, 'Error emitted');
+          var _this$analyticsHelper4;
+          (_this$analyticsHelper4 = this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(mappedError, 'Error emitted');
           this.emitCallback('error', mappedError);
         }
       }
@@ -153,8 +167,8 @@ export class Provider extends Emitter {
       try {
         return this.documentService.getCurrentState();
       } catch (error) {
-        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');
+        var _this$analyticsHelper5;
+        (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.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
       }
     });
@@ -167,8 +181,8 @@ export class Provider extends Emitter {
       try {
         return await this.documentService.getFinalAcknowledgedState();
       } catch (error) {
-        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');
+        var _this$analyticsHelper6;
+        (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.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
       }
     });
@@ -197,7 +211,7 @@ export class Provider extends Emitter {
     this.isPreinitializing = false;
     this.participantsService = new ParticipantsService(this.analyticsHelper, undefined, this.emitCallback, this.config.getUser, this.channel.broadcast, this.channel.sendPresenceJoined, this.getPresenceData, this.setUserId);
     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.config.failedStepLimitBeforeCatchupOnPublish);
+    this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService, this.config.failedStepLimitBeforeCatchupOnPublish, this.config.enableErrorOnFailedDocumentApply);
     this.getStatePromise = new Promise(resolve => {
       this.getStatePromiseResolve = resolve;
     });
@@ -259,8 +273,8 @@ export class Provider extends Emitter {
         this.isChannelInitialized = true;
       }
     } catch (initError) {
-      var _this$analyticsHelper5;
-      (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(initError, 'Error while initialising the provider');
+      var _this$analyticsHelper7;
+      (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.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);
     }
@@ -268,9 +282,9 @@ export class Provider extends Emitter {
   }
   checkForCookies() {
     if (!global.navigator.cookieEnabled) {
-      var _this$analyticsHelper6;
+      var _this$analyticsHelper8;
       const initError = new ProviderInitialisationError('Cookies are not enabled. Please enable cookies to use collaborative editing.');
-      (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
+      (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
       throw new ProviderInitialisationError('Provider initialisation error - cookies disabled', initError);
     }
   }
@@ -304,8 +318,8 @@ export class Provider extends Emitter {
       }
       this.documentService.send(_tr, _oldState, newState);
     } catch (error) {
-      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');
+      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');
       throw new SendTransactionError('Error while sending steps for a transaction', error);
     }
   }
@@ -330,9 +344,9 @@ export class Provider extends Emitter {
         this.channel.broadcast('participant:telepointer', payload, callback);
       }
     } catch (error) {
-      var _this$analyticsHelper8;
+      var _this$analyticsHelper10;
       // 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 sending message - telepointer');
+      (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while sending message - telepointer');
     }
   }
   /**
@@ -364,8 +378,8 @@ export class Provider extends Emitter {
       super.unsubscribeAll();
       this.channel.disconnect();
     } catch (error) {
-      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');
+      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');
       throw new DestroyError('Error while shutting down the collab provider', error);
     }
     this.clearTimers();
@@ -383,8 +397,8 @@ export class Provider extends Emitter {
     try {
       this.metadataService.setTitle(title, broadcast);
     } catch (error) {
-      var _this$analyticsHelper10;
-      (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while setting title');
+      var _this$analyticsHelper12;
+      (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while setting title');
       throw new SetTitleError('Error while setting title', error);
     }
   }
@@ -400,8 +414,8 @@ export class Provider extends Emitter {
     try {
       this.metadataService.setEditorWidth(editorWidth, broadcast);
     } catch (error) {
-      var _this$analyticsHelper11;
-      (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while setting editor width');
+      var _this$analyticsHelper13;
+      (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting editor width');
       throw new SetEditorWidthError('Error while setting editor width', error);
     }
   }
@@ -415,8 +429,8 @@ export class Provider extends Emitter {
     try {
       this.metadataService.setMetadata(metadata);
     } catch (error) {
-      var _this$analyticsHelper12;
-      (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while setting metadata');
+      var _this$analyticsHelper14;
+      (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.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 = "9.3.1";
+export const version = "9.5.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": "9.3.1",
+	"version": "9.5.0",
 	"sideEffects": false
 }

package/dist/esm/analytics/analytics-helper.js

@@ -8,6 +8,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 import { EVENT_ACTION } from '../helpers/const';
 import { name as packageName, version as packageVersion } from '../version-wrapper';
 import { network } from '../connectivity/singleton';
+import { CustomError } from '../errors/error-types';
 var EVENT_SUBJECT = 'collab';
 var COLLAB_SERVICE = /*#__PURE__*/function (COLLAB_SERVICE) {
   COLLAB_SERVICE["NCS"] = "ncs";
@@ -68,13 +69,17 @@ var AnalyticsHelper = /*#__PURE__*/function () {
   _createClass(AnalyticsHelper, [{
     key: "sendErrorEvent",
     value: function sendErrorEvent(error, errorMessage) {
+      var errorExtraAttributes = {};
+      if (error instanceof CustomError) {
+        errorExtraAttributes = error.getExtraErrorEventAttributes() || {};
+      }
       var errorAnalyticsEvent = {
         eventAction: EVENT_ACTION.ERROR,
-        attributes: {
+        attributes: _objectSpread({
           documentAri: this.documentAri,
           errorMessage: errorMessage,
           errorName: error instanceof Error ? error.name : undefined
-        },
+        }, errorExtraAttributes),
         nonPrivacySafeAttributes: {
           error: error
         }

package/dist/esm/channel.js

@@ -390,32 +390,33 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
         permissionTokenRefresh = _this$config2.permissionTokenRefresh,
         cacheToken = _this$config2.cacheToken;
       var auth;
-      var authData = {
-        // The initialized status. If false, BE will send document, otherwise not.
-        initialized: this.initialized,
-        // ESS-1009 Allow to opt-in into 404 response
-        need404: this.config.need404
-      };
       if (permissionTokenRefresh) {
         auth = /*#__PURE__*/function () {
           var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(cb) {
-            var token, _data, _data$meta, authenticationError;
+            var authData, token, _data, _data$meta, authenticationError;
             return _regeneratorRuntime.wrap(function _callee2$(_context2) {
               while (1) switch (_context2.prev = _context2.next) {
                 case 0:
+                  // Rebuild authData to ensure values are current
+                  authData = {
+                    // The initialized status. If false, BE will send document, otherwise not.
+                    initialized: _this2.initialized,
+                    // ESS-1009 Allow to opt-in into 404 response
+                    need404: _this2.config.need404
+                  }; // use the cached token if caching in enabled and token valid
                   if (!(cacheToken && _this2.token)) {
-                    _context2.next = 5;
+                    _context2.next = 6;
                     break;
                   }
                   authData.token = _this2.token;
                   cb(authData);
-                  _context2.next = 17;
+                  _context2.next = 18;
                   break;
-                case 5:
-                  _context2.prev = 5;
-                  _context2.next = 8;
+                case 6:
+                  _context2.prev = 6;
+                  _context2.next = 9;
                   return permissionTokenRefresh();
-                case 8:
+                case 9:
                   token = _context2.sent;
                   if (token) {
                     // save token locally
@@ -426,11 +427,11 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                     authData.token = undefined;
                   }
                   cb(authData);
-                  _context2.next = 17;
+                  _context2.next = 18;
                   break;
-                case 13:
-                  _context2.prev = 13;
-                  _context2.t0 = _context2["catch"](5);
+                case 14:
+                  _context2.prev = 14;
+                  _context2.t0 = _context2["catch"](6);
                   // Pass the error back to the consumers so they can deal with exceptional cases themselves (eg. no permissions because the page was deleted)
                   authenticationError = {
                     message: 'Insufficient editing permissions',
@@ -446,18 +447,23 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                   };
 
                   _this2.emit('error', authenticationError);
-                case 17:
+                case 18:
                 case "end":
                   return _context2.stop();
               }
-            }, _callee2, null, [[5, 13]]);
+            }, _callee2, null, [[6, 14]]);
           }));
           return function auth(_x2) {
             return _ref3.apply(this, arguments);
           };
         }();
       } else {
-        auth = authData;
+        auth = {
+          // The initialized status. If false, BE will send document, otherwise not.
+          initialized: this.initialized,
+          // ESS-1009 Allow to opt-in into 404 response
+          need404: this.config.need404
+        };
       }
       this.socket = createSocket("".concat(url, "/session/").concat(documentAri), auth, this.config.productInfo);