@atlaskit/collab-provider 9.18.4 → 9.20.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.20.0
+
+### Minor Changes
+
+- [#60038](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/60038) [`b1b34b86ab59`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/b1b34b86ab59) - verify clientIds from serverStepMaps to avoid content duplication
+
+## 9.19.0
+
+### Minor Changes
+
+- [#58777](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/58777) [`f28d4e12e540`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/f28d4e12e540) - Added PROSEMIRROR_SCHEMA_VALIDATION_ERROR from NCS
+
 ## 9.18.4
 
 ### Patch Changes

package/dist/cjs/document/catchup.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.catchup = void 0;
 exports.rebaseSteps = rebaseSteps;
+exports.removeConfirmedSteps = removeConfirmedSteps;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _const = require("../helpers/const");
@@ -41,9 +42,26 @@ function rebaseSteps(steps, mapping) {
   }
   return newSteps;
 }
+
+/**
+ * Check if clientId is in list of StepMaps returned by server, to avoid duplicating content
+ * Each time a StepMap contains the clientId, we should drop an unconfirmedStep
+ */
+function removeConfirmedSteps() {
+  var unconfirmedSteps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  var serverStepMaps = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  var clientId = arguments.length > 2 ? arguments[2] : undefined;
+  var newUnconfirmedSteps = Array.from(unconfirmedSteps);
+  for (var i = 0; i < serverStepMaps.length; i++) {
+    if (serverStepMaps[i].clientId === clientId) {
+      newUnconfirmedSteps.shift();
+    }
+  }
+  return newUnconfirmedSteps;
+}
 var catchup = exports.catchup = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(opt) {
-    var doc, serverStepMaps, serverVersion, metadata, _yield$opt$fetchCatch, _opt$analyticsHelper, currentPmVersion, unconfirmedSteps, _unconfirmedSteps, stepMaps, mapping, newUnconfirmedSteps, _opt$analyticsHelper2, _opt$analyticsHelper3;
+    var doc, serverStepMaps, serverVersion, metadata, _yield$opt$fetchCatch, _opt$analyticsHelper, currentPmVersion, unconfirmedSteps, _unconfirmedSteps2, _unconfirmedSteps, stepMaps, mapping, newUnconfirmedSteps, _opt$analyticsHelper2, _opt$analyticsHelper3;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
@@ -117,9 +135,10 @@ var catchup = exports.catchup = /*#__PURE__*/function () {
               // steps back into the editor, so we don't lose any data. But before that, we need to rebase
               // those steps since their position could be changed after replacing.
               // https://prosemirror.net/docs/guide/#transform.rebasing
-              if (_unconfirmedSteps !== null && _unconfirmedSteps !== void 0 && _unconfirmedSteps.length) {
+              if ((_unconfirmedSteps2 = _unconfirmedSteps) !== null && _unconfirmedSteps2 !== void 0 && _unconfirmedSteps2.length) {
                 // Create StepMap from StepMap JSON
                 // eslint-disable-next-line no-unused-vars
+                _unconfirmedSteps = removeConfirmedSteps(_unconfirmedSteps, serverStepMaps, opt.clientId);
                 stepMaps = serverStepMaps.map(function (_ref2) {
                   var ranges = _ref2.ranges,
                     inverted = _ref2.inverted;

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

@@ -73,6 +73,12 @@ var errorCodeMapper = exports.errorCodeMapper = function errorCodeMapper(error)
         recoverable: false,
         status: 500
       };
+    case _ncsErrors.NCS_ERROR_CODE.PROSEMIRROR_SCHEMA_VALIDATION_ERROR:
+      return {
+        code: _collab.PROVIDER_ERROR_CODE.INITIALISATION_ERROR,
+        message: "The initial document couldn't be loaded from the collab service due to a prosemirror schema validation error",
+        recoverable: false
+      };
     case _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR:
       return {
         code: _collab.PROVIDER_ERROR_CODE.DOCUMENT_UPDATE_ERROR,

package/dist/cjs/errors/ncs-errors.js

@@ -23,6 +23,7 @@ var NCS_ERROR_CODE = exports.NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_C
   NCS_ERROR_CODE["INVALID_DOCUMENT_ARI"] = "INVALID_DOCUMENT_ARI";
   NCS_ERROR_CODE["INVALID_CLOUD_ID"] = "INVALID_CLOUD_ID";
   NCS_ERROR_CODE["RATE_LIMIT_ERROR"] = "RATE_LIMIT_ERROR";
+  NCS_ERROR_CODE["PROSEMIRROR_SCHEMA_VALIDATION_ERROR"] = "PROSEMIRROR_SCHEMA_VALIDATION_ERROR";
   return NCS_ERROR_CODE;
 }({}); // TODO: Import emitted error codes from NCS
 // NCS Errors
@@ -30,6 +31,10 @@ var NCS_ERROR_CODE = exports.NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_C
 // - Permission errors
 // - Page missing / TTL errors
 // - Server errors
+/**
+ * The backend has retrieved the document successfully, as ADF, but failed to convert it to Prosemirror.
+ * This might be because invalid ADF has been written to a document, as it was not validated correctly.
+ */
 // - Less common back-end errors
 /**
  * The client is trying to send too many messages or messages that are too large. This not expected to be a standard

package/dist/cjs/version-wrapper.js

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

package/dist/es2019/document/catchup.js

@@ -19,6 +19,20 @@ export function rebaseSteps(steps, mapping) {
   }
   return newSteps;
 }
+
+/**
+ * Check if clientId is in list of StepMaps returned by server, to avoid duplicating content
+ * Each time a StepMap contains the clientId, we should drop an unconfirmedStep
+ */
+export function removeConfirmedSteps(unconfirmedSteps = [], serverStepMaps = [], clientId) {
+  let newUnconfirmedSteps = Array.from(unconfirmedSteps);
+  for (let i = 0; i < serverStepMaps.length; i++) {
+    if (serverStepMaps[i].clientId === clientId) {
+      newUnconfirmedSteps.shift();
+    }
+  }
+  return newUnconfirmedSteps;
+}
 export const catchup = async opt => {
   let doc, serverStepMaps, serverVersion, metadata;
   try {
@@ -58,9 +72,10 @@ export const catchup = async opt => {
           opt.applyLocalSteps(unconfirmedSteps);
         }
       } else {
+        var _unconfirmedSteps;
         // Please, do not use those steps inside of async
         // method. That will lead to outdated steps
-        const unconfirmedSteps = opt.getUnconfirmedSteps();
+        let unconfirmedSteps = opt.getUnconfirmedSteps();
         logger(`Too far behind[current: v${currentPmVersion}, server: v${serverVersion}. ${serverStepMaps.length} steps need to catchup]`);
         /**
          * Remove steps from queue where the version is older than
@@ -86,9 +101,10 @@ export const catchup = async opt => {
         // steps back into the editor, so we don't lose any data. But before that, we need to rebase
         // those steps since their position could be changed after replacing.
         // https://prosemirror.net/docs/guide/#transform.rebasing
-        if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
+        if ((_unconfirmedSteps = unconfirmedSteps) !== null && _unconfirmedSteps !== void 0 && _unconfirmedSteps.length) {
           // Create StepMap from StepMap JSON
           // eslint-disable-next-line no-unused-vars
+          unconfirmedSteps = removeConfirmedSteps(unconfirmedSteps, serverStepMaps, opt.clientId);
           const stepMaps = serverStepMaps.map(({
             ranges,
             inverted

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

@@ -68,6 +68,12 @@ export const errorCodeMapper = error => {
         recoverable: false,
         status: 500
       };
+    case NCS_ERROR_CODE.PROSEMIRROR_SCHEMA_VALIDATION_ERROR:
+      return {
+        code: PROVIDER_ERROR_CODE.INITIALISATION_ERROR,
+        message: "The initial document couldn't be loaded from the collab service due to a prosemirror schema validation error",
+        recoverable: false
+      };
     case INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR:
       return {
         code: PROVIDER_ERROR_CODE.DOCUMENT_UPDATE_ERROR,

package/dist/es2019/errors/ncs-errors.js

@@ -17,6 +17,7 @@ export let NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
   NCS_ERROR_CODE["INVALID_DOCUMENT_ARI"] = "INVALID_DOCUMENT_ARI";
   NCS_ERROR_CODE["INVALID_CLOUD_ID"] = "INVALID_CLOUD_ID";
   NCS_ERROR_CODE["RATE_LIMIT_ERROR"] = "RATE_LIMIT_ERROR";
+  NCS_ERROR_CODE["PROSEMIRROR_SCHEMA_VALIDATION_ERROR"] = "PROSEMIRROR_SCHEMA_VALIDATION_ERROR";
   return NCS_ERROR_CODE;
 }({});
 
@@ -27,6 +28,10 @@ export let NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
 // - Permission errors
 // - Page missing / TTL errors
 // - Server errors
+/**
+ * The backend has retrieved the document successfully, as ADF, but failed to convert it to Prosemirror.
+ * This might be because invalid ADF has been written to a document, as it was not validated correctly.
+ */
 // - Less common back-end errors
 /**
  * The client is trying to send too many messages or messages that are too large. This not expected to be a standard

package/dist/es2019/version-wrapper.js

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

package/dist/esm/document/catchup.js

@@ -33,9 +33,26 @@ export function rebaseSteps(steps, mapping) {
   }
   return newSteps;
 }
+
+/**
+ * Check if clientId is in list of StepMaps returned by server, to avoid duplicating content
+ * Each time a StepMap contains the clientId, we should drop an unconfirmedStep
+ */
+export function removeConfirmedSteps() {
+  var unconfirmedSteps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  var serverStepMaps = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  var clientId = arguments.length > 2 ? arguments[2] : undefined;
+  var newUnconfirmedSteps = Array.from(unconfirmedSteps);
+  for (var i = 0; i < serverStepMaps.length; i++) {
+    if (serverStepMaps[i].clientId === clientId) {
+      newUnconfirmedSteps.shift();
+    }
+  }
+  return newUnconfirmedSteps;
+}
 export var catchup = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(opt) {
-    var doc, serverStepMaps, serverVersion, metadata, _yield$opt$fetchCatch, _opt$analyticsHelper, currentPmVersion, unconfirmedSteps, _unconfirmedSteps, stepMaps, mapping, newUnconfirmedSteps, _opt$analyticsHelper2, _opt$analyticsHelper3;
+    var doc, serverStepMaps, serverVersion, metadata, _yield$opt$fetchCatch, _opt$analyticsHelper, currentPmVersion, unconfirmedSteps, _unconfirmedSteps2, _unconfirmedSteps, stepMaps, mapping, newUnconfirmedSteps, _opt$analyticsHelper2, _opt$analyticsHelper3;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
@@ -109,9 +126,10 @@ export var catchup = /*#__PURE__*/function () {
               // steps back into the editor, so we don't lose any data. But before that, we need to rebase
               // those steps since their position could be changed after replacing.
               // https://prosemirror.net/docs/guide/#transform.rebasing
-              if (_unconfirmedSteps !== null && _unconfirmedSteps !== void 0 && _unconfirmedSteps.length) {
+              if ((_unconfirmedSteps2 = _unconfirmedSteps) !== null && _unconfirmedSteps2 !== void 0 && _unconfirmedSteps2.length) {
                 // Create StepMap from StepMap JSON
                 // eslint-disable-next-line no-unused-vars
+                _unconfirmedSteps = removeConfirmedSteps(_unconfirmedSteps, serverStepMaps, opt.clientId);
                 stepMaps = serverStepMaps.map(function (_ref2) {
                   var ranges = _ref2.ranges,
                     inverted = _ref2.inverted;

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

@@ -68,6 +68,12 @@ export var errorCodeMapper = function errorCodeMapper(error) {
         recoverable: false,
         status: 500
       };
+    case NCS_ERROR_CODE.PROSEMIRROR_SCHEMA_VALIDATION_ERROR:
+      return {
+        code: PROVIDER_ERROR_CODE.INITIALISATION_ERROR,
+        message: "The initial document couldn't be loaded from the collab service due to a prosemirror schema validation error",
+        recoverable: false
+      };
     case INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR:
       return {
         code: PROVIDER_ERROR_CODE.DOCUMENT_UPDATE_ERROR,

package/dist/esm/errors/ncs-errors.js

@@ -17,6 +17,7 @@ export var NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
   NCS_ERROR_CODE["INVALID_DOCUMENT_ARI"] = "INVALID_DOCUMENT_ARI";
   NCS_ERROR_CODE["INVALID_CLOUD_ID"] = "INVALID_CLOUD_ID";
   NCS_ERROR_CODE["RATE_LIMIT_ERROR"] = "RATE_LIMIT_ERROR";
+  NCS_ERROR_CODE["PROSEMIRROR_SCHEMA_VALIDATION_ERROR"] = "PROSEMIRROR_SCHEMA_VALIDATION_ERROR";
   return NCS_ERROR_CODE;
 }({});
 
@@ -27,6 +28,10 @@ export var NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
 // - Permission errors
 // - Page missing / TTL errors
 // - Server errors
+/**
+ * The backend has retrieved the document successfully, as ADF, but failed to convert it to Prosemirror.
+ * This might be because invalid ADF has been written to a document, as it was not validated correctly.
+ */
 // - Less common back-end errors
 /**
  * The client is trying to send too many messages or messages that are too large. This not expected to be a standard

package/dist/esm/version-wrapper.js

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

package/dist/types/document/catchup.d.ts

@@ -7,4 +7,9 @@ import { Mapping } from '@atlaskit/editor-prosemirror/transform';
  * invalid after rebased.
  */
 export declare function rebaseSteps(steps: readonly Step[], mapping: Mapping): Step[];
+/**
+ * Check if clientId is in list of StepMaps returned by server, to avoid duplicating content
+ * Each time a StepMap contains the clientId, we should drop an unconfirmedStep
+ */
+export declare function removeConfirmedSteps(unconfirmedSteps: readonly Step[] | undefined, serverStepMaps: any[] | undefined, clientId: string | number | undefined): Step[];
 export declare const catchup: (opt: CatchupOptions) => Promise<void>;

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

@@ -15,7 +15,8 @@ export declare enum NCS_ERROR_CODE {
     INVALID_ACTIVATION_ID = "INVALID_ACTIVATION_ID",
     INVALID_DOCUMENT_ARI = "INVALID_DOCUMENT_ARI",
     INVALID_CLOUD_ID = "INVALID_CLOUD_ID",
-    RATE_LIMIT_ERROR = "RATE_LIMIT_ERROR"
+    RATE_LIMIT_ERROR = "RATE_LIMIT_ERROR",
+    PROSEMIRROR_SCHEMA_VALIDATION_ERROR = "PROSEMIRROR_SCHEMA_VALIDATION_ERROR"
 }
 type HeadVersionUpdateFailedError = {
     message: string;
@@ -69,6 +70,17 @@ type FailedToLoadInitDataError = {
         status: number;
     };
 };
+/**
+ * The backend has retrieved the document successfully, as ADF, but failed to convert it to Prosemirror.
+ * This might be because invalid ADF has been written to a document, as it was not validated correctly.
+ */
+type ProsemirrorSchemaValidationError = {
+    message: string;
+    data: {
+        code: NCS_ERROR_CODE.PROSEMIRROR_SCHEMA_VALIDATION_ERROR;
+        status: number;
+    };
+};
 type ErrorMappingError = {
     message: string;
     data: {
@@ -168,5 +180,5 @@ export type RateLimitError = {
         status: 500;
     };
 };
-export type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError | RateLimitError;
+export type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError | RateLimitError | ProsemirrorSchemaValidationError;
 export {};

package/dist/types-ts4.5/document/catchup.d.ts

@@ -7,4 +7,9 @@ import { Mapping } from '@atlaskit/editor-prosemirror/transform';
  * invalid after rebased.
  */
 export declare function rebaseSteps(steps: readonly Step[], mapping: Mapping): Step[];
+/**
+ * Check if clientId is in list of StepMaps returned by server, to avoid duplicating content
+ * Each time a StepMap contains the clientId, we should drop an unconfirmedStep
+ */
+export declare function removeConfirmedSteps(unconfirmedSteps: readonly Step[] | undefined, serverStepMaps: any[] | undefined, clientId: string | number | undefined): Step[];
 export declare const catchup: (opt: CatchupOptions) => Promise<void>;

package/dist/types-ts4.5/errors/ncs-errors.d.ts

@@ -15,7 +15,8 @@ export declare enum NCS_ERROR_CODE {
     INVALID_ACTIVATION_ID = "INVALID_ACTIVATION_ID",
     INVALID_DOCUMENT_ARI = "INVALID_DOCUMENT_ARI",
     INVALID_CLOUD_ID = "INVALID_CLOUD_ID",
-    RATE_LIMIT_ERROR = "RATE_LIMIT_ERROR"
+    RATE_LIMIT_ERROR = "RATE_LIMIT_ERROR",
+    PROSEMIRROR_SCHEMA_VALIDATION_ERROR = "PROSEMIRROR_SCHEMA_VALIDATION_ERROR"
 }
 type HeadVersionUpdateFailedError = {
     message: string;
@@ -69,6 +70,17 @@ type FailedToLoadInitDataError = {
         status: number;
     };
 };
+/**
+ * The backend has retrieved the document successfully, as ADF, but failed to convert it to Prosemirror.
+ * This might be because invalid ADF has been written to a document, as it was not validated correctly.
+ */
+type ProsemirrorSchemaValidationError = {
+    message: string;
+    data: {
+        code: NCS_ERROR_CODE.PROSEMIRROR_SCHEMA_VALIDATION_ERROR;
+        status: number;
+    };
+};
 type ErrorMappingError = {
     message: string;
     data: {
@@ -168,5 +180,5 @@ export type RateLimitError = {
         status: 500;
     };
 };
-export type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError | RateLimitError;
+export type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError | RateLimitError | ProsemirrorSchemaValidationError;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.18.4",
+  "version": "9.20.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,7 +36,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-common": "^76.25.0",
+    "@atlaskit/editor-common": "^76.26.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/prosemirror-collab": "^0.2.0",