@atlaskit/collab-provider 10.4.0 → 10.4.1

package/dist/es2019/analytics/analytics-helper.js

@@ -58,8 +58,6 @@ const triggerAnalyticsEvent = (analyticsEvent, analyticsClient) => {
   }
 };
 export default class AnalyticsHelper {
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/max-params
   constructor(documentAri, subProduct, analyticsClient, getAnalyticsClient) {
     this.documentAri = documentAri;
     this.subProduct = subProduct;

package/dist/es2019/api/api.js

@@ -1,5 +1,8 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { getProduct, getSubProduct, createLogger } from '../helpers/utils';
+import { getActiveTraceHttpRequestHeaders } from '@atlaskit/react-ufo/experience-trace-id-context';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { addFeatureFlagAccessed } from '@atlaskit/react-ufo/feature-flags-accessed';
 const logger = createLogger('Api', 'blue');
 class AddCommentError extends Error {
   constructor(message, status, meta) {
@@ -27,6 +30,14 @@ export class Api {
       });
       const url = `${this.config.url}/document/${encodeURIComponent(this.config.documentAri)}/comment`;
       logger(`Request url: `, url);
+
+      //Get tracing headers from UFO
+      const tracingHeaderEnabled = fg('platform_collab_provider_tracingheaders');
+      addFeatureFlagAccessed('platform_collab_provider_tracingheaders', tracingHeaderEnabled);
+      let tracingHeaders = {};
+      if (tracingHeaderEnabled) {
+        tracingHeaders = getActiveTraceHttpRequestHeaders(url);
+      }
       const fetchOptions = {
         credentials: 'include',
         headers: {
@@ -35,7 +46,8 @@ export class Api {
           } : {}),
           'x-product': getProduct(this.config.productInfo),
           'x-subproduct': getSubProduct(this.config.productInfo),
-          'Content-Type': 'application/json'
+          'Content-Type': 'application/json',
+          ...tracingHeaders
         },
         method: 'POST',
         body: reqBody

package/dist/es2019/channel.js

@@ -173,8 +173,6 @@ export class Channel extends Emitter {
         this.emit('steps:added', data);
       }
     });
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/max-params
     _defineProperty(this, "fetchCatchupv2", async (fromVersion, clientId, catchUpOutofSync, reason) => {
       try {
         const {

package/dist/es2019/document/catchupv2.js

@@ -68,9 +68,6 @@ const logObfuscatedSteps = (steps, opt) => {
  * @param clientId The ID of the currently connected session (one user can have multiple if theu have multiple tabs open)
  * @returns True if we're out of sync, false if not.
  */
-export const isOutOfSync = (fromVersion, currentVersion, steps, clientId
-// Ignored via go/ees005
-// eslint-disable-next-line @typescript-eslint/max-params
-) =>
+export const isOutOfSync = (fromVersion, currentVersion, steps, clientId) =>
 // If version number hasn't increased, and steps are not from our client, we're out of sync
 Boolean(fromVersion >= currentVersion && steps.some(step => step.clientId !== clientId));

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

@@ -34,8 +34,6 @@ export class DocumentService {
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    * @param getConnected - if the channel is currently connected
    */
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/max-params
   constructor(participantsService, analyticsHelper, fetchCatchupv2, fetchReconcile,
   // Ignored via go/ees005
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -46,6 +44,7 @@ export class DocumentService {
     _defineProperty(this, "stepRejectCounter", 0);
     _defineProperty(this, "aggressiveCatchup", false);
     _defineProperty(this, "catchUpOutofSync", false);
+    _defineProperty(this, "hasRecovered", false);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      * @param reason - optional reason to attach.
@@ -283,6 +282,9 @@ export class DocumentService {
       metadata,
       targetClientId
     }) => {
+      if (!targetClientId) {
+        this.hasRecovered = true;
+      }
       if (targetClientId && this.clientId !== targetClientId) {
         return;
       }
@@ -704,8 +706,6 @@ export class DocumentService {
    * Send steps from transaction to other participants
    * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
    */
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/max-params
   send(_tr, _oldState, newState, sendAnalyticsEvent) {
     const unconfirmedStepsData = sendableSteps(newState);
     const version = this.getVersionFromCollabState(newState, 'collab-provider: send');
@@ -763,7 +763,8 @@ export class DocumentService {
       onErrorHandled: this.onErrorHandled,
       analyticsHelper: this.analyticsHelper,
       emit: this.providerEmitCallback,
-      __livePage: this.options.__livePage
+      __livePage: this.options.__livePage,
+      hasRecovered: this.hasRecovered
     });
   }
 }

package/dist/es2019/helpers/utils.js

@@ -1,4 +1,6 @@
 import { scrubAdf } from '@atlaskit/adf-utils/scrub';
+import { sendableSteps } from '@atlaskit/prosemirror-collab';
+import { CustomError } from '../errors/custom-errors';
 export const createLogger = (prefix, color = 'blue') =>
 // Ignored via go/ees005
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -179,4 +181,31 @@ const stepToAdf = step => {
     });
   }
   return [];
-};
+};
+export async function logObfuscatedSteps(oldState, newState) {
+  try {
+    var _states$new, _states$old;
+    let stepsFromOldState = '',
+      stepsFromNewState = '';
+    const states = {
+      old: oldState ? sendableSteps(oldState) : null,
+      new: sendableSteps(newState)
+    };
+    if ((_states$new = states.new) !== null && _states$new !== void 0 && _states$new.steps) {
+      stepsFromNewState = await toObfuscatedSteps(states.new.steps);
+    }
+    if ((_states$old = states.old) !== null && _states$old !== void 0 && _states$old.steps) {
+      stepsFromOldState = await toObfuscatedSteps(states.old.steps);
+    }
+    return {
+      stepsFromOldState,
+      stepsFromNewState
+    };
+  } catch (err) {
+    return new CustomError('Failed to obfuscate steps', err);
+  }
+}
+export async function toObfuscatedSteps(steps) {
+  const _steps = await Promise.resolve(steps.slice().map(s => s.toJSON()));
+  return JSON.stringify(getObfuscatedSteps(_steps));
+}

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

@@ -18,8 +18,6 @@ const SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
  * @param sendPresenceJoined Callback to Channel class
  */
 export class ParticipantsService {
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/max-params
   constructor(analyticsHelper, participantsState = new ParticipantsState(), emit, getUser, channelBroadcast, sendPresenceJoined, getPresenceData, setUserId, getAIProviderActiveIds) {
     _defineProperty(this, "sendAIProviderChanged", payload => {
       if (payload.providerId) {

package/dist/es2019/provider/commit-step.js

@@ -17,7 +17,8 @@ export const commitStepQueue = ({
   onErrorHandled,
   analyticsHelper,
   emit,
-  __livePage
+  __livePage,
+  hasRecovered
 }) => {
   if (!readyToCommit) {
     logger('Not ready to commit, skip');
@@ -60,6 +61,17 @@ export const commitStepQueue = ({
       return step;
     });
   }
+
+  // tag unconfirmed steps sent after page has been recovered during client's editing session
+  if (hasRecovered && fg('tag_unconfirmed_steps_after_recovery')) {
+    stepsWithClientAndUserId = stepsWithClientAndUserId.map(step => {
+      step.metadata = {
+        ...step.metadata,
+        unconfirmedStepAfterRecovery: true
+      };
+      return step;
+    });
+  }
   const start = new Date().getTime();
   emit('commit-status', {
     status: 'attempt',

package/dist/es2019/provider/index.js

@@ -1,11 +1,12 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { v4 as uuidv4 } from 'uuid';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { Emitter } from '../emitter';
 import { Channel } from '../channel';
-import { createLogger } from '../helpers/utils';
+import { createLogger, logObfuscatedSteps } from '../helpers/utils';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import { telepointerCallback } from '../participants/telepointers-helper';
-import { DestroyError, GetCurrentStateError, GetFinalAcknowledgedStateError, ProviderInitialisationError, SendTransactionError, SetEditorWidthError, SetMetadataError, SetTitleError } from '../errors/custom-errors';
+import { CustomError, DestroyError, GetCurrentStateError, GetFinalAcknowledgedStateError, ProviderInitialisationError, SendTransactionError, SetEditorWidthError, SetMetadataError, SetTitleError } from '../errors/custom-errors';
 import { NCS_ERROR_CODE } from '../errors/ncs-errors';
 import { MetadataService } from '../metadata/metadata-service';
 import { DocumentService } from '../document/document-service';
@@ -140,7 +141,13 @@ export class Provider extends Emitter {
       }).on('restore', this.documentService.onRestore).on('permission', permit => {
         this.permit = Object.assign(this.permit, permit);
         this.emit('permission', permit);
-      }).on('steps:added', this.documentService.onStepsAdded).on('metadata:changed', this.metadataService.onMetadataChanged).on('participant:telepointer', payload => this.participantsService.onParticipantTelepointer(payload, this.sessionId)).on('participant:activity-join', this.participantsService.onParticipantActivityJoin).on('participant:activity-ack', this.participantsService.onParticipantActivityAck).on('presence:joined', this.participantsService.onPresenceJoined).on('presence', this.participantsService.onPresence).on('participant:left', this.participantsService.onParticipantLeft).on('participant:updated', this.participantsService.onParticipantUpdated).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled).on('status', this.namespaceService.onNamespaceStatusChanged).connect(shouldSkipDocumentInit);
+      }).on('steps:added', this.documentService.onStepsAdded).on('metadata:changed', this.metadataService.onMetadataChanged).on('participant:telepointer', payload => this.participantsService.onParticipantTelepointer(payload, this.sessionId)).on('participant:activity-join', this.participantsService.onParticipantActivityJoin).on('participant:activity-ack', this.participantsService.onParticipantActivityAck).on('presence:joined', this.participantsService.onPresenceJoined).on('presence', this.participantsService.onPresence).on('participant:left', this.participantsService.onParticipantLeft).on('participant:updated', this.participantsService.onParticipantUpdated).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled).on('status', async status => {
+        await this.namespaceService.onNamespaceStatusChanged(status);
+        const isLocked = this.namespaceService.getIsNamespaceLocked();
+        this.emit('namespace-lock:check', {
+          isLocked
+        });
+      }).connect(shouldSkipDocumentInit);
     });
     _defineProperty(this, "setUserId", id => {
       this.userId = id;
@@ -398,14 +405,30 @@ export class Provider extends Emitter {
   send(_tr, _oldState, newState) {
     try {
       if (this.isViewOnly()) {
-        var _this$analyticsHelper10;
         const error = {
           message: 'Attempted to send steps in view only mode',
           data: {
             code: INTERNAL_ERROR_CODE.VIEW_ONLY_STEPS_ERROR
           }
         };
-        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, error.message);
+        if (fg('log_obfuscated_steps_for_view_only')) {
+          logObfuscatedSteps(_oldState, newState).then(attributes => {
+            var _this$analyticsHelper10;
+            const stepAttributes = attributes instanceof CustomError ? {} : {
+              ...attributes
+            };
+            const stepsError = new CustomError(error.message, error, {
+              ...stepAttributes
+            });
+            (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(stepsError, stepsError.message);
+          }).catch(err => {
+            var _this$analyticsHelper11;
+            return (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(err, err.message);
+          });
+        } else {
+          var _this$analyticsHelper12;
+          (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, error.message);
+        }
         return;
       }
       // Don't send steps while the document is locked (eg. when restoring the document)
@@ -415,8 +438,8 @@ export class Provider extends Emitter {
       }
       this.documentService.send(_tr, _oldState, newState);
     } catch (error) {
-      var _this$analyticsHelper11;
-      (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while sending steps for a transaction');
+      var _this$analyticsHelper13;
+      (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while sending steps for a transaction');
       throw new SendTransactionError('Error while sending steps for a transaction', error);
     }
   }
@@ -468,9 +491,9 @@ export class Provider extends Emitter {
         });
       }
     } catch (error) {
-      var _this$analyticsHelper12;
+      var _this$analyticsHelper14;
       // We don't want to throw errors for Presence features as they tend to self-restore
-      (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while sending message - telepointer');
+      (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendErrorEvent(error, 'Error while sending message - telepointer');
     }
   }
   setAIProviderActiveIds(ids = []) {
@@ -511,8 +534,8 @@ export class Provider extends Emitter {
         this.sendStepsTimer = undefined;
       }
     } catch (error) {
-      var _this$analyticsHelper13;
-      (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while shutting down the collab provider');
+      var _this$analyticsHelper15;
+      (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendErrorEvent(error, 'Error while shutting down the collab provider');
       throw new DestroyError('Error while shutting down the collab provider', error);
     }
     this.clearTimers();
@@ -534,8 +557,8 @@ export class Provider extends Emitter {
       }
       this.metadataService.setTitle(title, broadcast);
     } catch (error) {
-      var _this$analyticsHelper14;
-      (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendErrorEvent(error, 'Error while setting title');
+      var _this$analyticsHelper16;
+      (_this$analyticsHelper16 = this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendErrorEvent(error, 'Error while setting title');
       throw new SetTitleError('Error while setting title', error);
     }
   }
@@ -552,8 +575,8 @@ export class Provider extends Emitter {
     try {
       this.metadataService.setEditorWidth(editorWidth, broadcast);
     } catch (error) {
-      var _this$analyticsHelper15;
-      (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendErrorEvent(error, 'Error while setting editor width');
+      var _this$analyticsHelper17;
+      (_this$analyticsHelper17 = this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendErrorEvent(error, 'Error while setting editor width');
       throw new SetEditorWidthError('Error while setting editor width', error);
     }
   }
@@ -570,8 +593,8 @@ export class Provider extends Emitter {
       }
       this.metadataService.setMetadata(metadata);
     } catch (error) {
-      var _this$analyticsHelper16;
-      (_this$analyticsHelper16 = this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 ? void 0 : _this$analyticsHelper16.sendErrorEvent(error, 'Error while setting metadata');
+      var _this$analyticsHelper18;
+      (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendErrorEvent(error, 'Error while setting metadata');
       throw new SetMetadataError('Error while setting metadata', error);
     }
   }

package/dist/es2019/version-wrapper.js

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

package/dist/esm/analytics/analytics-helper.js

@@ -64,8 +64,6 @@ var triggerAnalyticsEvent = function triggerAnalyticsEvent(analyticsEvent, analy
   }
 };
 var AnalyticsHelper = /*#__PURE__*/function () {
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/max-params
   function AnalyticsHelper(documentAri, subProduct, analyticsClient, getAnalyticsClient) {
     _classCallCheck(this, AnalyticsHelper);
     this.documentAri = documentAri;

package/dist/esm/api/api.js

@@ -12,6 +12,9 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import { getProduct, getSubProduct, createLogger } from '../helpers/utils';
+import { getActiveTraceHttpRequestHeaders } from '@atlaskit/react-ufo/experience-trace-id-context';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { addFeatureFlagAccessed } from '@atlaskit/react-ufo/feature-flags-accessed';
 var logger = createLogger('Api', 'blue');
 var AddCommentError = /*#__PURE__*/function (_Error) {
   function AddCommentError(message, status, meta) {
@@ -39,7 +42,7 @@ export var Api = /*#__PURE__*/function () {
     _classCallCheck(this, Api);
     _defineProperty(this, "submitComment", /*#__PURE__*/function () {
       var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(steps, version) {
-        var reqBody, url, fetchOptions;
+        var reqBody, url, tracingHeaderEnabled, tracingHeaders, fetchOptions;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -50,25 +53,33 @@ export var Api = /*#__PURE__*/function () {
               });
               url = "".concat(_this2.config.url, "/document/").concat(encodeURIComponent(_this2.config.documentAri), "/comment");
               logger("Request url: ", url);
+
+              //Get tracing headers from UFO
+              tracingHeaderEnabled = fg('platform_collab_provider_tracingheaders');
+              addFeatureFlagAccessed('platform_collab_provider_tracingheaders', tracingHeaderEnabled);
+              tracingHeaders = {};
+              if (tracingHeaderEnabled) {
+                tracingHeaders = getActiveTraceHttpRequestHeaders(url);
+              }
               _context.t0 = _objectSpread;
               _context.t1 = _objectSpread;
               _context.t2 = {};
               if (!_this2.config.permissionTokenRefresh) {
-                _context.next = 13;
+                _context.next = 17;
                 break;
               }
-              _context.next = 9;
+              _context.next = 13;
               return _this2.channel.getChannelToken();
-            case 9:
+            case 13:
               _context.t4 = _context.sent;
               _context.t3 = {
                 'x-token': _context.t4
               };
-              _context.next = 14;
+              _context.next = 18;
               break;
-            case 13:
+            case 17:
               _context.t3 = {};
-            case 14:
+            case 18:
               _context.t5 = _context.t3;
               _context.t6 = (0, _context.t1)(_context.t2, _context.t5);
               _context.t7 = {};
@@ -77,19 +88,20 @@ export var Api = /*#__PURE__*/function () {
                 'x-subproduct': getSubProduct(_this2.config.productInfo),
                 'Content-Type': 'application/json'
               };
-              _context.t9 = (0, _context.t0)(_context.t6, _context.t7, _context.t8);
-              _context.t10 = reqBody;
+              _context.t9 = tracingHeaders;
+              _context.t10 = (0, _context.t0)(_context.t6, _context.t7, _context.t8, _context.t9);
+              _context.t11 = reqBody;
               fetchOptions = {
                 credentials: 'include',
-                headers: _context.t9,
+                headers: _context.t10,
                 method: 'POST',
-                body: _context.t10
+                body: _context.t11
               };
-              _context.next = 23;
+              _context.next = 28;
               return fetch(url, fetchOptions);
-            case 23:
+            case 28:
               return _context.abrupt("return", _context.sent);
-            case 24:
+            case 29:
             case "end":
               return _context.stop();
           }

package/dist/esm/channel.js

@@ -228,8 +228,6 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
         _this.emit('steps:added', data);
       }
     });
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/max-params
     _defineProperty(_this, "fetchCatchupv2", /*#__PURE__*/function () {
       var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(fromVersion, clientId, catchUpOutofSync, reason) {
         var _yield$utils$requestS, steps, metadata, errorNotFound, errorCatchupv2;

package/dist/esm/document/catchupv2.js

@@ -89,10 +89,7 @@ var logObfuscatedSteps = function logObfuscatedSteps(steps, opt) {
  * @param clientId The ID of the currently connected session (one user can have multiple if theu have multiple tabs open)
  * @returns True if we're out of sync, false if not.
  */
-export var isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId
-// Ignored via go/ees005
-// eslint-disable-next-line @typescript-eslint/max-params
-) {
+export var isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId) {
   return (
     // If version number hasn't increased, and steps are not from our client, we're out of sync
     Boolean(fromVersion >= currentVersion && steps.some(function (step) {

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

@@ -40,8 +40,6 @@ export var DocumentService = /*#__PURE__*/function () {
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    * @param getConnected - if the channel is currently connected
    */
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/max-params
   function DocumentService(participantsService, analyticsHelper, fetchCatchupv2, fetchReconcile,
   // Ignored via go/ees005
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -57,6 +55,7 @@ export var DocumentService = /*#__PURE__*/function () {
     _defineProperty(this, "stepRejectCounter", 0);
     _defineProperty(this, "aggressiveCatchup", false);
     _defineProperty(this, "catchUpOutofSync", false);
+    _defineProperty(this, "hasRecovered", false);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      * @param reason - optional reason to attach.
@@ -308,21 +307,24 @@ export var DocumentService = /*#__PURE__*/function () {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
               doc = _ref6.doc, version = _ref6.version, metadata = _ref6.metadata, targetClientId = _ref6.targetClientId;
+              if (!targetClientId) {
+                _this.hasRecovered = true;
+              }
               if (!(targetClientId && _this.clientId !== targetClientId)) {
-                _context3.next = 3;
+                _context3.next = 4;
                 break;
               }
               return _context3.abrupt("return");
-            case 3:
+            case 4:
               // We preserve these as they will be lost apon this.updateDocument. This is because we are using document recovery.
               // We can then reconcile the document with the preserved state.
               unconfirmedSteps = _this.getUnconfirmedSteps();
-              _context3.next = 6;
+              _context3.next = 7;
               return _this.getCurrentState();
-            case 6:
+            case 7:
               currentState = _context3.sent;
               useReconcile = Boolean((unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) && currentState && !targetClientId);
-              _context3.prev = 8;
+              _context3.prev = 9;
               // Reset the editor,
               //  - Replace the document, keep in sync with the server
               //  - Replace the version number, so editor is in sync with NCS server and can commit new changes.
@@ -337,10 +339,10 @@ export var DocumentService = /*#__PURE__*/function () {
               });
               _this.metadataService.updateMetadata(metadata);
               if (!fg('restore_localstep_fallback_reconcile')) {
-                _context3.next = 25;
+                _context3.next = 26;
                 break;
               }
-              _context3.prev = 12;
+              _context3.prev = 13;
               (_this$analyticsHelper13 = _this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.INFO, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
@@ -351,35 +353,35 @@ export var DocumentService = /*#__PURE__*/function () {
               if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                 _this.applyLocalSteps(unconfirmedSteps);
               }
-              _context3.next = 23;
+              _context3.next = 24;
               break;
-            case 17:
-              _context3.prev = 17;
-              _context3.t0 = _context3["catch"](12);
+            case 18:
+              _context3.prev = 18;
+              _context3.t0 = _context3["catch"](13);
               (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 || _this$analyticsHelper14.sendErrorEvent(_context3.t0, "Error while onRestore with applyLocalSteps. Will fallback to fetchReconcile");
               useReconcile = true;
-              _context3.next = 23;
+              _context3.next = 24;
               return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-restore');
-            case 23:
-              _context3.next = 31;
+            case 24:
+              _context3.next = 32;
               break;
-            case 25:
+            case 26:
               if (!(useReconcile && currentState)) {
-                _context3.next = 30;
+                _context3.next = 31;
                 break;
               }
-              _context3.next = 28;
+              _context3.next = 29;
               return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-restore');
-            case 28:
-              _context3.next = 31;
+            case 29:
+              _context3.next = 32;
               break;
-            case 30:
+            case 31:
               if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                 // we don't want to use reconcile for restore triggered by catchup client out of sync (when targetClientId is provided)
                 // as this results in all changes made while the client was out of sync being lost
                 _this.applyLocalSteps(unconfirmedSteps);
               }
-            case 31:
+            case 32:
               (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 || _this$analyticsHelper15.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.SUCCESS, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
@@ -388,11 +390,11 @@ export var DocumentService = /*#__PURE__*/function () {
                 targetClientId: targetClientId,
                 triggeredByCatchup: targetClientId ? true : false
               });
-              _context3.next = 39;
+              _context3.next = 40;
               break;
-            case 34:
-              _context3.prev = 34;
-              _context3.t1 = _context3["catch"](8);
+            case 35:
+              _context3.prev = 35;
+              _context3.t1 = _context3["catch"](9);
               (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 || _this$analyticsHelper16.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.FAILURE, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 useReconcile: useReconcile,
@@ -409,11 +411,11 @@ export var DocumentService = /*#__PURE__*/function () {
                   code: INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR
                 }
               });
-            case 39:
+            case 40:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, null, [[8, 34], [12, 17]]);
+        }, _callee3, null, [[9, 35], [13, 18]]);
       }));
       return function (_x3) {
         return _ref7.apply(this, arguments);
@@ -824,8 +826,6 @@ export var DocumentService = /*#__PURE__*/function () {
      * Send steps from transaction to other participants
      * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
      */
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/max-params
     function send(_tr, _oldState, newState, sendAnalyticsEvent) {
       var unconfirmedStepsData = sendableSteps(newState);
       var version = this.getVersionFromCollabState(newState, 'collab-provider: send');
@@ -883,7 +883,8 @@ export var DocumentService = /*#__PURE__*/function () {
         onErrorHandled: this.onErrorHandled,
         analyticsHelper: this.analyticsHelper,
         emit: this.providerEmitCallback,
-        __livePage: this.options.__livePage
+        __livePage: this.options.__livePage,
+        hasRecovered: this.hasRecovered
       });
     }
   }]);