@atlaskit/collab-provider 9.3.0 → 9.4.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/collab-provider
 
+## 9.4.0
+
+### Minor Changes
+
+- [`606d4ad65fc`](https://bitbucket.org/atlassian/atlassian-frontend/commits/606d4ad65fc) - ESS-3682 Add detection that it the editor failed to update, emit analytics as well added an option to
+  enable emitting fatal errors.
+
+### Patch Changes
+
+- [`5eb1273509c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5eb1273509c) - ESS-3728: Fix initialized always set to false when reconnecting.
+
+## 9.3.1
+
+### Patch Changes
+
+- [`a9350cf3831`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a9350cf3831) - Check existence of window and document variable for confluence SSR to work
+
 ## 9.3.0
 
 ### Minor Changes

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

@@ -13,6 +13,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _const = require("../helpers/const");
 var _versionWrapper = require("../version-wrapper");
 var _singleton = require("../connectivity/singleton");
+var _errorTypes = require("../errors/error-types");
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var EVENT_SUBJECT = 'collab';
@@ -75,13 +76,17 @@ var AnalyticsHelper = /*#__PURE__*/function () {
   (0, _createClass2.default)(AnalyticsHelper, [{
     key: "sendErrorEvent",
     value: function sendErrorEvent(error, errorMessage) {
+      var errorExtraAttributes = {};
+      if (error instanceof _errorTypes.CustomError) {
+        errorExtraAttributes = error.getExtraErrorEventAttributes() || {};
+      }
       var errorAnalyticsEvent = {
         eventAction: _const.EVENT_ACTION.ERROR,
-        attributes: {
+        attributes: _objectSpread({
           documentAri: this.documentAri,
           errorMessage: errorMessage,
           errorName: error instanceof Error ? error.name : undefined
-        },
+        }, errorExtraAttributes),
         nonPrivacySafeAttributes: {
           error: error
         }

package/dist/cjs/channel.js

@@ -397,32 +397,33 @@ 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 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(cb) {
-            var token, _data, _data$meta, authenticationError;
+            var authData, token, _data, _data$meta, authenticationError;
             return _regenerator.default.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
@@ -433,11 +434,11 @@ 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',
@@ -453,18 +454,23 @@ 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);
 

package/dist/cjs/connectivity/network.js

@@ -33,8 +33,10 @@ var Network = /*#__PURE__*/function () {
     if (props !== null && props !== void 0 && props.onlineCallback) {
       this.onlineCallback = props.onlineCallback;
     }
-    window.addEventListener('offline', this.offlineHandler);
-    window.addEventListener('online', this.onlineHandler);
+    if (typeof window !== 'undefined') {
+      window.addEventListener('offline', this.offlineHandler);
+      window.addEventListener('online', this.onlineHandler);
+    }
   }
   (0, _createClass2.default)(Network, [{
     key: "getStatus",

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

@@ -42,10 +42,12 @@ var DocumentService = /*#__PURE__*/function () {
    * @param onErrorHandled - Callback to handle
    * @param metadataService
    * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
+   * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
   function DocumentService(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
     var failedStepsBeforeCatchupOnPublish = arguments.length > 8 && arguments[8] !== undefined ? arguments[8] : _provider.MAX_STEP_REJECTED_ERROR;
+    var enableErrorOnFailedDocumentApply = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : false;
     (0, _classCallCheck2.default)(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     (0, _defineProperty2.default)(this, "stepRejectCounter", 0);
@@ -328,13 +330,59 @@ var DocumentService = /*#__PURE__*/function () {
       }, reserveCursor ? {
         reserveCursor: reserveCursor
       } : {}));
+      var updatedVersion = _this.getCurrentPmVersion();
+      if (_this.getCurrentPmVersion() !== version) {
+        var _doc$content, _this$analyticsHelper17;
+        var isDocContentValid = _this.validatePMJSONDocument(doc);
+        var _error = new _errorTypes.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: 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: _errorTypes.INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR,
+              meta: {
+                newVersion: version,
+                editorVersion: updatedVersion
+              },
+              status: 500
+            }
+          });
+          throw _error;
+        }
+        // Otherwise just fail silently for now
+      }
+    });
+    (0, _defineProperty2.default)(this, "validatePMJSONDocument", function (doc) {
+      try {
+        var state = _this.getState();
+        var content = (doc.content || []).map(function (child) {
+          return state.schema.nodeFromJSON(child);
+        });
+        return content.every(function (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
      * @throws {Error} Couldn't sync the steps after retrying 30 times
      */
     (0, _defineProperty2.default)(this, "commitUnconfirmedSteps", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
-      var unconfirmedSteps, _this$analyticsHelper18, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, _this$analyticsHelper17, state, unconfirmedStepsInfoUGCRemoved, measure, _this$analyticsHelper19, _this$analyticsHelper20, _measure3;
+      var unconfirmedSteps, _this$analyticsHelper19, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, _this$analyticsHelper18, state, unconfirmedStepsInfoUGCRemoved, measure, _this$analyticsHelper20, _this$analyticsHelper21, _measure3;
       return _regenerator.default.wrap(function _callee4$(_context4) {
         while (1) switch (_context4.prev = _context4.next) {
           case 0:
@@ -387,7 +435,7 @@ var DocumentService = /*#__PURE__*/function () {
             unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(function (step) {
               return (0, _utils.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");
@@ -396,7 +444,7 @@ var DocumentService = /*#__PURE__*/function () {
             break;
           case 21:
             measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.SUCCESS, {
+            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.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
@@ -408,11 +456,11 @@ var DocumentService = /*#__PURE__*/function () {
             _context4.prev = 25;
             _context4.t0 = _context4["catch"](1);
             _measure3 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
+            (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
               latency: _measure3 === null || _measure3 === void 0 ? void 0 : _measure3.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(_context4.t0, 'Error while committing unconfirmed steps');
+            (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendErrorEvent(_context4.t0, 'Error while committing unconfirmed steps');
             throw _context4.t0;
           case 31:
           case "end":
@@ -421,17 +469,17 @@ var DocumentService = /*#__PURE__*/function () {
       }, _callee4, null, [[1, 25]]);
     })));
     (0, _defineProperty2.default)(this, "onStepRejectedError", function () {
-      var _this$analyticsHelper21;
+      var _this$analyticsHelper22;
       _this.stepRejectCounter++;
       logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
-      (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO, {
+      (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO, {
         count: _this.stepRejectCounter
       });
       var maxRetries = _this.aggressiveCatchup ? _this.failedStepsBeforeCatchupOnPublish : _provider.MAX_STEP_REJECTED_ERROR;
       if (_this.stepRejectCounter >= maxRetries) {
-        var _this$analyticsHelper22;
+        var _this$analyticsHelper23;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(_provider.MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
-        (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(_const.EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO);
+        (_this$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendActionEvent(_const.EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO);
         _this.throttledCatchup();
       } else {
         // If committing steps failed try again automatically in 1s
@@ -452,6 +500,7 @@ var DocumentService = /*#__PURE__*/function () {
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
     this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
+    this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.stepQueue = new _stepQueueState.StepQueueState();
   }
   (0, _createClass2.default)(DocumentService, [{
@@ -503,9 +552,9 @@ var DocumentService = /*#__PURE__*/function () {
             }, 100);
           }
         } catch (error) {
-          var _this$analyticsHelper23;
+          var _this$analyticsHelper24;
           logger("Processing steps failed with error: ".concat(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/cjs/errors/error-code-mapper.js

@@ -71,6 +71,13 @@ var errorCodeMapper = function errorCodeMapper(error) {
         recoverable: false,
         status: 500
       };
+    case _errorTypes.INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR:
+      return {
+        code: _errorTypes.PROVIDER_ERROR_CODE.DOCUMENT_UPDATE_ERROR,
+        message: 'The provider failed to apply changes to the editor',
+        recoverable: false,
+        status: 500
+      };
     case _errorTypes.INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE:
       return {
         code: _errorTypes.PROVIDER_ERROR_CODE.NETWORK_ISSUE,

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

@@ -4,15 +4,15 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SetTitleError = exports.SetMetadataError = exports.SetEditorWidthError = exports.SendTransactionError = exports.ProviderInitialisationError = exports.PROVIDER_ERROR_CODE = exports.NotInitializedError = exports.NotConnectedError = exports.NCS_ERROR_CODE = exports.INTERNAL_ERROR_CODE = exports.GetFinalAcknowledgedStateError = exports.GetCurrentStateError = exports.DestroyError = void 0;
-var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+exports.UpdateDocumentError = exports.SetTitleError = exports.SetMetadataError = exports.SetEditorWidthError = exports.SendTransactionError = exports.ProviderInitialisationError = exports.PROVIDER_ERROR_CODE = exports.NotInitializedError = exports.NotConnectedError = exports.NCS_ERROR_CODE = exports.INTERNAL_ERROR_CODE = exports.GetFinalAcknowledgedStateError = exports.GetCurrentStateError = exports.DestroyError = exports.CustomError = void 0;
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/wrapNativeSuper"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 // Internal error codes (generated by collab provider)
@@ -25,6 +25,7 @@ var 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)
 exports.INTERNAL_ERROR_CODE = INTERNAL_ERROR_CODE;
@@ -55,6 +56,10 @@ var 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.
  */
@@ -71,6 +76,7 @@ var 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;
 }({});
 /*
@@ -170,13 +176,19 @@ exports.PROVIDER_ERROR_CODE = PROVIDER_ERROR_CODE;
 var CustomError = /*#__PURE__*/function (_Error) {
   (0, _inherits2.default)(CustomError, _Error);
   var _super = _createSuper(CustomError);
-  function CustomError(message, error) {
+  function CustomError(message, error, extraEventAttributes) {
     var _this;
     (0, _classCallCheck2.default)(this, CustomError);
     _this = _super.call(this, message);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getExtraErrorEventAttributes", function () {
+      return _this.extraEventAttributes;
+    });
     if (typeof (error === null || error === void 0 ? void 0 : error.message) === 'string') {
       _this.message = error.message;
     }
+    if (extraEventAttributes) {
+      _this.extraEventAttributes = extraEventAttributes;
+    }
     return _this;
   }
   (0, _createClass2.default)(CustomError, [{
@@ -190,6 +202,7 @@ var CustomError = /*#__PURE__*/function (_Error) {
   }]);
   return CustomError;
 }( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error));
+exports.CustomError = CustomError;
 var NotConnectedError = /*#__PURE__*/function (_CustomError) {
   (0, _inherits2.default)(NotConnectedError, _CustomError);
   var _super2 = _createSuper(NotConnectedError);
@@ -349,4 +362,17 @@ var GetFinalAcknowledgedStateError = /*#__PURE__*/function (_CustomError10) {
   }
   return (0, _createClass2.default)(GetFinalAcknowledgedStateError);
 }(CustomError);
-exports.GetFinalAcknowledgedStateError = GetFinalAcknowledgedStateError;
+exports.GetFinalAcknowledgedStateError = GetFinalAcknowledgedStateError;
+var UpdateDocumentError = /*#__PURE__*/function (_CustomError11) {
+  (0, _inherits2.default)(UpdateDocumentError, _CustomError11);
+  var _super12 = _createSuper(UpdateDocumentError);
+  function UpdateDocumentError(message, extraAttributes) {
+    var _this12;
+    (0, _classCallCheck2.default)(this, UpdateDocumentError);
+    _this12 = _super12.call(this, message, undefined, extraAttributes);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this12), "name", 'UpdateDocumentError');
+    return _this12;
+  }
+  return (0, _createClass2.default)(UpdateDocumentError);
+}(CustomError);
+exports.UpdateDocumentError = UpdateDocumentError;

package/dist/cjs/provider/index.js

@@ -89,12 +89,19 @@ var Provider = /*#__PURE__*/function (_Emitter) {
               document = _this$initialDraft.document,
               version = _this$initialDraft.version,
               metadata = _this$initialDraft.metadata;
-            // Initial document, version, metadata from initial draft
-            _this.documentService.updateDocument({
-              doc: document,
-              version: version,
-              metadata: metadata
-            });
+            try {
+              // Initial document, version, metadata from initial draft
+              _this.documentService.updateDocument({
+                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;
@@ -112,13 +119,20 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           version = _ref2.version,
           metadata = _ref2.metadata;
         // Initial document and version
-        _this.documentService.updateDocument({
-          doc: doc,
-          version: version,
-          metadata: metadata
-        });
-        _this.metadataService.updateMetadata(metadata);
-        _this.isProviderInitialized = true;
+        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();
+        }
       }).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((0, _assertThisInitialized2.default)(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
@@ -144,13 +158,13 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       if (((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) === _errorTypes.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || ((_error$data2 = error.data) === null || _error$data2 === void 0 ? void 0 : _error$data2.code) === _errorTypes.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');
         var mappedError = (0, _errorCodeMapper.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);
         }
       }
@@ -173,7 +187,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
      * @throws {GetCurrentStateError} Something went wrong while returning the current state
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getCurrentState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-      var _this$analyticsHelper3;
+      var _this$analyticsHelper5;
       return _regenerator.default.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
@@ -182,7 +196,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           case 4:
             _context.prev = 4;
             _context.t0 = _context["catch"](0);
-            (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
+            (_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');
             throw new _errorTypes.GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
           case 8:
           case "end":
@@ -196,7 +210,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
-      var _this$analyticsHelper4;
+      var _this$analyticsHelper6;
       return _regenerator.default.wrap(function _callee2$(_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
@@ -208,7 +222,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           case 6:
             _context2.prev = 6;
             _context2.t0 = _context2["catch"](0);
-            (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
+            (_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');
             throw new _errorTypes.GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
           case 10:
           case "end":
@@ -243,7 +257,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     _this.metadataService = new _metadataService.MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     _this.documentService = new _documentService.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.onErrorHandled, _this.metadataService, _this.config.failedStepLimitBeforeCatchupOnPublish, _this.config.enableErrorOnFailedDocumentApply);
     _this.getStatePromise = new Promise(function (resolve) {
       _this.getStatePromiseResolve = resolve;
     });
@@ -312,8 +326,8 @@ var Provider = /*#__PURE__*/function (_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 _errorTypes.ProviderInitialisationError('Provider initialisation error', initError);
       }
@@ -323,9 +337,9 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     key: "checkForCookies",
     value: function checkForCookies() {
       if (!global.navigator.cookieEnabled) {
-        var _this$analyticsHelper6;
+        var _this$analyticsHelper8;
         var initError = new _errorTypes.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 _errorTypes.ProviderInitialisationError('Provider initialisation error - cookies disabled', initError);
       }
     }
@@ -363,8 +377,8 @@ var Provider = /*#__PURE__*/function (_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 _errorTypes.SendTransactionError('Error while sending steps for a transaction', error);
       }
     }
@@ -392,9 +406,9 @@ var Provider = /*#__PURE__*/function (_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');
       }
     }
   }, {
@@ -433,8 +447,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         (0, _get2.default)((0, _getPrototypeOf2.default)(Provider.prototype), "unsubscribeAll", this).call(this);
         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 _errorTypes.DestroyError('Error while shutting down the collab provider', error);
       }
       this.clearTimers();
@@ -454,8 +468,8 @@ var Provider = /*#__PURE__*/function (_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 _errorTypes.SetTitleError('Error while setting title', error);
       }
     }
@@ -473,8 +487,8 @@ var Provider = /*#__PURE__*/function (_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 _errorTypes.SetEditorWidthError('Error while setting editor width', error);
       }
     }
@@ -490,8 +504,8 @@ var Provider = /*#__PURE__*/function (_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 _errorTypes.SetMetadataError('Error while setting metadata', error);
       }
     }

package/dist/cjs/version-wrapper.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = "@atlaskit/collab-provider";
 exports.name = name;
-var version = "9.3.0";
+var version = "9.4.0";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/cjs/version.json

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