@atlaskit/collab-provider 23.0.4 → 23.1.0

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # @atlaskit/collab-provider
 
+## 23.1.0
+
+### Minor Changes
+
+- [`94d2f2443bb25`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/94d2f2443bb25) -
+  Share the process suspension detector so consumers outside the provider can react to a device
+  waking, via a new `./sleep-detector` entry point.
+
+  `SleepDetector` was an internal class holding its own interval and gap history. It is replaced by
+  a module-scoped detector with a single shared interval:
+
+  ```ts
+  import {
+  	acquireSleepDetector,
+  	getMaxGapSince,
+  	onSuspension,
+  } from '@atlaskit/collab-provider/sleep-detector';
+
+  const release = acquireSleepDetector(); // ref-counted; the interval runs until every consumer releases
+  const unsubscribe = onSuspension((gapMs) => {
+  	/* the process was frozen for gapMs */
+  });
+  const sleptFor = getMaxGapSince(watermark);
+  ```
+
+  Consumers pass their own watermark to `getMaxGapSince` instead of clearing history, so one
+  consumer observing a suspension cannot hide it from another. `Provider` behaviour is unchanged; it
+  now holds a watermark internally where it previously reset the detector. No existing entry point
+  changes, so no migration is required for current consumers.
+
+  The refactor itself is not gated, but the behaviour it exists to serve is: `Provider` only acts on
+  a detected suspension when the `collab_check_sleep_detection_experiment` experiment is enabled,
+  and the first consumer of the new entry point (Confluence quick reload) is gated on the same
+  experiment.
+
+### Patch Changes
+
+- [`b22ad50198f6a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b22ad50198f6a) -
+  Propagate the actingUserId for presence attribution
+- Updated dependencies
+
+## 23.0.5
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 23.0.4
 
 ### Patch Changes

package/dist/cjs/entry-points/sleep-detector.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "acquireSleepDetector", {
+  enumerable: true,
+  get: function get() {
+    return _sleepDetector.acquireSleepDetector;
+  }
+});
+Object.defineProperty(exports, "getMaxGapSince", {
+  enumerable: true,
+  get: function get() {
+    return _sleepDetector.getMaxGapSince;
+  }
+});
+Object.defineProperty(exports, "onSuspension", {
+  enumerable: true,
+  get: function get() {
+    return _sleepDetector.onSuspension;
+  }
+});
+var _sleepDetector = require("../provider/sleep-detector");

package/dist/cjs/participants/participants-helper.js

@@ -15,11 +15,11 @@ var PARTICIPANT_UPDATE_INTERVAL = exports.PARTICIPANT_UPDATE_INTERVAL = 300 * 10
 var DEFAULT_BATCH_FETCH_SIZE = 25;
 var createParticipantFromPayload = exports.createParticipantFromPayload = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(payload, getUser) {
-    var sessionId, timestamp, clientId, userId, permit, presenceId, presenceActivity, user, participant;
+    var actingUserId, sessionId, timestamp, clientId, userId, permit, presenceId, presenceActivity, user, participant;
     return _regenerator.default.wrap(function (_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
-          sessionId = payload.sessionId, timestamp = payload.timestamp, clientId = payload.clientId, userId = payload.userId, permit = payload.permit, presenceId = payload.presenceId, presenceActivity = payload.presenceActivity;
+          actingUserId = payload.actingUserId, sessionId = payload.sessionId, timestamp = payload.timestamp, clientId = payload.clientId, userId = payload.userId, permit = payload.permit, presenceId = payload.presenceId, presenceActivity = payload.presenceActivity;
           _context.next = 1;
           return getUser === null || getUser === void 0 ? void 0 : getUser(userId);
         case 1:
@@ -33,6 +33,7 @@ var createParticipantFromPayload = exports.createParticipantFromPayload = /*#__P
             userId: userId,
             clientId: clientId,
             permit: permit,
+            actingUserId: actingUserId,
             isGuest: user === null || user === void 0 ? void 0 : user.isGuest,
             presenceId: presenceId,
             presenceActivity: presenceActivity,
@@ -104,6 +105,7 @@ var fetchParticipants = exports.fetchParticipants = /*#__PURE__*/function () {
                 lastActive: participant.lastActive,
                 clientId: participant.clientId,
                 permit: participant.permit,
+                actingUserId: participant.actingUserId,
                 presenceId: participant.presenceId,
                 presenceActivity: participant.presenceActivity,
                 isHydrated: true

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

@@ -201,6 +201,9 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
     (0, _defineProperty2.default)(this, "hasPresenceActivityChanged", function (previous, current) {
       return previous.presenceActivity !== current.presenceActivity;
     });
+    (0, _defineProperty2.default)(this, "hasActingUserChanged", function (previous, current) {
+      return previous.actingUserId !== current.actingUserId;
+    });
     (0, _defineProperty2.default)(this, "handleAnonymousUser", /*#__PURE__*/function () {
       var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(payload) {
         var _previousParticipant$, _ref2, _previousParticipant$2, _asset2;
@@ -300,6 +303,11 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
                 _context2.next = 7;
                 break;
               }
+              if (_this.hasActingUserChanged(previousParticipant, participant)) {
+                _this.emitPresence({
+                  joined: [participant]
+                }, 'handling participant acting user changed event');
+              }
               if (_this.hasPresenceActivityChanged(previousParticipant, participant)) {
                 _this.emitPresenceActivityChange({
                   type: 'participant:activity',
@@ -391,11 +399,17 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
             case 4:
               // would handle activity and lastActive changes
               participant = _objectSpread(_objectSpread({}, previousParticipant), {}, {
+                actingUserId: payload.actingUserId,
                 presenceActivity: payload.presenceActivity,
                 lastActive: payload.timestamp
               });
+              _this.participantsState.setBySessionId(sessionId, participant);
+              if (_this.hasActingUserChanged(previousParticipant, participant)) {
+                _this.emitPresence({
+                  joined: [participant]
+                }, 'handling participant acting user changed event');
+              }
               if (_this.hasPresenceActivityChanged(previousParticipant, participant)) {
-                _this.participantsState.setBySessionId(sessionId, participant);
                 _this.emitPresenceActivityChange({
                   type: 'participant:activity',
                   activity: participant.presenceActivity

package/dist/cjs/provider/index.js

@@ -68,7 +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());
+    (0, _defineProperty2.default)(_this, "sleepWatermark", 0);
     // Local IDs of active AI Providers
     (0, _defineProperty2.default)(_this, "aiProviderActiveIds", []);
     /**
@@ -180,7 +180,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
           _this.participantsService.initializeFirstBatchFetchUsers();
         }
         _this.disconnectedAt = undefined;
-        _this.sleepDetector.reset();
+        _this.sleepWatermark = Date.now();
       }).on('init', function (_ref3) {
         var doc = _ref3.doc,
           version = _ref3.version,
@@ -276,7 +276,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       if (disconnectedDuration >= OUT_OF_SYNC_PERIOD) {
         return disconnectedDuration;
       }
-      var sleepDuration = _this.sleepDetector.getSleepDuration();
+      var sleepDuration = (0, _sleepDetector.getMaxGapSince)(_this.sleepWatermark);
       if (sleepDuration >= OUT_OF_SYNC_PERIOD && (0, _isExperimentEnabled.isExperimentEnabled)('collab_check_sleep_detection_experiment')) {
         return sleepDuration;
       }
@@ -469,7 +469,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       logger('Intervally sendStepsFromCurrentState');
       _this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
-    _this.sleepDetector.start();
+    _this.sleepWatermark = Date.now();
+    _this.releaseSleepDetector = (0, _sleepDetector.acquireSleepDetector)();
     return _this;
   }
   (0, _inherits2.default)(Provider, _Emitter);
@@ -724,13 +725,15 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     key: "unsubscribeAll",
     value: function unsubscribeAll() {
       try {
+        var _this$releaseSleepDet;
         _superPropGet(Provider, "unsubscribeAll", this, 3)([]);
         this.channel.disconnect();
         if (this.sendStepsTimer) {
           clearInterval(this.sendStepsTimer);
           this.sendStepsTimer = undefined;
         }
-        this.sleepDetector.stop();
+        (_this$releaseSleepDet = this.releaseSleepDetector) === null || _this$releaseSleepDet === void 0 || _this$releaseSleepDet.call(this);
+        this.releaseSleepDetector = undefined;
       } 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

@@ -1,58 +1,67 @@
 "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"));
+exports.onSuspension = exports.getMaxGapSince = exports.acquireSleepDetector = void 0;
 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;
+var MIN_REPORTED_GAP = TICK_INTERVAL * 2;
+var lastTickAt = Date.now();
+var gaps = [];
+var sentinel;
+var consumers = 0;
+var listeners = new Set();
+var tick = function tick() {
+  var now = Date.now();
+  var gap = now - lastTickAt;
+  lastTickAt = now;
+  gaps.push({
+    at: now,
+    gap: gap
+  });
+  if (gaps.length > GAP_HISTORY_SIZE) {
+    gaps.shift();
+  }
+  if (gap >= MIN_REPORTED_GAP) {
+    listeners.forEach(function (listener) {
+      return listener(gap);
     });
   }
-  return (0, _createClass2.default)(SleepDetector, [{
-    key: "start",
-    value: function start() {
-      if (this.sentinel) {
-        return;
-      }
-      this.reset();
-      this.sentinel = setInterval(this.tick, TICK_INTERVAL);
+};
+var acquireSleepDetector = exports.acquireSleepDetector = function acquireSleepDetector() {
+  consumers += 1;
+  if (!sentinel) {
+    gaps = [];
+    lastTickAt = Date.now();
+    sentinel = setInterval(tick, TICK_INTERVAL);
+  }
+  var released = false;
+  return function () {
+    if (released) {
+      return;
     }
-  }, {
-    key: "stop",
-    value: function stop() {
-      if (this.sentinel) {
-        clearInterval(this.sentinel);
-        this.sentinel = undefined;
+    released = true;
+    consumers -= 1;
+    if (consumers <= 0) {
+      consumers = 0;
+      if (sentinel) {
+        clearInterval(sentinel);
+        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;
-    }
-  }]);
-}();
+  };
+};
+var onSuspension = exports.onSuspension = function onSuspension(listener) {
+  listeners.add(listener);
+  return function () {
+    listeners.delete(listener);
+  };
+};
+var getMaxGapSince = exports.getMaxGapSince = function getMaxGapSince(since) {
+  return gaps.reduce(function (max, _ref) {
+    var at = _ref.at,
+      gap = _ref.gap;
+    return at > since && gap > max ? gap : max;
+  }, 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 = "23.0.3";
+var version = exports.version = "23.0.5";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/entry-points/sleep-detector.js

@@ -0,0 +1,2 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+export { acquireSleepDetector, getMaxGapSince, onSuspension } from '../provider/sleep-detector';

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

@@ -5,6 +5,7 @@ export const PARTICIPANT_UPDATE_INTERVAL = 300 * 1000; // 300 seconds
 const DEFAULT_BATCH_FETCH_SIZE = 25;
 export const createParticipantFromPayload = async (payload, getUser) => {
   const {
+    actingUserId,
     sessionId,
     timestamp,
     clientId,
@@ -23,6 +24,7 @@ export const createParticipantFromPayload = async (payload, getUser) => {
     userId,
     clientId,
     permit,
+    actingUserId,
     isGuest: user === null || user === void 0 ? void 0 : user.isGuest,
     presenceId: presenceId,
     presenceActivity: presenceActivity,
@@ -77,6 +79,7 @@ export const fetchParticipants = async (participantsState, batchProps) => {
         lastActive: participant.lastActive,
         clientId: participant.clientId,
         permit: participant.permit,
+        actingUserId: participant.actingUserId,
         presenceId: participant.presenceId,
         presenceActivity: participant.presenceActivity,
         isHydrated: true

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

@@ -185,6 +185,9 @@ export class ParticipantsService {
     _defineProperty(this, "hasPresenceActivityChanged", (previous, current) => {
       return previous.presenceActivity !== current.presenceActivity;
     });
+    _defineProperty(this, "hasActingUserChanged", (previous, current) => {
+      return previous.actingUserId !== current.actingUserId;
+    });
     _defineProperty(this, "handleAnonymousUser", async payload => {
       var _previousParticipant$, _ref, _previousParticipant$2, _asset2;
       const {
@@ -250,6 +253,11 @@ export class ParticipantsService {
       const previousParticipant = this.participantsState.getBySessionId(participant.sessionId);
       this.participantsState.setBySessionId(participant.sessionId, participant);
       if (previousParticipant) {
+        if (this.hasActingUserChanged(previousParticipant, participant)) {
+          this.emitPresence({
+            joined: [participant]
+          }, 'handling participant acting user changed event');
+        }
         if (this.hasPresenceActivityChanged(previousParticipant, participant)) {
           this.emitPresenceActivityChange({
             type: 'participant:activity',
@@ -327,11 +335,17 @@ export class ParticipantsService {
       // would handle activity and lastActive changes
       const participant = {
         ...previousParticipant,
+        actingUserId: payload.actingUserId,
         presenceActivity: payload.presenceActivity,
         lastActive: payload.timestamp
       };
+      this.participantsState.setBySessionId(sessionId, participant);
+      if (this.hasActingUserChanged(previousParticipant, participant)) {
+        this.emitPresence({
+          joined: [participant]
+        }, 'handling participant acting user changed event');
+      }
       if (this.hasPresenceActivityChanged(previousParticipant, participant)) {
-        this.participantsState.setBySessionId(sessionId, participant);
         this.emitPresenceActivityChange({
           type: 'participant:activity',
           activity: participant.presenceActivity

package/dist/es2019/provider/index.js

@@ -23,7 +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';
+import { acquireSleepDetector, getMaxGapSince } from './sleep-detector';
 const logger = createLogger('Provider', 'black');
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
@@ -47,7 +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());
+    _defineProperty(this, "sleepWatermark", 0);
     // Local IDs of active AI Providers
     _defineProperty(this, "aiProviderActiveIds", []);
     /**
@@ -160,7 +160,7 @@ export class Provider extends Emitter {
           this.participantsService.initializeFirstBatchFetchUsers();
         }
         this.disconnectedAt = undefined;
-        this.sleepDetector.reset();
+        this.sleepWatermark = Date.now();
       }).on('init', ({
         doc,
         version,
@@ -239,7 +239,7 @@ export class Provider extends Emitter {
       if (disconnectedDuration >= OUT_OF_SYNC_PERIOD) {
         return disconnectedDuration;
       }
-      const sleepDuration = this.sleepDetector.getSleepDuration();
+      const sleepDuration = getMaxGapSince(this.sleepWatermark);
       if (sleepDuration >= OUT_OF_SYNC_PERIOD && isExperimentEnabled('collab_check_sleep_detection_experiment')) {
         return sleepDuration;
       }
@@ -384,7 +384,8 @@ export class Provider extends Emitter {
       logger('Intervally sendStepsFromCurrentState');
       this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
-    this.sleepDetector.start();
+    this.sleepWatermark = Date.now();
+    this.releaseSleepDetector = acquireSleepDetector();
   }
   // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883
   /**
@@ -620,13 +621,15 @@ export class Provider extends Emitter {
    */
   unsubscribeAll() {
     try {
+      var _this$releaseSleepDet;
       super.unsubscribeAll();
       this.channel.disconnect();
       if (this.sendStepsTimer) {
         clearInterval(this.sendStepsTimer);
         this.sendStepsTimer = undefined;
       }
-      this.sleepDetector.stop();
+      (_this$releaseSleepDet = this.releaseSleepDetector) === null || _this$releaseSleepDet === void 0 ? void 0 : _this$releaseSleepDet.call(this);
+      this.releaseSleepDetector = undefined;
     } 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

@@ -1,37 +1,56 @@
-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;
-    });
+const MIN_REPORTED_GAP = TICK_INTERVAL * 2;
+let lastTickAt = Date.now();
+let gaps = [];
+let sentinel;
+let consumers = 0;
+const listeners = new Set();
+const tick = () => {
+  const now = Date.now();
+  const gap = now - lastTickAt;
+  lastTickAt = now;
+  gaps.push({
+    at: now,
+    gap
+  });
+  if (gaps.length > GAP_HISTORY_SIZE) {
+    gaps.shift();
+  }
+  if (gap >= MIN_REPORTED_GAP) {
+    listeners.forEach(listener => listener(gap));
   }
-  start() {
-    if (this.sentinel) {
+};
+export const acquireSleepDetector = () => {
+  consumers += 1;
+  if (!sentinel) {
+    gaps = [];
+    lastTickAt = Date.now();
+    sentinel = setInterval(tick, TICK_INTERVAL);
+  }
+  let released = false;
+  return () => {
+    if (released) {
       return;
     }
-    this.reset();
-    this.sentinel = setInterval(this.tick, TICK_INTERVAL);
-  }
-  stop() {
-    if (this.sentinel) {
-      clearInterval(this.sentinel);
-      this.sentinel = undefined;
+    released = true;
+    consumers -= 1;
+    if (consumers <= 0) {
+      consumers = 0;
+      if (sentinel) {
+        clearInterval(sentinel);
+        sentinel = undefined;
+      }
     }
-  }
-  reset() {
-    this.gaps = [];
-    this.lastTickAt = Date.now();
-  }
-  getSleepDuration() {
-    return this.gaps.length ? Math.max(...this.gaps) : 0;
-  }
-}
+  };
+};
+export const onSuspension = listener => {
+  listeners.add(listener);
+  return () => {
+    listeners.delete(listener);
+  };
+};
+export const getMaxGapSince = since => gaps.reduce((max, {
+  at,
+  gap
+}) => at > since && gap > max ? gap : max, 0);

package/dist/es2019/version-wrapper.js

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

package/dist/esm/entry-points/sleep-detector.js

@@ -0,0 +1,2 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+export { acquireSleepDetector, getMaxGapSince, onSuspension } from '../provider/sleep-detector';

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

@@ -8,11 +8,11 @@ export var PARTICIPANT_UPDATE_INTERVAL = 300 * 1000; // 300 seconds
 var DEFAULT_BATCH_FETCH_SIZE = 25;
 export var createParticipantFromPayload = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(payload, getUser) {
-    var sessionId, timestamp, clientId, userId, permit, presenceId, presenceActivity, user, participant;
+    var actingUserId, sessionId, timestamp, clientId, userId, permit, presenceId, presenceActivity, user, participant;
     return _regeneratorRuntime.wrap(function (_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
-          sessionId = payload.sessionId, timestamp = payload.timestamp, clientId = payload.clientId, userId = payload.userId, permit = payload.permit, presenceId = payload.presenceId, presenceActivity = payload.presenceActivity;
+          actingUserId = payload.actingUserId, sessionId = payload.sessionId, timestamp = payload.timestamp, clientId = payload.clientId, userId = payload.userId, permit = payload.permit, presenceId = payload.presenceId, presenceActivity = payload.presenceActivity;
           _context.next = 1;
           return getUser === null || getUser === void 0 ? void 0 : getUser(userId);
         case 1:
@@ -26,6 +26,7 @@ export var createParticipantFromPayload = /*#__PURE__*/function () {
             userId: userId,
             clientId: clientId,
             permit: permit,
+            actingUserId: actingUserId,
             isGuest: user === null || user === void 0 ? void 0 : user.isGuest,
             presenceId: presenceId,
             presenceActivity: presenceActivity,
@@ -97,6 +98,7 @@ export var fetchParticipants = /*#__PURE__*/function () {
                 lastActive: participant.lastActive,
                 clientId: participant.clientId,
                 permit: participant.permit,
+                actingUserId: participant.actingUserId,
                 presenceId: participant.presenceId,
                 presenceActivity: participant.presenceActivity,
                 isHydrated: true

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

@@ -194,6 +194,9 @@ export var ParticipantsService = /*#__PURE__*/function () {
     _defineProperty(this, "hasPresenceActivityChanged", function (previous, current) {
       return previous.presenceActivity !== current.presenceActivity;
     });
+    _defineProperty(this, "hasActingUserChanged", function (previous, current) {
+      return previous.actingUserId !== current.actingUserId;
+    });
     _defineProperty(this, "handleAnonymousUser", /*#__PURE__*/function () {
       var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(payload) {
         var _previousParticipant$, _ref2, _previousParticipant$2, _asset2;
@@ -293,6 +296,11 @@ export var ParticipantsService = /*#__PURE__*/function () {
                 _context2.next = 7;
                 break;
               }
+              if (_this.hasActingUserChanged(previousParticipant, participant)) {
+                _this.emitPresence({
+                  joined: [participant]
+                }, 'handling participant acting user changed event');
+              }
               if (_this.hasPresenceActivityChanged(previousParticipant, participant)) {
                 _this.emitPresenceActivityChange({
                   type: 'participant:activity',
@@ -384,11 +392,17 @@ export var ParticipantsService = /*#__PURE__*/function () {
             case 4:
               // would handle activity and lastActive changes
               participant = _objectSpread(_objectSpread({}, previousParticipant), {}, {
+                actingUserId: payload.actingUserId,
                 presenceActivity: payload.presenceActivity,
                 lastActive: payload.timestamp
               });
+              _this.participantsState.setBySessionId(sessionId, participant);
+              if (_this.hasActingUserChanged(previousParticipant, participant)) {
+                _this.emitPresence({
+                  joined: [participant]
+                }, 'handling participant acting user changed event');
+              }
               if (_this.hasPresenceActivityChanged(previousParticipant, participant)) {
-                _this.participantsState.setBySessionId(sessionId, participant);
                 _this.emitPresenceActivityChange({
                   type: 'participant:activity',
                   activity: participant.presenceActivity

package/dist/esm/provider/index.js

@@ -36,7 +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';
+import { acquireSleepDetector, getMaxGapSince } from './sleep-detector';
 var logger = createLogger('Provider', 'black');
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
@@ -62,7 +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());
+    _defineProperty(_this, "sleepWatermark", 0);
     // Local IDs of active AI Providers
     _defineProperty(_this, "aiProviderActiveIds", []);
     /**
@@ -174,7 +174,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           _this.participantsService.initializeFirstBatchFetchUsers();
         }
         _this.disconnectedAt = undefined;
-        _this.sleepDetector.reset();
+        _this.sleepWatermark = Date.now();
       }).on('init', function (_ref3) {
         var doc = _ref3.doc,
           version = _ref3.version,
@@ -270,7 +270,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       if (disconnectedDuration >= OUT_OF_SYNC_PERIOD) {
         return disconnectedDuration;
       }
-      var sleepDuration = _this.sleepDetector.getSleepDuration();
+      var sleepDuration = getMaxGapSince(_this.sleepWatermark);
       if (sleepDuration >= OUT_OF_SYNC_PERIOD && isExperimentEnabled('collab_check_sleep_detection_experiment')) {
         return sleepDuration;
       }
@@ -463,7 +463,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       logger('Intervally sendStepsFromCurrentState');
       _this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
-    _this.sleepDetector.start();
+    _this.sleepWatermark = Date.now();
+    _this.releaseSleepDetector = acquireSleepDetector();
     return _this;
   }
   _inherits(Provider, _Emitter);
@@ -718,13 +719,15 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     key: "unsubscribeAll",
     value: function unsubscribeAll() {
       try {
+        var _this$releaseSleepDet;
         _superPropGet(Provider, "unsubscribeAll", this, 3)([]);
         this.channel.disconnect();
         if (this.sendStepsTimer) {
           clearInterval(this.sendStepsTimer);
           this.sendStepsTimer = undefined;
         }
-        this.sleepDetector.stop();
+        (_this$releaseSleepDet = this.releaseSleepDetector) === null || _this$releaseSleepDet === void 0 || _this$releaseSleepDet.call(this);
+        this.releaseSleepDetector = undefined;
       } 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

@@ -1,51 +1,61 @@
-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;
+var MIN_REPORTED_GAP = TICK_INTERVAL * 2;
+var lastTickAt = Date.now();
+var gaps = [];
+var sentinel;
+var consumers = 0;
+var listeners = new Set();
+var tick = function tick() {
+  var now = Date.now();
+  var gap = now - lastTickAt;
+  lastTickAt = now;
+  gaps.push({
+    at: now,
+    gap: gap
+  });
+  if (gaps.length > GAP_HISTORY_SIZE) {
+    gaps.shift();
+  }
+  if (gap >= MIN_REPORTED_GAP) {
+    listeners.forEach(function (listener) {
+      return listener(gap);
     });
   }
-  return _createClass(SleepDetector, [{
-    key: "start",
-    value: function start() {
-      if (this.sentinel) {
-        return;
-      }
-      this.reset();
-      this.sentinel = setInterval(this.tick, TICK_INTERVAL);
+};
+export var acquireSleepDetector = function acquireSleepDetector() {
+  consumers += 1;
+  if (!sentinel) {
+    gaps = [];
+    lastTickAt = Date.now();
+    sentinel = setInterval(tick, TICK_INTERVAL);
+  }
+  var released = false;
+  return function () {
+    if (released) {
+      return;
     }
-  }, {
-    key: "stop",
-    value: function stop() {
-      if (this.sentinel) {
-        clearInterval(this.sentinel);
-        this.sentinel = undefined;
+    released = true;
+    consumers -= 1;
+    if (consumers <= 0) {
+      consumers = 0;
+      if (sentinel) {
+        clearInterval(sentinel);
+        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;
-    }
-  }]);
-}();
+  };
+};
+export var onSuspension = function onSuspension(listener) {
+  listeners.add(listener);
+  return function () {
+    listeners.delete(listener);
+  };
+};
+export var getMaxGapSince = function getMaxGapSince(since) {
+  return gaps.reduce(function (max, _ref) {
+    var at = _ref.at,
+      gap = _ref.gap;
+    return at > since && gap > max ? gap : max;
+  }, 0);
+};

package/dist/esm/version-wrapper.js

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

package/dist/types/entry-points/sleep-detector.d.ts

@@ -0,0 +1 @@
+export { acquireSleepDetector, getMaxGapSince, onSuspension } from '../provider/sleep-detector';

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

@@ -100,6 +100,7 @@ export declare class ParticipantsService {
      */
     private clearAgentPresenceTimers;
     private hasPresenceActivityChanged;
+    private hasActingUserChanged;
     private handleAnonymousUser;
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event

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

@@ -35,7 +35,8 @@ export declare class Provider extends Emitter<CollabEvents> implements CollabEdi
     private presenceUpdateTimeout?;
     private disconnectedAt?;
     private sendStepsTimer?;
-    private readonly sleepDetector;
+    private releaseSleepDetector?;
+    private sleepWatermark;
     private readonly participantsService;
     private readonly metadataService;
     private readonly documentService;

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

@@ -1,10 +1,5 @@
-export declare class SleepDetector {
-    private lastTickAt;
-    private gaps;
-    private sentinel?;
-    start(): void;
-    stop(): void;
-    reset(): void;
-    getSleepDuration(): number;
-    private tick;
-}
+type SuspensionListener = (gapMs: number) => void;
+export declare const acquireSleepDetector: () => (() => void);
+export declare const onSuspension: (listener: SuspensionListener) => (() => void);
+export declare const getMaxGapSince: (since: number) => number;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "23.0.4",
+	"version": "23.1.0",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -29,8 +29,8 @@
 		"@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": "^145.0.0",
+		"@atlaskit/react-ufo": "^7.4.0",
+		"@atlaskit/tmp-editor-statsig": "^147.0.0",
 		"@atlaskit/ufo": "^1.0.0",
 		"@atlaskit/util-service-support": "^7.2.0",
 		"@babel/runtime": "^7.0.0",
@@ -70,6 +70,6 @@
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^118.4.0"
+		"@atlaskit/editor-common": "^118.10.0"
 	}
 }

package/sleep-detector/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/collab-provider/sleep-detector",
+  "main": "../dist/cjs/entry-points/sleep-detector.js",
+  "module": "../dist/esm/entry-points/sleep-detector.js",
+  "module:es2019": "../dist/es2019/entry-points/sleep-detector.js",
+  "sideEffects": false,
+  "types": "../dist/types/entry-points/sleep-detector.d.ts"
+}