@atlaskit/collab-provider 9.7.1 → 9.7.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.7.3
+
+### Patch Changes
+
+- [`04fa8eb5246`](https://bitbucket.org/atlassian/atlassian-frontend/commits/04fa8eb5246) - Added rate limiting options to 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,11 @@ 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 _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; }
 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); }; }
@@ -36,11 +41,19 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     var _this;
     (0, _classCallCheck2.default)(this, Channel);
     _this = _super.call(this);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "RATE_LIMIT_TYPE_NONE", 0);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "RATE_LIMIT_TYPE_SOFT", 1);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "RATE_LIMIT_TYPE_HARD", 2);
     (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), "reconnectHelper", null);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "initialized", false);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "network", null);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "rateLimitWindowDurationMs", 60000);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "rateLimitWindowStartMs", 0);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "stepCounter", 0);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "stepSizeCounter", 0);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "maxStepSize", 0);
     // read-only getters used for tests
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getInitialized", function () {
       return _this.initialized;
@@ -70,7 +83,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         reason: data.reason,
         // Potentially incorrect when value of token changes between connecting and connect.
         // See: https://bitbucket.org/atlassian/%7Bc8e2f021-38d2-46d0-9b7a-b3f7b428f724%7D/pull-requests/29905#comment-375308874
-        usedCachedToken: _this.token ? true : false
+        usedCachedToken: !!_this.token
       });
       _this.unsetToken();
     });
@@ -81,7 +94,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         latency: measure === null || measure === void 0 ? void 0 : measure.duration,
         // Potentially incorrect when value of token changes between connecting and connect.
         // See: https://bitbucket.org/atlassian/%7Bc8e2f021-38d2-46d0-9b7a-b3f7b428f724%7D/pull-requests/29905#comment-375308874
-        usedCachedToken: _this.token ? true : false
+        usedCachedToken: !!_this.token
       });
       (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error while establishing connection');
       // If error received with `data`, it means the connection is rejected
@@ -125,6 +138,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);
@@ -132,7 +148,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         latency: measure === null || measure === void 0 ? void 0 : measure.duration,
         // Potentially incorrect when value of token changes between connecting and connect.
         // See: https://bitbucket.org/atlassian/%7Bc8e2f021-38d2-46d0-9b7a-b3f7b428f724%7D/pull-requests/29905#comment-375308874
-        usedCachedToken: _this.token ? true : false
+        usedCachedToken: !!_this.token
       });
       _this.emit('connected', {
         sid: _this.socket.id,
@@ -474,6 +490,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 +544,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 +568,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                     _this2.emit('error', reconnectionError);
                   }
                 }
-              case 4:
+              case 5:
               case "end":
                 return _context3.stop();
             }
@@ -566,6 +588,12 @@ 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', this.onConnectError);
       this.socket.on('permission:invalidateToken', this.handlePermissionInvalidateToken);
+      this.socket.onAnyOutgoing(function (event) {
+        for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+          args[_key - 1] = arguments[_key];
+        }
+        return _this2.onAnyOutgoingHandler(Date.now(), args);
+      });
 
       // To trigger reconnection when browser comes back online
       if (!this.network) {
@@ -579,6 +607,81 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       // Fired upon a reconnection attempt error (from Socket.IO Manager)
       this.socket.io.on('reconnect_error', this.onReconnectError);
     }
+  }, {
+    key: "onAnyOutgoingHandler",
+    value: function onAnyOutgoingHandler(currentTimeMs, args) {
+      var rateLimitType = this.config.rateLimitType || this.RATE_LIMIT_TYPE_NONE;
+      if (rateLimitType === this.RATE_LIMIT_TYPE_NONE) {
+        return;
+      }
+      var stepLimit = this.config.rateLimitStepCount || 0;
+      var stepSizeLimit = this.config.rateLimitTotalStepSize || 0;
+      var maxStepSizeLimit = this.config.rateLimitMaxStepSize || 0;
+      var _iterator = _createForOfIteratorHelper(args),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var arg = _step.value;
+          if (arg.type === 'steps:commit') {
+            if (currentTimeMs - this.rateLimitWindowStartMs > this.rateLimitWindowDurationMs) {
+              // Start a new window
+              this.rateLimitWindowStartMs = currentTimeMs;
+              this.stepCounter = 0;
+              this.stepSizeCounter = 0;
+              this.maxStepSize = 0;
+            }
+            this.stepCounter += arg.steps.length;
+            var _iterator2 = _createForOfIteratorHelper(arg.steps),
+              _step2;
+            try {
+              for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+                var step = _step2.value;
+                var stepSize = JSON.stringify(step).length;
+                this.stepSizeCounter += stepSize;
+                if (stepSize > this.maxStepSize) {
+                  this.maxStepSize = stepSize;
+                }
+              }
+            } catch (err) {
+              _iterator2.e(err);
+            } finally {
+              _iterator2.f();
+            }
+            if (this.isLimitExceeded(stepLimit, stepSizeLimit, maxStepSizeLimit)) {
+              var rateLimitError = {
+                message: 'Rate limited',
+                data: {
+                  code: _errorTypes.NCS_ERROR_CODE.RATE_LIMIT_ERROR,
+                  status: 500,
+                  meta: {
+                    rateLimitType: rateLimitType,
+                    maxStepSize: this.maxStepSize,
+                    stepSizeCounter: this.stepSizeCounter,
+                    stepCounter: this.stepCounter
+                  }
+                }
+              };
+              if (rateLimitType === this.RATE_LIMIT_TYPE_HARD) {
+                this.emit('error', rateLimitError);
+                throw new Error();
+              } else if (rateLimitType === this.RATE_LIMIT_TYPE_SOFT) {
+                var _this$analyticsHelper7;
+                (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(rateLimitError, 'Rate limited');
+              }
+            }
+          }
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+    }
+  }, {
+    key: "isLimitExceeded",
+    value: function isLimitExceeded(stepLimit, stepSizeLimit, maxStepSizeLimit) {
+      return stepLimit > 0 && this.stepCounter > stepLimit || stepSizeLimit > 0 && this.stepSizeCounter > stepSizeLimit || maxStepSizeLimit > 0 && this.maxStepSize > maxStepSizeLimit;
+    }
   }, {
     key: "disconnect",
     value: function disconnect() {

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

@@ -103,7 +103,7 @@ var errorCodeMapper = function errorCodeMapper(error) {
       return {
         code: _collab.PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
         message: 'Collab Provider experienced an unrecoverable error',
-        recoverable: false,
+        recoverable: true,
         reason: (_error$data3 = error.data) === null || _error$data3 === void 0 ? void 0 : _error$data3.code,
         status: 500
       };
@@ -115,6 +115,12 @@ var errorCodeMapper = function errorCodeMapper(error) {
         reason: (_error$data4 = error.data) === null || _error$data4 === void 0 ? void 0 : _error$data4.code,
         status: 500
       };
+    case _errorTypes.NCS_ERROR_CODE.RATE_LIMIT_ERROR:
+      return {
+        code: _collab.PROVIDER_ERROR_CODE.FAIL_TO_SAVE,
+        message: 'Document rate limit',
+        recoverable: false
+      };
     default:
       return;
   }

package/dist/cjs/errors/error-types.js

@@ -46,6 +46,7 @@ var NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
   NCS_ERROR_CODE["INVALID_ACTIVATION_ID"] = "INVALID_ACTIVATION_ID";
   NCS_ERROR_CODE["INVALID_DOCUMENT_ARI"] = "INVALID_DOCUMENT_ARI";
   NCS_ERROR_CODE["INVALID_CLOUD_ID"] = "INVALID_CLOUD_ID";
+  NCS_ERROR_CODE["RATE_LIMIT_ERROR"] = "RATE_LIMIT_ERROR";
   return NCS_ERROR_CODE;
 }({}); // TODO: Import emitted error codes from NCS
 // NCS Errors
@@ -60,6 +61,10 @@ var NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
  * When we try to apply state updates to the editor, if that fails to apply the user can enter an invalid state where no
  * changes can be saved to NCS.
  */
+/**
+ * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
+ * operating condition and should only ever indicate a frontend bug.
+ */
 /**
  * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
  */

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.3";
 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.3",
 	"sideEffects": false
 }

package/dist/es2019/channel.js

@@ -8,16 +8,26 @@ import ReconnectHelper from './connectivity/reconnect-helper';
 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 { NotConnectedError, NotInitializedError, INTERNAL_ERROR_CODE, NCS_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) {
     super();
+    _defineProperty(this, "RATE_LIMIT_TYPE_NONE", 0);
+    _defineProperty(this, "RATE_LIMIT_TYPE_SOFT", 1);
+    _defineProperty(this, "RATE_LIMIT_TYPE_HARD", 2);
     _defineProperty(this, "connected", false);
     _defineProperty(this, "socket", null);
     _defineProperty(this, "reconnectHelper", null);
     _defineProperty(this, "initialized", false);
     _defineProperty(this, "network", null);
+    _defineProperty(this, "rateLimitWindowDurationMs", 60000);
+    _defineProperty(this, "rateLimitWindowStartMs", 0);
+    _defineProperty(this, "stepCounter", 0);
+    _defineProperty(this, "stepSizeCounter", 0);
+    _defineProperty(this, "maxStepSize", 0);
     // read-only getters used for tests
     _defineProperty(this, "getInitialized", () => this.initialized);
     _defineProperty(this, "getConnected", () => this.connected);
@@ -37,7 +47,7 @@ export class Channel extends Emitter {
         reason: data.reason,
         // Potentially incorrect when value of token changes between connecting and connect.
         // See: https://bitbucket.org/atlassian/%7Bc8e2f021-38d2-46d0-9b7a-b3f7b428f724%7D/pull-requests/29905#comment-375308874
-        usedCachedToken: this.token ? true : false
+        usedCachedToken: !!this.token
       });
       this.unsetToken();
     });
@@ -48,7 +58,7 @@ export class Channel extends Emitter {
         latency: measure === null || measure === void 0 ? void 0 : measure.duration,
         // Potentially incorrect when value of token changes between connecting and connect.
         // See: https://bitbucket.org/atlassian/%7Bc8e2f021-38d2-46d0-9b7a-b3f7b428f724%7D/pull-requests/29905#comment-375308874
-        usedCachedToken: this.token ? true : false
+        usedCachedToken: !!this.token
       });
       (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error while establishing connection');
       // If error received with `data`, it means the connection is rejected
@@ -93,6 +103,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);
@@ -100,7 +113,7 @@ export class Channel extends Emitter {
         latency: measure === null || measure === void 0 ? void 0 : measure.duration,
         // Potentially incorrect when value of token changes between connecting and connect.
         // See: https://bitbucket.org/atlassian/%7Bc8e2f021-38d2-46d0-9b7a-b3f7b428f724%7D/pull-requests/29905#comment-375308874
-        usedCachedToken: this.token ? true : false
+        usedCachedToken: !!this.token
       });
       this.emit('connected', {
         sid: this.socket.id,
@@ -350,6 +363,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 +416,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', {
@@ -433,6 +452,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', this.onConnectError);
     this.socket.on('permission:invalidateToken', this.handlePermissionInvalidateToken);
+    this.socket.onAnyOutgoing((event, ...args) => this.onAnyOutgoingHandler(Date.now(), args));
 
     // To trigger reconnection when browser comes back online
     if (!this.network) {
@@ -446,6 +466,59 @@ export class Channel extends Emitter {
     // Fired upon a reconnection attempt error (from Socket.IO Manager)
     this.socket.io.on('reconnect_error', this.onReconnectError);
   }
+  onAnyOutgoingHandler(currentTimeMs, args) {
+    const rateLimitType = this.config.rateLimitType || this.RATE_LIMIT_TYPE_NONE;
+    if (rateLimitType === this.RATE_LIMIT_TYPE_NONE) {
+      return;
+    }
+    const stepLimit = this.config.rateLimitStepCount || 0;
+    const stepSizeLimit = this.config.rateLimitTotalStepSize || 0;
+    const maxStepSizeLimit = this.config.rateLimitMaxStepSize || 0;
+    for (const arg of args) {
+      if (arg.type === 'steps:commit') {
+        if (currentTimeMs - this.rateLimitWindowStartMs > this.rateLimitWindowDurationMs) {
+          // Start a new window
+          this.rateLimitWindowStartMs = currentTimeMs;
+          this.stepCounter = 0;
+          this.stepSizeCounter = 0;
+          this.maxStepSize = 0;
+        }
+        this.stepCounter += arg.steps.length;
+        for (const step of arg.steps) {
+          const stepSize = JSON.stringify(step).length;
+          this.stepSizeCounter += stepSize;
+          if (stepSize > this.maxStepSize) {
+            this.maxStepSize = stepSize;
+          }
+        }
+        if (this.isLimitExceeded(stepLimit, stepSizeLimit, maxStepSizeLimit)) {
+          const rateLimitError = {
+            message: 'Rate limited',
+            data: {
+              code: NCS_ERROR_CODE.RATE_LIMIT_ERROR,
+              status: 500,
+              meta: {
+                rateLimitType,
+                maxStepSize: this.maxStepSize,
+                stepSizeCounter: this.stepSizeCounter,
+                stepCounter: this.stepCounter
+              }
+            }
+          };
+          if (rateLimitType === this.RATE_LIMIT_TYPE_HARD) {
+            this.emit('error', rateLimitError);
+            throw new Error();
+          } else if (rateLimitType === this.RATE_LIMIT_TYPE_SOFT) {
+            var _this$analyticsHelper8;
+            (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(rateLimitError, 'Rate limited');
+          }
+        }
+      }
+    }
+  }
+  isLimitExceeded(stepLimit, stepSizeLimit, maxStepSizeLimit) {
+    return stepLimit > 0 && this.stepCounter > stepLimit || stepSizeLimit > 0 && this.stepSizeCounter > stepSizeLimit || maxStepSizeLimit > 0 && this.maxStepSize > maxStepSizeLimit;
+  }
   disconnect() {
     var _this$network;
     this.unsubscribeAll();

package/dist/es2019/errors/error-code-mapper.js

@@ -99,7 +99,7 @@ export const errorCodeMapper = error => {
       return {
         code: PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
         message: 'Collab Provider experienced an unrecoverable error',
-        recoverable: false,
+        recoverable: true,
         reason: (_error$data3 = error.data) === null || _error$data3 === void 0 ? void 0 : _error$data3.code,
         status: 500
       };
@@ -111,6 +111,12 @@ export const errorCodeMapper = error => {
         reason: (_error$data4 = error.data) === null || _error$data4 === void 0 ? void 0 : _error$data4.code,
         status: 500
       };
+    case NCS_ERROR_CODE.RATE_LIMIT_ERROR:
+      return {
+        code: PROVIDER_ERROR_CODE.FAIL_TO_SAVE,
+        message: 'Document rate limit',
+        recoverable: false
+      };
     default:
       return;
   }

package/dist/es2019/errors/error-types.js

@@ -32,6 +32,7 @@ export let NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
   NCS_ERROR_CODE["INVALID_ACTIVATION_ID"] = "INVALID_ACTIVATION_ID";
   NCS_ERROR_CODE["INVALID_DOCUMENT_ARI"] = "INVALID_DOCUMENT_ARI";
   NCS_ERROR_CODE["INVALID_CLOUD_ID"] = "INVALID_CLOUD_ID";
+  NCS_ERROR_CODE["RATE_LIMIT_ERROR"] = "RATE_LIMIT_ERROR";
   return NCS_ERROR_CODE;
 }({});
 
@@ -49,6 +50,10 @@ export let NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
  * When we try to apply state updates to the editor, if that fails to apply the user can enter an invalid state where no
  * changes can be saved to NCS.
  */
+/**
+ * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
+ * operating condition and should only ever indicate a frontend bug.
+ */
 /**
  * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
  */

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;
+  }
+}