@atlaskit/collab-provider 9.7.1 → 9.7.3

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

package/dist/esm/channel.js

@@ -6,6 +6,9 @@ import _inherits from "@babel/runtime/helpers/inherits";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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; }
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 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) { _defineProperty(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; }
@@ -20,7 +23,9 @@ 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';
 var logger = createLogger('Channel', 'green');
 export var Channel = /*#__PURE__*/function (_Emitter) {
   _inherits(Channel, _Emitter);
@@ -29,11 +34,19 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
     var _this;
     _classCallCheck(this, Channel);
     _this = _super.call(this);
+    _defineProperty(_assertThisInitialized(_this), "RATE_LIMIT_TYPE_NONE", 0);
+    _defineProperty(_assertThisInitialized(_this), "RATE_LIMIT_TYPE_SOFT", 1);
+    _defineProperty(_assertThisInitialized(_this), "RATE_LIMIT_TYPE_HARD", 2);
     _defineProperty(_assertThisInitialized(_this), "connected", false);
     _defineProperty(_assertThisInitialized(_this), "socket", null);
     _defineProperty(_assertThisInitialized(_this), "reconnectHelper", null);
     _defineProperty(_assertThisInitialized(_this), "initialized", false);
     _defineProperty(_assertThisInitialized(_this), "network", null);
+    _defineProperty(_assertThisInitialized(_this), "rateLimitWindowDurationMs", 60000);
+    _defineProperty(_assertThisInitialized(_this), "rateLimitWindowStartMs", 0);
+    _defineProperty(_assertThisInitialized(_this), "stepCounter", 0);
+    _defineProperty(_assertThisInitialized(_this), "stepSizeCounter", 0);
+    _defineProperty(_assertThisInitialized(_this), "maxStepSize", 0);
     // read-only getters used for tests
     _defineProperty(_assertThisInitialized(_this), "getInitialized", function () {
       return _this.initialized;
@@ -63,7 +76,7 @@ export 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();
     });
@@ -74,7 +87,7 @@ export 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
@@ -118,6 +131,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);
@@ -125,7 +141,7 @@ export 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,
@@ -467,6 +483,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 +537,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 +561,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                     _this2.emit('error', reconnectionError);
                   }
                 }
-              case 4:
+              case 5:
               case "end":
                 return _context3.stop();
             }
@@ -559,6 +581,12 @@ export 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) {
@@ -572,6 +600,81 @@ export 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: 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/esm/errors/error-code-mapper.js

@@ -99,7 +99,7 @@ export var errorCodeMapper = function 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 var errorCodeMapper = function 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/esm/errors/error-types.js

@@ -41,6 +41,7 @@ export 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;
 }({});
 
@@ -58,6 +59,10 @@ export 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/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.3";
 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.3",
 	"sideEffects": false
 }

package/dist/types/channel.d.ts

@@ -4,15 +4,24 @@ import type { Socket } from 'socket.io-client';
 import AnalyticsHelper from './analytics/analytics-helper';
 import type { Metadata } from '@atlaskit/editor-common/collab';
 export declare class Channel extends Emitter<ChannelEvent> {
+    private readonly RATE_LIMIT_TYPE_NONE;
+    private readonly RATE_LIMIT_TYPE_SOFT;
+    private readonly RATE_LIMIT_TYPE_HARD;
     private connected;
-    private config;
+    private readonly config;
     private socket;
     private reconnectHelper?;
     private initialized;
-    private analyticsHelper?;
+    private readonly analyticsHelper?;
     private initExperience?;
     private token?;
     private network;
+    private socketMessageMetrics?;
+    private readonly rateLimitWindowDurationMs;
+    private rateLimitWindowStartMs;
+    private stepCounter;
+    private stepSizeCounter;
+    private maxStepSize;
     constructor(config: Config, analyticsHelper: AnalyticsHelper);
     getInitialized: () => boolean;
     getConnected: () => boolean;
@@ -24,6 +33,8 @@ export declare class Channel extends Emitter<ChannelEvent> {
      * Connect to collab service using websockets
      */
     connect(shouldInitialize?: boolean): void;
+    onAnyOutgoingHandler(currentTimeMs: number, args: any[]): void;
+    private isLimitExceeded;
     private handlePermissionInvalidateToken;
     private onConnectError;
     private onReconnectError;

package/dist/types/errors/error-types.d.ts

@@ -26,7 +26,8 @@ export declare enum NCS_ERROR_CODE {
     DYNAMO_ERROR = "DYNAMO_ERROR",
     INVALID_ACTIVATION_ID = "INVALID_ACTIVATION_ID",
     INVALID_DOCUMENT_ARI = "INVALID_DOCUMENT_ARI",
-    INVALID_CLOUD_ID = "INVALID_CLOUD_ID"
+    INVALID_CLOUD_ID = "INVALID_CLOUD_ID",
+    RATE_LIMIT_ERROR = "RATE_LIMIT_ERROR"
 }
 type HeadVersionUpdateFailedError = {
     message: string;
@@ -236,10 +237,27 @@ export type InternalDocumentUpdateFailure = {
         status: 500;
     };
 };
+/**
+ * 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.
+ */
+export type RateLimitError = {
+    message: string;
+    data: {
+        code: NCS_ERROR_CODE.RATE_LIMIT_ERROR;
+        meta: {
+            rateLimitType: number;
+            maxStepSize: number;
+            stepSizeCounter: number;
+            stepCounter: number;
+        };
+        status: 500;
+    };
+};
 /**
  * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
  */
-export type InternalError = NCSErrors | DocumentRecoveryError | AddStepsError | CatchUpFailedError | TokenPermissionError | ReconnectionError | ConnectionError | ReconnectionNetworkError | DocumentNotFoundError | InternalDocumentUpdateFailure;
+export type InternalError = NCSErrors | DocumentRecoveryError | AddStepsError | CatchUpFailedError | TokenPermissionError | ReconnectionError | ConnectionError | ReconnectionNetworkError | DocumentNotFoundError | InternalDocumentUpdateFailure | RateLimitError;
 type ValidEventAttributeType = boolean | string | number;
 export declare class CustomError extends Error {
     extraEventAttributes?: {

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/types.d.ts

@@ -63,6 +63,15 @@ export interface Config {
      * throwing a non-recoverable error if it's detected.
      */
     enableErrorOnFailedDocumentApply?: boolean;
+    /**
+     * Configure the client side circuit breaker in the event that abnormal behaviour causes the client to flood
+     * NCS with too many steps or too large a volume of data. This can result in either a soft fail or a hard (fatal) fail
+     * depending on the configured rate limit type.
+     */
+    rateLimitMaxStepSize?: number;
+    rateLimitStepCount?: number;
+    rateLimitTotalStepSize?: number;
+    rateLimitType?: number;
 }
 export interface InitAndAuthData {
     initialized: boolean;

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

@@ -4,15 +4,24 @@ import type { Socket } from 'socket.io-client';
 import AnalyticsHelper from './analytics/analytics-helper';
 import type { Metadata } from '@atlaskit/editor-common/collab';
 export declare class Channel extends Emitter<ChannelEvent> {
+    private readonly RATE_LIMIT_TYPE_NONE;
+    private readonly RATE_LIMIT_TYPE_SOFT;
+    private readonly RATE_LIMIT_TYPE_HARD;
     private connected;
-    private config;
+    private readonly config;
     private socket;
     private reconnectHelper?;
     private initialized;
-    private analyticsHelper?;
+    private readonly analyticsHelper?;
     private initExperience?;
     private token?;
     private network;
+    private socketMessageMetrics?;
+    private readonly rateLimitWindowDurationMs;
+    private rateLimitWindowStartMs;
+    private stepCounter;
+    private stepSizeCounter;
+    private maxStepSize;
     constructor(config: Config, analyticsHelper: AnalyticsHelper);
     getInitialized: () => boolean;
     getConnected: () => boolean;
@@ -24,6 +33,8 @@ export declare class Channel extends Emitter<ChannelEvent> {
      * Connect to collab service using websockets
      */
     connect(shouldInitialize?: boolean): void;
+    onAnyOutgoingHandler(currentTimeMs: number, args: any[]): void;
+    private isLimitExceeded;
     private handlePermissionInvalidateToken;
     private onConnectError;
     private onReconnectError;

package/dist/types-ts4.5/errors/error-types.d.ts

@@ -26,7 +26,8 @@ export declare enum NCS_ERROR_CODE {
     DYNAMO_ERROR = "DYNAMO_ERROR",
     INVALID_ACTIVATION_ID = "INVALID_ACTIVATION_ID",
     INVALID_DOCUMENT_ARI = "INVALID_DOCUMENT_ARI",
-    INVALID_CLOUD_ID = "INVALID_CLOUD_ID"
+    INVALID_CLOUD_ID = "INVALID_CLOUD_ID",
+    RATE_LIMIT_ERROR = "RATE_LIMIT_ERROR"
 }
 type HeadVersionUpdateFailedError = {
     message: string;
@@ -236,10 +237,27 @@ export type InternalDocumentUpdateFailure = {
         status: 500;
     };
 };
+/**
+ * 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.
+ */
+export type RateLimitError = {
+    message: string;
+    data: {
+        code: NCS_ERROR_CODE.RATE_LIMIT_ERROR;
+        meta: {
+            rateLimitType: number;
+            maxStepSize: number;
+            stepSizeCounter: number;
+            stepCounter: number;
+        };
+        status: 500;
+    };
+};
 /**
  * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
  */
-export type InternalError = NCSErrors | DocumentRecoveryError | AddStepsError | CatchUpFailedError | TokenPermissionError | ReconnectionError | ConnectionError | ReconnectionNetworkError | DocumentNotFoundError | InternalDocumentUpdateFailure;
+export type InternalError = NCSErrors | DocumentRecoveryError | AddStepsError | CatchUpFailedError | TokenPermissionError | ReconnectionError | ConnectionError | ReconnectionNetworkError | DocumentNotFoundError | InternalDocumentUpdateFailure | RateLimitError;
 type ValidEventAttributeType = boolean | string | number;
 export declare class CustomError extends Error {
     extraEventAttributes?: {

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