@atlaskit/collab-provider 10.5.0 → 10.5.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/collab-provider
 
+## 10.5.2
+
+### Patch Changes
+
+- [#109636](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/109636)
+  [`2eadf04054ac2`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/2eadf04054ac2) -
+  [ux] Introduces way to retrieve the document from offline if there is a possible conflict event on
+  reconnection.
+- Updated dependencies
+
+## 10.5.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 10.5.0
 
 ### Minor Changes

package/dist/cjs/connectivity/reconnect-helper.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _readOnlyError2 = _interopRequireDefault(require("@babel/runtime/helpers/readOnlyError"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));

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

@@ -120,6 +120,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                     (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 || _this$analyticsHelper.sendActionEvent(_const.EVENT_ACTION.RECONNECTION, _const.EVENT_STATUS.INFO, _objectSpread(_objectSpread({}, reconnectionMetadata), {}, {
                       remoteStepsLength: (_steps$length = steps === null || steps === void 0 ? void 0 : steps.length) !== null && _steps$length !== void 0 ? _steps$length : 0
                     }));
+                    _this.notifyReconnectionConflict(steps);
                   }
                 },
                 getState: _this.getState
@@ -724,6 +725,29 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       }
       return collabState.version;
     }
+  }, {
+    key: "notifyReconnectionConflict",
+    value:
+    /**
+     * In the event we reconnect check if we have existing unconfirmed steps and if so
+     * notify the editor that we have a potential conflict to resolve on the frontend.
+     *
+     * @param data remote steps payload
+     */
+    function notifyReconnectionConflict(steps) {
+      var _this$getState7, _getCollabState;
+      if (!(0, _platformFeatureFlags.fg)('platform_editor_offline_conflict_resolution')) {
+        return;
+      }
+      var state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
+      var unconfirmedSteps = state ? (_getCollabState = (0, _prosemirrorCollab.getCollabState)(state)) === null || _getCollabState === void 0 ? void 0 : _getCollabState.unconfirmed : undefined;
+      if (steps.length > 0 && state && unconfirmedSteps && unconfirmedSteps.length > 0) {
+        // In the future we can determine the type of conflict
+        this.providerEmitCallback('data:conflict', {
+          offlineDoc: state.doc
+        });
+      }
+    }
   }, {
     key: "processQueue",
     value: function processQueue() {
@@ -817,8 +841,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
   }, {
     key: "sendStepsFromCurrentState",
     value: function sendStepsFromCurrentState(sendAnalyticsEvent) {
-      var _this$getState7;
-      var state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
+      var _this$getState8;
+      var state = (_this$getState8 = this.getState) === null || _this$getState8 === void 0 ? void 0 : _this$getState8.call(this);
       if (!state) {
         var _this$analyticsHelper33;
         (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 || _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');

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

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

@@ -114,6 +114,7 @@ export class DocumentService {
                 ...reconnectionMetadata,
                 remoteStepsLength: (_steps$length = steps === null || steps === void 0 ? void 0 : steps.length) !== null && _steps$length !== void 0 ? _steps$length : 0
               });
+              this.notifyReconnectionConflict(steps);
             }
           },
           getState: this.getState
@@ -611,6 +612,26 @@ export class DocumentService {
     }
     return collabState.version;
   }
+  /**
+   * In the event we reconnect check if we have existing unconfirmed steps and if so
+   * notify the editor that we have a potential conflict to resolve on the frontend.
+   *
+   * @param data remote steps payload
+   */
+  notifyReconnectionConflict(steps) {
+    var _this$getState7, _getCollabState;
+    if (!fg('platform_editor_offline_conflict_resolution')) {
+      return;
+    }
+    const state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
+    const unconfirmedSteps = state ? (_getCollabState = getCollabState(state)) === null || _getCollabState === void 0 ? void 0 : _getCollabState.unconfirmed : undefined;
+    if (steps.length > 0 && state && unconfirmedSteps && unconfirmedSteps.length > 0) {
+      // In the future we can determine the type of conflict
+      this.providerEmitCallback('data:conflict', {
+        offlineDoc: state.doc
+      });
+    }
+  }
   processQueue() {
     if (this.stepQueue.isPaused()) {
       logger(`Queue is paused. Aborting.`);
@@ -693,8 +714,8 @@ export class DocumentService {
    * from the EditorView.
    */
   sendStepsFromCurrentState(sendAnalyticsEvent) {
-    var _this$getState7;
-    const state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
+    var _this$getState8;
+    const state = (_this$getState8 = this.getState) === null || _this$getState8 === void 0 ? void 0 : _this$getState8.call(this);
     if (!state) {
       var _this$analyticsHelper33;
       (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 ? void 0 : _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');

package/dist/es2019/version-wrapper.js

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

package/dist/esm/connectivity/reconnect-helper.js

@@ -1,3 +1,4 @@
+import _readOnlyError from "@babel/runtime/helpers/readOnlyError";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";

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

@@ -113,6 +113,7 @@ export var DocumentService = /*#__PURE__*/function () {
                     (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 || _this$analyticsHelper.sendActionEvent(EVENT_ACTION.RECONNECTION, EVENT_STATUS.INFO, _objectSpread(_objectSpread({}, reconnectionMetadata), {}, {
                       remoteStepsLength: (_steps$length = steps === null || steps === void 0 ? void 0 : steps.length) !== null && _steps$length !== void 0 ? _steps$length : 0
                     }));
+                    _this.notifyReconnectionConflict(steps);
                   }
                 },
                 getState: _this.getState
@@ -717,6 +718,29 @@ export var DocumentService = /*#__PURE__*/function () {
       }
       return collabState.version;
     }
+  }, {
+    key: "notifyReconnectionConflict",
+    value:
+    /**
+     * In the event we reconnect check if we have existing unconfirmed steps and if so
+     * notify the editor that we have a potential conflict to resolve on the frontend.
+     *
+     * @param data remote steps payload
+     */
+    function notifyReconnectionConflict(steps) {
+      var _this$getState7, _getCollabState;
+      if (!fg('platform_editor_offline_conflict_resolution')) {
+        return;
+      }
+      var state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
+      var unconfirmedSteps = state ? (_getCollabState = getCollabState(state)) === null || _getCollabState === void 0 ? void 0 : _getCollabState.unconfirmed : undefined;
+      if (steps.length > 0 && state && unconfirmedSteps && unconfirmedSteps.length > 0) {
+        // In the future we can determine the type of conflict
+        this.providerEmitCallback('data:conflict', {
+          offlineDoc: state.doc
+        });
+      }
+    }
   }, {
     key: "processQueue",
     value: function processQueue() {
@@ -810,8 +834,8 @@ export var DocumentService = /*#__PURE__*/function () {
   }, {
     key: "sendStepsFromCurrentState",
     value: function sendStepsFromCurrentState(sendAnalyticsEvent) {
-      var _this$getState7;
-      var state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
+      var _this$getState8;
+      var state = (_this$getState8 = this.getState) === null || _this$getState8 === void 0 ? void 0 : _this$getState8.call(this);
       if (!state) {
         var _this$analyticsHelper33;
         (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 || _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');

package/dist/esm/version-wrapper.js

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

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

@@ -62,6 +62,13 @@ export declare class DocumentService implements DocumentServiceInterface {
     private catchupv2;
     private getVersionFromCollabState;
     getCurrentPmVersion: () => number;
+    /**
+     * In the event we reconnect check if we have existing unconfirmed steps and if so
+     * notify the editor that we have a potential conflict to resolve on the frontend.
+     *
+     * @param data remote steps payload
+     */
+    private notifyReconnectionConflict;
     private processQueue;
     getCurrentState: () => Promise<ResolvedEditorState>;
     private isStepsFromNewClientIdForSameUserId;

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

@@ -62,6 +62,13 @@ export declare class DocumentService implements DocumentServiceInterface {
     private catchupv2;
     private getVersionFromCollabState;
     getCurrentPmVersion: () => number;
+    /**
+     * In the event we reconnect check if we have existing unconfirmed steps and if so
+     * notify the editor that we have a potential conflict to resolve on the frontend.
+     *
+     * @param data remote steps payload
+     */
+    private notifyReconnectionConflict;
     private processQueue;
     getCurrentState: () => Promise<ResolvedEditorState>;
     private isStepsFromNewClientIdForSameUserId;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "10.5.0",
+	"version": "10.5.2",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -35,11 +35,11 @@
 		"@atlaskit/adf-utils": "^19.18.0",
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-listeners": "^8.14.0",
-		"@atlaskit/editor-common": "^99.6.0",
+		"@atlaskit/editor-common": "^99.8.0",
 		"@atlaskit/editor-json-transformer": "^8.22.0",
 		"@atlaskit/editor-prosemirror": "6.2.1",
 		"@atlaskit/feature-gate-js-client": "^4.22.0",
-		"@atlaskit/platform-feature-flags": "^0.3.0",
+		"@atlaskit/platform-feature-flags": "^1.0.0",
 		"@atlaskit/prosemirror-collab": "^0.11.0",
 		"@atlaskit/react-ufo": "^2.14.0",
 		"@atlaskit/ufo": "^0.3.0",
@@ -85,6 +85,9 @@
 		"tag_unconfirmed_steps_after_recovery": {
 			"type": "boolean"
 		},
+		"platform_editor_offline_conflict_resolution": {
+			"type": "boolean"
+		},
 		"platform_collab_provider_tracingheaders": {
 			"type": "boolean"
 		},