@atlaskit/collab-provider 7.3.1 → 7.4.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/collab-provider
 
+## 7.4.0
+
+### Minor Changes
+
+- [`de9e3c28026`](https://bitbucket.org/atlassian/atlassian-frontend/commits/de9e3c28026) - [ED-14689] Refactor getFinalAcknowledgedState to only wait for the unconfirmed steps at the time of calling it to be confirmed. It will no longer wait for there to be no unconfirmed steps at all.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 7.3.1
 
 ### Patch Changes

package/channel/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/channel.js",
   "module": "../dist/esm/channel.js",
   "module:es2019": "../dist/es2019/channel.js",
+  "sideEffects": false,
   "types": "../dist/types/channel.d.ts"
 }

package/disconnected-reason-mapper/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/disconnected-reason-mapper.js",
   "module": "../dist/esm/disconnected-reason-mapper.js",
   "module:es2019": "../dist/es2019/disconnected-reason-mapper.js",
+  "sideEffects": false,
   "types": "../dist/types/disconnected-reason-mapper.d.ts"
 }

package/dist/cjs/provider/index.js

@@ -535,70 +535,106 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         });
       }
     });
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
-      var _this$getUnconfirmedS, _this$metadata$title;
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
+      var _this$metadata$title;
 
-      var maxAttemptsToSync, count, unconfirmedSteps, _this$getUnconfirmedS2, _unconfirmedSteps, _state, state;
-
-      return _regenerator.default.wrap(function _callee3$(_context3) {
+      var maxAttemptsToSync, count, unconfirmedState, state;
+      return _regenerator.default.wrap(function _callee4$(_context4) {
         while (1) {
-          switch (_context3.prev = _context3.next) {
+          switch (_context4.prev = _context4.next) {
             case 0:
               maxAttemptsToSync = _const.ACK_MAX_TRY;
               count = 0;
-              unconfirmedSteps = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps;
-
-            case 3:
-              if (!(unconfirmedSteps && unconfirmedSteps.length)) {
-                _context3.next = 13;
-                break;
-              }
-
-              _this.sendStepsFromCurrentState();
-
-              _context3.next = 7;
-              return (0, _utils.sleep)(500);
-
-            case 7:
-              unconfirmedSteps = (_this$getUnconfirmedS2 = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps;
+              unconfirmedState = _this.getUnconfirmedSteps();
 
-              if (!(count++ >= maxAttemptsToSync)) {
-                _context3.next = 11;
+              if (!(unconfirmedState && unconfirmedState.steps.length)) {
+                _context4.next = 5;
                 break;
               }
 
-              if (_this.onSyncUpError) {
-                _state = _this.getState();
-
-                _this.onSyncUpError({
-                  lengthOfUnconfirmedSteps: (_unconfirmedSteps = unconfirmedSteps) === null || _unconfirmedSteps === void 0 ? void 0 : _unconfirmedSteps.length,
-                  tries: count,
-                  maxRetries: maxAttemptsToSync,
-                  clientId: _this.clientId,
-                  version: (0, _prosemirrorCollab.getVersion)(_state)
-                });
-              }
-
-              throw new Error("Can't syncup with Collab Service");
-
-            case 11:
-              _context3.next = 3;
-              break;
-
-            case 13:
+              return _context4.delegateYield( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
+                var unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedState, nextUnconfirmedTrs, _state;
+
+                return _regenerator.default.wrap(function _callee3$(_context3) {
+                  while (1) {
+                    switch (_context3.prev = _context3.next) {
+                      case 0:
+                        // We use origins here as steps can be rebased. When steps are rebased a new step is created.
+                        // This means that we can not track if it has been removed from the unconfirmed array or not.
+                        // Origins points to the original transaction that the step was created in. This is never changed
+                        // and gets passed down when a step is rebased.
+                        unconfirmedTrs = unconfirmedState.origins;
+                        lastTr = unconfirmedTrs[unconfirmedTrs.length - 1];
+                        isLastTrConfirmed = false;
+
+                      case 3:
+                        if (isLastTrConfirmed) {
+                          _context3.next = 14;
+                          break;
+                        }
+
+                        _this.sendStepsFromCurrentState();
+
+                        _context3.next = 7;
+                        return (0, _utils.sleep)(500);
+
+                      case 7:
+                        nextUnconfirmedState = _this.getUnconfirmedSteps();
+
+                        if (nextUnconfirmedState && nextUnconfirmedState.steps.length) {
+                          nextUnconfirmedTrs = nextUnconfirmedState.origins;
+                          isLastTrConfirmed = !nextUnconfirmedTrs.some(function (tr) {
+                            return tr === lastTr;
+                          });
+                        } else {
+                          isLastTrConfirmed = true;
+                        }
+
+                        if (!(!isLastTrConfirmed && count++ >= maxAttemptsToSync)) {
+                          _context3.next = 12;
+                          break;
+                        }
+
+                        if (_this.onSyncUpError) {
+                          _state = _this.getState();
+
+                          _this.onSyncUpError({
+                            lengthOfUnconfirmedSteps: nextUnconfirmedState === null || nextUnconfirmedState === void 0 ? void 0 : nextUnconfirmedState.steps.length,
+                            tries: count,
+                            maxRetries: maxAttemptsToSync,
+                            clientId: _this.clientId,
+                            version: (0, _prosemirrorCollab.getVersion)(_state)
+                          });
+                        }
+
+                        throw new Error("Can't syncup with Collab Service");
+
+                      case 12:
+                        _context3.next = 3;
+                        break;
+
+                      case 14:
+                      case "end":
+                        return _context3.stop();
+                    }
+                  }
+                }, _callee3);
+              })(), "t0", 5);
+
+            case 5:
               state = _this.getState();
-              return _context3.abrupt("return", {
+              return _context4.abrupt("return", {
                 content: state.doc.toJSON(),
                 title: (_this$metadata$title = _this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
                 stepVersion: (0, _prosemirrorCollab.getVersion)(state)
               });
 
-            case 15:
+            case 7:
             case "end":
-              return _context3.stop();
+              return _context4.stop();
           }
         }
-      }, _callee3);
+      }, _callee4);
     })));
     _this.config = config;
     _this.channel = new _channel.Channel(config);

package/dist/cjs/version.json

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

package/dist/es2019/provider/index.js

@@ -424,34 +424,47 @@ export class Provider extends Emitter {
     });
 
     _defineProperty(this, "getFinalAcknowledgedState", async () => {
-      var _this$getUnconfirmedS, _this$metadata$title;
+      var _this$metadata$title;
 
       const maxAttemptsToSync = ACK_MAX_TRY;
       let count = 0;
-      let unconfirmedSteps = (_this$getUnconfirmedS = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps;
-
-      while (unconfirmedSteps && unconfirmedSteps.length) {
-        var _this$getUnconfirmedS2;
-
-        this.sendStepsFromCurrentState();
-        await sleep(500);
-        unconfirmedSteps = (_this$getUnconfirmedS2 = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps;
-
-        if (count++ >= maxAttemptsToSync) {
-          if (this.onSyncUpError) {
-            var _unconfirmedSteps;
-
-            const state = this.getState();
-            this.onSyncUpError({
-              lengthOfUnconfirmedSteps: (_unconfirmedSteps = unconfirmedSteps) === null || _unconfirmedSteps === void 0 ? void 0 : _unconfirmedSteps.length,
-              tries: count,
-              maxRetries: maxAttemptsToSync,
-              clientId: this.clientId,
-              version: getVersion(state)
-            });
+      let unconfirmedState = this.getUnconfirmedSteps();
+
+      if (unconfirmedState && unconfirmedState.steps.length) {
+        // We use origins here as steps can be rebased. When steps are rebased a new step is created.
+        // This means that we can not track if it has been removed from the unconfirmed array or not.
+        // Origins points to the original transaction that the step was created in. This is never changed
+        // and gets passed down when a step is rebased.
+        const unconfirmedTrs = unconfirmedState.origins;
+        const lastTr = unconfirmedTrs[unconfirmedTrs.length - 1];
+        let isLastTrConfirmed = false;
+
+        while (!isLastTrConfirmed) {
+          this.sendStepsFromCurrentState();
+          await sleep(500);
+          const nextUnconfirmedState = this.getUnconfirmedSteps();
+
+          if (nextUnconfirmedState && nextUnconfirmedState.steps.length) {
+            const nextUnconfirmedTrs = nextUnconfirmedState.origins;
+            isLastTrConfirmed = !nextUnconfirmedTrs.some(tr => tr === lastTr);
+          } else {
+            isLastTrConfirmed = true;
           }
 
-          throw new Error("Can't syncup with Collab Service");
+          if (!isLastTrConfirmed && count++ >= maxAttemptsToSync) {
+            if (this.onSyncUpError) {
+              const state = this.getState();
+              this.onSyncUpError({
+                lengthOfUnconfirmedSteps: nextUnconfirmedState === null || nextUnconfirmedState === void 0 ? void 0 : nextUnconfirmedState.steps.length,
+                tries: count,
+                maxRetries: maxAttemptsToSync,
+                clientId: this.clientId,
+                version: getVersion(state)
+              });
+            }
+
+            throw new Error("Can't syncup with Collab Service");
+          }
         }
       }
 

package/dist/es2019/version.json

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

package/dist/esm/provider/index.js

@@ -527,70 +527,106 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       }
     });
 
-    _defineProperty(_assertThisInitialized(_this), "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
-      var _this$getUnconfirmedS, _this$metadata$title;
+    _defineProperty(_assertThisInitialized(_this), "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4() {
+      var _this$metadata$title;
 
-      var maxAttemptsToSync, count, unconfirmedSteps, _this$getUnconfirmedS2, _unconfirmedSteps, _state, state;
-
-      return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+      var maxAttemptsToSync, count, unconfirmedState, state;
+      return _regeneratorRuntime.wrap(function _callee4$(_context4) {
         while (1) {
-          switch (_context3.prev = _context3.next) {
+          switch (_context4.prev = _context4.next) {
             case 0:
               maxAttemptsToSync = ACK_MAX_TRY;
               count = 0;
-              unconfirmedSteps = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.steps;
-
-            case 3:
-              if (!(unconfirmedSteps && unconfirmedSteps.length)) {
-                _context3.next = 13;
-                break;
-              }
-
-              _this.sendStepsFromCurrentState();
-
-              _context3.next = 7;
-              return sleep(500);
-
-            case 7:
-              unconfirmedSteps = (_this$getUnconfirmedS2 = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS2 === void 0 ? void 0 : _this$getUnconfirmedS2.steps;
+              unconfirmedState = _this.getUnconfirmedSteps();
 
-              if (!(count++ >= maxAttemptsToSync)) {
-                _context3.next = 11;
+              if (!(unconfirmedState && unconfirmedState.steps.length)) {
+                _context4.next = 5;
                 break;
               }
 
-              if (_this.onSyncUpError) {
-                _state = _this.getState();
-
-                _this.onSyncUpError({
-                  lengthOfUnconfirmedSteps: (_unconfirmedSteps = unconfirmedSteps) === null || _unconfirmedSteps === void 0 ? void 0 : _unconfirmedSteps.length,
-                  tries: count,
-                  maxRetries: maxAttemptsToSync,
-                  clientId: _this.clientId,
-                  version: getVersion(_state)
-                });
-              }
-
-              throw new Error("Can't syncup with Collab Service");
-
-            case 11:
-              _context3.next = 3;
-              break;
-
-            case 13:
+              return _context4.delegateYield( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
+                var unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedState, nextUnconfirmedTrs, _state;
+
+                return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+                  while (1) {
+                    switch (_context3.prev = _context3.next) {
+                      case 0:
+                        // We use origins here as steps can be rebased. When steps are rebased a new step is created.
+                        // This means that we can not track if it has been removed from the unconfirmed array or not.
+                        // Origins points to the original transaction that the step was created in. This is never changed
+                        // and gets passed down when a step is rebased.
+                        unconfirmedTrs = unconfirmedState.origins;
+                        lastTr = unconfirmedTrs[unconfirmedTrs.length - 1];
+                        isLastTrConfirmed = false;
+
+                      case 3:
+                        if (isLastTrConfirmed) {
+                          _context3.next = 14;
+                          break;
+                        }
+
+                        _this.sendStepsFromCurrentState();
+
+                        _context3.next = 7;
+                        return sleep(500);
+
+                      case 7:
+                        nextUnconfirmedState = _this.getUnconfirmedSteps();
+
+                        if (nextUnconfirmedState && nextUnconfirmedState.steps.length) {
+                          nextUnconfirmedTrs = nextUnconfirmedState.origins;
+                          isLastTrConfirmed = !nextUnconfirmedTrs.some(function (tr) {
+                            return tr === lastTr;
+                          });
+                        } else {
+                          isLastTrConfirmed = true;
+                        }
+
+                        if (!(!isLastTrConfirmed && count++ >= maxAttemptsToSync)) {
+                          _context3.next = 12;
+                          break;
+                        }
+
+                        if (_this.onSyncUpError) {
+                          _state = _this.getState();
+
+                          _this.onSyncUpError({
+                            lengthOfUnconfirmedSteps: nextUnconfirmedState === null || nextUnconfirmedState === void 0 ? void 0 : nextUnconfirmedState.steps.length,
+                            tries: count,
+                            maxRetries: maxAttemptsToSync,
+                            clientId: _this.clientId,
+                            version: getVersion(_state)
+                          });
+                        }
+
+                        throw new Error("Can't syncup with Collab Service");
+
+                      case 12:
+                        _context3.next = 3;
+                        break;
+
+                      case 14:
+                      case "end":
+                        return _context3.stop();
+                    }
+                  }
+                }, _callee3);
+              })(), "t0", 5);
+
+            case 5:
               state = _this.getState();
-              return _context3.abrupt("return", {
+              return _context4.abrupt("return", {
                 content: state.doc.toJSON(),
                 title: (_this$metadata$title = _this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
                 stepVersion: getVersion(state)
               });
 
-            case 15:
+            case 7:
             case "end":
-              return _context3.stop();
+              return _context4.stop();
           }
         }
-      }, _callee3);
+      }, _callee4);
     })));
 
     _this.config = config;

package/dist/esm/version.json

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

package/emitter/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/emitter.js",
   "module": "../dist/esm/emitter.js",
   "module:es2019": "../dist/es2019/emitter.js",
+  "sideEffects": false,
   "types": "../dist/types/emitter.d.ts"
 }

package/error-code-mapper/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/error-code-mapper.js",
   "module": "../dist/esm/error-code-mapper.js",
   "module:es2019": "../dist/es2019/error-code-mapper.js",
+  "sideEffects": false,
   "types": "../dist/types/error-code-mapper.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "7.3.1",
+  "version": "7.4.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -23,7 +23,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "5.0.6",
     "@atlaskit/analytics-listeners": "^8.2.0",
-    "@atlaskit/editor-common": "^66.0.0",
+    "@atlaskit/editor-common": "^67.0.0",
     "@atlaskit/editor-json-transformer": "^8.7.0",
     "@atlaskit/util-service-support": "^6.1.0",
     "@babel/runtime": "^7.0.0",
@@ -39,7 +39,8 @@
       "tree-shaking": []
     },
     "@repo/internal": {
-      "deprecation": "no-deprecated-imports"
+      "deprecation": "no-deprecated-imports",
+      "theming": "tokens"
     }
   },
   "devDependencies": {

package/socket-io-provider/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/socket-io-provider.js",
   "module": "../dist/esm/socket-io-provider.js",
   "module:es2019": "../dist/es2019/socket-io-provider.js",
+  "sideEffects": false,
   "types": "../dist/types/socket-io-provider.d.ts"
 }

package/types/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/types.js",
   "module": "../dist/esm/types.js",
   "module:es2019": "../dist/es2019/types.js",
+  "sideEffects": false,
   "types": "../dist/types/types.d.ts"
 }