@atlaskit/collab-provider 7.0.0 → 7.1.2

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @atlaskit/collab-provider
 
+## 7.1.2
+
+### Patch Changes
+
+- Updated dependencies
+
+## 7.1.1
+
+### Patch Changes
+
+- [`c6feed82071`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c6feed82071) - ED-11632: Bump prosemirror packages;
+
+  - prosmirror-commands 1.1.4 -> 1.1.11,
+  - prosemirror-model 1.11.0 -> 1.14.3,
+  - prosemirror-state 1.3.3 -> 1.3.4,
+  - prosemirror-transform 1.2.8 -> 1.3.2,
+  - prosemirror-view 1.15.4 + 1.18.8 -> 1.20.2.
+
+- [`b670f0469c4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b670f0469c4) - COLLAB-990: fixing duplciated avatar
+- Updated dependencies
+
+## 7.1.0
+
+### Minor Changes
+
+- [`cf853e39278`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cf853e39278) - COLLAB-411-change-to-metadata: 'setTitle' and 'setEditorWidth' are deprecated, going to be removed in the next release, use 'setMetadata' instead.
+- [`10d7bc384aa`](https://bitbucket.org/atlassian/atlassian-frontend/commits/10d7bc384aa) - COLLAB-933: add disconnected event
+
+### Patch Changes
+
+- Updated dependencies
+
+## 7.0.1
+
+### Patch Changes
+
+- [`2f5b81920af`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2f5b81920af) - Refactor the provider class in collab provider
+- [`0ec1c930f96`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0ec1c930f96) - NONE: tuning catchup trigger
+- Updated dependencies
+
 ## 7.0.0
 
 ### Major Changes

package/disconnected-reason-mapper/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@atlaskit/collab-provider/disconnected-reason-mapper",
+  "main": "../dist/cjs/disconnected-reason-mapper.js",
+  "module": "../dist/esm/disconnected-reason-mapper.js",
+  "module:es2019": "../dist/es2019/disconnected-reason-mapper.js",
+  "types": "../dist/types/disconnected-reason-mapper.d.ts"
+}

package/dist/cjs/analytics/index.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.triggerAnalyticsForCatchupSuccessfulWithLatency = exports.triggerAnalyticsForCatchupFailed = exports.triggerAnalyticsForStepsRejected = exports.triggerAnalyticsForStepsAddedSuccessfully = exports.fireAnalyticsEvent = exports.buildAnalyticsPayload = void 0;
+exports.triggerAnalyticsForStepsRejected = exports.triggerAnalyticsForStepsAddedSuccessfully = exports.triggerAnalyticsForCatchupSuccessfulWithLatency = exports.triggerAnalyticsForCatchupFailed = exports.fireAnalyticsEvent = exports.buildAnalyticsPayload = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 

package/dist/cjs/analytics/performance.js

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.clearMeasure = clearMeasure;
 exports.startMeasure = startMeasure;
 exports.stopMeasure = stopMeasure;
-exports.clearMeasure = clearMeasure;
 
 var isPerformanceAPIAvailable = function isPerformanceAPIAvailable() {
   return typeof window !== 'undefined' && 'performance' in window && ['measure', 'clearMeasures', 'clearMarks', 'getEntriesByName', 'getEntriesByType'].every(function (api) {

package/dist/cjs/channel.js

@@ -33,6 +33,10 @@ var _errorCodeMapper = require("./error-code-mapper");
 
 var _utils = require("./helpers/utils");
 
+var _performance = require("./analytics/performance");
+
+var _analytics = require("./analytics");
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
@@ -98,6 +102,11 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       }
     });
     _this.config = config;
+
+    if (config.analyticsClient) {
+      _this.analyticsClient = config.analyticsClient;
+    }
+
     return _this;
   } // read-only getters used for tests
 
@@ -154,8 +163,11 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       this.socket.on('participant:telepointer', function (payload) {
         _this2.emit('participant:telepointer', payload.data);
       });
-      this.socket.on('participant:joined', function (data) {
-        _this2.emit('participant:joined', data);
+      this.socket.on('presence:joined', function (data) {
+        _this2.emit('presence:joined', data);
+      });
+      this.socket.on('presence', function (data) {
+        _this2.emit('presence', data);
       });
       this.socket.on('participant:left', function (data) {
         _this2.emit('participant:left', data);
@@ -172,11 +184,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
           clientId: clientId
         }, data));
       });
-      this.socket.on('title:changed', function (payload) {
-        _this2.emit('title:changed', payload.data);
-      });
-      this.socket.on('width:changed', function (payload) {
-        _this2.emit('width:changed', payload.data);
+      this.socket.on('metadata:changed', function (payload) {
+        _this2.emit('metadata:changed', payload);
       });
       this.socket.on('disconnect', /*#__PURE__*/function () {
         var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(reason) {
@@ -235,6 +244,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     key: "fetchCatchup",
     value: function () {
       var _fetchCatchup = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(fromVersion) {
+        var _this3 = this;
+
         var _yield$utils$requestS, doc, version, stepMaps, metadata, errorCatchup;
 
         return _regenerator.default.wrap(function _callee2$(_context2) {
@@ -242,6 +253,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
             switch (_context2.prev = _context2.next) {
               case 0:
                 _context2.prev = 0;
+                (0, _performance.startMeasure)('callingCatchupApi');
                 _context2.t0 = _utilServiceSupport.utils;
                 _context2.t1 = this.config;
                 _context2.t2 = _objectSpread;
@@ -253,14 +265,14 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                 };
 
                 if (!this.config.permissionTokenRefresh) {
-                  _context2.next = 14;
+                  _context2.next = 15;
                   break;
                 }
 
-                _context2.next = 8;
+                _context2.next = 9;
                 return this.config.permissionTokenRefresh();
 
-              case 8:
+              case 9:
                 _context2.t5 = _context2.sent;
                 _context2.t6 = {
                   'x-token': _context2.t5
@@ -271,19 +283,19 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                 _context2.t4 = {
                   requestInit: _context2.t7
                 };
-                _context2.next = 15;
+                _context2.next = 16;
                 break;
 
-              case 14:
+              case 15:
                 _context2.t4 = {};
 
-              case 15:
+              case 16:
                 _context2.t8 = _context2.t4;
                 _context2.t9 = (0, _context2.t2)(_context2.t3, _context2.t8);
-                _context2.next = 19;
+                _context2.next = 20;
                 return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t9);
 
-              case 19:
+              case 20:
                 _yield$utils$requestS = _context2.sent;
                 doc = _yield$utils$requestS.doc;
                 version = _yield$utils$requestS.version;
@@ -296,8 +308,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                   metadata: metadata
                 });
 
-              case 27:
-                _context2.prev = 27;
+              case 28:
+                _context2.prev = 28;
                 _context2.t10 = _context2["catch"](0);
                 logger("Can't fetch the catchup", _context2.t10.message);
                 errorCatchup = {
@@ -310,12 +322,19 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                 this.emit('error', errorCatchup);
                 return _context2.abrupt("return", {});
 
-              case 33:
+              case 34:
+                _context2.prev = 34;
+                (0, _performance.stopMeasure)('callingCatchupApi', function (duration, _) {
+                  (0, _analytics.triggerAnalyticsForCatchupSuccessfulWithLatency)(_this3.analyticsClient, duration);
+                });
+                return _context2.finish(34);
+
+              case 37:
               case "end":
                 return _context2.stop();
             }
           }
-        }, _callee2, this, [[0, 27]]);
+        }, _callee2, this, [[0, 28, 34, 37]]);
       }));
 
       function fetchCatchup(_x2) {
@@ -339,6 +358,24 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         type: type
       }, data));
     }
+  }, {
+    key: "sendMetadata",
+    value: function sendMetadata(metadata) {
+      if (!this.connected || !this.socket) {
+        return;
+      }
+
+      this.socket.emit('metadata', metadata);
+    }
+  }, {
+    key: "sendPresenceJoined",
+    value: function sendPresenceJoined() {
+      if (!this.connected || !this.socket) {
+        return;
+      }
+
+      this.socket.emit('presence:joined');
+    }
   }, {
     key: "disconnect",
     value: function disconnect() {

package/dist/cjs/disconnected-reason-mapper.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.socketIOReasons = exports.DisconnectReason = void 0;
+// See https://socket.io/docs/v3/client-socket-instance#disconnect for emitted reasons
+var socketIOReasons = {
+  IO_CLIENT_DISCONNECT: 'io client disconnect',
+  // The socket was manually disconnected using socket.disconnect()
+  IO_SERVER_DISCONNECT: 'io server disconnect',
+  // The server has forcefully disconnected the socket with socket.disconnect()
+  TRANSPORT_CLOSED: 'transport close',
+  // The server did not send a PING within the pingInterval + pingTimeout range
+  TRANSPORT_ERROR: 'transport error',
+  // The connection was closed (example: the user has lost connection, or the network was changed from WiFi to 4G)
+  PING_TIMEOUT: 'ping timeout' // The connection has encountered an error (example: the server was killed during a HTTP long-polling cycle)
+
+};
+exports.socketIOReasons = socketIOReasons;
+var DisconnectReason;
+exports.DisconnectReason = DisconnectReason;
+
+(function (DisconnectReason) {
+  DisconnectReason["CLIENT_DISCONNECT"] = "CLIENT_DISCONNECT";
+  DisconnectReason["SERVER_DISCONNECT"] = "SERVER_DISCONNECT";
+  DisconnectReason["SOCKET_CLOSED"] = "SOCKET_CLOSED";
+  DisconnectReason["SOCKET_ERROR"] = "SOCKET_ERROR";
+  DisconnectReason["SOCKET_TIMEOUT"] = "SOCKET_TIMEOUT";
+  DisconnectReason["UNKNOWN_DISCONNECT"] = "UNKNOWN_DISCONNECT";
+})(DisconnectReason || (exports.DisconnectReason = DisconnectReason = {}));

package/dist/cjs/error-code-mapper.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ErrorCodeMapper = void 0;
+exports.errorCodeMapper = exports.ErrorCodeMapper = void 0;
 var ErrorCodeMapper = {
   noPermissionError: {
     code: 'NO_PERMISSION_ERROR',
@@ -34,4 +34,45 @@ var ErrorCodeMapper = {
     message: 'Collab service has return internal server error'
   }
 };
-exports.ErrorCodeMapper = ErrorCodeMapper;
+exports.ErrorCodeMapper = ErrorCodeMapper;
+
+var errorCodeMapper = function errorCodeMapper(error) {
+  if (error.data) {
+    switch (error.data.code) {
+      case 'INSUFFICIENT_EDITING_PERMISSION':
+        return {
+          status: 403,
+          code: ErrorCodeMapper.noPermissionError.code,
+          message: ErrorCodeMapper.noPermissionError.message
+        };
+
+      case 'DOCUMENT_NOT_FOUND':
+        return {
+          status: 404,
+          code: ErrorCodeMapper.documentNotFound.code,
+          message: ErrorCodeMapper.documentNotFound.message
+        };
+
+      case 'FAILED_ON_S3':
+      case 'DYNAMO_ERROR':
+        return {
+          status: 500,
+          code: ErrorCodeMapper.failToSave.code,
+          message: ErrorCodeMapper.failToSave.message
+        };
+
+      case 'CATCHUP_FAILED':
+      case 'GET_QUERY_TIME_OUT':
+        return {
+          status: 500,
+          code: ErrorCodeMapper.internalError.code,
+          message: ErrorCodeMapper.internalError.message
+        };
+
+      default:
+        break;
+    }
+  }
+};
+
+exports.errorCodeMapper = errorCodeMapper;

package/dist/cjs/helpers/const.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ACK_MAX_TRY = exports.CATCHUP_FAILURE = exports.CATCHUP_SUCCESS = exports.ATTRIBUTES_PACKAGE = exports.STEPS_REJECTED = exports.STEPS_ADDED = void 0;
+exports.STEPS_REJECTED = exports.STEPS_ADDED = exports.CATCHUP_SUCCESS = exports.CATCHUP_FAILURE = exports.ATTRIBUTES_PACKAGE = exports.ACK_MAX_TRY = void 0;
 var STEPS_ADDED = 'collabStepsAddedSuccess';
 exports.STEPS_ADDED = STEPS_ADDED;
 var STEPS_REJECTED = 'collabStepsAddedRejected';

package/dist/cjs/helpers/utils.js

@@ -3,8 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.sleep = sleep;
 exports.getParticipant = exports.createLogger = void 0;
+exports.sleep = sleep;
 
 var createLogger = function createLogger(prefix) {
   var color = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'blue';
@@ -13,27 +13,22 @@ var createLogger = function createLogger(prefix) {
 
     if (window.COLLAB_PROVIDER_LOGGER) {
       // eslint-disable-next-line no-console
-      console.log("%cCollab-".concat(prefix, ": ").concat(msg), "color: ".concat(color, "; font-weight: bold"));
-
-      if (data) {
-        // eslint-disable-next-line no-console
-        console.log(data);
-      }
+      console.log("%cCollab-".concat(prefix, ": ").concat(msg), "color: ".concat(color, "; font-weight: bold"), data);
     }
   };
 };
 
 exports.createLogger = createLogger;
+var logger = createLogger('Helper:util', 'black');
 
 var getParticipant = function getParticipant(userId) {
-  // eslint-disable-next-line no-bitwise
-  var name = 'Demo User';
-  return Promise.resolve({
+  logger('getParticipant: ', userId);
+  return {
     userId: userId,
-    name: name,
-    avatar: "https://api.adorable.io/avatars/80/".concat(name.replace(/\s/g, ''), ".png"),
-    email: "".concat(name.replace(/\s/g, '').toLocaleLowerCase(), "@atlassian.com")
-  });
+    name: userId,
+    avatar: '',
+    email: "".concat(userId.replace(/\s/g, '').toLocaleLowerCase(), "@atlassian.com")
+  };
 };
 
 exports.getParticipant = getParticipant;

package/dist/cjs/provider/catchup.js

@@ -0,0 +1,147 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.catchup = void 0;
+exports.rebaseSteps = rebaseSteps;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _utils = require("../helpers/utils");
+
+var _prosemirrorTransform = require("prosemirror-transform");
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+var logger = (0, _utils.createLogger)('Catchup', 'red');
+/**
+ * Rebase the steps based on the mapping pipeline.
+ * Some steps could be lost, if they are no longer
+ * invalid after rebased.
+ */
+
+function rebaseSteps(steps, mapping) {
+  var newSteps = [];
+
+  var _iterator = _createForOfIteratorHelper(steps),
+      _step;
+
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var step = _step.value;
+      var newStep = step.map(mapping); // newStep could be null(means invalid after rebase) when can't rebase.
+
+      if (newStep) {
+        newSteps.push(newStep);
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+
+  return newSteps;
+}
+
+var catchup = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(opt) {
+    var _yield$opt$fetchCatch, doc, serverStepMaps, serverVersion, metadata, currentPmVersion, _ref2, unconfirmedSteps, stepMaps, mapping, newUnconfirmedSteps;
+
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return opt.fetchCatchup(opt.getCurrentPmVersion());
+
+          case 2:
+            _yield$opt$fetchCatch = _context.sent;
+            doc = _yield$opt$fetchCatch.doc;
+            serverStepMaps = _yield$opt$fetchCatch.stepMaps;
+            serverVersion = _yield$opt$fetchCatch.version;
+            metadata = _yield$opt$fetchCatch.metadata;
+
+            if (doc) {
+              currentPmVersion = opt.getCurrentPmVersion();
+
+              if (typeof serverVersion === 'undefined') {
+                logger("Could not determine server version");
+              } else if (serverVersion <= currentPmVersion) {
+                logger("Catchup steps we already have. Ignoring.");
+              } else {
+                // Please, do not use those steps inside of async
+                // method. That will lead to outdated steps
+                _ref2 = opt.getUnconfirmedSteps() || {
+                  steps: []
+                }, unconfirmedSteps = _ref2.steps;
+                logger("Too far behind[current: v".concat(currentPmVersion, ", server: v").concat(serverVersion, ". ").concat(serverStepMaps.length, " steps need to catchup]"));
+                /**
+                 * Remove steps from queue where the version is older than
+                 * the version we received from service. Keep steps that might be
+                 * newer.
+                 */
+
+                opt.fitlerQueue(function (data) {
+                  return data.version > serverVersion;
+                }); // We are too far behind - replace the entire document
+
+                logger("Replacing document: ".concat(doc));
+                logger("getting metadata: ".concat(metadata)); // Replace local document and version number
+
+                opt.updateDocumentWithMetadata({
+                  doc: JSON.parse(doc),
+                  version: serverVersion,
+                  metadata: metadata,
+                  reserveCursor: true
+                }); // After replacing the whole document in the editor, we need to reapply the unconfirmed
+                // steps back into the editor, so we don't lose any data. But before that, we need to rebase
+                // those steps since their position could be changed after replacing.
+                // https://prosemirror.net/docs/guide/#transform.rebasing
+
+                if (unconfirmedSteps.length) {
+                  // Create StepMap from StepMap JSON
+                  // eslint-disable-next-line no-unused-vars
+                  stepMaps = serverStepMaps.map(function (_ref3) {
+                    var ranges = _ref3.ranges,
+                        inverted = _ref3.inverted;
+                    // Due to @types/prosemirror-transform mismatch with the actual
+                    // constructor, hack to set the `inverted`.
+                    var stepMap = new _prosemirrorTransform.StepMap(ranges);
+                    stepMap.inverted = inverted;
+                    return stepMap;
+                  }); // create Mappng used for Step.map
+
+                  mapping = new _prosemirrorTransform.Mapping(stepMaps);
+                  logger("".concat(unconfirmedSteps.length, " unconfirmed steps before rebased: ").concat(JSON.stringify(unconfirmedSteps)));
+                  newUnconfirmedSteps = rebaseSteps(unconfirmedSteps, mapping);
+                  logger("Re-aply ".concat(newUnconfirmedSteps.length, " mapped unconfirmed steps: ").concat(JSON.stringify(newUnconfirmedSteps))); // Re-aply local steps
+
+                  opt.applyLocalsteps(newUnconfirmedSteps);
+                }
+              }
+            }
+
+          case 8:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function catchup(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+exports.catchup = catchup;