@atlaskit/collab-provider 7.6.3 → 8.0.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @atlaskit/collab-provider
 
+## 8.0.0
+
+### Major Changes
+
+- [`618b64f0d8c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/618b64f0d8c) - Introduce ufo and measure document init latency with histogram
+
+### Minor Changes
+
+- [`83060253868`](https://bitbucket.org/atlassian/atlassian-frontend/commits/83060253868) - [ESS-2752] Introduced the capability to distinguish step commit failures due to errors and step rejections in collab provider analytics
+- [`cc8b81f8fd8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cc8b81f8fd8) - Use socket.io acknowledgements to improve add-step performance tracking
+- [`50d8749c3fa`](https://bitbucket.org/atlassian/atlassian-frontend/commits/50d8749c3fa) - Track telepointer latency
+
+### Patch Changes
+
+- [`0a482422f75`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0a482422f75) - Update add-steps analytic
+- [`9f1f34a71ea`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9f1f34a71ea) - [ESS-3020] Turned all type dependencies in dev dependencies
+- [`de027d19a65`](https://bitbucket.org/atlassian/atlassian-frontend/commits/de027d19a65) - Handle null for permission token refresh callback response
+- [`62332c99254`](https://bitbucket.org/atlassian/atlassian-frontend/commits/62332c99254) - ESS-2964 - add numSteps and stepType to ADD-STEPS analytic events
+- Updated dependencies
+
+## 7.7.0
+
+### Minor Changes
+
+- [`fa0da169cce`](https://bitbucket.org/atlassian/atlassian-frontend/commits/fa0da169cce) - Introducing namespace status update: lock & unlock events
+- [`eaada7441d0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/eaada7441d0) - ESS-2853 Add metrics for page recovery events
+- [`6319cd08784`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6319cd08784) - add page restoration event handler
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 7.6.3
 
 ### Patch Changes

package/dist/cjs/analytics/index.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.triggerCollabAnalyticsEvent = exports.fireAnalyticsEvent = void 0;
+exports.triggerAnalyticsEvent = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -17,40 +17,30 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
-var fireAnalyticsEvent = function fireAnalyticsEvent(analyticsClient, payload) {
-  if (!analyticsClient || !payload) {
+var triggerAnalyticsEvent = function triggerAnalyticsEvent(analyticsEvent, analyticsClient) {
+  if (!analyticsClient) {
     return;
   }
 
-  var client = analyticsClient;
-  var requestIdleCallbackFunction = window.requestIdleCallback;
-  var runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame; // Let the browser figure out
-  // when it should send those events
-
-  runItLater(function () {
-    client.sendOperationalEvent(_objectSpread(_objectSpread({
-      action: 'collab'
-    }, payload), {}, {
-      source: payload.source || 'unknown',
-      tags: ['editor']
-    }));
-  });
-};
-
-exports.fireAnalyticsEvent = fireAnalyticsEvent;
-
-var triggerCollabAnalyticsEvent = function triggerCollabAnalyticsEvent(analyticsEvent, analyticsClient) {
   var payload = {
-    action: analyticsEvent.eventAction,
     actionSubject: _const.EVENT_SUBJECT,
-    source: 'unknown',
     attributes: _objectSpread({
       packageName: _versionWrapper.name,
       packageVersion: _versionWrapper.version,
       collabService: _const.COLLAB_SERVICE.NCS
-    }, analyticsEvent.attributes)
-  };
-  fireAnalyticsEvent(analyticsClient, payload);
+    }, analyticsEvent.attributes),
+    tags: ['editor'],
+    action: analyticsEvent.eventAction,
+    source: 'unknown' // Adds zero analytics value, but event validation throws an error if you don't add it :-(
+
+  }; // Let the browser figure out
+  // when it should send those events
+
+  var requestIdleCallbackFunction = window.requestIdleCallback;
+  var runItLater = typeof requestIdleCallbackFunction === 'function' ? requestIdleCallbackFunction : window.requestAnimationFrame;
+  runItLater(function () {
+    analyticsClient.sendOperationalEvent(payload);
+  });
 };
 
-exports.triggerCollabAnalyticsEvent = triggerCollabAnalyticsEvent;
+exports.triggerAnalyticsEvent = triggerAnalyticsEvent;

package/dist/cjs/analytics/performance.js

@@ -11,11 +11,9 @@ var MEASURE_NAME;
 exports.MEASURE_NAME = MEASURE_NAME;
 
 (function (MEASURE_NAME) {
-  MEASURE_NAME["CALLING_CATCHUP_API"] = "callingCatchupApi";
   MEASURE_NAME["SOCKET_CONNECT"] = "socketConnect";
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
   MEASURE_NAME["CONVERT_PM_TO_ADF"] = "convertPMToADF";
-  MEASURE_NAME["ADD_STEPS"] = "addSteps";
   MEASURE_NAME["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
 })(MEASURE_NAME || (exports.MEASURE_NAME = MEASURE_NAME = {}));
 

package/dist/cjs/channel.js

@@ -39,6 +39,8 @@ var _analytics = require("./analytics");
 
 var _const = require("./helpers/const");
 
+var _ufo = require("@atlaskit/ufo");
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -62,6 +64,15 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "connected", false);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "socket", null);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "initialized", false);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "initExperience", new _ufo.UFOExperience('collab-provider.document-init', {
+      type: _ufo.ExperienceTypes.Load,
+      performanceType: _ufo.ExperiencePerformanceTypes.Custom,
+      performanceConfig: {
+        histogram: (0, _defineProperty2.default)({}, _ufo.ExperiencePerformanceTypes.Custom, {
+          duration: '250_500_1000_1500_2000_3000_4000'
+        })
+      }
+    }));
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getInitialized", function () {
       return _this.initialized;
     });
@@ -75,7 +86,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       _this.connected = true;
       logger('Connected.', _this.socket.id);
       var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT);
-      (0, _analytics.triggerCollabAnalyticsEvent)({
+      (0, _analytics.triggerAnalyticsEvent)({
         eventAction: _const.EVENT_ACTION.CONNECTION,
         attributes: {
           eventStatus: _const.EVENT_STATUS.SUCCESS,
@@ -96,7 +107,10 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       if (data.type === 'initial') {
         if (!_this.initialized) {
           var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.DOCUMENT_INIT);
-          (0, _analytics.triggerCollabAnalyticsEvent)({
+
+          _this.initExperience.success();
+
+          (0, _analytics.triggerAnalyticsEvent)({
             eventAction: _const.EVENT_ACTION.DOCUMENT_INIT,
             attributes: {
               eventStatus: _const.EVENT_STATUS.SUCCESS,
@@ -117,6 +131,19 @@ var Channel = /*#__PURE__*/function (_Emitter) {
             userId: userId,
             metadata: metadata
           });
+        } else {
+          // Page is been just restored, need to fix all the participants as well.
+          var _doc = data.doc,
+              _version = data.version,
+              _userId = data.userId,
+              _metadata = data.metadata;
+
+          _this.emit('restore', {
+            doc: _doc,
+            version: _version,
+            userId: _userId,
+            metadata: _metadata
+          });
         }
       } else {
         _this.emit('steps:added', data);
@@ -145,6 +172,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
 
       if (!this.initialized) {
         (0, _performance.startMeasure)(_performance.MEASURE_NAME.DOCUMENT_INIT);
+        this.initExperience.start();
       }
 
       var _this$config = this.config,
@@ -157,14 +185,14 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       if (permissionTokenRefresh) {
         authCb = function authCb(cb) {
           permissionTokenRefresh().then(function (token) {
-            cb({
-              // The permission token.
-              token: token,
+            cb(_objectSpread(_objectSpread({}, token ? {
+              token: token
+            } : {}), {}, {
               // The initialized status. If false, BE will send document, otherwise not.
               initialized: _this2.initialized,
               // ESS-1009 Allow to opt-in into 404 response
               need404: _this2.config.need404
-            });
+            }));
           }).catch(function (err) {
             _this2.emit('error', err);
           });
@@ -215,6 +243,10 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       });
       this.socket.on('metadata:changed', function (payload) {
         _this2.emit('metadata:changed', payload);
+      }); // ESS-2916 namespace status event - lock/unlock
+
+      this.socket.on('status', function (data) {
+        _this2.emit('status', data);
       });
       this.socket.on('disconnect', /*#__PURE__*/function () {
         var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(reason) {
@@ -254,7 +286,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
 
       this.socket.on('connect_error', function (error) {
         var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT);
-        (0, _analytics.triggerCollabAnalyticsEvent)({
+        (0, _analytics.triggerAnalyticsEvent)({
           eventAction: _const.EVENT_ACTION.CONNECTION,
           attributes: {
             eventStatus: _const.EVENT_STATUS.FAILURE,
@@ -283,7 +315,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     key: "fetchCatchup",
     value: function () {
       var _fetchCatchup = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(fromVersion) {
-        var _yield$utils$requestS, doc, version, stepMaps, metadata, errorCatchup;
+        var _yield$this$config$pe, _yield$utils$requestS, doc, version, stepMaps, metadata, errorCatchup;
 
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) {
@@ -301,7 +333,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                 _context2.t6 = {};
 
                 if (!this.config.permissionTokenRefresh) {
-                  _context2.next = 15;
+                  _context2.next = 24;
                   break;
                 }
 
@@ -309,37 +341,61 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                 return this.config.permissionTokenRefresh();
 
               case 11:
-                _context2.t8 = _context2.sent;
+                _context2.t9 = _yield$this$config$pe = _context2.sent;
+                _context2.t8 = _context2.t9 !== null;
+
+                if (!_context2.t8) {
+                  _context2.next = 15;
+                  break;
+                }
+
+                _context2.t8 = _yield$this$config$pe !== void 0;
+
+              case 15:
+                if (!_context2.t8) {
+                  _context2.next = 19;
+                  break;
+                }
+
+                _context2.t10 = _yield$this$config$pe;
+                _context2.next = 20;
+                break;
+
+              case 19:
+                _context2.t10 = undefined;
+
+              case 20:
+                _context2.t11 = _context2.t10;
                 _context2.t7 = {
-                  'x-token': _context2.t8
+                  'x-token': _context2.t11
                 };
-                _context2.next = 16;
+                _context2.next = 25;
                 break;
 
-              case 15:
+              case 24:
                 _context2.t7 = {};
 
-              case 16:
-                _context2.t9 = _context2.t7;
-                _context2.t10 = (0, _context2.t5)(_context2.t6, _context2.t9);
-                _context2.t11 = {};
-                _context2.t12 = {
+              case 25:
+                _context2.t12 = _context2.t7;
+                _context2.t13 = (0, _context2.t5)(_context2.t6, _context2.t12);
+                _context2.t14 = {};
+                _context2.t15 = {
                   'x-product': (0, _utils.getProduct)(this.config.productInfo),
                   'x-subproduct': (0, _utils.getSubProduct)(this.config.productInfo)
                 };
-                _context2.t13 = (0, _context2.t4)(_context2.t10, _context2.t11, _context2.t12);
-                _context2.t14 = {
-                  headers: _context2.t13
+                _context2.t16 = (0, _context2.t4)(_context2.t13, _context2.t14, _context2.t15);
+                _context2.t17 = {
+                  headers: _context2.t16
                 };
-                _context2.t15 = {
+                _context2.t18 = {
                   path: _context2.t2,
                   queryParams: _context2.t3,
-                  requestInit: _context2.t14
+                  requestInit: _context2.t17
                 };
-                _context2.next = 25;
-                return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t15);
+                _context2.next = 34;
+                return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t18);
 
-              case 25:
+              case 34:
                 _yield$utils$requestS = _context2.sent;
                 doc = _yield$utils$requestS.doc;
                 version = _yield$utils$requestS.version;
@@ -352,26 +408,26 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                   metadata: metadata
                 });
 
-              case 33:
-                _context2.prev = 33;
-                _context2.t16 = _context2["catch"](0);
-                logger("Can't fetch the catchup", _context2.t16.message);
+              case 42:
+                _context2.prev = 42;
+                _context2.t19 = _context2["catch"](0);
+                logger("Can't fetch the catchup", _context2.t19.message);
                 errorCatchup = {
                   message: _errorCodeMapper.ErrorCodeMapper.catchupFail.message,
                   data: {
-                    status: _context2.t16.status,
+                    status: _context2.t19.status,
                     code: _errorCodeMapper.ErrorCodeMapper.catchupFail.code
                   }
                 };
                 this.emit('error', errorCatchup);
                 return _context2.abrupt("return", {});
 
-              case 39:
+              case 48:
               case "end":
                 return _context2.stop();
             }
           }
-        }, _callee2, this, [[0, 33]]);
+        }, _callee2, this, [[0, 42]]);
       }));
 
       function fetchCatchup(_x2) {
@@ -386,14 +442,14 @@ var Channel = /*#__PURE__*/function (_Emitter) {
 
   }, {
     key: "broadcast",
-    value: function broadcast(type, data) {
+    value: function broadcast(type, data, callback) {
       if (!this.connected || !this.socket) {
         return;
       }
 
       this.socket.emit('broadcast', _objectSpread({
         type: type
-      }, data));
+      }, data), callback);
     }
   }, {
     key: "sendMetadata",

package/dist/cjs/helpers/const.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.EVENT_SUBJECT = exports.EVENT_STATUS = exports.EVENT_ACTION = exports.COLLAB_SERVICE = exports.ACK_MAX_TRY = void 0;
+exports.EVENT_SUBJECT = exports.EVENT_STATUS = exports.EVENT_ACTION = exports.COLLAB_SERVICE = exports.ADD_STEPS_TYPE = exports.ACK_MAX_TRY = void 0;
 var EVENT_SUBJECT = 'collab';
 exports.EVENT_SUBJECT = EVENT_SUBJECT;
 var COLLAB_SERVICE;
@@ -25,6 +25,7 @@ exports.EVENT_ACTION = EVENT_ACTION;
   EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
   EVENT_ACTION["UPDATE_PARTICIPANTS"] = "updateParticipants";
   EVENT_ACTION["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
+  EVENT_ACTION["REINITIALISE_DOCUMENT"] = "reinitialiseDocument";
 })(EVENT_ACTION || (exports.EVENT_ACTION = EVENT_ACTION = {}));
 
 var EVENT_STATUS;
@@ -35,5 +36,14 @@ exports.EVENT_STATUS = EVENT_STATUS;
   EVENT_STATUS["FAILURE"] = "FAILURE";
 })(EVENT_STATUS || (exports.EVENT_STATUS = EVENT_STATUS = {}));
 
+var ADD_STEPS_TYPE;
+exports.ADD_STEPS_TYPE = ADD_STEPS_TYPE;
+
+(function (ADD_STEPS_TYPE) {
+  ADD_STEPS_TYPE["ACCEPTED"] = "ACCEPTED";
+  ADD_STEPS_TYPE["REJECTED"] = "REJECTED";
+  ADD_STEPS_TYPE["ERROR"] = "ERROR";
+})(ADD_STEPS_TYPE || (exports.ADD_STEPS_TYPE = ADD_STEPS_TYPE = {}));
+
 var ACK_MAX_TRY = 30;
 exports.ACK_MAX_TRY = ACK_MAX_TRY;

package/dist/cjs/provider/catchup.js

@@ -91,7 +91,7 @@ var catchup = /*#__PURE__*/function () {
                  * newer.
                  */
 
-                opt.fitlerQueue(function (data) {
+                opt.filterQueue(function (data) {
                   return data.version > serverVersion;
                 }); // We are too far behind - replace the entire document
 
@@ -126,7 +126,7 @@ var catchup = /*#__PURE__*/function () {
                   newUnconfirmedSteps = rebaseSteps(unconfirmedSteps, mapping);
                   logger("Re-aply ".concat(newUnconfirmedSteps.length, " mapped unconfirmed steps: ").concat(JSON.stringify(newUnconfirmedSteps))); // Re-aply local steps
 
-                  opt.applyLocalsteps(newUnconfirmedSteps);
+                  opt.applyLocalSteps(newUnconfirmedSteps);
                 }
               }
             }