@atlaskit/collab-provider 7.7.0 → 8.0.0

package/dist/esm/channel.js

@@ -22,8 +22,9 @@ import { Emitter } from './emitter';
 import { ErrorCodeMapper } from './error-code-mapper';
 import { createLogger, getProduct, getSubProduct } from './helpers/utils';
 import { MEASURE_NAME, startMeasure, stopMeasure } from './analytics/performance';
-import { triggerCollabAnalyticsEvent } from './analytics';
+import { triggerAnalyticsEvent } from './analytics';
 import { EVENT_ACTION, EVENT_STATUS } from './helpers/const';
+import { ExperiencePerformanceTypes, ExperienceTypes, UFOExperience } from '@atlaskit/ufo';
 var logger = createLogger('Channel', 'green');
 export var Channel = /*#__PURE__*/function (_Emitter) {
   _inherits(Channel, _Emitter);
@@ -43,6 +44,16 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
 
     _defineProperty(_assertThisInitialized(_this), "initialized", false);
 
+    _defineProperty(_assertThisInitialized(_this), "initExperience", new UFOExperience('collab-provider.document-init', {
+      type: ExperienceTypes.Load,
+      performanceType: ExperiencePerformanceTypes.Custom,
+      performanceConfig: {
+        histogram: _defineProperty({}, ExperiencePerformanceTypes.Custom, {
+          duration: '250_500_1000_1500_2000_3000_4000'
+        })
+      }
+    }));
+
     _defineProperty(_assertThisInitialized(_this), "getInitialized", function () {
       return _this.initialized;
     });
@@ -59,7 +70,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       _this.connected = true;
       logger('Connected.', _this.socket.id);
       var measure = stopMeasure(MEASURE_NAME.SOCKET_CONNECT);
-      triggerCollabAnalyticsEvent({
+      triggerAnalyticsEvent({
         eventAction: EVENT_ACTION.CONNECTION,
         attributes: {
           eventStatus: EVENT_STATUS.SUCCESS,
@@ -81,7 +92,10 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       if (data.type === 'initial') {
         if (!_this.initialized) {
           var measure = stopMeasure(MEASURE_NAME.DOCUMENT_INIT);
-          triggerCollabAnalyticsEvent({
+
+          _this.initExperience.success();
+
+          triggerAnalyticsEvent({
             eventAction: EVENT_ACTION.DOCUMENT_INIT,
             attributes: {
               eventStatus: EVENT_STATUS.SUCCESS,
@@ -144,6 +158,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
 
       if (!this.initialized) {
         startMeasure(MEASURE_NAME.DOCUMENT_INIT);
+        this.initExperience.start();
       }
 
       var _this$config = this.config,
@@ -156,14 +171,14 @@ export 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);
           });
@@ -257,7 +272,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
 
       this.socket.on('connect_error', function (error) {
         var measure = stopMeasure(MEASURE_NAME.SOCKET_CONNECT);
-        triggerCollabAnalyticsEvent({
+        triggerAnalyticsEvent({
           eventAction: EVENT_ACTION.CONNECTION,
           attributes: {
             eventStatus: EVENT_STATUS.FAILURE,
@@ -286,7 +301,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
     key: "fetchCatchup",
     value: function () {
       var _fetchCatchup = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.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 _regeneratorRuntime.wrap(function _callee2$(_context2) {
           while (1) {
@@ -304,7 +319,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                 _context2.t6 = {};
 
                 if (!this.config.permissionTokenRefresh) {
-                  _context2.next = 15;
+                  _context2.next = 24;
                   break;
                 }
 
@@ -312,37 +327,61 @@ export 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': getProduct(this.config.productInfo),
                   'x-subproduct': 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;
@@ -355,26 +394,26 @@ export 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.catchupFail.message,
                   data: {
-                    status: _context2.t16.status,
+                    status: _context2.t19.status,
                     code: 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) {
@@ -389,14 +428,14 @@ export 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/esm/helpers/const.js

@@ -26,4 +26,12 @@ export var EVENT_STATUS;
   EVENT_STATUS["FAILURE"] = "FAILURE";
 })(EVENT_STATUS || (EVENT_STATUS = {}));
 
+export var 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 || (ADD_STEPS_TYPE = {}));
+
 export var ACK_MAX_TRY = 30;

package/dist/esm/provider/catchup.js

@@ -77,7 +77,7 @@ export 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
 
@@ -112,7 +112,7 @@ export 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);
                 }
               }
             }