@atlaskit/collab-provider 9.26.0 → 9.26.2

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/collab-provider
 
+## 9.26.2
+
+### Patch Changes
+
+- [#90942](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/90942) [`30e989b2e4bb`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/30e989b2e4bb) - catchupV2 is a noop when document is locked
+
+## 9.26.1
+
+### Patch Changes
+
+- [#91106](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/91106) [`b6ffa30186b9`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/b6ffa30186b9) - Bump ADF-schema package to version 35.0.0
+- Updated dependencies
+
 ## 9.26.0
 
 ### Minor Changes

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

@@ -47,11 +47,11 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
-  function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
+  function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, isNameSpaceLocked) {
     var _this = this;
-    var enableErrorOnFailedDocumentApply = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
-    var reconcileOnRecovery = arguments.length > 11 && arguments[11] !== undefined ? arguments[11] : false;
-    var options = arguments.length > 12 && arguments[12] !== undefined ? arguments[12] : {
+    var enableErrorOnFailedDocumentApply = arguments.length > 11 && arguments[11] !== undefined ? arguments[11] : false;
+    var reconcileOnRecovery = arguments.length > 12 && arguments[12] !== undefined ? arguments[12] : false;
+    var options = arguments.length > 13 && arguments[13] !== undefined ? arguments[13] : {
       __livePage: false
     };
     (0, _classCallCheck2.default)(this, DocumentService);
@@ -155,9 +155,16 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             logger("Queue is paused. Aborting.");
             return _context2.abrupt("return");
           case 4:
+            if (!_this.isNameSpaceLocked()) {
+              _context2.next = 7;
+              break;
+            }
+            logger("catchupv2: Document is locked. Aborting.");
+            return _context2.abrupt("return");
+          case 7:
             _this.stepQueue.pauseQueue();
-            _context2.prev = 5;
-            _context2.next = 8;
+            _context2.prev = 8;
+            _context2.next = 11;
             return (0, _catchupv.catchupv2)({
               getCurrentPmVersion: _this.getCurrentPmVersion,
               fetchCatchupv2: _this.fetchCatchupv2,
@@ -166,32 +173,32 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
               clientId: _this.clientId,
               onStepsAdded: _this.onStepsAdded
             });
-          case 8:
+          case 11:
             latency = new Date().getTime() - start;
             (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.SUCCESS, {
               latency: latency
             });
-            _context2.next = 16;
+            _context2.next = 19;
             break;
-          case 12:
-            _context2.prev = 12;
-            _context2.t0 = _context2["catch"](5);
+          case 15:
+            _context2.prev = 15;
+            _context2.t0 = _context2["catch"](8);
             _latency2 = new Date().getTime() - start;
             (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.FAILURE, {
               latency: _latency2
             });
-          case 16:
-            _context2.prev = 16;
+          case 19:
+            _context2.prev = 19;
             _this.stepQueue.resumeQueue();
             _this.processQueue();
             _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls throttledCommitStep which will either catchup on onStepsAdded or onErrorHandled
             _this.stepRejectCounter = 0;
-            return _context2.finish(16);
-          case 22:
+            return _context2.finish(19);
+          case 25:
           case "end":
             return _context2.stop();
         }
-      }, _callee2, null, [[5, 12, 16, 22]]);
+      }, _callee2, null, [[8, 15, 19, 25]]);
     })));
     (0, _defineProperty2.default)(this, "getCurrentPmVersion", function () {
       var _this$getState;
@@ -653,6 +660,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
+    this.isNameSpaceLocked = isNameSpaceLocked;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.reconcileOnRecovery = reconcileOnRecovery;
     this.options = options;

package/dist/cjs/provider/index.js

@@ -274,12 +274,12 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     _this.participantsService = new _participantsService.ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId);
     _this.metadataService = new _metadataService.MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     var reconcileOnRecovery = (0, _featureFlags.getCollabProviderFeatureFlag)('reconcileOnRecovery', _this.config.featureFlags);
+    _this.namespaceService = new _namespaceService.NamespaceService();
     _this.documentService = new _documentService.DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.channel.fetchCatchupv2, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
+    }, _this.onErrorHandled, _this.metadataService, _this.namespaceService.getIsNamespaceLocked.bind(_this.namespaceService), _this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
       __livePage: _this.config.__livePage || false
     });
-    _this.namespaceService = new _namespaceService.NamespaceService();
     _this.api = new _api.Api(config, _this.documentService, _this.channel);
     _this.sendStepsTimer = setInterval(function () {
       logger('Intervally sendStepsFromCurrentState');

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.26.0";
+var version = exports.version = "9.26.2";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -34,7 +34,7 @@ export class DocumentService {
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
-  constructor(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, enableErrorOnFailedDocumentApply = false, reconcileOnRecovery = false, options = {
+  constructor(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, isNameSpaceLocked, enableErrorOnFailedDocumentApply = false, reconcileOnRecovery = false, options = {
     __livePage: false
   }) {
     // Fires analytics to editor when collab editor cannot sync up
@@ -111,6 +111,21 @@ export class DocumentService {
         logger(`Queue is paused. Aborting.`);
         return;
       }
+
+      /**
+       * If the database is in a transitionary state (i.e locked),
+       * it likely that another user may already be in the process of catching up.
+       *
+       * If multiple users are trying to catch up at the same time, it can lead to
+       * the database being stuck in a transitionary state due to duplicated page recovery requests.
+       * We don't wanna be stuck in a transitionary state as that will cause issues with
+       * content reconciliation and other operations.
+       */
+      // check if the document is locked -> noop
+      if (this.isNameSpaceLocked()) {
+        logger(`catchupv2: Document is locked. Aborting.`);
+        return;
+      }
       this.stepQueue.pauseQueue();
       try {
         var _this$analyticsHelper3;
@@ -517,6 +532,7 @@ export class DocumentService {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
+    this.isNameSpaceLocked = isNameSpaceLocked;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.reconcileOnRecovery = reconcileOnRecovery;
     this.options = options;

package/dist/es2019/provider/index.js

@@ -229,10 +229,10 @@ export class Provider extends Emitter {
     this.participantsService = new ParticipantsService(this.analyticsHelper, undefined, this.emitCallback, this.config.getUser, this.channel.broadcast, this.channel.sendPresenceJoined, this.getPresenceData, this.setUserId);
     this.metadataService = new MetadataService(this.emitCallback, this.channel.sendMetadata);
     const reconcileOnRecovery = getCollabProviderFeatureFlag('reconcileOnRecovery', this.config.featureFlags);
-    this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.channel.fetchCatchupv2, this.channel.fetchReconcile, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService, this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
+    this.namespaceService = new NamespaceService();
+    this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.channel.fetchCatchupv2, this.channel.fetchReconcile, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService, this.namespaceService.getIsNamespaceLocked.bind(this.namespaceService), this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
       __livePage: this.config.__livePage || false
     });
-    this.namespaceService = new NamespaceService();
     this.api = new Api(config, this.documentService, this.channel);
     this.sendStepsTimer = setInterval(() => {
       logger('Intervally sendStepsFromCurrentState');

package/dist/es2019/version-wrapper.js

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

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

@@ -40,11 +40,11 @@ export var DocumentService = /*#__PURE__*/function () {
    * @param metadataService
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    */
-  function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
+  function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchCatchupv2, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService, isNameSpaceLocked) {
     var _this = this;
-    var enableErrorOnFailedDocumentApply = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
-    var reconcileOnRecovery = arguments.length > 11 && arguments[11] !== undefined ? arguments[11] : false;
-    var options = arguments.length > 12 && arguments[12] !== undefined ? arguments[12] : {
+    var enableErrorOnFailedDocumentApply = arguments.length > 11 && arguments[11] !== undefined ? arguments[11] : false;
+    var reconcileOnRecovery = arguments.length > 12 && arguments[12] !== undefined ? arguments[12] : false;
+    var options = arguments.length > 13 && arguments[13] !== undefined ? arguments[13] : {
       __livePage: false
     };
     _classCallCheck(this, DocumentService);
@@ -148,9 +148,16 @@ export var DocumentService = /*#__PURE__*/function () {
             logger("Queue is paused. Aborting.");
             return _context2.abrupt("return");
           case 4:
+            if (!_this.isNameSpaceLocked()) {
+              _context2.next = 7;
+              break;
+            }
+            logger("catchupv2: Document is locked. Aborting.");
+            return _context2.abrupt("return");
+          case 7:
             _this.stepQueue.pauseQueue();
-            _context2.prev = 5;
-            _context2.next = 8;
+            _context2.prev = 8;
+            _context2.next = 11;
             return catchupv2({
               getCurrentPmVersion: _this.getCurrentPmVersion,
               fetchCatchupv2: _this.fetchCatchupv2,
@@ -159,32 +166,32 @@ export var DocumentService = /*#__PURE__*/function () {
               clientId: _this.clientId,
               onStepsAdded: _this.onStepsAdded
             });
-          case 8:
+          case 11:
             latency = new Date().getTime() - start;
             (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {
               latency: latency
             });
-            _context2.next = 16;
+            _context2.next = 19;
             break;
-          case 12:
-            _context2.prev = 12;
-            _context2.t0 = _context2["catch"](5);
+          case 15:
+            _context2.prev = 15;
+            _context2.t0 = _context2["catch"](8);
             _latency2 = new Date().getTime() - start;
             (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.FAILURE, {
               latency: _latency2
             });
-          case 16:
-            _context2.prev = 16;
+          case 19:
+            _context2.prev = 19;
             _this.stepQueue.resumeQueue();
             _this.processQueue();
             _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls throttledCommitStep which will either catchup on onStepsAdded or onErrorHandled
             _this.stepRejectCounter = 0;
-            return _context2.finish(16);
-          case 22:
+            return _context2.finish(19);
+          case 25:
           case "end":
             return _context2.stop();
         }
-      }, _callee2, null, [[5, 12, 16, 22]]);
+      }, _callee2, null, [[8, 15, 19, 25]]);
     })));
     _defineProperty(this, "getCurrentPmVersion", function () {
       var _this$getState;
@@ -646,6 +653,7 @@ export var DocumentService = /*#__PURE__*/function () {
     this.getUserId = getUserId;
     this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
+    this.isNameSpaceLocked = isNameSpaceLocked;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.reconcileOnRecovery = reconcileOnRecovery;
     this.options = options;

package/dist/esm/provider/index.js

@@ -267,12 +267,12 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this.participantsService = new ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId);
     _this.metadataService = new MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     var reconcileOnRecovery = getCollabProviderFeatureFlag('reconcileOnRecovery', _this.config.featureFlags);
+    _this.namespaceService = new NamespaceService();
     _this.documentService = new DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.channel.fetchCatchupv2, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService, _this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
+    }, _this.onErrorHandled, _this.metadataService, _this.namespaceService.getIsNamespaceLocked.bind(_this.namespaceService), _this.config.enableErrorOnFailedDocumentApply, reconcileOnRecovery, {
       __livePage: _this.config.__livePage || false
     });
-    _this.namespaceService = new NamespaceService();
     _this.api = new Api(config, _this.documentService, _this.channel);
     _this.sendStepsTimer = setInterval(function () {
       logger('Intervally sendStepsFromCurrentState');

package/dist/esm/version-wrapper.js

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

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

@@ -19,6 +19,7 @@ export declare class DocumentService {
     private getUserId;
     private onErrorHandled;
     private metadataService;
+    private isNameSpaceLocked;
     private enableErrorOnFailedDocumentApply;
     private reconcileOnRecovery;
     private options;
@@ -43,7 +44,7 @@ export declare class DocumentService {
      * @param metadataService
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, 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, enableErrorOnFailedDocumentApply?: boolean, reconcileOnRecovery?: boolean, options?: {
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, 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, isNameSpaceLocked: () => boolean, enableErrorOnFailedDocumentApply?: boolean, reconcileOnRecovery?: boolean, options?: {
         __livePage: boolean;
     });
     /**

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

@@ -19,6 +19,7 @@ export declare class DocumentService {
     private getUserId;
     private onErrorHandled;
     private metadataService;
+    private isNameSpaceLocked;
     private enableErrorOnFailedDocumentApply;
     private reconcileOnRecovery;
     private options;
@@ -43,7 +44,7 @@ export declare class DocumentService {
      * @param metadataService
      * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
      */
-    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, 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, enableErrorOnFailedDocumentApply?: boolean, reconcileOnRecovery?: boolean, options?: {
+    constructor(participantsService: ParticipantsService, analyticsHelper: AnalyticsHelper | undefined, fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>, fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined) => Promise<Catchupv2Response>, fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>, 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, isNameSpaceLocked: () => boolean, enableErrorOnFailedDocumentApply?: boolean, reconcileOnRecovery?: boolean, options?: {
         __livePage: boolean;
     });
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.26.0",
+  "version": "9.26.2",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -39,7 +39,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.9.0",
-    "@atlaskit/editor-common": "^78.25.0",
+    "@atlaskit/editor-common": "^78.28.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "3.0.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",
@@ -66,7 +66,7 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^35.8.0",
+    "@atlaskit/adf-schema": "^35.9.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@atlassian/feature-flags-test-utils": "^0.2.0",
     "typescript": "~5.4.2"