@atlaskit/collab-provider 22.0.2 → 22.1.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @atlaskit/collab-provider
 
+## 22.1.0
+
+### Minor Changes
+
+- [`83cf312c45f2f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/83cf312c45f2f) -
+  Detect process suspension on reconnect so catchup runs after a device wakes from sleep, where
+  `disconnectedAt` is only stamped once the process resumes. Behind
+  `collab_check_sleep_detection_experiment`, read through `@atlaskit/platform-feature-experiments`.
+
+  `@atlaskit/collab-provider` adds no public API. `SleepDetector` is internal: it is not reachable
+  from the `.`, `./provider`, `./socket-io-provider`, `./types` or `./version-wrapper` entry points
+  and does not appear in `report.api.md`. The provider constructs and drives it internally, so
+  consumers need no migration and no call sites change.
+
+  `@atlaskit/tmp-editor-statsig` drops `collab_bypass_out_of_sync_period_experiment` from
+  `editorExperimentsConfig`, which is part of its typed surface. The key had no call sites outside
+  `@atlaskit/collab-provider`, which no longer reads it, so no consumer migration is expected in
+  practice. Any remaining caller must move to the new experiment:
+
+  ```ts
+  // before
+  if (expValEquals('collab_bypass_out_of_sync_period_experiment', 'isEnabled', true, false)) {
+  	// catch up regardless of how long the client was offline
+  }
+
+  // after
+  if (isExperimentEnabled('collab_check_sleep_detection_experiment')) {
+  	// catch up when a suspension of at least OUT_OF_SYNC_PERIOD was detected
+  }
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 22.0.2
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -46,6 +46,9 @@
 		{
 			"path": "../../../measurement/feature-gate-js-client/afm-cc/tsconfig.json"
 		},
+		{
+			"path": "../../../platform/feature-experiments/afm-cc/tsconfig.json"
+		},
 		{
 			"path": "../../../platform/feature-flags/afm-cc/tsconfig.json"
 		},

package/dist/cjs/provider/index.js

@@ -17,6 +17,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _uuid = require("uuid");
 var _emitter = require("../emitter");
 var _channel = require("../channel");
+var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
 var _utils = require("../helpers/utils");
@@ -36,6 +37,7 @@ var _api = require("../api/api");
 var _performance = require("../analytics/performance");
 var _nullApi = require("../api/null-api");
 var _getOfflineStepsLength = require("./get-offline-steps-length");
+var _sleepDetector = require("./sleep-detector");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
@@ -66,6 +68,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     // 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)(_this, "isBufferingEnabled", false);
+    (0, _defineProperty2.default)(_this, "sleepDetector", new _sleepDetector.SleepDetector());
     // Local IDs of active AI Providers
     (0, _defineProperty2.default)(_this, "aiProviderActiveIds", []);
     /**
@@ -151,12 +154,10 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
           });
         }
         // If already initialized, `connected` means reconnected
-        var shouldBypassOutOfSyncGracePeriod = (0, _expValEquals.expValEquals)('collab_bypass_out_of_sync_period_experiment', 'isEnabled', true, false);
-        if (initialized && _this.disconnectedAt && (
-        // Offline longer than `OUT_OF_SYNC_PERIOD`
-        shouldBypassOutOfSyncGracePeriod || Date.now() - _this.disconnectedAt >= OUT_OF_SYNC_PERIOD)) {
+        var offlineDuration = initialized ? _this.getOutOfSyncDuration() : undefined;
+        if (offlineDuration !== undefined) {
           _this.documentService.throttledCatchupv2(_const.CatchupEventReason.RECONNECTED, {
-            disconnectionPeriodSeconds: Math.floor((Date.now() - _this.disconnectedAt) / 1000),
+            disconnectionPeriodSeconds: Math.floor(offlineDuration / 1000),
             offlineStepsLength: (0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true) ? (0, _getOfflineStepsLength.getOfflineStepsLength)(_this.documentService.getUnconfirmedSteps(), _this.documentService.getUnconfirmedStepsOrigins()) : undefined,
             offlineReplaceStepsLength: (0, _experiments.editorExperiment)('platform_editor_offline_editing_web', true) ? (0, _getOfflineStepsLength.getOfflineReplaceStepsLength)(_this.documentService.getUnconfirmedSteps(), _this.documentService.getUnconfirmedStepsOrigins()) : undefined,
             unconfirmedStepsLength: unconfirmedStepsLength
@@ -179,6 +180,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
           _this.participantsService.initializeFirstBatchFetchUsers();
         }
         _this.disconnectedAt = undefined;
+        _this.sleepDetector.reset();
       }).on('init', function (_ref3) {
         var doc = _ref3.doc,
           version = _ref3.version,
@@ -266,6 +268,20 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)(_this, "getAIProviderActiveIds", function () {
       return _this.aiProviderActiveIds;
     });
+    (0, _defineProperty2.default)(_this, "getOutOfSyncDuration", function () {
+      if (!_this.disconnectedAt) {
+        return undefined;
+      }
+      var disconnectedDuration = Date.now() - _this.disconnectedAt;
+      if (disconnectedDuration >= OUT_OF_SYNC_PERIOD) {
+        return disconnectedDuration;
+      }
+      var sleepDuration = _this.sleepDetector.getSleepDuration();
+      if (sleepDuration >= OUT_OF_SYNC_PERIOD && (0, _isExperimentEnabled.isExperimentEnabled)('collab_check_sleep_detection_experiment')) {
+        return sleepDuration;
+      }
+      return undefined;
+    });
     // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
     (0, _defineProperty2.default)(_this, "onDisconnected", function (_ref5) {
       var reason = _ref5.reason;
@@ -453,6 +469,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       logger('Intervally sendStepsFromCurrentState');
       _this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
+    _this.sleepDetector.start();
     return _this;
   }
   (0, _inherits2.default)(Provider, _Emitter);
@@ -713,6 +730,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
           clearInterval(this.sendStepsTimer);
           this.sendStepsTimer = undefined;
         }
+        this.sleepDetector.stop();
       } catch (error) {
         var _this$analyticsHelper10;
         (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 || _this$analyticsHelper10.sendErrorEvent(error, 'Error while shutting down the collab provider');

package/dist/cjs/provider/sleep-detector.js

@@ -0,0 +1,58 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SleepDetector = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var TICK_INTERVAL = 1000;
+var GAP_HISTORY_SIZE = 20;
+var SleepDetector = exports.SleepDetector = /*#__PURE__*/function () {
+  function SleepDetector() {
+    var _this = this;
+    (0, _classCallCheck2.default)(this, SleepDetector);
+    (0, _defineProperty2.default)(this, "lastTickAt", Date.now());
+    (0, _defineProperty2.default)(this, "gaps", []);
+    (0, _defineProperty2.default)(this, "tick", function () {
+      var now = Date.now();
+      _this.gaps.push(now - _this.lastTickAt);
+      if (_this.gaps.length > GAP_HISTORY_SIZE) {
+        _this.gaps.shift();
+      }
+      _this.lastTickAt = now;
+    });
+  }
+  return (0, _createClass2.default)(SleepDetector, [{
+    key: "start",
+    value: function start() {
+      if (this.sentinel) {
+        return;
+      }
+      this.reset();
+      this.sentinel = setInterval(this.tick, TICK_INTERVAL);
+    }
+  }, {
+    key: "stop",
+    value: function stop() {
+      if (this.sentinel) {
+        clearInterval(this.sentinel);
+        this.sentinel = undefined;
+      }
+    }
+  }, {
+    key: "reset",
+    value: function reset() {
+      this.gaps = [];
+      this.lastTickAt = Date.now();
+    }
+  }, {
+    key: "getSleepDuration",
+    value: function getSleepDuration() {
+      return this.gaps.length ? Math.max.apply(Math, (0, _toConsumableArray2.default)(this.gaps)) : 0;
+    }
+  }]);
+}();

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

package/dist/es2019/provider/index.js

@@ -3,6 +3,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { v4 as uuidv4 } from 'uuid';
 import { Emitter } from '../emitter';
 import { Channel } from '../channel';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { createLogger, logObfuscatedSteps } from '../helpers/utils';
@@ -22,6 +23,7 @@ import { Api } from '../api/api';
 import { shouldTelepointerBeSampled } from '../analytics/performance';
 import { NullApi } from '../api/null-api';
 import { getOfflineStepsLength, getOfflineReplaceStepsLength } from './get-offline-steps-length';
+import { SleepDetector } from './sleep-detector';
 const logger = createLogger('Provider', 'black');
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
@@ -45,6 +47,7 @@ export class Provider extends Emitter {
     // 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.
     _defineProperty(this, "isBufferingEnabled", false);
+    _defineProperty(this, "sleepDetector", new SleepDetector());
     // Local IDs of active AI Providers
     _defineProperty(this, "aiProviderActiveIds", []);
     /**
@@ -131,12 +134,10 @@ export class Provider extends Emitter {
           });
         }
         // If already initialized, `connected` means reconnected
-        const shouldBypassOutOfSyncGracePeriod = expValEquals('collab_bypass_out_of_sync_period_experiment', 'isEnabled', true, false);
-        if (initialized && this.disconnectedAt && (
-        // Offline longer than `OUT_OF_SYNC_PERIOD`
-        shouldBypassOutOfSyncGracePeriod || Date.now() - this.disconnectedAt >= OUT_OF_SYNC_PERIOD)) {
+        const offlineDuration = initialized ? this.getOutOfSyncDuration() : undefined;
+        if (offlineDuration !== undefined) {
           this.documentService.throttledCatchupv2(CatchupEventReason.RECONNECTED, {
-            disconnectionPeriodSeconds: Math.floor((Date.now() - this.disconnectedAt) / 1000),
+            disconnectionPeriodSeconds: Math.floor(offlineDuration / 1000),
             offlineStepsLength: editorExperiment('platform_editor_offline_editing_web', true) ? getOfflineStepsLength(this.documentService.getUnconfirmedSteps(), this.documentService.getUnconfirmedStepsOrigins()) : undefined,
             offlineReplaceStepsLength: editorExperiment('platform_editor_offline_editing_web', true) ? getOfflineReplaceStepsLength(this.documentService.getUnconfirmedSteps(), this.documentService.getUnconfirmedStepsOrigins()) : undefined,
             unconfirmedStepsLength: unconfirmedStepsLength
@@ -159,6 +160,7 @@ export class Provider extends Emitter {
           this.participantsService.initializeFirstBatchFetchUsers();
         }
         this.disconnectedAt = undefined;
+        this.sleepDetector.reset();
       }).on('init', ({
         doc,
         version,
@@ -229,6 +231,20 @@ export class Provider extends Emitter {
     _defineProperty(this, "getAIProviderActiveIds", () => {
       return this.aiProviderActiveIds;
     });
+    _defineProperty(this, "getOutOfSyncDuration", () => {
+      if (!this.disconnectedAt) {
+        return undefined;
+      }
+      const disconnectedDuration = Date.now() - this.disconnectedAt;
+      if (disconnectedDuration >= OUT_OF_SYNC_PERIOD) {
+        return disconnectedDuration;
+      }
+      const sleepDuration = this.sleepDetector.getSleepDuration();
+      if (sleepDuration >= OUT_OF_SYNC_PERIOD && isExperimentEnabled('collab_check_sleep_detection_experiment')) {
+        return sleepDuration;
+      }
+      return undefined;
+    });
     // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
     _defineProperty(this, "onDisconnected", ({
       reason
@@ -368,6 +384,7 @@ export class Provider extends Emitter {
       logger('Intervally sendStepsFromCurrentState');
       this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
+    this.sleepDetector.start();
   }
   // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883
   /**
@@ -609,6 +626,7 @@ export class Provider extends Emitter {
         clearInterval(this.sendStepsTimer);
         this.sendStepsTimer = undefined;
       }
+      this.sleepDetector.stop();
     } catch (error) {
       var _this$analyticsHelper12;
       (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while shutting down the collab provider');

package/dist/es2019/provider/sleep-detector.js

@@ -0,0 +1,37 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+const TICK_INTERVAL = 1000;
+const GAP_HISTORY_SIZE = 20;
+export class SleepDetector {
+  constructor() {
+    _defineProperty(this, "lastTickAt", Date.now());
+    _defineProperty(this, "gaps", []);
+    _defineProperty(this, "tick", () => {
+      const now = Date.now();
+      this.gaps.push(now - this.lastTickAt);
+      if (this.gaps.length > GAP_HISTORY_SIZE) {
+        this.gaps.shift();
+      }
+      this.lastTickAt = now;
+    });
+  }
+  start() {
+    if (this.sentinel) {
+      return;
+    }
+    this.reset();
+    this.sentinel = setInterval(this.tick, TICK_INTERVAL);
+  }
+  stop() {
+    if (this.sentinel) {
+      clearInterval(this.sentinel);
+      this.sentinel = undefined;
+    }
+  }
+  reset() {
+    this.gaps = [];
+    this.lastTickAt = Date.now();
+  }
+  getSleepDuration() {
+    return this.gaps.length ? Math.max(...this.gaps) : 0;
+  }
+}

package/dist/es2019/version-wrapper.js

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

package/dist/esm/provider/index.js

@@ -16,6 +16,7 @@ function _superPropGet(t, o, e, r) { var p = _get(_getPrototypeOf(1 & r ? t.prot
 import { v4 as uuidv4 } from 'uuid';
 import { Emitter } from '../emitter';
 import { Channel } from '../channel';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { createLogger, logObfuscatedSteps } from '../helpers/utils';
@@ -35,6 +36,7 @@ import { Api } from '../api/api';
 import { shouldTelepointerBeSampled } from '../analytics/performance';
 import { NullApi } from '../api/null-api';
 import { getOfflineStepsLength, getOfflineReplaceStepsLength } from './get-offline-steps-length';
+import { SleepDetector } from './sleep-detector';
 var logger = createLogger('Provider', 'black');
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
@@ -60,6 +62,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     // 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.
     _defineProperty(_this, "isBufferingEnabled", false);
+    _defineProperty(_this, "sleepDetector", new SleepDetector());
     // Local IDs of active AI Providers
     _defineProperty(_this, "aiProviderActiveIds", []);
     /**
@@ -145,12 +148,10 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           });
         }
         // If already initialized, `connected` means reconnected
-        var shouldBypassOutOfSyncGracePeriod = expValEquals('collab_bypass_out_of_sync_period_experiment', 'isEnabled', true, false);
-        if (initialized && _this.disconnectedAt && (
-        // Offline longer than `OUT_OF_SYNC_PERIOD`
-        shouldBypassOutOfSyncGracePeriod || Date.now() - _this.disconnectedAt >= OUT_OF_SYNC_PERIOD)) {
+        var offlineDuration = initialized ? _this.getOutOfSyncDuration() : undefined;
+        if (offlineDuration !== undefined) {
           _this.documentService.throttledCatchupv2(CatchupEventReason.RECONNECTED, {
-            disconnectionPeriodSeconds: Math.floor((Date.now() - _this.disconnectedAt) / 1000),
+            disconnectionPeriodSeconds: Math.floor(offlineDuration / 1000),
             offlineStepsLength: editorExperiment('platform_editor_offline_editing_web', true) ? getOfflineStepsLength(_this.documentService.getUnconfirmedSteps(), _this.documentService.getUnconfirmedStepsOrigins()) : undefined,
             offlineReplaceStepsLength: editorExperiment('platform_editor_offline_editing_web', true) ? getOfflineReplaceStepsLength(_this.documentService.getUnconfirmedSteps(), _this.documentService.getUnconfirmedStepsOrigins()) : undefined,
             unconfirmedStepsLength: unconfirmedStepsLength
@@ -173,6 +174,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           _this.participantsService.initializeFirstBatchFetchUsers();
         }
         _this.disconnectedAt = undefined;
+        _this.sleepDetector.reset();
       }).on('init', function (_ref3) {
         var doc = _ref3.doc,
           version = _ref3.version,
@@ -260,6 +262,20 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _defineProperty(_this, "getAIProviderActiveIds", function () {
       return _this.aiProviderActiveIds;
     });
+    _defineProperty(_this, "getOutOfSyncDuration", function () {
+      if (!_this.disconnectedAt) {
+        return undefined;
+      }
+      var disconnectedDuration = Date.now() - _this.disconnectedAt;
+      if (disconnectedDuration >= OUT_OF_SYNC_PERIOD) {
+        return disconnectedDuration;
+      }
+      var sleepDuration = _this.sleepDetector.getSleepDuration();
+      if (sleepDuration >= OUT_OF_SYNC_PERIOD && isExperimentEnabled('collab_check_sleep_detection_experiment')) {
+        return sleepDuration;
+      }
+      return undefined;
+    });
     // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
     _defineProperty(_this, "onDisconnected", function (_ref5) {
       var reason = _ref5.reason;
@@ -447,6 +463,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       logger('Intervally sendStepsFromCurrentState');
       _this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
+    _this.sleepDetector.start();
     return _this;
   }
   _inherits(Provider, _Emitter);
@@ -707,6 +724,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           clearInterval(this.sendStepsTimer);
           this.sendStepsTimer = undefined;
         }
+        this.sleepDetector.stop();
       } catch (error) {
         var _this$analyticsHelper10;
         (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 || _this$analyticsHelper10.sendErrorEvent(error, 'Error while shutting down the collab provider');

package/dist/esm/provider/sleep-detector.js

@@ -0,0 +1,51 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+var TICK_INTERVAL = 1000;
+var GAP_HISTORY_SIZE = 20;
+export var SleepDetector = /*#__PURE__*/function () {
+  function SleepDetector() {
+    var _this = this;
+    _classCallCheck(this, SleepDetector);
+    _defineProperty(this, "lastTickAt", Date.now());
+    _defineProperty(this, "gaps", []);
+    _defineProperty(this, "tick", function () {
+      var now = Date.now();
+      _this.gaps.push(now - _this.lastTickAt);
+      if (_this.gaps.length > GAP_HISTORY_SIZE) {
+        _this.gaps.shift();
+      }
+      _this.lastTickAt = now;
+    });
+  }
+  return _createClass(SleepDetector, [{
+    key: "start",
+    value: function start() {
+      if (this.sentinel) {
+        return;
+      }
+      this.reset();
+      this.sentinel = setInterval(this.tick, TICK_INTERVAL);
+    }
+  }, {
+    key: "stop",
+    value: function stop() {
+      if (this.sentinel) {
+        clearInterval(this.sentinel);
+        this.sentinel = undefined;
+      }
+    }
+  }, {
+    key: "reset",
+    value: function reset() {
+      this.gaps = [];
+      this.lastTickAt = Date.now();
+    }
+  }, {
+    key: "getSleepDuration",
+    value: function getSleepDuration() {
+      return this.gaps.length ? Math.max.apply(Math, _toConsumableArray(this.gaps)) : 0;
+    }
+  }]);
+}();

package/dist/esm/version-wrapper.js

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

package/dist/types/provider/index.d.ts

@@ -35,6 +35,7 @@ export declare class Provider extends Emitter<CollabEvents> implements CollabEdi
     private presenceUpdateTimeout?;
     private disconnectedAt?;
     private sendStepsTimer?;
+    private readonly sleepDetector;
     private readonly participantsService;
     private readonly metadataService;
     private readonly documentService;
@@ -108,6 +109,7 @@ export declare class Provider extends Emitter<CollabEvents> implements CollabEdi
     sendMessage(data: CollabTelepointerPayload | CollabActivityAIProviderChangedPayload | CollabPresenceActivityChangePayload): void;
     setAIProviderActiveIds(ids?: string[]): void;
     private getAIProviderActiveIds;
+    private getOutOfSyncDuration;
     private onDisconnected;
     /**
      * "Destroy" the provider, disconnect it's connection to the back-end service and unsubscribe all event listeners on the provider.

package/dist/types/provider/sleep-detector.d.ts

@@ -0,0 +1,10 @@
+export declare class SleepDetector {
+    private lastTickAt;
+    private gaps;
+    private sentinel?;
+    start(): void;
+    stop(): void;
+    reset(): void;
+    getSleepDuration(): number;
+    private tick;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "22.0.2",
+	"version": "22.1.0",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -26,10 +26,11 @@
 		"@atlaskit/editor-json-transformer": "^9.2.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/feature-gate-js-client": "^6.0.0",
+		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
 		"@atlaskit/prosemirror-collab": "^1.0.0",
 		"@atlaskit/react-ufo": "^7.3.0",
-		"@atlaskit/tmp-editor-statsig": "^139.0.0",
+		"@atlaskit/tmp-editor-statsig": "^140.0.0",
 		"@atlaskit/ufo": "^1.0.0",
 		"@atlaskit/util-service-support": "^7.2.0",
 		"@babel/runtime": "^7.0.0",
@@ -57,6 +58,7 @@
 	"devDependencies": {
 		"@atlaskit/adf-schema": "^56.5.0",
 		"@atlassian/a11y-jest-testing": "^0.14.0",
+		"@atlassian/experiment-test-utils": "^0.2.0",
 		"@atlassian/feature-flags-test-utils": "^1.2.0"
 	},
 	"platform-feature-flags": {
@@ -71,6 +73,6 @@
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^117.1.0"
+		"@atlaskit/editor-common": "^117.2.0"
 	}
 }