@atlaskit/collab-provider 7.4.4 → 7.5.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/collab-provider
 
+## 7.5.0
+
+### Minor Changes
+
+- [`1c555e79e56`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1c555e79e56) - Added the capability to pass product information (product & sub-product) to the collab service
+- [`247420a48f7`](https://bitbucket.org/atlassian/atlassian-frontend/commits/247420a48f7) - [ESS-1050] Return ADF document from getFinalAcknowledgedState
+- [`17f1b0b87cc`](https://bitbucket.org/atlassian/atlassian-frontend/commits/17f1b0b87cc) - ESS-1019 changes the reconnectionDelayMax to 128s to reduce the reconnection storm.
+
+### Patch Changes
+
+- [`bf848f39cb1`](https://bitbucket.org/atlassian/atlassian-frontend/commits/bf848f39cb1) - ESS-2419 Emit the reason of permission errors to the consumers of collab-provider
+- [`680dc155ebc`](https://bitbucket.org/atlassian/atlassian-frontend/commits/680dc155ebc) - Raise errors in the collab provider when the server fails loading initilisation data
+- Updated dependencies
+
 ## 7.4.4
 
 ### Patch Changes

package/config/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/collab-provider/config",
+  "main": "../dist/cjs/config.js",
+  "module": "../dist/esm/config.js",
+  "module:es2019": "../dist/es2019/config.js",
+  "sideEffects": false,
+  "types": "../dist/types/config.d.ts"
+}

package/dist/cjs/analytics/performance.js

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

package/dist/cjs/channel.js

@@ -74,7 +74,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onConnect", function () {
       _this.connected = true;
       logger('Connected.', _this.socket.id);
-      var measure = (0, _performance.stopMeasure)('socketConnect');
+      var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT);
       (0, _analytics.triggerCollabAnalyticsEvent)({
         eventAction: _const.EVENT_ACTION.CONNECTION,
         attributes: {
@@ -94,7 +94,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
 
       if (data.type === 'initial') {
         if (!_this.initialized) {
-          var measure = (0, _performance.stopMeasure)('documentInit');
+          var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.DOCUMENT_INIT);
           (0, _analytics.triggerCollabAnalyticsEvent)({
             eventAction: _const.EVENT_ACTION.DOCUMENT_INIT,
             attributes: {
@@ -139,10 +139,10 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     function connect() {
       var _this2 = this;
 
-      (0, _performance.startMeasure)('socketConnect');
+      (0, _performance.startMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT);
 
       if (!this.initialized) {
-        (0, _performance.startMeasure)('documentInit');
+        (0, _performance.startMeasure)(_performance.MEASURE_NAME.DOCUMENT_INIT);
       }
 
       var _this$config = this.config,
@@ -150,9 +150,10 @@ var Channel = /*#__PURE__*/function (_Emitter) {
           url = _this$config.url;
       var createSocket = this.config.createSocket;
       var permissionTokenRefresh = this.config.permissionTokenRefresh;
+      var authCb = null;
 
       if (permissionTokenRefresh) {
-        var authCb = function authCb(cb) {
+        authCb = function authCb(cb) {
           permissionTokenRefresh().then(function (token) {
             cb({
               // The permission token.
@@ -166,10 +167,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
             _this2.emit('error', err);
           });
         };
-
-        this.socket = createSocket("".concat(url, "/session/").concat(documentAri), authCb);
       } else {
-        var _authCb = function _authCb(cb) {
+        authCb = function authCb(cb) {
           cb({
             // The initialized status. If false, BE will send document, otherwise not.
             initialized: _this2.initialized,
@@ -177,13 +176,12 @@ var Channel = /*#__PURE__*/function (_Emitter) {
             need404: _this2.config.need404
           });
         };
+      }
 
-        this.socket = createSocket("".concat(url, "/session/").concat(documentAri), _authCb);
-      } // Due to https://github.com/socketio/socket.io-client/issues/1473,
+      this.socket = createSocket("".concat(url, "/session/").concat(documentAri), authCb, this.config.productInfo); // Due to https://github.com/socketio/socket.io-client/issues/1473,
       // reconnect no longer fired on the socket.
       // We should use `connect` for better cross platform compatibility(Mobile/Web).
 
-
       this.socket.on('connect', this.onConnect);
       this.socket.on('data', this.onReceiveData);
       this.socket.on('steps:added', function (data) {
@@ -253,7 +251,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       // Ensure the error emit to the provider has the same structure, so we can handle them unified.
 
       this.socket.on('connect_error', function (error) {
-        var measure = (0, _performance.stopMeasure)('socketConnect');
+        var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT);
         (0, _analytics.triggerCollabAnalyticsEvent)({
           eventAction: _const.EVENT_ACTION.CONNECTION,
           attributes: {
@@ -291,46 +289,54 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                 _context2.prev = 0;
                 _context2.t0 = _utilServiceSupport.utils;
                 _context2.t1 = this.config;
-                _context2.t2 = _objectSpread;
+                _context2.t2 = "document/".concat(encodeURIComponent(this.config.documentAri), "/catchup");
                 _context2.t3 = {
-                  path: "document/".concat(encodeURIComponent(this.config.documentAri), "/catchup"),
-                  queryParams: {
-                    version: fromVersion
-                  }
+                  version: fromVersion
                 };
+                _context2.t4 = _objectSpread;
+                _context2.t5 = _objectSpread;
+                _context2.t6 = {};
 
                 if (!this.config.permissionTokenRefresh) {
-                  _context2.next = 14;
+                  _context2.next = 15;
                   break;
                 }
 
-                _context2.next = 8;
+                _context2.next = 11;
                 return this.config.permissionTokenRefresh();
 
-              case 8:
-                _context2.t5 = _context2.sent;
-                _context2.t6 = {
-                  'x-token': _context2.t5
-                };
+              case 11:
+                _context2.t8 = _context2.sent;
                 _context2.t7 = {
-                  headers: _context2.t6
-                };
-                _context2.t4 = {
-                  requestInit: _context2.t7
+                  'x-token': _context2.t8
                 };
-                _context2.next = 15;
+                _context2.next = 16;
                 break;
 
-              case 14:
-                _context2.t4 = {};
-
               case 15:
-                _context2.t8 = _context2.t4;
-                _context2.t9 = (0, _context2.t2)(_context2.t3, _context2.t8);
-                _context2.next = 19;
-                return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t9);
+                _context2.t7 = {};
+
+              case 16:
+                _context2.t9 = _context2.t7;
+                _context2.t10 = (0, _context2.t5)(_context2.t6, _context2.t9);
+                _context2.t11 = {};
+                _context2.t12 = {
+                  '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.t15 = {
+                  path: _context2.t2,
+                  queryParams: _context2.t3,
+                  requestInit: _context2.t14
+                };
+                _context2.next = 25;
+                return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t15);
 
-              case 19:
+              case 25:
                 _yield$utils$requestS = _context2.sent;
                 doc = _yield$utils$requestS.doc;
                 version = _yield$utils$requestS.version;
@@ -343,26 +349,26 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                   metadata: metadata
                 });
 
-              case 27:
-                _context2.prev = 27;
-                _context2.t10 = _context2["catch"](0);
-                logger("Can't fetch the catchup", _context2.t10.message);
+              case 33:
+                _context2.prev = 33;
+                _context2.t16 = _context2["catch"](0);
+                logger("Can't fetch the catchup", _context2.t16.message);
                 errorCatchup = {
                   message: _errorCodeMapper.ErrorCodeMapper.catchupFail.message,
                   data: {
-                    status: _context2.t10.status,
+                    status: _context2.t16.status,
                     code: _errorCodeMapper.ErrorCodeMapper.catchupFail.code
                   }
                 };
                 this.emit('error', errorCatchup);
                 return _context2.abrupt("return", {});
 
-              case 33:
+              case 39:
               case "end":
                 return _context2.stop();
             }
           }
-        }, _callee2, this, [[0, 27]]);
+        }, _callee2, this, [[0, 33]]);
       }));
 
       function fetchCatchup(_x2) {

package/dist/cjs/config.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SOCKET_IO_OPTIONS = void 0;
+var SOCKET_IO_OPTIONS = {
+  RECONNECTION_DELAY_MAX: 128 * 1000,
+  RECONNECTION_DELAY: 1000,
+  RANDOMIZATION_FACTOR: 0.1
+};
+exports.SOCKET_IO_OPTIONS = SOCKET_IO_OPTIONS;

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

@@ -1,9 +1,14 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.errorCodeMapper = exports.ErrorCodeMapper = void 0;
+
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+
 var ErrorCodeMapper = {
   noPermissionError: {
     code: 'NO_PERMISSION_ERROR',
@@ -37,41 +42,44 @@ var 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
-        };
+  var _error$data;
+
+  switch ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) {
+    case 'INSUFFICIENT_EDITING_PERMISSION':
+      return {
+        status: 403,
+        code: ErrorCodeMapper.noPermissionError.code,
+        message: ErrorCodeMapper.noPermissionError.message,
+        reason: // Typescript magic so it detects the union type
+        (0, _typeof2.default)(error.data.meta) === 'object' ? error.data.meta.reason : undefined
+      };
 
-      case 'DOCUMENT_NOT_FOUND':
-        return {
-          status: 404,
-          code: ErrorCodeMapper.documentNotFound.code,
-          message: ErrorCodeMapper.documentNotFound.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 '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
-        };
+    case 'CATCHUP_FAILED':
+    case 'GET_QUERY_TIME_OUT':
+    case 'INIT_DATA_LOAD_FAILED':
+      return {
+        status: 500,
+        code: ErrorCodeMapper.internalError.code,
+        message: ErrorCodeMapper.internalError.message
+      };
 
-      default:
-        break;
-    }
+    default:
+      break;
   }
 };
 

package/dist/cjs/helpers/const.js

@@ -16,6 +16,7 @@ exports.EVENT_ACTION = EVENT_ACTION;
   EVENT_ACTION["CATCHUP"] = "catchup";
   EVENT_ACTION["DOCUMENT_INIT"] = "documentInit";
   EVENT_ACTION["ADD_STEPS"] = "addSteps";
+  EVENT_ACTION["CONVERT_PM_TO_ADF"] = "convertPMToADF";
 })(EVENT_ACTION || (exports.EVENT_ACTION = EVENT_ACTION = {}));
 
 var EVENT_STATUS;

package/dist/cjs/helpers/utils.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getParticipant = exports.createLogger = void 0;
+exports.getSubProduct = exports.getProduct = exports.getParticipant = exports.createLogger = void 0;
 exports.sleep = sleep;
 
 var createLogger = function createLogger(prefix) {
@@ -37,4 +37,20 @@ function sleep(ms) {
   return new Promise(function (resolve) {
     setTimeout(resolve, ms);
   });
-}
+}
+
+var getProduct = function getProduct(productInfo) {
+  var _productInfo$product;
+
+  return (_productInfo$product = productInfo === null || productInfo === void 0 ? void 0 : productInfo.product) !== null && _productInfo$product !== void 0 ? _productInfo$product : 'unknown';
+};
+
+exports.getProduct = getProduct;
+
+var getSubProduct = function getSubProduct(productInfo) {
+  var _productInfo$subProdu;
+
+  return (_productInfo$subProdu = productInfo === null || productInfo === void 0 ? void 0 : productInfo.subProduct) !== null && _productInfo$subProdu !== void 0 ? _productInfo$subProdu : !!(productInfo !== null && productInfo !== void 0 && productInfo.product) ? 'none' : 'unknown';
+};
+
+exports.getSubProduct = getSubProduct;

package/dist/cjs/provider/index.js

@@ -39,6 +39,8 @@ var _throttle = _interopRequireDefault(require("lodash/throttle"));
 
 var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 
+var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
+
 var _emitter = require("../emitter");
 
 var _channel = require("../channel");
@@ -232,7 +234,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         while (1) {
           switch (_context.prev = _context.next) {
             case 0:
-              (0, _performance.startMeasure)('callingCatchupApi'); // if the queue is already paused, we are busy with something else, so don't proceed.
+              (0, _performance.startMeasure)(_performance.MEASURE_NAME.CALLING_CATCHUP_API); // if the queue is already paused, we are busy with something else, so don't proceed.
 
               if (!_this.pauseQueue) {
                 _context.next = 4;
@@ -256,7 +258,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
               });
 
             case 8:
-              measure = (0, _performance.stopMeasure)('callingCatchupApi');
+              measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CALLING_CATCHUP_API);
               (0, _analytics.triggerCollabAnalyticsEvent)({
                 eventAction: _const.EVENT_ACTION.CATCHUP,
                 attributes: {
@@ -270,7 +272,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
             case 12:
               _context.prev = 12;
               _context.t0 = _context["catch"](5);
-              _measure = (0, _performance.stopMeasure)('callingCatchupApi');
+              _measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CALLING_CATCHUP_API);
               (0, _analytics.triggerCollabAnalyticsEvent)({
                 eventAction: _const.EVENT_ACTION.CATCHUP,
                 attributes: {
@@ -566,7 +568,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
       var _this$metadata$title;
 
-      var maxAttemptsToSync, count, unconfirmedState, state;
+      var maxAttemptsToSync, count, unconfirmedState, state, adfDocument, measure, _measure2;
+
       return _regenerator.default.wrap(function _callee4$(_context4) {
         while (1) {
           switch (_context4.prev = _context4.next) {
@@ -650,14 +653,39 @@ var Provider = /*#__PURE__*/function (_Emitter) {
               })(), "t0", 5);
 
             case 5:
-              state = _this.getState();
+              state = _this.getState(); // Convert ProseMirror document in Editor state to ADF document
+
+              try {
+                (0, _performance.startMeasure)(_performance.MEASURE_NAME.CONVERT_PM_TO_ADF);
+                adfDocument = new _editorJsonTransformer.JSONTransformer().encode(state.doc);
+                measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CONVERT_PM_TO_ADF);
+                (0, _analytics.triggerCollabAnalyticsEvent)({
+                  eventAction: _const.EVENT_ACTION.CONVERT_PM_TO_ADF,
+                  attributes: {
+                    eventStatus: _const.EVENT_STATUS.SUCCESS,
+                    latency: measure === null || measure === void 0 ? void 0 : measure.duration
+                  }
+                }, _this.analyticsClient);
+              } catch (error) {
+                _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.CONVERT_PM_TO_ADF);
+                (0, _analytics.triggerCollabAnalyticsEvent)({
+                  eventAction: _const.EVENT_ACTION.CONVERT_PM_TO_ADF,
+                  attributes: {
+                    eventStatus: _const.EVENT_STATUS.FAILURE,
+                    latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration,
+                    error: error
+                  }
+                }, _this.analyticsClient);
+                logger("Error when converting PM document to ADF: ", error);
+              }
+
               return _context4.abrupt("return", {
-                content: state.doc.toJSON(),
+                content: adfDocument,
                 title: (_this$metadata$title = _this.metadata.title) === null || _this$metadata$title === void 0 ? void 0 : _this$metadata$title.toString(),
                 stepVersion: (0, _prosemirrorCollab.getVersion)(state)
               });
 
-            case 7:
+            case 8:
             case "end":
               return _context4.stop();
           }

package/dist/cjs/socket-io-provider.js

@@ -14,19 +14,31 @@ var _provider = require("./provider");
 
 var _socket = require("socket.io-client");
 
+var _utils = require("./helpers/utils");
+
+var _config = require("./config");
+
 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; }
 
-function createSocketIOSocket(url, auth) {
+function createSocketIOSocket(url, auth, productInfo) {
   var _URL = new URL(url),
-      pathname = _URL.pathname;
+      pathname = _URL.pathname; // to limit the reconnection flooding towards collab service, here we set the reconnectionDelayMax to 128s.
+
 
   return (0, _socket.io)(url, {
+    reconnectionDelayMax: _config.SOCKET_IO_OPTIONS.RECONNECTION_DELAY_MAX,
+    reconnectionDelay: _config.SOCKET_IO_OPTIONS.RECONNECTION_DELAY,
+    randomizationFactor: _config.SOCKET_IO_OPTIONS.RANDOMIZATION_FACTOR,
     withCredentials: true,
     transports: ['polling', 'websocket'],
     path: "/".concat(pathname.split('/')[1], "/socket.io"),
-    auth: auth
+    auth: auth,
+    extraHeaders: {
+      'x-product': (0, _utils.getProduct)(productInfo),
+      'x-subproduct': (0, _utils.getSubProduct)(productInfo)
+    }
   });
 }
 

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "7.4.4",
+	"version": "7.5.0",
 	"sideEffects": false
 }

package/dist/es2019/analytics/performance.js

@@ -1,3 +1,12 @@
+export let 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 || (MEASURE_NAME = {}));
+
 const isPerformanceAPIAvailable = () => {
   return typeof window !== 'undefined' && 'performance' in window && ['measure', 'clearMeasures', 'clearMarks', 'getEntriesByName', 'getEntriesByType'].every(api => !!performance[api]);
 };

package/dist/es2019/channel.js

@@ -1,9 +1,10 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import { utils } from '@atlaskit/util-service-support';
+import { utils } from '@atlaskit/util-service-support'; // TODO: Validate if this is actually equivalent to the AnalyticsWebClient in @atlassiansox/analytics-web-client
+
 import { Emitter } from './emitter';
 import { ErrorCodeMapper } from './error-code-mapper';
-import { createLogger } from './helpers/utils';
-import { startMeasure, stopMeasure } from './analytics/performance';
+import { createLogger, getProduct, getSubProduct } from './helpers/utils';
+import { MEASURE_NAME, startMeasure, stopMeasure } from './analytics/performance';
 import { triggerCollabAnalyticsEvent } from './analytics';
 import { EVENT_ACTION, EVENT_STATUS } from './helpers/const';
 const logger = createLogger('Channel', 'green');
@@ -26,7 +27,7 @@ export class Channel extends Emitter {
     _defineProperty(this, "onConnect", () => {
       this.connected = true;
       logger('Connected.', this.socket.id);
-      const measure = stopMeasure('socketConnect');
+      const measure = stopMeasure(MEASURE_NAME.SOCKET_CONNECT);
       triggerCollabAnalyticsEvent({
         eventAction: EVENT_ACTION.CONNECTION,
         attributes: {
@@ -46,7 +47,7 @@ export class Channel extends Emitter {
 
       if (data.type === 'initial') {
         if (!this.initialized) {
-          const measure = stopMeasure('documentInit');
+          const measure = stopMeasure(MEASURE_NAME.DOCUMENT_INIT);
           triggerCollabAnalyticsEvent({
             eventAction: EVENT_ACTION.DOCUMENT_INIT,
             attributes: {
@@ -86,10 +87,10 @@ export class Channel extends Emitter {
    * Connect to collab service using websockets
    */
   connect() {
-    startMeasure('socketConnect');
+    startMeasure(MEASURE_NAME.SOCKET_CONNECT);
 
     if (!this.initialized) {
-      startMeasure('documentInit');
+      startMeasure(MEASURE_NAME.DOCUMENT_INIT);
     }
 
     const {
@@ -102,9 +103,10 @@ export class Channel extends Emitter {
     const {
       permissionTokenRefresh
     } = this.config;
+    let authCb = null;
 
     if (permissionTokenRefresh) {
-      const authCb = cb => {
+      authCb = cb => {
         permissionTokenRefresh().then(token => {
           cb({
             // The permission token.
@@ -118,10 +120,8 @@ export class Channel extends Emitter {
           this.emit('error', err);
         });
       };
-
-      this.socket = createSocket(`${url}/session/${documentAri}`, authCb);
     } else {
-      const authCb = cb => {
+      authCb = cb => {
         cb({
           // The initialized status. If false, BE will send document, otherwise not.
           initialized: this.initialized,
@@ -129,13 +129,12 @@ export class Channel extends Emitter {
           need404: this.config.need404
         });
       };
+    }
 
-      this.socket = createSocket(`${url}/session/${documentAri}`, authCb);
-    } // Due to https://github.com/socketio/socket.io-client/issues/1473,
+    this.socket = createSocket(`${url}/session/${documentAri}`, authCb, this.config.productInfo); // Due to https://github.com/socketio/socket.io-client/issues/1473,
     // reconnect no longer fired on the socket.
     // We should use `connect` for better cross platform compatibility(Mobile/Web).
 
-
     this.socket.on('connect', this.onConnect);
     this.socket.on('data', this.onReceiveData);
     this.socket.on('steps:added', data => {
@@ -188,7 +187,7 @@ export class Channel extends Emitter {
     // Ensure the error emit to the provider has the same structure, so we can handle them unified.
 
     this.socket.on('connect_error', error => {
-      const measure = stopMeasure('socketConnect');
+      const measure = stopMeasure(MEASURE_NAME.SOCKET_CONNECT);
       triggerCollabAnalyticsEvent({
         eventAction: EVENT_ACTION.CONNECTION,
         attributes: {
@@ -226,13 +225,14 @@ export class Channel extends Emitter {
         queryParams: {
           version: fromVersion
         },
-        ...(this.config.permissionTokenRefresh ? {
-          requestInit: {
-            headers: {
+        requestInit: {
+          headers: { ...(this.config.permissionTokenRefresh ? {
               'x-token': await this.config.permissionTokenRefresh()
-            }
+            } : {}),
+            'x-product': getProduct(this.config.productInfo),
+            'x-subproduct': getSubProduct(this.config.productInfo)
           }
-        } : {})
+        }
       });
       return {
         doc,

package/dist/es2019/config.js

@@ -0,0 +1,5 @@
+export const SOCKET_IO_OPTIONS = {
+  RECONNECTION_DELAY_MAX: 128 * 1000,
+  RECONNECTION_DELAY: 1000,
+  RANDOMIZATION_FACTOR: 0.1
+};