@atlaskit/collab-provider 10.14.3 → 10.15.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @atlaskit/collab-provider
 
+## 10.15.0
+
+### Minor Changes
+
+- [#157909](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/157909)
+  [`384136c930190`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/384136c930190) -
+  Add support for initializing collab-provider with presenceActivity
+
+## 10.14.4
+
+### Patch Changes
+
+- [#144227](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/144227)
+  [`6da190d8e3a24`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6da190d8e3a24) -
+  Add ability to rebase drag and drop content
+- [#155123](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/155123)
+  [`51d32b995a851`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/51d32b995a851) -
+  ED-27636 Offline Editing: Add catchup reason and other metadata to catchup failure error log in
+  collab provider.
+- Updated dependencies
+
 ## 10.14.3
 
 ### Patch Changes

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

@@ -151,7 +151,10 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
               _context.t0 = _context["catch"](8);
               _latency = new Date().getTime() - start;
               (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.FAILURE, {
-                latency: _latency
+                latency: _latency,
+                reason: reason,
+                unconfirmedStepsLength: reconnectionMetadata === null || reconnectionMetadata === void 0 ? void 0 : reconnectionMetadata.unconfirmedStepsLength,
+                disconnectionPeriodSeconds: reconnectionMetadata === null || reconnectionMetadata === void 0 ? void 0 : reconnectionMetadata.disconnectionPeriodSeconds
               });
             case 20:
               _context.prev = 20;

package/dist/cjs/document/getConflictChanges.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.getConflictChanges = getConflictChanges;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _prosemirrorChangeset = require("prosemirror-changeset");
+var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
 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; }
 var simplifySteps = function simplifySteps(steps) {
@@ -77,36 +78,34 @@ var getConflicts = function getConflicts(_ref) {
 };
 
 /**
- * Almost a copy of the rebaseSteps in the collab algorithm (which gets called
- * synchronously after this).
- *
- * This also tracks the intermediate documents so we can generate the changesets
- * to use for finding any overlapping regions.
+ * This runs a collab rebase (that is run synchronously after this)
+ * and extracts the local doc (before changes), remote doc and the
+ * mapping to determine any conflicts.
  * See: `packages/editor/prosemirror-collab/src/index.ts`
  */
 var rebaseSteps = function rebaseSteps(_ref2) {
-  var _tr$mapping$maps;
+  var _tr$mapping$maps, _tr$docs, _tr$docs2;
   var localSteps = _ref2.localSteps,
     remoteSteps = _ref2.remoteSteps,
     tr = _ref2.tr;
-  for (var i = (localSteps === null || localSteps === void 0 ? void 0 : localSteps.length) - 1; i >= 0; i--) {
-    tr.step(localSteps[i].inverted);
-  }
-  var originalDoc = tr.doc;
-  var mapStart = (_tr$mapping$maps = tr.mapping.maps) === null || _tr$mapping$maps === void 0 ? void 0 : _tr$mapping$maps.length;
-  for (var _i = 0; _i < remoteSteps.length; _i++) {
-    tr.step(remoteSteps[_i]);
-  }
-  var remoteDoc = tr.doc;
-  for (var _i2 = 0, mapFrom = localSteps.length; _i2 < localSteps.length; _i2++) {
-    var mapped = localSteps[_i2].step.map(tr.mapping.slice(mapFrom));
-    mapFrom--;
-    if (mapped && !tr.maybeStep(mapped).failed) {
-      // Open ticket for setMirror https://github.com/ProseMirror/prosemirror/issues/869
-      // @ts-expect-error
-      tr.mapping.setMirror(mapFrom, tr.steps.length - 1);
-    }
-  }
+  var originalMapsLength = (_tr$mapping$maps = tr.mapping.maps) === null || _tr$mapping$maps === void 0 ? void 0 : _tr$mapping$maps.length;
+  var originalDocsLength = tr.docs.length;
+  (0, _prosemirrorCollab.rebaseSteps)(localSteps, remoteSteps, tr);
+  /**
+   * `tr.docs` contains the documents before each change.
+   *
+   * To get "originalDoc" we need to get the document immediately after the local steps are inverted
+   * which is the equal to the number of local steps. If there are no remote steps this will be undefined and
+   * the most current document is appropriate
+   *
+   * To get the "remoteDoc" we need to get the document immediately after the local steps have been inverted
+   * and the remote steps re-applied. If there are no local steps or they are all lost in rebase this will be
+   * undefined and the most current document is appropriate
+   *
+   */
+  var originalDoc = (_tr$docs = tr.docs[originalDocsLength + localSteps.length]) !== null && _tr$docs !== void 0 ? _tr$docs : tr.doc;
+  var remoteDoc = (_tr$docs2 = tr.docs[originalDocsLength + localSteps.length + remoteSteps.length]) !== null && _tr$docs2 !== void 0 ? _tr$docs2 : tr.doc;
+  var mapStart = originalMapsLength + localSteps.length;
   return {
     mapStart: mapStart,
     originalDoc: originalDoc,

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

@@ -4,13 +4,15 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createParticipantFromPayload = exports.PARTICIPANT_UPDATE_INTERVAL = void 0;
+exports.fetchParticipants = exports.createParticipantFromPayload = exports.PARTICIPANT_UPDATE_INTERVAL = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var PARTICIPANT_UPDATE_INTERVAL = exports.PARTICIPANT_UPDATE_INTERVAL = 300 * 1000; // 300 seconds
 
 // Names are hard
 
+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;
@@ -33,7 +35,8 @@ var createParticipantFromPayload = exports.createParticipantFromPayload = /*#__P
             permit: permit,
             isGuest: user === null || user === void 0 ? void 0 : user.isGuest,
             presenceId: presenceId,
-            presenceActivity: presenceActivity
+            presenceActivity: presenceActivity,
+            isHydrated: !!user
           };
           return _context.abrupt("return", participant);
         case 6:
@@ -45,4 +48,78 @@ var createParticipantFromPayload = exports.createParticipantFromPayload = /*#__P
   return function createParticipantFromPayload(_x, _x2) {
     return _ref.apply(this, arguments);
   };
+}();
+
+/**
+ * Will use the getUsers callback from batchProps to fetch users
+ *
+ * 1. Determine all the participants that need to be hydrated
+ * 2. Only fetch a subset of those participants based on batchSize
+ * 3. Of the users fetched, find all of those users' sessions and mark those entries as hydrated
+ *
+ * @param participantsState
+ * @param batchProps
+ * @returns
+ * @example
+ */
+var fetchParticipants = exports.fetchParticipants = /*#__PURE__*/function () {
+  var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(participantsState, batchProps) {
+    var _batchProps$batchSize, batchSize, getUsers, participantsToHydrate, participants, aaids, users, hydratedParticipants;
+    return _regenerator.default.wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          _batchProps$batchSize = batchProps.batchSize, batchSize = _batchProps$batchSize === void 0 ? DEFAULT_BATCH_FETCH_SIZE : _batchProps$batchSize, getUsers = batchProps.getUsers;
+          participantsToHydrate = participantsState.getUniqueParticipants({
+            isHydrated: false
+          });
+          participants = participantsToHydrate.splice(0, batchSize);
+          if (participants.length) {
+            _context2.next = 5;
+            break;
+          }
+          return _context2.abrupt("return", []);
+        case 5:
+          aaids = new Set();
+          participants.forEach(function (p) {
+            aaids.add(p.userId);
+          });
+          _context2.next = 9;
+          return getUsers === null || getUsers === void 0 ? void 0 : getUsers((0, _toConsumableArray2.default)(aaids.values()));
+        case 9:
+          users = _context2.sent;
+          hydratedParticipants = [];
+          users === null || users === void 0 || users.forEach(function (user) {
+            // find all sessions of the user we just hydrated and populate data
+            participantsState.getParticipants().filter(function (p) {
+              return p.userId === user.userId;
+            }).forEach(function (participant) {
+              var sessionId = participant.sessionId;
+              var hydratedParticipant = {
+                name: user.name,
+                avatar: user.avatar,
+                email: user.email,
+                userId: user.userId,
+                isGuest: user.isGuest,
+                sessionId: sessionId,
+                lastActive: participant.lastActive,
+                clientId: participant.clientId,
+                permit: participant.permit,
+                presenceId: participant.presenceId,
+                presenceActivity: participant.presenceActivity,
+                isHydrated: true
+              };
+              participantsState.setBySessionId(sessionId, hydratedParticipant);
+              hydratedParticipants.push(hydratedParticipant);
+            });
+          });
+          return _context2.abrupt("return", hydratedParticipants);
+        case 13:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  }));
+  return function fetchParticipants(_x3, _x4) {
+    return _ref2.apply(this, arguments);
+  };
 }();