@atlaskit/collab-provider 9.3.1 → 9.4.0

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

@@ -15,7 +15,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';
 var CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
 var noop = function noop() {};
@@ -35,10 +35,12 @@ export 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] : MAX_STEP_REJECTED_ERROR;
+    var enableErrorOnFailedDocumentApply = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : false;
     _classCallCheck(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     _defineProperty(this, "stepRejectCounter", 0);
@@ -321,13 +323,59 @@ export 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 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: INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR,
+              meta: {
+                newVersion: version,
+                editorVersion: updatedVersion
+              },
+              status: 500
+            }
+          });
+          throw _error;
+        }
+        // Otherwise just fail silently for now
+      }
+    });
+    _defineProperty(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
      */
     _defineProperty(this, "commitUnconfirmedSteps", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.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 _regeneratorRuntime.wrap(function _callee4$(_context4) {
         while (1) switch (_context4.prev = _context4.next) {
           case 0:
@@ -380,7 +428,7 @@ export var DocumentService = /*#__PURE__*/function () {
             unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(function (step) {
               return 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");
@@ -389,7 +437,7 @@ export var DocumentService = /*#__PURE__*/function () {
             break;
           case 21:
             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
@@ -401,11 +449,11 @@ export var DocumentService = /*#__PURE__*/function () {
             _context4.prev = 25;
             _context4.t0 = _context4["catch"](1);
             _measure3 = 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: _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":
@@ -414,17 +462,17 @@ export var DocumentService = /*#__PURE__*/function () {
       }, _callee4, null, [[1, 25]]);
     })));
     _defineProperty(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(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
       });
       var 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=".concat(_this.stepRejectCounter, ", limit=").concat(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
@@ -445,6 +493,7 @@ export var DocumentService = /*#__PURE__*/function () {
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
     this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
+    this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.stepQueue = new StepQueueState();
   }
   _createClass(DocumentService, [{
@@ -496,9 +545,9 @@ export 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/esm/errors/error-code-mapper.js

@@ -67,6 +67,13 @@ export var errorCodeMapper = function 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/esm/errors/error-types.js

@@ -1,14 +1,15 @@
-import _assertThisInitialized from "@babel/runtime/helpers/assertThisInitialized";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
+import _assertThisInitialized from "@babel/runtime/helpers/assertThisInitialized";
 import _inherits from "@babel/runtime/helpers/inherits";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _wrapNativeSuper from "@babel/runtime/helpers/wrapNativeSuper";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(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)
+
 export var 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";
@@ -18,8 +19,10 @@ export 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)
 export var NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
   NCS_ERROR_CODE["HEAD_VERSION_UPDATE_FAILED"] = "HEAD_VERSION_UPDATE_FAILED";
@@ -51,6 +54,10 @@ export 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.
  */
@@ -66,6 +73,7 @@ export 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;
 }({});
 
@@ -163,16 +171,22 @@ export var 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
-var CustomError = /*#__PURE__*/function (_Error) {
+export var CustomError = /*#__PURE__*/function (_Error) {
   _inherits(CustomError, _Error);
   var _super = _createSuper(CustomError);
-  function CustomError(message, error) {
+  function CustomError(message, error, extraEventAttributes) {
     var _this;
     _classCallCheck(this, CustomError);
     _this = _super.call(this, message);
+    _defineProperty(_assertThisInitialized(_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;
   }
   _createClass(CustomError, [{
@@ -335,4 +349,16 @@ export var GetFinalAcknowledgedStateError = /*#__PURE__*/function (_CustomError1
     return _this11;
   }
   return _createClass(GetFinalAcknowledgedStateError);
+}(CustomError);
+export var UpdateDocumentError = /*#__PURE__*/function (_CustomError11) {
+  _inherits(UpdateDocumentError, _CustomError11);
+  var _super12 = _createSuper(UpdateDocumentError);
+  function UpdateDocumentError(message, extraAttributes) {
+    var _this12;
+    _classCallCheck(this, UpdateDocumentError);
+    _this12 = _super12.call(this, message, undefined, extraAttributes);
+    _defineProperty(_assertThisInitialized(_this12), "name", 'UpdateDocumentError');
+    return _this12;
+  }
+  return _createClass(UpdateDocumentError);
 }(CustomError);

package/dist/esm/provider/index.js

@@ -81,12 +81,19 @@ export 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;
@@ -104,13 +111,20 @@ export 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(_assertThisInitialized(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
@@ -136,13 +150,13 @@ 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$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 = 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);
         }
       }
@@ -165,7 +179,7 @@ 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$analyticsHelper3;
+      var _this$analyticsHelper5;
       return _regeneratorRuntime.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
@@ -174,7 +188,7 @@ export 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 GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
           case 8:
           case "end":
@@ -188,7 +202,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$analyticsHelper4;
+      var _this$analyticsHelper6;
       return _regeneratorRuntime.wrap(function _callee2$(_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
@@ -200,7 +214,7 @@ export 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 GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
           case 10:
           case "end":
@@ -235,7 +249,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _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, 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;
     });
@@ -304,8 +318,8 @@ export 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 ProviderInitialisationError('Provider initialisation error', initError);
       }
@@ -315,9 +329,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     key: "checkForCookies",
     value: function checkForCookies() {
       if (!global.navigator.cookieEnabled) {
-        var _this$analyticsHelper6;
+        var _this$analyticsHelper8;
         var 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);
       }
     }
@@ -355,8 +369,8 @@ export 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 SendTransactionError('Error while sending steps for a transaction', error);
       }
     }
@@ -384,9 +398,9 @@ export 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');
       }
     }
   }, {
@@ -425,8 +439,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         _get(_getPrototypeOf(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 DestroyError('Error while shutting down the collab provider', error);
       }
       this.clearTimers();
@@ -446,8 +460,8 @@ export 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 SetTitleError('Error while setting title', error);
       }
     }
@@ -465,8 +479,8 @@ export 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 SetEditorWidthError('Error while setting editor width', error);
       }
     }
@@ -482,8 +496,8 @@ export 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 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.3.1";
+export var version = "9.4.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.3.1",
+	"version": "9.4.0",
 	"sideEffects": false
 }

package/dist/types/document/document-service.d.ts

@@ -17,6 +17,7 @@ export declare class DocumentService {
     private onErrorHandled;
     private metadataService;
     private failedStepsBeforeCatchupOnPublish;
+    private enableErrorOnFailedDocumentApply;
     private getState;
     private onSyncUpError?;
     private stepQueue;
@@ -35,8 +36,9 @@ export declare 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: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, failedStepsBeforeCatchupOnPublish?: number);
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number) => Promise<CatchupResponse>, providerEmitCallback: (evt: keyof CollabEvents, data: any) => void, broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, getUserId: () => string | undefined, onErrorHandled: (error: InternalError) => void, metadataService: MetadataService, failedStepsBeforeCatchupOnPublish?: number, enableErrorOnFailedDocumentApply?: boolean);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      */
@@ -61,6 +63,7 @@ export declare class DocumentService {
     onRestore: ({ doc, version, metadata }: CollabInitPayload) => void;
     getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
     updateDocument: ({ doc, version, metadata, reserveCursor, }: CollabInitPayload) => void;
+    private validatePMJSONDocument;
     /**
      * Commit the unconfirmed local steps to the back-end service
      * @throws {Error} Couldn't sync the steps after retrying 30 times

package/dist/types/errors/error-types.d.ts

@@ -1,3 +1,4 @@
+import { DocumentUpdateErrorAttributes } from '../helpers/const';
 export declare enum INTERNAL_ERROR_CODE {
     TOKEN_PERMISSION_ERROR = "TOKEN_PERMISSION_ERROR",
     RECONNECTION_NETWORK_ISSUE = "RECONNECTION_NETWORK_ISSUE",
@@ -6,7 +7,8 @@ export declare enum INTERNAL_ERROR_CODE {
     DOCUMENT_NOT_FOUND = "DOCUMENT_NOT_FOUND",
     CATCHUP_FAILED = "CATCHUP_FAILED",
     DOCUMENT_RESTORE_ERROR = "DOCUMENT_RESTORE_ERROR",
-    ADD_STEPS_ERROR = "ADD_STEPS_ERROR"
+    ADD_STEPS_ERROR = "ADD_STEPS_ERROR",
+    DOCUMENT_UPDATE_ERROR = "DOCUMENT_UPDATE_ERROR"
 }
 export declare enum NCS_ERROR_CODE {
     HEAD_VERSION_UPDATE_FAILED = "HEAD_VERSION_UPDATE_FAILED",
@@ -160,7 +162,7 @@ type InvalidCloudIdError = {
         status: number;
     };
 };
-type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError;
+type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError | InternalDocumentUpdateFailure;
 type DocumentRecoveryError = {
     message: string;
     data: {
@@ -219,10 +221,25 @@ export type DocumentNotFoundError = {
         status: number;
     };
 };
+/**
+ * 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.
+ */
+export type InternalDocumentUpdateFailure = {
+    message: 'The provider failed to apply changes to the editor';
+    data: {
+        code: INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR;
+        meta: {
+            newVersion?: number;
+            editorVersion?: number;
+        };
+        status: 500;
+    };
+};
 /**
  * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
  */
-export type InternalError = NCSErrors | DocumentRecoveryError | AddStepsError | CatchUpFailedError | TokenPermissionError | ReconnectionError | ConnectionError | ReconnectionNetworkError | DocumentNotFoundError;
+export type InternalError = NCSErrors | DocumentRecoveryError | AddStepsError | CatchUpFailedError | TokenPermissionError | ReconnectionError | ConnectionError | ReconnectionNetworkError | DocumentNotFoundError | InternalDocumentUpdateFailure;
 export declare enum PROVIDER_ERROR_CODE {
     NO_PERMISSION_ERROR = "NO_PERMISSION_ERROR",
     INVALID_USER_TOKEN = "INVALID_USER_TOKEN",
@@ -233,7 +250,8 @@ export declare enum PROVIDER_ERROR_CODE {
     INITIALISATION_ERROR = "INITIALISATION_ERROR",
     NETWORK_ISSUE = "NETWORK_ISSUE",
     INVALID_PROVIDER_CONFIGURATION = "INVALID_PROVIDER_CONFIGURATION",
-    INTERNAL_SERVICE_ERROR = "INTERNAL_SERVICE_ERROR"
+    INTERNAL_SERVICE_ERROR = "INTERNAL_SERVICE_ERROR",
+    DOCUMENT_UPDATE_ERROR = "DOCUMENT_UPDATE_ERROR"
 }
 /**
  * This occurs when the provided user token is considered invalid for the given document ARI.
@@ -399,16 +417,34 @@ type InternalServiceError = {
      */
     status?: number;
 };
+type ProviderDocumentUpdateError = {
+    code: PROVIDER_ERROR_CODE.DOCUMENT_UPDATE_ERROR;
+    message: 'The provider failed to apply changes to the editor';
+    recoverable: boolean;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
 /**
  * A union of all possible provider errors that can be emitted back to the editor.
  */
-export type ProviderError = InsufficientEditingPermission | InvalidUserToken | DocumentNotFound | Locked | FailToSave | DocumentNotRestore | InitialisationError | NetworkIssue | InvalidProviderConfiguration | InternalServiceError;
-declare class CustomError extends Error {
-    constructor(message: string, error?: unknown);
+export type ProviderError = InsufficientEditingPermission | InvalidUserToken | DocumentNotFound | Locked | FailToSave | DocumentNotRestore | InitialisationError | NetworkIssue | InvalidProviderConfiguration | InternalServiceError | ProviderDocumentUpdateError;
+type ValidEventAttributeType = boolean | string | number;
+export declare class CustomError extends Error {
+    extraEventAttributes?: {
+        [key: string]: ValidEventAttributeType;
+    };
+    constructor(message: string, error?: unknown, extraEventAttributes?: {
+        [key: string]: ValidEventAttributeType;
+    });
     toJSON(): {
         name: string;
         message: string;
     };
+    getExtraErrorEventAttributes: () => {
+        [key: string]: ValidEventAttributeType;
+    } | undefined;
 }
 export declare class NotConnectedError extends CustomError {
     name: string;
@@ -440,4 +476,8 @@ export declare class GetCurrentStateError extends CustomError {
 export declare class GetFinalAcknowledgedStateError extends CustomError {
     name: string;
 }
+export declare class UpdateDocumentError extends CustomError {
+    name: string;
+    constructor(message: string, extraAttributes: DocumentUpdateErrorAttributes);
+}
 export {};

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

@@ -25,6 +25,13 @@ export declare enum ADD_STEPS_TYPE {
     REJECTED = "REJECTED",
     ERROR = "ERROR"
 }
+export type DocumentUpdateErrorAttributes = {
+    isDocTruthy?: boolean;
+    editorVersion?: number;
+    newVersion?: number;
+    docHasContent?: boolean;
+    isDocContentValid?: boolean;
+};
 export type ErrorAnalyticsEvent = {
     eventAction: EVENT_ACTION.ERROR;
     attributes: {
@@ -32,7 +39,7 @@ export type ErrorAnalyticsEvent = {
         errorName?: string;
         documentAri?: string;
         mappedError?: ProviderError;
-    };
+    } & DocumentUpdateErrorAttributes;
     nonPrivacySafeAttributes: {
         error: unknown;
     };