@atlaskit/collab-provider 9.7.4 → 9.9.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.9.0
+
+### Minor Changes
+
+- [`4c6ebd50aeb`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4c6ebd50aeb) - call reconcile when commitUnconfirmedSteps fails (mitigation for 'can't sync up' errors)
+
+## 9.8.0
+
+### Minor Changes
+
+- [`aceff84b101`](https://bitbucket.org/atlassian/atlassian-frontend/commits/aceff84b101) - initializing provider on setup if buffering is enabled
+
 ## 9.7.4
 
 ### Patch Changes

package/dist/cjs/channel.js

@@ -332,6 +332,112 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         return _ref.apply(this, arguments);
       };
     }());
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "fetchReconcile", /*#__PURE__*/function () {
+      var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(currentStateDoc) {
+        var _ref4, _this$token2, reqBody, reconcileResponse, _this$analyticsHelper7;
+        return _regenerator.default.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.prev = 0;
+              reqBody = JSON.stringify({
+                doc: currentStateDoc,
+                productId: 'ccollab',
+                reason: 'UNKNOWN' // different reason here?
+              });
+              _context2.t0 = _utilServiceSupport.utils;
+              _context2.t1 = _this.config;
+              _context2.t2 = "document/".concat(encodeURIComponent(_this.config.documentAri), "/reconcile");
+              _context2.t3 = _objectSpread;
+              _context2.t4 = _objectSpread;
+              _context2.t5 = {};
+              if (!_this.config.permissionTokenRefresh) {
+                _context2.next = 29;
+                break;
+              }
+              if (!((_this$token2 = _this.token) !== null && _this$token2 !== void 0)) {
+                _context2.next = 13;
+                break;
+              }
+              _context2.t8 = _this$token2;
+              _context2.next = 16;
+              break;
+            case 13:
+              _context2.next = 15;
+              return _this.config.permissionTokenRefresh().then(function (token) {
+                if (token) {
+                  _this.setToken(token);
+                }
+                return token;
+              });
+            case 15:
+              _context2.t8 = _context2.sent;
+            case 16:
+              _context2.t9 = _ref4 = _context2.t8;
+              _context2.t7 = _context2.t9 !== null;
+              if (!_context2.t7) {
+                _context2.next = 20;
+                break;
+              }
+              _context2.t7 = _ref4 !== void 0;
+            case 20:
+              if (!_context2.t7) {
+                _context2.next = 24;
+                break;
+              }
+              _context2.t10 = _ref4;
+              _context2.next = 25;
+              break;
+            case 24:
+              _context2.t10 = undefined;
+            case 25:
+              _context2.t11 = _context2.t10;
+              _context2.t6 = {
+                'x-token': _context2.t11
+              };
+              _context2.next = 30;
+              break;
+            case 29:
+              _context2.t6 = {};
+            case 30:
+              _context2.t12 = _context2.t6;
+              _context2.t13 = (0, _context2.t4)(_context2.t5, _context2.t12);
+              _context2.t14 = {};
+              _context2.t15 = {
+                'x-product': (0, _utils.getProduct)(_this.config.productInfo),
+                'x-subproduct': (0, _utils.getSubProduct)(_this.config.productInfo),
+                'Content-Type': 'application/json'
+              };
+              _context2.t16 = (0, _context2.t3)(_context2.t13, _context2.t14, _context2.t15);
+              _context2.t17 = reqBody;
+              _context2.t18 = {
+                headers: _context2.t16,
+                method: 'POST',
+                body: _context2.t17
+              };
+              _context2.t19 = {
+                path: _context2.t2,
+                requestInit: _context2.t18
+              };
+              _context2.next = 40;
+              return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t19);
+            case 40:
+              reconcileResponse = _context2.sent;
+              return _context2.abrupt("return", reconcileResponse);
+            case 44:
+              _context2.prev = 44;
+              _context2.t20 = _context2["catch"](0);
+              (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(_context2.t20, 'Error while fetching reconciled document');
+              throw _context2.t20;
+            case 48:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, null, [[0, 44]]);
+      }));
+      return function (_x2) {
+        return _ref3.apply(this, arguments);
+      };
+    }());
     /**
      * Send message to the back-end service over the channel. Timestamp will be added server side.
      * @throws {NotInitializedError} Channel not initialized
@@ -416,10 +522,10 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       var auth;
       if (permissionTokenRefresh) {
         auth = /*#__PURE__*/function () {
-          var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(cb) {
+          var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(cb) {
             var authData, token, _data, _data$meta, authenticationError;
-            return _regenerator.default.wrap(function _callee2$(_context2) {
-              while (1) switch (_context2.prev = _context2.next) {
+            return _regenerator.default.wrap(function _callee3$(_context3) {
+              while (1) switch (_context3.prev = _context3.next) {
                 case 0:
                   // Rebuild authData to ensure values are current
                   authData = {
@@ -429,19 +535,19 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                     need404: _this2.config.need404
                   }; // use the cached token if caching in enabled and token valid
                   if (!(cacheToken && _this2.token)) {
-                    _context2.next = 6;
+                    _context3.next = 6;
                     break;
                   }
                   authData.token = _this2.token;
                   cb(authData);
-                  _context2.next = 18;
+                  _context3.next = 18;
                   break;
                 case 6:
-                  _context2.prev = 6;
-                  _context2.next = 9;
+                  _context3.prev = 6;
+                  _context3.next = 9;
                   return permissionTokenRefresh();
                 case 9:
-                  token = _context2.sent;
+                  token = _context3.sent;
                   if (token) {
                     // save token locally
                     _this2.setToken(token);
@@ -451,11 +557,11 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                     authData.token = undefined;
                   }
                   cb(authData);
-                  _context2.next = 18;
+                  _context3.next = 18;
                   break;
                 case 14:
-                  _context2.prev = 14;
-                  _context2.t0 = _context2["catch"](6);
+                  _context3.prev = 14;
+                  _context3.t0 = _context3["catch"](6);
                   // Pass the error back to the consumers so they can deal with exceptional cases themselves (eg. no permissions because the page was deleted)
                   authenticationError = {
                     message: 'Insufficient editing permissions',
@@ -463,8 +569,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                       status: 403,
                       code: _errorTypes.INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR,
                       meta: {
-                        originalError: _context2.t0,
-                        reason: _context2.t0 === null || _context2.t0 === void 0 ? void 0 : (_data = _context2.t0.data) === null || _data === void 0 ? void 0 : (_data$meta = _data.meta) === null || _data$meta === void 0 ? void 0 : _data$meta.reason // Should always be 'RESOURCE_DELETED' Temporary, until Confluence Cloud removes their hack
+                        originalError: _context3.t0,
+                        reason: _context3.t0 === null || _context3.t0 === void 0 ? void 0 : (_data = _context3.t0.data) === null || _data === void 0 ? void 0 : (_data$meta = _data.meta) === null || _data$meta === void 0 ? void 0 : _data$meta.reason // Should always be 'RESOURCE_DELETED' Temporary, until Confluence Cloud removes their hack
                         // https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/browse/next/packages/native-collab/src/fetchCollabPermissionToken.ts#37
                       }
                     }
@@ -473,12 +579,12 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                   _this2.emit('error', authenticationError);
                 case 18:
                 case "end":
-                  return _context2.stop();
+                  return _context3.stop();
               }
-            }, _callee2, null, [[6, 14]]);
+            }, _callee3, null, [[6, 14]]);
           }));
-          return function auth(_x2) {
-            return _ref3.apply(this, arguments);
+          return function auth(_x3) {
+            return _ref5.apply(this, arguments);
           };
         }();
       } else {
@@ -502,9 +608,9 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       this.socket.on('steps:added', function (data) {
         _this2.emit('steps:added', data);
       });
-      this.socket.on('participant:telepointer', function (_ref4) {
-        var timestamp = _ref4.timestamp,
-          data = _ref4.data;
+      this.socket.on('participant:telepointer', function (_ref6) {
+        var timestamp = _ref6.timestamp,
+          data = _ref6.data;
         // data is TelepointerPayload without timestamp
         _this2.emit('participant:telepointer', _objectSpread({
           timestamp: timestamp
@@ -519,11 +625,11 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       this.socket.on('participant:left', function (data) {
         _this2.emit('participant:left', data);
       });
-      this.socket.on('participant:updated', function (_ref5) {
-        var sessionId = _ref5.sessionId,
-          timestamp = _ref5.timestamp,
-          data = _ref5.data,
-          clientId = _ref5.clientId;
+      this.socket.on('participant:updated', function (_ref7) {
+        var sessionId = _ref7.sessionId,
+          timestamp = _ref7.timestamp,
+          data = _ref7.data,
+          clientId = _ref7.clientId;
         _this2.emit('participant:updated', _objectSpread({
           sessionId: sessionId,
           timestamp: timestamp,
@@ -539,10 +645,10 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         _this2.emit('status', data);
       });
       this.socket.on('disconnect', /*#__PURE__*/function () {
-        var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(reason) {
+        var _ref8 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(reason) {
           var _this2$analyticsHelpe, reconnectionError;
-          return _regenerator.default.wrap(function _callee3$(_context3) {
-            while (1) switch (_context3.prev = _context3.next) {
+          return _regenerator.default.wrap(function _callee4$(_context4) {
+            while (1) switch (_context4.prev = _context4.next) {
               case 0:
                 if ((0, _featureFlags.getCollabProviderFeatureFlag)('socketMessageMetricsFF', _this2.config.featureFlags) && _this2.socketMessageMetrics) {
                   _this2.socketMessageMetrics.closeSocketMessageMetrics();
@@ -570,12 +676,12 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                 }
               case 5:
               case "end":
-                return _context3.stop();
+                return _context4.stop();
             }
-          }, _callee3);
+          }, _callee4);
         }));
-        return function (_x3) {
-          return _ref6.apply(this, arguments);
+        return function (_x4) {
+          return _ref8.apply(this, arguments);
         };
       }());
 
@@ -665,8 +771,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                 this.emit('error', rateLimitError);
                 throw new Error();
               } else if (rateLimitType === this.RATE_LIMIT_TYPE_SOFT) {
-                var _this$analyticsHelper7;
-                (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(rateLimitError, 'Rate limited');
+                var _this$analyticsHelper8;
+                (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(rateLimitError, 'Rate limited');
               }
             }
           }

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

@@ -20,6 +20,7 @@ var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
 var _provider = require("../provider");
 var _catchup = require("./catchup");
 var _stepQueueState = require("./step-queue-state");
+var _featureFlags = require("../feature-flags");
 var _errorTypes = require("../errors/error-types");
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -36,6 +37,7 @@ var DocumentService = /*#__PURE__*/function () {
    * and to emit their telepointers from steps they add
    * @param analyticsHelper - Helper for analytics events
    * @param fetchCatchup - Function to fetch "catchup" data, data required to rebase current steps to the latest version.
+   * @param fetchReconcile - Function to call "reconcile" from NCS backend
    * @param providerEmitCallback - Callback for emitting events to listeners on the provider
    * @param broadcast - Callback for broadcasting events to other clients
    * @param getUserId - Callback to fetch the current user's ID
@@ -43,11 +45,13 @@ var DocumentService = /*#__PURE__*/function () {
    * @param metadataService
    * @param failedStepsBeforeCatchupOnPublish - Control MAX_STEP_REJECTED_ERROR during page publishes.
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
+   * @param featureFlags - Feature flag config
    */
-  function DocumentService(participantsService, analyticsHelper, fetchCatchup, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
+  function DocumentService(participantsService, analyticsHelper, fetchCatchup, fetchReconcile, providerEmitCallback, broadcast, getUserId, onErrorHandled, metadataService) {
     var _this = this;
-    var failedStepsBeforeCatchupOnPublish = arguments.length > 8 && arguments[8] !== undefined ? arguments[8] : _provider.MAX_STEP_REJECTED_ERROR;
-    var enableErrorOnFailedDocumentApply = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : false;
+    var failedStepsBeforeCatchupOnPublish = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : _provider.MAX_STEP_REJECTED_ERROR;
+    var enableErrorOnFailedDocumentApply = arguments.length > 10 && arguments[10] !== undefined ? arguments[10] : false;
+    var featureFlags = arguments.length > 11 ? arguments[11] : undefined;
     (0, _classCallCheck2.default)(this, DocumentService);
     // Fires analytics to editor when collab editor cannot sync up
     (0, _defineProperty2.default)(this, "stepRejectCounter", 0);
@@ -283,41 +287,76 @@ var DocumentService = /*#__PURE__*/function () {
       }
     });
     (0, _defineProperty2.default)(this, "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
-      var _this$analyticsHelper14, currentState, measure, _this$analyticsHelper15, _this$analyticsHelper16, _measure2;
+      var _this$analyticsHelper14, finalAcknowledgedState, currentState, reconcileResponse, measure, _this$analyticsHelper15, _this$analyticsHelper16, _measure2;
       return _regenerator.default.wrap(function _callee3$(_context3) {
         while (1) switch (_context3.prev = _context3.next) {
           case 0:
             _this.aggressiveCatchup = true;
             _context3.prev = 1;
             (0, _performance.startMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-            _context3.next = 5;
-            return _this.commitUnconfirmedSteps();
-          case 5:
+            if (!(0, _featureFlags.getCollabProviderFeatureFlag)('enableFallbackToReconcile', _this.featureFlags)) {
+              _context3.next = 23;
+              break;
+            }
+            _context3.prev = 4;
             _context3.next = 7;
-            return _this.getCurrentState();
+            return _this.commitUnconfirmedSteps();
           case 7:
+            _context3.next = 9;
+            return _this.getCurrentState();
+          case 9:
+            finalAcknowledgedState = _context3.sent;
+            _context3.next = 21;
+            break;
+          case 12:
+            _context3.prev = 12;
+            _context3.t0 = _context3["catch"](4);
+            _context3.next = 16;
+            return _this.getCurrentState();
+          case 16:
             currentState = _context3.sent;
+            _context3.next = 19;
+            return _this.fetchReconcile(JSON.stringify(currentState.content));
+          case 19:
+            reconcileResponse = _context3.sent;
+            finalAcknowledgedState = {
+              content: JSON.parse(reconcileResponse.document),
+              title: currentState.title,
+              stepVersion: reconcileResponse.version
+            };
+          case 21:
+            _context3.next = 28;
+            break;
+          case 23:
+            _context3.next = 25;
+            return _this.commitUnconfirmedSteps();
+          case 25:
+            _context3.next = 27;
+            return _this.getCurrentState();
+          case 27:
+            finalAcknowledgedState = _context3.sent;
+          case 28:
             measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
             (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.SUCCESS, {
               latency: measure === null || measure === void 0 ? void 0 : measure.duration
             });
             _this.aggressiveCatchup = false;
-            return _context3.abrupt("return", currentState);
-          case 14:
-            _context3.prev = 14;
-            _context3.t0 = _context3["catch"](1);
+            return _context3.abrupt("return", finalAcknowledgedState);
+          case 34:
+            _context3.prev = 34;
+            _context3.t1 = _context3["catch"](1);
             _this.aggressiveCatchup = false;
             _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
             (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.FAILURE, {
               latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration
             });
-            (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
-            throw _context3.t0;
-          case 21:
+            (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendErrorEvent(_context3.t1, 'Error while returning ADF version of the final draft document');
+            throw _context3.t1;
+          case 41:
           case "end":
             return _context3.stop();
         }
-      }, _callee3, null, [[1, 14]]);
+      }, _callee3, null, [[1, 34], [4, 12]]);
     })));
     (0, _defineProperty2.default)(this, "updateDocument", function (_ref6) {
       var doc = _ref6.doc,
@@ -495,6 +534,7 @@ var DocumentService = /*#__PURE__*/function () {
     this.participantsService = participantsService;
     this.analyticsHelper = analyticsHelper;
     this.fetchCatchup = fetchCatchup;
+    this.fetchReconcile = fetchReconcile;
     this.providerEmitCallback = providerEmitCallback;
     this.broadcast = broadcast;
     this.getUserId = getUserId;
@@ -502,6 +542,7 @@ var DocumentService = /*#__PURE__*/function () {
     this.metadataService = metadataService;
     this.failedStepsBeforeCatchupOnPublish = failedStepsBeforeCatchupOnPublish;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
+    this.featureFlags = featureFlags;
     this.stepQueue = new _stepQueueState.StepQueueState();
   }
   (0, _createClass2.default)(DocumentService, [{

package/dist/cjs/feature-flags/__test__/index.unit.js

@@ -5,9 +5,10 @@ describe('Feature flags', function () {
   it('getProductSpecificFeatureFlags', function () {
     var result = (0, _index.getProductSpecificFeatureFlags)({
       testFF: true,
-      socketMessageMetricsFF: true
+      socketMessageMetricsFF: true,
+      enableFallbackToReconcile: true
     }, 'confluence');
-    expect(result).toEqual(['confluence.fe.collab.provider.testFF', 'confluence.fe.collab.provider.socketMessageMetricsFF']);
+    expect(result).toEqual(['confluence.frontend.collab.provider.testFF', 'confluence.frontend.collab.provider.socketMessageMetricsFF', 'confluence.frontend.collab.provider.enable-fallback-to-reconcile']);
   });
   it('getCollabProviderFeatureFlag return true', function () {
     var result = (0, _index.getCollabProviderFeatureFlag)('testFF', {

package/dist/cjs/feature-flags/index.js

@@ -9,7 +9,8 @@ exports.getProductSpecificFeatureFlags = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var defaultNCSFeatureFlags = {
   testFF: false,
-  socketMessageMetricsFF: false
+  socketMessageMetricsFF: false,
+  enableFallbackToReconcile: false
 };
 
 /**
@@ -17,8 +18,9 @@ var defaultNCSFeatureFlags = {
  */
 var productKeys = {
   confluence: {
-    testFF: 'confluence.fe.collab.provider.testFF',
-    socketMessageMetricsFF: 'confluence.fe.collab.provider.socketMessageMetricsFF'
+    testFF: 'confluence.frontend.collab.provider.testFF',
+    socketMessageMetricsFF: 'confluence.frontend.collab.provider.socketMessageMetricsFF',
+    enableFallbackToReconcile: 'confluence.frontend.collab.provider.enable-fallback-to-reconcile'
   }
 };
 var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {

package/dist/cjs/provider/index.js

@@ -43,6 +43,10 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     _this = _super.call(this);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isChannelInitialized", false);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isProviderInitialized", false);
+    // isBufferingEnabled is a boolean value passed to the config during provider creation.
+    // It determines if the provider should initialize immediately and will only be true if:
+    // the feature flag is enabled and the initial draft fetched from NCS is also passed in the config.
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isBufferingEnabled", false);
     // isPreinitializating acts as a feature flag to determine when the provider has been initialized early
     // and also contains the initial draft
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isPreinitializing", false);
@@ -96,6 +100,13 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         var sid = _ref2.sid,
           initialized = _ref2.initialized;
         _this.sessionId = sid;
+        // if buffering is enabled and the provider is initialized before connection, call catchup
+        // once setup resolves with the defined editor state
+        if (_this.isBufferingEnabled && _this.isProviderInitialized) {
+          _this.onSetupPromise.then(function () {
+            _this.documentService.sendStepsFromCurrentState();
+          });
+        }
         _this.emitCallback('connected', {
           sid: sid,
           initial: !initialized
@@ -271,13 +282,14 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     _this.channel = new _channel.Channel(config, _this.analyticsHelper);
     _this.isChannelInitialized = false;
     _this.initialDraft = _this.config.initialDraft;
+    _this.isBufferingEnabled = Boolean(_this.config.isBufferingEnabled);
     _this.isProviderInitialized = false;
     _this.isPreinitializing = false;
     _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);
-    _this.documentService = new _documentService.DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.emitCallback, _this.channel.broadcast, function () {
+    _this.documentService = new _documentService.DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService, _this.config.failedStepLimitBeforeCatchupOnPublish, _this.config.enableErrorOnFailedDocumentApply);
+    }, _this.onErrorHandled, _this.metadataService, _this.config.failedStepLimitBeforeCatchupOnPublish, _this.config.enableErrorOnFailedDocumentApply, _this.config.featureFlags);
     _this.onSetupPromise = new Promise(function (resolve) {
       _this.resolveOnSetupPromise = resolve;
     });
@@ -341,6 +353,17 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           // a defined getState (ie editor state is ready) AND after documentService sets the editor state
           if (this.isPreinitializing) {
             this.resolveOnSetupPromise();
+            if (this.isBufferingEnabled && this.initialDraft && !this.isProviderInitialized) {
+              var _this$initialDraft2 = this.initialDraft,
+                document = _this$initialDraft2.document,
+                version = _this$initialDraft2.version,
+                metadata = _this$initialDraft2.metadata;
+              this.updateDocumentAndMetadata({
+                doc: document,
+                version: version,
+                metadata: metadata
+              });
+            }
           }
         }
         if (!this.isChannelInitialized) {
@@ -374,8 +397,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
   }, {
     key: "isDraftTimestampStale",
     value: function isDraftTimestampStale() {
-      var _this$initialDraft2;
-      if (!((_this$initialDraft2 = this.initialDraft) !== null && _this$initialDraft2 !== void 0 && _this$initialDraft2.timestamp)) {
+      var _this$initialDraft3;
+      if (!((_this$initialDraft3 = this.initialDraft) !== null && _this$initialDraft3 !== void 0 && _this$initialDraft3.timestamp)) {
         return false;
       }
       return Date.now() - this.initialDraft.timestamp >= PRELOAD_DRAFT_SYNC_PERIOD;

package/dist/cjs/version-wrapper.js

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

package/dist/cjs/version.json

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

package/dist/es2019/channel.js

@@ -228,6 +228,42 @@ export class Channel extends Emitter {
         throw error;
       }
     });
+    _defineProperty(this, "fetchReconcile", async currentStateDoc => {
+      try {
+        var _ref2, _this$token2;
+        const reqBody = JSON.stringify({
+          doc: currentStateDoc,
+          productId: 'ccollab',
+          reason: 'UNKNOWN' // different reason here?
+        });
+
+        const reconcileResponse = await utils.requestService(this.config, {
+          path: `document/${encodeURIComponent(this.config.documentAri)}/reconcile`,
+          requestInit: {
+            headers: {
+              ...(this.config.permissionTokenRefresh ? {
+                'x-token': (_ref2 = (_this$token2 = this.token) !== null && _this$token2 !== void 0 ? _this$token2 : await this.config.permissionTokenRefresh().then(token => {
+                  if (token) {
+                    this.setToken(token);
+                  }
+                  return token;
+                })) !== null && _ref2 !== void 0 ? _ref2 : undefined
+              } : {}),
+              'x-product': getProduct(this.config.productInfo),
+              'x-subproduct': getSubProduct(this.config.productInfo),
+              'Content-Type': 'application/json'
+            },
+            method: 'POST',
+            body: reqBody
+          }
+        });
+        return reconcileResponse;
+      } catch (error) {
+        var _this$analyticsHelper7;
+        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(error, 'Error while fetching reconciled document');
+        throw error;
+      }
+    });
     /**
      * Send message to the back-end service over the channel. Timestamp will be added server side.
      * @throws {NotInitializedError} Channel not initialized
@@ -429,8 +465,8 @@ export class Channel extends Emitter {
         try {
           this.socket.connect();
         } catch (error) {
-          var _this$analyticsHelper7;
-          (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(error, 'Error while reconnecting the channel');
+          var _this$analyticsHelper8;
+          (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(error, 'Error while reconnecting the channel');
           const reconnectionError = {
             message: 'Caught error during reconnection',
             data: {
@@ -509,8 +545,8 @@ export class Channel extends Emitter {
             this.emit('error', rateLimitError);
             throw new Error();
           } else if (rateLimitType === this.RATE_LIMIT_TYPE_SOFT) {
-            var _this$analyticsHelper8;
-            (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(rateLimitError, 'Rate limited');
+            var _this$analyticsHelper9;
+            (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(rateLimitError, 'Rate limited');
           }
         }
       }