@atlaskit/collab-provider 8.8.2 → 8.9.0

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

@@ -35,18 +35,27 @@ var triggerAnalyticsEvent = function triggerAnalyticsEvent(analyticsEvent, analy
 
   if (analyticsEvent.eventAction === EVENT_ACTION.ERROR) {
     payload.nonPrivacySafeAttributes = analyticsEvent.nonPrivacySafeAttributes;
-  }
-
-  // Let the browser figure out
-  // when it should send those events
-  try {
-    var requestIdleCallbackFunction = window.requestIdleCallback;
-    var runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame;
-    runItLater(function () {
-      analyticsClient.sendOperationalEvent(payload);
-    });
-  } catch (error) {
-    // silently fail for now https://product-fabric.atlassian.net/browse/ESS-3112
+    try {
+      var requestIdleCallbackFunction = window.requestIdleCallback;
+      var runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame;
+      runItLater(function () {
+        analyticsClient.sendTrackEvent(payload);
+      });
+    } catch (error) {
+      // silently fail for now https://product-fabric.atlassian.net/browse/ESS-3112
+    }
+  } else {
+    // Let the browser figure out
+    // when it should send those events
+    try {
+      var _requestIdleCallbackFunction = window.requestIdleCallback;
+      var _runItLater = typeof _requestIdleCallbackFunction === 'function' ? _requestIdleCallbackFunction : window.requestAnimationFrame;
+      _runItLater(function () {
+        analyticsClient.sendOperationalEvent(payload);
+      });
+    } catch (error) {
+      // silently fail for now https://product-fabric.atlassian.net/browse/ESS-3112
+    }
   }
 };
 var AnalyticsHelper = /*#__PURE__*/function () {

package/dist/esm/channel.js

@@ -393,7 +393,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       if (permissionTokenRefresh) {
         auth = /*#__PURE__*/function () {
           var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(cb) {
-            var token, _err, _err$data, _err$data$meta, authenticationError;
+            var token, _data, _data$meta, authenticationError;
             return _regeneratorRuntime.wrap(function _callee2$(_context2) {
               while (1) switch (_context2.prev = _context2.next) {
                 case 0:
@@ -415,6 +415,9 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                     // save token locally
                     _this2.setToken(token);
                     authData.token = token;
+                  } else {
+                    _this2.unsetToken();
+                    authData.token = undefined;
                   }
                   cb(authData);
                   _context2.next = 17;
@@ -430,8 +433,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                       code: INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR,
                       meta: {
                         originalError: _context2.t0,
-                        // @ts-expect-error we know the error structure passed in this hack
-                        reason: (_err = err) === null || _err === void 0 ? void 0 : (_err$data = _err.data) === null || _err$data === void 0 ? void 0 : (_err$data$meta = _err$data.meta) === null || _err$data$meta === void 0 ? void 0 : _err$data$meta.reason // Should always be 'RESOURCE_DELETED' Temporary, until Confluence Cloud removes their hack
+                        reason: _context2.t0 === null || _context2.t0 === void 0 ? void 0 : (_data = _context2.t0.data) === null || _data === void 0 ? void 0 : (_data$meta = _data.meta) === null || _data$meta === void 0 ? void 0 : _data$meta.reason // Should always be 'RESOURCE_DELETED' Temporary, until Confluence Cloud removes their hack
                         // https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/browse/next/packages/native-collab/src/fetchCollabPermissionToken.ts#37
                       }
                     }

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

@@ -466,7 +466,7 @@ export var DocumentService = /*#__PURE__*/function () {
           });
           // If steps can apply to local editor successfully, no need to accumulate the error counter.
           this.stepRejectCounter = 0;
-          this.participantsService.emitTelepointersFromSteps(steps, this.providerEmitCallback);
+          this.participantsService.emitTelepointersFromSteps(steps);
 
           // Resend local steps if none of the received steps originated with us!
           if (clientIds.indexOf(this.clientId) === -1) {

package/dist/esm/errors/error-code-mapper.js

@@ -5,7 +5,7 @@ import { INTERNAL_ERROR_CODE, PROVIDER_ERROR_CODE } from './error-types';
  * Maps internal collab provider errors to an emitted error format
  */
 export var errorCodeMapper = function errorCodeMapper(error) {
-  var _error$data, _error$data2, _error$data3;
+  var _error$data, _error$data2, _error$data3, _error$data4;
   switch ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) {
     case NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED:
     case NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS:
@@ -88,7 +88,6 @@ export var errorCodeMapper = function errorCodeMapper(error) {
     case NCS_ERROR_CODE.NAMESPACE_NOT_FOUND:
     case NCS_ERROR_CODE.ERROR_MAPPING_ERROR:
     case NCS_ERROR_CODE.EMPTY_BROADCAST:
-    case INTERNAL_ERROR_CODE.CATCHUP_FAILED:
       return {
         code: PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
         message: 'Collab Provider experienced an unrecoverable error',
@@ -96,6 +95,14 @@ export var errorCodeMapper = function errorCodeMapper(error) {
         reason: (_error$data3 = error.data) === null || _error$data3 === void 0 ? void 0 : _error$data3.code,
         status: 500
       };
+    case INTERNAL_ERROR_CODE.CATCHUP_FAILED:
+      return {
+        code: PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
+        message: 'Collab Provider experienced an unrecoverable error',
+        recoverable: true,
+        reason: (_error$data4 = error.data) === null || _error$data4 === void 0 ? void 0 : _error$data4.code,
+        status: 500
+      };
     default:
       return;
   }

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

@@ -0,0 +1,69 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { createLogger } from '../helpers/utils';
+var logger = createLogger('Provider', 'orange');
+
+/**
+ * Allows us to keep track of any namespace changes from the server.
+ * @param isNamespaceLocked - whether the namespace is locked or not, defaults to false
+ */
+export var NamespaceService = /*#__PURE__*/_createClass(function NamespaceService() {
+  var _this = this;
+  var isNamespaceLocked = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+  _classCallCheck(this, NamespaceService);
+  // Primitive values are always copied
+  _defineProperty(this, "getIsNamespaceLocked", function () {
+    return _this.isNamespaceLocked;
+  });
+  /**
+   * ESS-2916 namespace status event- lock/unlock
+   */
+  _defineProperty(this, "onNamespaceStatusChanged", /*#__PURE__*/function () {
+    var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref) {
+      var isLocked, waitTimeInMs, timestamp, start;
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            isLocked = _ref.isLocked, waitTimeInMs = _ref.waitTimeInMs, timestamp = _ref.timestamp;
+            start = Date.now();
+            logger("Received a namespace status changed event ", {
+              isLocked: isLocked,
+              waitTimeInMs: waitTimeInMs,
+              timestamp: timestamp
+            });
+            if (!(isLocked && waitTimeInMs)) {
+              _context.next = 8;
+              break;
+            }
+            _this.isNamespaceLocked = true;
+            logger("Received a namespace status change event ", {
+              isLocked: isLocked
+            });
+
+            // To protect the collab editing process from locked out due to BE
+            setTimeout(function () {
+              logger("The namespace lock has expired", {
+                waitTime: Date.now() - start,
+                timestamp: timestamp
+              });
+              _this.isNamespaceLocked = false;
+            }, waitTimeInMs);
+            return _context.abrupt("return");
+          case 8:
+            _this.isNamespaceLocked = false;
+            logger("The page lock has expired");
+          case 10:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee);
+    }));
+    return function (_x) {
+      return _ref2.apply(this, arguments);
+    };
+  }());
+  this.isNamespaceLocked = isNamespaceLocked;
+});

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

@@ -2,6 +2,8 @@ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 export var PARTICIPANT_UPDATE_INTERVAL = 300 * 1000; // 300 seconds
 
+// Names are hard
+
 export var createParticipantFromPayload = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(payload, getUser) {
     var sessionId, timestamp, clientId, userId, user, participant;

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

@@ -10,20 +10,35 @@ import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { telepointerFromStep } from './telepointers-helper';
 import { createParticipantFromPayload as enrichParticipant, PARTICIPANT_UPDATE_INTERVAL } from './participants-helper';
 import { ParticipantsState } from './participants-state';
+import { createLogger } from '../helpers/utils';
+var logger = createLogger('PresenceService', 'pink');
+var SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
+
+/**
+ * This service is responsible for handling presence and participant events, as well as sending them on to the editor or NCS.
+ * @param analyticsHelper Analytics helper instance
+ * @param participantsState Starts with no participants, only add this when testing
+ * @param emit Emit from the Provider class (to the editor)
+ * @param getUser Callback to get user data from the editor
+ * @param channelBroadcast Broadcast from the Channel class (to NCS)
+ * @param sendPresenceJoined Callback to Channel class
+ */
 export var ParticipantsService = /*#__PURE__*/function () {
   function ParticipantsService(analyticsHelper) {
     var _this = this;
     var participantsState = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : new ParticipantsState();
+    var emit = arguments.length > 2 ? arguments[2] : undefined;
+    var getUser = arguments.length > 3 ? arguments[3] : undefined;
+    var channelBroadcast = arguments.length > 4 ? arguments[4] : undefined;
+    var sendPresenceJoined = arguments.length > 5 ? arguments[5] : undefined;
     _classCallCheck(this, ParticipantsService);
     /**
      * Carries out 3 things: 1) enriches the participant with user data, 2) updates the participantsState, 3) emits the presence event
      * @param payload Payload from incoming socket event
-     * @param getUser Function to get user data from confluence
-     * @param emit Function to execute emit from provider socket
      * @returns Awaitable Promise, due to getUser
      */
-    _defineProperty(this, "updateParticipant", /*#__PURE__*/function () {
-      var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(payload, getUser, emit) {
+    _defineProperty(this, "onParticipantUpdated", /*#__PURE__*/function () {
+      var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(payload) {
         var userId, participant, _this$analyticsHelper, isNewParticipant;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
@@ -40,7 +55,7 @@ export var ParticipantsService = /*#__PURE__*/function () {
               return enrichParticipant( // userId _must_ be defined, this lets the compiler know
               _objectSpread(_objectSpread({}, payload), {}, {
                 userId: userId
-              }), getUser);
+              }), _this.getUser);
             case 6:
               participant = _context.sent;
               _context.next = 12;
@@ -49,7 +64,7 @@ export var ParticipantsService = /*#__PURE__*/function () {
               _context.prev = 9;
               _context.t0 = _context["catch"](3);
               // We don't want to throw errors for Presence features as they tend to self-restore
-              (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(_context.t0, 'enriching participant');
+              (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(_context.t0, 'Error while enriching participant');
             case 12:
               if (participant) {
                 _context.next = 14;
@@ -67,36 +82,35 @@ export var ParticipantsService = /*#__PURE__*/function () {
             case 18:
               _this.emitPresence({
                 joined: [participant]
-              }, emit, 'handling participant updated event');
+              }, 'handling participant updated event');
             case 19:
             case "end":
               return _context.stop();
           }
         }, _callee, null, [[3, 9]]);
       }));
-      return function (_x, _x2, _x3) {
+      return function (_x) {
         return _ref.apply(this, arguments);
       };
     }());
     /**
      * Called when a participant leaves the session.
-     *
      * We emit the `presence` event to update the active avatars in the editor.
      */
-    _defineProperty(this, "participantLeft", function (_ref2, emit) {
+    _defineProperty(this, "onParticipantLeft", function (_ref2) {
       var sessionId = _ref2.sessionId;
       _this.participantsState.removeBySessionId(sessionId);
       _this.emitPresence({
         left: [{
           sessionId: sessionId
         }]
-      }, emit, 'participant leaving');
+      }, 'participant leaving');
     });
-    _defineProperty(this, "disconnect", function (reason, sessionId, emit) {
+    _defineProperty(this, "disconnect", function (reason, sessionId) {
       var left = _this.participantsState.getParticipants();
       _this.participantsState.clear();
       try {
-        emit('disconnected', {
+        _this.emit('disconnected', {
           reason: disconnectedReasonMapper(reason),
           sid: sessionId
         });
@@ -108,7 +122,7 @@ export var ParticipantsService = /*#__PURE__*/function () {
       if (left.length) {
         _this.emitPresence({
           left: left
-        }, emit, 'emitting presence update on disconnect');
+        }, 'emitting presence update on disconnect');
       }
     });
     /**
@@ -123,7 +137,7 @@ export var ParticipantsService = /*#__PURE__*/function () {
      * Called when we receive a telepointer update from another
      * participant.
      */
-    _defineProperty(this, "participantTelepointer", function (payload, thisSessionId, getUser, emit) {
+    _defineProperty(this, "onParticipantTelepointer", function (payload, thisSessionId) {
       var sessionId = payload.sessionId,
         selection = payload.selection,
         timestamp = payload.timestamp;
@@ -141,30 +155,29 @@ export var ParticipantsService = /*#__PURE__*/function () {
         type: 'telepointer',
         selection: selection,
         sessionId: sessionId
-      }, emit, 'handling participant telepointer event');
+      }, 'handling participant telepointer event');
     });
     /**
      * Every 5 minutes (PARTICIPANT_UPDATE_INTERVAL), removes inactive participants and emits the update to other participants.
      * Needs to be kicked off in the Provider.
      * @param sessionId SessionId from provider's connection
-     * @param emit Function to execute emit from provider socket
      */
-    _defineProperty(this, "removeInactiveParticipants", function (sessionId, emit) {
+    _defineProperty(this, "startInactiveRemover", function (sessionId) {
       clearTimeout(_this.participantUpdateTimeout);
       try {
-        _this.filterInactive(sessionId, emit);
+        _this.filterInactive(sessionId);
       } catch (err) {
         var _this$analyticsHelper3;
         (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(err, 'Failed filtering inactive participants');
       }
       _this.participantUpdateTimeout = window.setTimeout(function () {
-        return _this.removeInactiveParticipants(sessionId, emit);
+        return _this.startInactiveRemover(sessionId);
       }, PARTICIPANT_UPDATE_INTERVAL);
     });
     /**
      * Keep list of participants up to date. Filter out inactive users etc.
      */
-    _defineProperty(this, "filterInactive", function (sessionId, emit) {
+    _defineProperty(this, "filterInactive", function (sessionId) {
       var now = Date.now();
       var left = _this.participantsState.getParticipants().filter(function (p) {
         return p.sessionId !== sessionId && now - p.lastActive > PARTICIPANT_UPDATE_INTERVAL;
@@ -174,17 +187,17 @@ export var ParticipantsService = /*#__PURE__*/function () {
       });
       left.length && _this.emitPresence({
         left: left
-      }, emit, 'filtering inactive participants');
+      }, 'filtering inactive participants');
     });
     /**
      * Wrapper function to emit with error handling and analytics
      * @param data Data to emit
      * @param emit Emit function from Provider
      */
-    _defineProperty(this, "emitPresence", function (data, emit, errorMessage) {
+    _defineProperty(this, "emitPresence", function (data, errorMessage) {
       try {
         var _this$analyticsHelper4;
-        emit('presence', data);
+        _this.emit('presence', data);
         (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendActionEvent(EVENT_ACTION.UPDATE_PARTICIPANTS, EVENT_STATUS.SUCCESS, {
           participants: _this.participantsState.size()
         });
@@ -199,9 +212,9 @@ export var ParticipantsService = /*#__PURE__*/function () {
      * @param data Data to emit
      * @param emit Emit function from Provider
      */
-    _defineProperty(this, "emitTelepointer", function (data, emit, errorMessage) {
+    _defineProperty(this, "emitTelepointer", function (data, errorMessage) {
       try {
-        emit('telepointer', data);
+        _this.emit('telepointer', data);
       } catch (error) {
         var _this$analyticsHelper6;
         // We don't want to throw errors for Presence features as they tend to self-restore
@@ -214,8 +227,60 @@ export var ParticipantsService = /*#__PURE__*/function () {
     _defineProperty(this, "clearTimers", function () {
       clearTimeout(_this.participantUpdateTimeout);
     });
-    this.participantsState = participantsState;
+    _defineProperty(this, "sendPresence", function (payload) {
+      try {
+        clearTimeout(_this.presenceUpdateTimeout);
+        _this.channelBroadcast('participant:updated', payload);
+        _this.presenceUpdateTimeout = window.setTimeout(function () {
+          return _this.sendPresence(payload);
+        }, SEND_PRESENCE_INTERVAL);
+      } catch (error) {
+        var _this$analyticsHelper7;
+        // We don't want to throw errors for Presence features as they tend to self-restore
+        (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(error, 'Error while sending presence');
+      }
+    });
+    /**
+     * Called when a participant joins the session.
+     *
+     * We keep track of participants internally, and emit the `presence` event to update
+     * the active avatars in the editor.
+     * This method will be triggered from backend to notify all participants to exchange presence
+     */
+    _defineProperty(this, "onPresenceJoined", function (payload) {
+      try {
+        logger('Participant joined with session: ', payload.sessionId);
+        // This expose existing users to the newly joined user
+        _this.sendPresence(payload);
+      } catch (error) {
+        var _this$analyticsHelper8;
+        // We don't want to throw errors for Presence features as they tend to self-restore
+        (_this$analyticsHelper8 = _this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(error, 'Error while joining presence');
+      }
+    });
+    /**
+     * Called when the current user joins the session.
+     *
+     * This will send both a 'presence' event and a 'participant:updated' event.
+     * This updates both the avatars and the participants list.
+     */
+    _defineProperty(this, "onPresence", function (payload) {
+      try {
+        logger('onPresence userId: ', payload.userId);
+        _this.sendPresence(payload);
+        _this.sendPresenceJoined();
+      } catch (error) {
+        var _this$analyticsHelper9;
+        // We don't want to throw errors for Presence features as they tend to self-restore
+        (_this$analyticsHelper9 = _this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(error, 'Error while receiving presence');
+      }
+    });
     this.analyticsHelper = analyticsHelper;
+    this.participantsState = participantsState;
+    this.emit = emit;
+    this.getUser = getUser;
+    this.channelBroadcast = channelBroadcast;
+    this.sendPresenceJoined = sendPresenceJoined;
   }
   _createClass(ParticipantsService, [{
     key: "emitTelepointersFromSteps",
@@ -223,14 +288,13 @@ export var ParticipantsService = /*#__PURE__*/function () {
     /**
      * Called on receiving steps, emits each step's telepointer
      * @param steps Steps to extract telepointers from
-     * @param emit Provider emit function
      */
-    function emitTelepointersFromSteps(steps, emit) {
+    function emitTelepointersFromSteps(steps) {
       var _this2 = this;
       steps.forEach(function (step) {
         var event = telepointerFromStep(_this2.participantsState.getParticipants(), step);
         if (event) {
-          _this2.emitTelepointer(event, emit, 'emitting telepointers from steps');
+          _this2.emitTelepointer(event, 'emitting telepointers from steps');
         }
       });
     }