@atlaskit/collab-provider 9.7.1 → 9.7.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/collab-provider
 
+## 9.7.2
+
+### Patch Changes
+
+- [`f9735e0690e`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f9735e0690e) - Using socket.onAnyOutgoing to measure and send message metrics
+
 ## 9.7.1
 
 ### Patch Changes

package/dist/cjs/channel.js

@@ -24,6 +24,8 @@ var _ufo = require("./analytics/ufo");
 var _disconnectedReasonMapper = require("./disconnected-reason-mapper");
 var _network = _interopRequireDefault(require("./connectivity/network"));
 var _errorTypes = require("./errors/error-types");
+var _socketMessageMetrics = require("./helpers/socket-message-metrics");
+var _featureFlags = require("./feature-flags");
 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 _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
@@ -125,6 +127,9 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onConnect", function () {
       var _this$analyticsHelper5;
+      if ((0, _featureFlags.getCollabProviderFeatureFlag)('socketMessageMetricsFF', _this.config.featureFlags) && _this.socketMessageMetrics) {
+        _this.socketMessageMetrics.setupSocketMessageMetrics();
+      }
       _this.connected = true;
       logger('Connected.', _this.socket.id);
       var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT, _this.analyticsHelper);
@@ -474,6 +479,9 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         };
       }
       this.socket = createSocket("".concat(url, "/session/").concat(documentAri), auth, this.config.productInfo);
+      if (this.socket && this.analyticsHelper) {
+        this.socketMessageMetrics = new _socketMessageMetrics.SocketMessageMetrics(this.socket, this.analyticsHelper);
+      }
 
       // Due to https://github.com/socketio/socket.io-client/issues/1473,
       // reconnect no longer fired on the socket.
@@ -525,6 +533,9 @@ var Channel = /*#__PURE__*/function (_Emitter) {
           return _regenerator.default.wrap(function _callee3$(_context3) {
             while (1) switch (_context3.prev = _context3.next) {
               case 0:
+                if ((0, _featureFlags.getCollabProviderFeatureFlag)('socketMessageMetricsFF', _this2.config.featureFlags) && _this2.socketMessageMetrics) {
+                  _this2.socketMessageMetrics.closeSocketMessageMetrics();
+                }
                 _this2.connected = false;
                 logger("disconnect reason: ".concat(reason));
                 _this2.emit('disconnect', {
@@ -546,7 +557,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                     _this2.emit('error', reconnectionError);
                   }
                 }
-              case 4:
+              case 5:
               case "end":
                 return _context3.stop();
             }

package/dist/cjs/feature-flags/__test__/index.unit.js

@@ -4,9 +4,10 @@ var _index = require("../index");
 describe('Feature flags', function () {
   it('getProductSpecificFeatureFlags', function () {
     var result = (0, _index.getProductSpecificFeatureFlags)({
-      testFF: true
+      testFF: true,
+      socketMessageMetricsFF: true
     }, 'confluence');
-    expect(result).toEqual(['confluence.fe.collab.provider.testFF']);
+    expect(result).toEqual(['confluence.fe.collab.provider.testFF', 'confluence.fe.collab.provider.socketMessageMetricsFF']);
   });
   it('getCollabProviderFeatureFlag return true', function () {
     var result = (0, _index.getCollabProviderFeatureFlag)('testFF', {

package/dist/cjs/feature-flags/index.js

@@ -8,7 +8,8 @@ exports.getCollabProviderFeatureFlag = getCollabProviderFeatureFlag;
 exports.getProductSpecificFeatureFlags = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var defaultNCSFeatureFlags = {
-  testFF: false
+  testFF: false,
+  socketMessageMetricsFF: false
 };
 
 /**
@@ -16,7 +17,8 @@ var defaultNCSFeatureFlags = {
  */
 var productKeys = {
   confluence: {
-    testFF: 'confluence.fe.collab.provider.testFF'
+    testFF: 'confluence.fe.collab.provider.testFF',
+    socketMessageMetricsFF: 'confluence.fe.collab.provider.socketMessageMetricsFF'
   }
 };
 var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {

package/dist/cjs/helpers/const.js

@@ -19,8 +19,9 @@ var EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["SEND_STEPS_RETRY"] = "sendStepsRetry";
   EVENT_ACTION["CATCHUP_AFTER_MAX_SEND_STEPS_RETRY"] = "catchupAfterMaxSendStepsRetry";
   EVENT_ACTION["DROPPED_STEPS"] = "droppedStepInCatchup";
+  EVENT_ACTION["WEBSOCKET_MESSAGE_VOLUME_METRIC"] = "websocketMessageVolumeMetric";
   return EVENT_ACTION;
-}({}); // https://data-portal.internal.atlassian.com/analytics/registry/53724
+}({}); // https://data-portal.internal.atlassian.com/analytics/registry/53596
 exports.EVENT_ACTION = EVENT_ACTION;
 var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";

package/dist/cjs/helpers/socket-message-metrics.js

@@ -0,0 +1,54 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS = exports.SocketMessageMetrics = void 0;
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _const = require("./const");
+var _utils = require("./utils");
+var logger = (0, _utils.createLogger)('SocketMessageMetrics', 'green');
+var WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS = 60000;
+exports.WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS = WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS;
+var SocketMessageMetrics = /*#__PURE__*/(0, _createClass2.default)(function SocketMessageMetrics(socket, analyticsHelper) {
+  var _this = this;
+  (0, _classCallCheck2.default)(this, SocketMessageMetrics);
+  (0, _defineProperty2.default)(this, "messageCount", 0);
+  (0, _defineProperty2.default)(this, "totalMessageSize", 0);
+  (0, _defineProperty2.default)(this, "metricsIntervalID", undefined);
+  (0, _defineProperty2.default)(this, "socketMessageMetricsListener", function (event) {
+    _this.messageCount++;
+    for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+      args[_key - 1] = arguments[_key];
+    }
+    _this.totalMessageSize += Buffer.byteLength(JSON.stringify(args), 'utf8');
+  });
+  (0, _defineProperty2.default)(this, "setupSocketMessageMetrics", function () {
+    if (_this.metricsIntervalID !== undefined) {
+      logger('calling setupSocketMessageMetrics function with metricsIntervalID that is not undefined');
+      return;
+    }
+    _this.socket.onAnyOutgoing(_this.socketMessageMetricsListener);
+
+    // send metrics every 60 seconds
+    _this.metricsIntervalID = window.setInterval(function () {
+      _this.analyticsHelper.sendActionEvent(_const.EVENT_ACTION.WEBSOCKET_MESSAGE_VOLUME_METRIC, _const.EVENT_STATUS.INFO, {
+        messageCount: _this.messageCount,
+        totalMessageSize: _this.totalMessageSize
+      });
+      _this.messageCount = 0;
+      _this.totalMessageSize = 0;
+    }, WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS);
+  });
+  (0, _defineProperty2.default)(this, "closeSocketMessageMetrics", function () {
+    clearInterval(_this.metricsIntervalID);
+    _this.metricsIntervalID = undefined;
+    _this.socket.offAnyOutgoing(_this.socketMessageMetricsListener);
+  });
+  this.socket = socket;
+  this.analyticsHelper = analyticsHelper;
+});
+exports.SocketMessageMetrics = SocketMessageMetrics;

package/dist/cjs/version-wrapper.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = "@atlaskit/collab-provider";
 exports.name = name;
-var version = "9.7.1";
+var version = "9.7.2";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/cjs/version.json

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

package/dist/es2019/channel.js

@@ -9,6 +9,8 @@ import { createDocInitExp } from './analytics/ufo';
 import { socketIOReasons } from './disconnected-reason-mapper';
 import Network from './connectivity/network';
 import { NotConnectedError, NotInitializedError, INTERNAL_ERROR_CODE } from './errors/error-types';
+import { SocketMessageMetrics } from './helpers/socket-message-metrics';
+import { getCollabProviderFeatureFlag } from './feature-flags';
 const logger = createLogger('Channel', 'green');
 export class Channel extends Emitter {
   constructor(config, analyticsHelper) {
@@ -93,6 +95,9 @@ export class Channel extends Emitter {
     });
     _defineProperty(this, "onConnect", () => {
       var _this$analyticsHelper5;
+      if (getCollabProviderFeatureFlag('socketMessageMetricsFF', this.config.featureFlags) && this.socketMessageMetrics) {
+        this.socketMessageMetrics.setupSocketMessageMetrics();
+      }
       this.connected = true;
       logger('Connected.', this.socket.id);
       const measure = stopMeasure(MEASURE_NAME.SOCKET_CONNECT, this.analyticsHelper);
@@ -350,6 +355,9 @@ export class Channel extends Emitter {
       };
     }
     this.socket = createSocket(`${url}/session/${documentAri}`, auth, this.config.productInfo);
+    if (this.socket && this.analyticsHelper) {
+      this.socketMessageMetrics = new SocketMessageMetrics(this.socket, this.analyticsHelper);
+    }
 
     // Due to https://github.com/socketio/socket.io-client/issues/1473,
     // reconnect no longer fired on the socket.
@@ -400,6 +408,9 @@ export class Channel extends Emitter {
       this.emit('status', data);
     });
     this.socket.on('disconnect', async reason => {
+      if (getCollabProviderFeatureFlag('socketMessageMetricsFF', this.config.featureFlags) && this.socketMessageMetrics) {
+        this.socketMessageMetrics.closeSocketMessageMetrics();
+      }
       this.connected = false;
       logger(`disconnect reason: ${reason}`);
       this.emit('disconnect', {

package/dist/es2019/feature-flags/__test__/index.unit.js

@@ -2,9 +2,10 @@ import { getProductSpecificFeatureFlags, getCollabProviderFeatureFlag } from '..
 describe('Feature flags', () => {
   it('getProductSpecificFeatureFlags', () => {
     const result = getProductSpecificFeatureFlags({
-      testFF: true
+      testFF: true,
+      socketMessageMetricsFF: true
     }, 'confluence');
-    expect(result).toEqual(['confluence.fe.collab.provider.testFF']);
+    expect(result).toEqual(['confluence.fe.collab.provider.testFF', 'confluence.fe.collab.provider.socketMessageMetricsFF']);
   });
   it('getCollabProviderFeatureFlag return true', () => {
     const result = getCollabProviderFeatureFlag('testFF', {

package/dist/es2019/feature-flags/index.js

@@ -1,5 +1,6 @@
 const defaultNCSFeatureFlags = {
-  testFF: false
+  testFF: false,
+  socketMessageMetricsFF: false
 };
 
 /**
@@ -7,7 +8,8 @@ const defaultNCSFeatureFlags = {
  */
 const productKeys = {
   confluence: {
-    testFF: 'confluence.fe.collab.provider.testFF'
+    testFF: 'confluence.fe.collab.provider.testFF',
+    socketMessageMetricsFF: 'confluence.fe.collab.provider.socketMessageMetricsFF'
   }
 };
 const filterFeatureFlagNames = flags => {

package/dist/es2019/helpers/const.js

@@ -13,8 +13,9 @@ export let EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["SEND_STEPS_RETRY"] = "sendStepsRetry";
   EVENT_ACTION["CATCHUP_AFTER_MAX_SEND_STEPS_RETRY"] = "catchupAfterMaxSendStepsRetry";
   EVENT_ACTION["DROPPED_STEPS"] = "droppedStepInCatchup";
+  EVENT_ACTION["WEBSOCKET_MESSAGE_VOLUME_METRIC"] = "websocketMessageVolumeMetric";
   return EVENT_ACTION;
-}({}); // https://data-portal.internal.atlassian.com/analytics/registry/53724
+}({}); // https://data-portal.internal.atlassian.com/analytics/registry/53596
 export let EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";

package/dist/es2019/helpers/socket-message-metrics.js

@@ -0,0 +1,40 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { EVENT_ACTION, EVENT_STATUS } from './const';
+import { createLogger } from './utils';
+const logger = createLogger('SocketMessageMetrics', 'green');
+export const WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS = 60000;
+export class SocketMessageMetrics {
+  constructor(socket, analyticsHelper) {
+    _defineProperty(this, "messageCount", 0);
+    _defineProperty(this, "totalMessageSize", 0);
+    _defineProperty(this, "metricsIntervalID", undefined);
+    _defineProperty(this, "socketMessageMetricsListener", (event, ...args) => {
+      this.messageCount++;
+      this.totalMessageSize += Buffer.byteLength(JSON.stringify(args), 'utf8');
+    });
+    _defineProperty(this, "setupSocketMessageMetrics", () => {
+      if (this.metricsIntervalID !== undefined) {
+        logger('calling setupSocketMessageMetrics function with metricsIntervalID that is not undefined');
+        return;
+      }
+      this.socket.onAnyOutgoing(this.socketMessageMetricsListener);
+
+      // send metrics every 60 seconds
+      this.metricsIntervalID = window.setInterval(() => {
+        this.analyticsHelper.sendActionEvent(EVENT_ACTION.WEBSOCKET_MESSAGE_VOLUME_METRIC, EVENT_STATUS.INFO, {
+          messageCount: this.messageCount,
+          totalMessageSize: this.totalMessageSize
+        });
+        this.messageCount = 0;
+        this.totalMessageSize = 0;
+      }, WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS);
+    });
+    _defineProperty(this, "closeSocketMessageMetrics", () => {
+      clearInterval(this.metricsIntervalID);
+      this.metricsIntervalID = undefined;
+      this.socket.offAnyOutgoing(this.socketMessageMetricsListener);
+    });
+    this.socket = socket;
+    this.analyticsHelper = analyticsHelper;
+  }
+}

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.7.1";
+export const version = "9.7.2";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/version.json

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

package/dist/esm/channel.js

@@ -21,6 +21,8 @@ import { createDocInitExp } from './analytics/ufo';
 import { socketIOReasons } from './disconnected-reason-mapper';
 import Network from './connectivity/network';
 import { NotConnectedError, NotInitializedError, INTERNAL_ERROR_CODE } from './errors/error-types';
+import { SocketMessageMetrics } from './helpers/socket-message-metrics';
+import { getCollabProviderFeatureFlag } from './feature-flags';
 var logger = createLogger('Channel', 'green');
 export var Channel = /*#__PURE__*/function (_Emitter) {
   _inherits(Channel, _Emitter);
@@ -118,6 +120,9 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
     });
     _defineProperty(_assertThisInitialized(_this), "onConnect", function () {
       var _this$analyticsHelper5;
+      if (getCollabProviderFeatureFlag('socketMessageMetricsFF', _this.config.featureFlags) && _this.socketMessageMetrics) {
+        _this.socketMessageMetrics.setupSocketMessageMetrics();
+      }
       _this.connected = true;
       logger('Connected.', _this.socket.id);
       var measure = stopMeasure(MEASURE_NAME.SOCKET_CONNECT, _this.analyticsHelper);
@@ -467,6 +472,9 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
         };
       }
       this.socket = createSocket("".concat(url, "/session/").concat(documentAri), auth, this.config.productInfo);
+      if (this.socket && this.analyticsHelper) {
+        this.socketMessageMetrics = new SocketMessageMetrics(this.socket, this.analyticsHelper);
+      }
 
       // Due to https://github.com/socketio/socket.io-client/issues/1473,
       // reconnect no longer fired on the socket.
@@ -518,6 +526,9 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
           return _regeneratorRuntime.wrap(function _callee3$(_context3) {
             while (1) switch (_context3.prev = _context3.next) {
               case 0:
+                if (getCollabProviderFeatureFlag('socketMessageMetricsFF', _this2.config.featureFlags) && _this2.socketMessageMetrics) {
+                  _this2.socketMessageMetrics.closeSocketMessageMetrics();
+                }
                 _this2.connected = false;
                 logger("disconnect reason: ".concat(reason));
                 _this2.emit('disconnect', {
@@ -539,7 +550,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                     _this2.emit('error', reconnectionError);
                   }
                 }
-              case 4:
+              case 5:
               case "end":
                 return _context3.stop();
             }

package/dist/esm/feature-flags/__test__/index.unit.js

@@ -2,9 +2,10 @@ import { getProductSpecificFeatureFlags, getCollabProviderFeatureFlag } from '..
 describe('Feature flags', function () {
   it('getProductSpecificFeatureFlags', function () {
     var result = getProductSpecificFeatureFlags({
-      testFF: true
+      testFF: true,
+      socketMessageMetricsFF: true
     }, 'confluence');
-    expect(result).toEqual(['confluence.fe.collab.provider.testFF']);
+    expect(result).toEqual(['confluence.fe.collab.provider.testFF', 'confluence.fe.collab.provider.socketMessageMetricsFF']);
   });
   it('getCollabProviderFeatureFlag return true', function () {
     var result = getCollabProviderFeatureFlag('testFF', {

package/dist/esm/feature-flags/index.js

@@ -1,6 +1,7 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 var defaultNCSFeatureFlags = {
-  testFF: false
+  testFF: false,
+  socketMessageMetricsFF: false
 };
 
 /**
@@ -8,7 +9,8 @@ var defaultNCSFeatureFlags = {
  */
 var productKeys = {
   confluence: {
-    testFF: 'confluence.fe.collab.provider.testFF'
+    testFF: 'confluence.fe.collab.provider.testFF',
+    socketMessageMetricsFF: 'confluence.fe.collab.provider.socketMessageMetricsFF'
   }
 };
 var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {

package/dist/esm/helpers/const.js

@@ -13,8 +13,9 @@ export var EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["SEND_STEPS_RETRY"] = "sendStepsRetry";
   EVENT_ACTION["CATCHUP_AFTER_MAX_SEND_STEPS_RETRY"] = "catchupAfterMaxSendStepsRetry";
   EVENT_ACTION["DROPPED_STEPS"] = "droppedStepInCatchup";
+  EVENT_ACTION["WEBSOCKET_MESSAGE_VOLUME_METRIC"] = "websocketMessageVolumeMetric";
   return EVENT_ACTION;
-}({}); // https://data-portal.internal.atlassian.com/analytics/registry/53724
+}({}); // https://data-portal.internal.atlassian.com/analytics/registry/53596
 export var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";

package/dist/esm/helpers/socket-message-metrics.js

@@ -0,0 +1,45 @@
+import _createClass from "@babel/runtime/helpers/createClass";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { EVENT_ACTION, EVENT_STATUS } from './const';
+import { createLogger } from './utils';
+var logger = createLogger('SocketMessageMetrics', 'green');
+export var WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS = 60000;
+export var SocketMessageMetrics = /*#__PURE__*/_createClass(function SocketMessageMetrics(socket, analyticsHelper) {
+  var _this = this;
+  _classCallCheck(this, SocketMessageMetrics);
+  _defineProperty(this, "messageCount", 0);
+  _defineProperty(this, "totalMessageSize", 0);
+  _defineProperty(this, "metricsIntervalID", undefined);
+  _defineProperty(this, "socketMessageMetricsListener", function (event) {
+    _this.messageCount++;
+    for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+      args[_key - 1] = arguments[_key];
+    }
+    _this.totalMessageSize += Buffer.byteLength(JSON.stringify(args), 'utf8');
+  });
+  _defineProperty(this, "setupSocketMessageMetrics", function () {
+    if (_this.metricsIntervalID !== undefined) {
+      logger('calling setupSocketMessageMetrics function with metricsIntervalID that is not undefined');
+      return;
+    }
+    _this.socket.onAnyOutgoing(_this.socketMessageMetricsListener);
+
+    // send metrics every 60 seconds
+    _this.metricsIntervalID = window.setInterval(function () {
+      _this.analyticsHelper.sendActionEvent(EVENT_ACTION.WEBSOCKET_MESSAGE_VOLUME_METRIC, EVENT_STATUS.INFO, {
+        messageCount: _this.messageCount,
+        totalMessageSize: _this.totalMessageSize
+      });
+      _this.messageCount = 0;
+      _this.totalMessageSize = 0;
+    }, WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS);
+  });
+  _defineProperty(this, "closeSocketMessageMetrics", function () {
+    clearInterval(_this.metricsIntervalID);
+    _this.metricsIntervalID = undefined;
+    _this.socket.offAnyOutgoing(_this.socketMessageMetricsListener);
+  });
+  this.socket = socket;
+  this.analyticsHelper = analyticsHelper;
+});

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "9.7.1";
+export var version = "9.7.2";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/version.json

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

package/dist/types/channel.d.ts

@@ -13,6 +13,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
     private initExperience?;
     private token?;
     private network;
+    private socketMessageMetrics?;
     constructor(config: Config, analyticsHelper: AnalyticsHelper);
     getInitialized: () => boolean;
     getConnected: () => boolean;

package/dist/types/feature-flags/types.d.ts

@@ -1,5 +1,6 @@
 export interface NCSFeatureFlags {
     testFF?: boolean;
+    socketMessageMetricsFF?: boolean;
 }
 export interface WithNCSFeatureFlags {
     featureFlags?: NCSFeatureFlags;

package/dist/types/helpers/const.d.ts

@@ -13,7 +13,8 @@ export declare enum EVENT_ACTION {
     INVALIDATE_TOKEN = "invalidateToken",
     SEND_STEPS_RETRY = "sendStepsRetry",
     CATCHUP_AFTER_MAX_SEND_STEPS_RETRY = "catchupAfterMaxSendStepsRetry",
-    DROPPED_STEPS = "droppedStepInCatchup"
+    DROPPED_STEPS = "droppedStepInCatchup",
+    WEBSOCKET_MESSAGE_VOLUME_METRIC = "websocketMessageVolumeMetric"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -215,7 +216,16 @@ type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
         eventStatus: EVENT_STATUS.INFO;
     };
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent;
+type WebsocketMessageVolumeMetricEvent = {
+    eventAction: EVENT_ACTION.WEBSOCKET_MESSAGE_VOLUME_METRIC;
+    attributes: {
+        documentAri?: string;
+        eventStatus: EVENT_STATUS.INFO;
+        messageCount: number;
+        messageSize: number;
+    };
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 export {};

package/dist/types/helpers/socket-message-metrics.d.ts

@@ -0,0 +1,14 @@
+import AnalyticsHelper from '../analytics/analytics-helper';
+import type { Socket } from 'socket.io-client';
+export declare const WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS = 60000;
+export declare class SocketMessageMetrics {
+    private messageCount;
+    private totalMessageSize;
+    private metricsIntervalID;
+    private socket;
+    private analyticsHelper;
+    constructor(socket: Socket, analyticsHelper: AnalyticsHelper);
+    socketMessageMetricsListener: (event: any, ...args: any[]) => void;
+    setupSocketMessageMetrics: () => void;
+    closeSocketMessageMetrics: () => void;
+}

package/dist/types-ts4.5/channel.d.ts

@@ -13,6 +13,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
     private initExperience?;
     private token?;
     private network;
+    private socketMessageMetrics?;
     constructor(config: Config, analyticsHelper: AnalyticsHelper);
     getInitialized: () => boolean;
     getConnected: () => boolean;

package/dist/types-ts4.5/feature-flags/types.d.ts

@@ -1,5 +1,6 @@
 export interface NCSFeatureFlags {
     testFF?: boolean;
+    socketMessageMetricsFF?: boolean;
 }
 export interface WithNCSFeatureFlags {
     featureFlags?: NCSFeatureFlags;

package/dist/types-ts4.5/helpers/const.d.ts

@@ -13,7 +13,8 @@ export declare enum EVENT_ACTION {
     INVALIDATE_TOKEN = "invalidateToken",
     SEND_STEPS_RETRY = "sendStepsRetry",
     CATCHUP_AFTER_MAX_SEND_STEPS_RETRY = "catchupAfterMaxSendStepsRetry",
-    DROPPED_STEPS = "droppedStepInCatchup"
+    DROPPED_STEPS = "droppedStepInCatchup",
+    WEBSOCKET_MESSAGE_VOLUME_METRIC = "websocketMessageVolumeMetric"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -215,7 +216,16 @@ type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
         eventStatus: EVENT_STATUS.INFO;
     };
 };
-export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent;
+type WebsocketMessageVolumeMetricEvent = {
+    eventAction: EVENT_ACTION.WEBSOCKET_MESSAGE_VOLUME_METRIC;
+    attributes: {
+        documentAri?: string;
+        eventStatus: EVENT_STATUS.INFO;
+        messageCount: number;
+        messageSize: number;
+    };
+};
+export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
 export {};

package/dist/types-ts4.5/helpers/socket-message-metrics.d.ts

@@ -0,0 +1,14 @@
+import AnalyticsHelper from '../analytics/analytics-helper';
+import type { Socket } from 'socket.io-client';
+export declare const WEBSOCKET_MESSAGE_VOLUME_METRIC_SEND_INTERVAL_MS = 60000;
+export declare class SocketMessageMetrics {
+    private messageCount;
+    private totalMessageSize;
+    private metricsIntervalID;
+    private socket;
+    private analyticsHelper;
+    constructor(socket: Socket, analyticsHelper: AnalyticsHelper);
+    socketMessageMetricsListener: (event: any, ...args: any[]) => void;
+    setupSocketMessageMetrics: () => void;
+    closeSocketMessageMetrics: () => void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.7.1",
+  "version": "9.7.2",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,7 +36,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-common": "^74.19.0",
+    "@atlaskit/editor-common": "^74.22.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/prosemirror-collab": "^0.2.0",
     "@atlaskit/ufo": "^0.2.0",