@atlaskit/collab-provider 9.7.2 → 9.7.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.7.4
+
+### Patch Changes
+
+- [`4e6f1bf8511`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4e6f1bf8511) - [ED-19233] Import prosemirror libraries from internal facade package
+
+## 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

package/dist/cjs/channel.js

@@ -26,6 +26,9 @@ 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); }; }
@@ -38,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;
@@ -72,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();
     });
@@ -83,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
@@ -137,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,
@@ -577,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) {
@@ -590,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/document/catchup.js

@@ -10,7 +10,7 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _const = require("../helpers/const");
 var _utils = require("../helpers/utils");
-var _prosemirrorTransform = require("prosemirror-transform");
+var _transform = require("@atlaskit/editor-prosemirror/transform");
 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; }
@@ -114,11 +114,11 @@ var catchup = /*#__PURE__*/function () {
                     inverted = _ref2.inverted;
                   // Due to @types/prosemirror-transform mismatch with the actual
                   // constructor, hack to set the `inverted`.
-                  var stepMap = new _prosemirrorTransform.StepMap(ranges);
+                  var stepMap = new _transform.StepMap(ranges);
                   stepMap.inverted = inverted;
                   return stepMap;
                 }); // create Mapping used for Step.map
-                mapping = new _prosemirrorTransform.Mapping(stepMaps);
+                mapping = new _transform.Mapping(stepMaps);
                 logger("".concat(_unconfirmedSteps.length, " unconfirmed steps before rebased: ").concat(JSON.stringify(_unconfirmedSteps)));
                 newUnconfirmedSteps = rebaseSteps(_unconfirmedSteps, mapping);
                 if ((newUnconfirmedSteps === null || newUnconfirmedSteps === void 0 ? void 0 : newUnconfirmedSteps.length) < _unconfirmedSteps.length) {

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/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.2";
+var version = "9.7.4";
 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.2",
+	"version": "9.7.4",
 	"sideEffects": false
 }

package/dist/es2019/channel.js

@@ -8,18 +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);
@@ -39,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();
     });
@@ -50,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
@@ -105,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,
@@ -444,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) {
@@ -457,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/document/catchup.js

@@ -1,6 +1,6 @@
 import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { createLogger } from '../helpers/utils';
-import { StepMap, Mapping } from 'prosemirror-transform';
+import { StepMap, Mapping } from '@atlaskit/editor-prosemirror/transform';
 const logger = createLogger('Catchup', 'red');
 
 /**

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/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.7.2";
+export const version = "9.7.4";
 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.2",
+	"version": "9.7.4",
 	"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,7 @@ 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');
@@ -31,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;
@@ -65,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();
     });
@@ -76,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
@@ -130,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,
@@ -570,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) {
@@ -583,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/document/catchup.js

@@ -5,7 +5,7 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 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 { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { createLogger } from '../helpers/utils';
-import { StepMap, Mapping } from 'prosemirror-transform';
+import { StepMap, Mapping } from '@atlaskit/editor-prosemirror/transform';
 var logger = createLogger('Catchup', 'red');
 
 /**

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/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "9.7.2";
+export var version = "9.7.4";
 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.2",
+	"version": "9.7.4",
 	"sideEffects": false
 }

package/dist/types/channel.d.ts

@@ -4,16 +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;
@@ -25,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/document/catchup.d.ts

@@ -1,5 +1,5 @@
 import type { CatchupOptions } from '../types';
-import { Mapping, Step } from 'prosemirror-transform';
+import { Mapping, Step } from '@atlaskit/editor-prosemirror/transform';
 /**
  * Rebase the steps based on the mapping pipeline.
  * Some steps could be lost, if they are no longer

package/dist/types/document/document-service.d.ts

@@ -2,10 +2,10 @@
 import AnalyticsHelper from '../analytics/analytics-helper';
 import { CatchupResponse, ChannelEvent, StepsPayload } from '../types';
 import type { SyncUpErrorFunction, ResolvedEditorState } from '@atlaskit/editor-common/collab';
-import type { Step as ProseMirrorStep } from 'prosemirror-transform';
+import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type { MetadataService } from '../metadata/metadata-service';
 import type { CollabEvents, CollabInitPayload } from '@atlaskit/editor-common/collab';
-import type { EditorState, Transaction } from 'prosemirror-state';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import { ParticipantsService } from '../participants/participants-service';
 import type { InternalError } from '../errors/error-types';
 export declare class DocumentService {

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

@@ -1,5 +1,5 @@
 import type { ProductInformation } from '../types';
-import type { Step as ProseMirrorStep } from 'prosemirror-transform';
+import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<unknown>;
 export declare const getProduct: (productInfo?: ProductInformation) => string;

package/dist/types/provider/commit-step.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="lodash" />
 import { ChannelEvent, StepsPayload } from '../types';
 import type { CollabCommitStatusEventPayload, CollabEvents } from '@atlaskit/editor-common/collab';
-import type { Step as ProseMirrorStep } from 'prosemirror-transform';
+import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/error-types';
 export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {

package/dist/types/provider/index.d.ts

@@ -1,5 +1,5 @@
-import type { EditorState, Transaction } from 'prosemirror-state';
-import type { Step as ProseMirrorStep } from 'prosemirror-transform';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { Emitter } from '../emitter';
 import type { Config } from '../types';
 import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';

package/dist/types/types.d.ts

@@ -1,4 +1,4 @@
-import type { Step } from 'prosemirror-transform';
+import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import type { Manager } from 'socket.io-client';
 import type { InternalError } from './errors/error-types';
@@ -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,16 +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;
@@ -25,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/document/catchup.d.ts

@@ -1,5 +1,5 @@
 import type { CatchupOptions } from '../types';
-import { Mapping, Step } from 'prosemirror-transform';
+import { Mapping, Step } from '@atlaskit/editor-prosemirror/transform';
 /**
  * Rebase the steps based on the mapping pipeline.
  * Some steps could be lost, if they are no longer

package/dist/types-ts4.5/document/document-service.d.ts

@@ -2,10 +2,10 @@
 import AnalyticsHelper from '../analytics/analytics-helper';
 import { CatchupResponse, ChannelEvent, StepsPayload } from '../types';
 import type { SyncUpErrorFunction, ResolvedEditorState } from '@atlaskit/editor-common/collab';
-import type { Step as ProseMirrorStep } from 'prosemirror-transform';
+import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type { MetadataService } from '../metadata/metadata-service';
 import type { CollabEvents, CollabInitPayload } from '@atlaskit/editor-common/collab';
-import type { EditorState, Transaction } from 'prosemirror-state';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import { ParticipantsService } from '../participants/participants-service';
 import type { InternalError } from '../errors/error-types';
 export declare class DocumentService {

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

@@ -1,5 +1,5 @@
 import type { ProductInformation } from '../types';
-import type { Step as ProseMirrorStep } from 'prosemirror-transform';
+import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<unknown>;
 export declare const getProduct: (productInfo?: ProductInformation) => string;

package/dist/types-ts4.5/provider/commit-step.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="lodash" />
 import { ChannelEvent, StepsPayload } from '../types';
 import type { CollabCommitStatusEventPayload, CollabEvents } from '@atlaskit/editor-common/collab';
-import type { Step as ProseMirrorStep } from 'prosemirror-transform';
+import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/error-types';
 export declare const commitStep: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, }: {

package/dist/types-ts4.5/provider/index.d.ts

@@ -1,5 +1,5 @@
-import type { EditorState, Transaction } from 'prosemirror-state';
-import type { Step as ProseMirrorStep } from 'prosemirror-transform';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { Emitter } from '../emitter';
 import type { Config } from '../types';
 import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';

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

@@ -1,4 +1,4 @@
-import type { Step } from 'prosemirror-transform';
+import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import type { Manager } from 'socket.io-client';
 import type { InternalError } from './errors/error-types';
@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.7.2",
+  "version": "9.7.4",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -36,15 +36,15 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-common": "^74.22.0",
+    "@atlaskit/editor-common": "^74.29.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
+    "@atlaskit/editor-prosemirror": "1.0.2",
     "@atlaskit/prosemirror-collab": "^0.2.0",
     "@atlaskit/ufo": "^0.2.0",
     "@atlaskit/util-service-support": "^6.2.0",
     "@babel/runtime": "^7.0.0",
     "eventemitter2": "^4.1.0",
     "lodash": "^4.17.21",
-    "prosemirror-transform": "1.3.2",
     "socket.io-client": "^4.7.1"
   },
   "techstack": {
@@ -62,12 +62,10 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^26.2.0",
+    "@atlaskit/adf-schema": "^26.4.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
     "@atlaskit/editor-test-helpers": "^18.10.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
-    "prosemirror-model": "1.16.0",
-    "prosemirror-state": "1.3.4",
     "typescript": "~4.9.5"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"

package/report.api.md

@@ -34,7 +34,7 @@ import { CollabParticipant } from '@atlaskit/editor-common/collab';
 import { CollabPresencePayload } from '@atlaskit/editor-common/collab';
 import { CollabSendableSelection } from '@atlaskit/editor-common/collab';
 import { CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
-import type { EditorState } from 'prosemirror-state';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { Manager } from 'socket.io-client';
 import type { Metadata as Metadata_2 } from '@atlaskit/editor-common/collab';
@@ -43,9 +43,9 @@ import { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';
 import { ProviderError } from '@atlaskit/editor-common/collab';
 import { ProviderParticipant } from '@atlaskit/editor-common/collab';
 import { ResolvedEditorState } from '@atlaskit/editor-common/collab';
-import type { Step } from 'prosemirror-transform';
+import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import { SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
-import type { Transaction } from 'prosemirror-state';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 
 // @public (undocumented)
 type AuthCallback = (cb: (data: InitAndAuthData) => void) => void;
@@ -144,6 +144,13 @@ interface Config {
   permissionTokenRefresh?: () => Promise<null | string>;
   // (undocumented)
   productInfo?: ProductInformation;
+  rateLimitMaxStepSize?: number;
+  // (undocumented)
+  rateLimitStepCount?: number;
+  // (undocumented)
+  rateLimitTotalStepSize?: number;
+  // (undocumented)
+  rateLimitType?: number;
   // (undocumented)
   storage?: Storage_2;
   throwOnNotConnected?: boolean;

package/tmp/api-report-tmp.d.ts

@@ -23,7 +23,7 @@ import { CollabParticipant } from '@atlaskit/editor-common/collab';
 import { CollabPresencePayload } from '@atlaskit/editor-common/collab';
 import { CollabSendableSelection } from '@atlaskit/editor-common/collab';
 import { CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
-import type { EditorState } from 'prosemirror-state';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { Manager } from 'socket.io-client';
 import type { Metadata as Metadata_2 } from '@atlaskit/editor-common/collab';
@@ -32,9 +32,9 @@ import { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';
 import { ProviderError } from '@atlaskit/editor-common/collab';
 import { ProviderParticipant } from '@atlaskit/editor-common/collab';
 import { ResolvedEditorState } from '@atlaskit/editor-common/collab';
-import type { Step } from 'prosemirror-transform';
+import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import { SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
-import type { Transaction } from 'prosemirror-state';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 
 // @public (undocumented)
 type AuthCallback = (cb: (data: InitAndAuthData) => void) => void;
@@ -120,6 +120,13 @@ interface Config {
     permissionTokenRefresh?: () => Promise<null | string>;
     // (undocumented)
     productInfo?: ProductInformation;
+    rateLimitMaxStepSize?: number;
+    // (undocumented)
+    rateLimitStepCount?: number;
+    // (undocumented)
+    rateLimitTotalStepSize?: number;
+    // (undocumented)
+    rateLimitType?: number;
     // (undocumented)
     storage?: Storage_2;
     throwOnNotConnected?: boolean;