@atlaskit/collab-provider 9.2.0 → 9.2.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.2.2
+
+### Patch Changes
+
+- [`11ac0368176`](https://bitbucket.org/atlassian/atlassian-frontend/commits/11ac0368176) - Dummy changeset to trigger release
+
+## 9.2.1
+
+### Patch Changes
+
+- [`65fafdf95fe`](https://bitbucket.org/atlassian/atlassian-frontend/commits/65fafdf95fe) - ESS-3666: add additional analytics events for when the cant sync up with collab service error occurs for better troubleshooting
+
 ## 9.2.0
 
 ### Minor Changes

package/dist/cjs/document/document-service.js

@@ -334,14 +334,14 @@ var DocumentService = /*#__PURE__*/function () {
      * @throws {Error} Couldn't sync the steps after retrying 30 times
      */
     (0, _defineProperty2.default)(this, "commitUnconfirmedSteps", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
-      var unconfirmedSteps, _this$analyticsHelper17, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, state, measure, _this$analyticsHelper18, _this$analyticsHelper19, _measure3;
+      var unconfirmedSteps, _this$analyticsHelper18, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, _this$analyticsHelper17, state, unconfirmedStepsInfoUGCRemoved, measure, _this$analyticsHelper19, _this$analyticsHelper20, _measure3;
       return _regenerator.default.wrap(function _callee4$(_context4) {
         while (1) switch (_context4.prev = _context4.next) {
           case 0:
             unconfirmedSteps = _this.getUnconfirmedSteps();
             _context4.prev = 1;
             if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
-              _context4.next = 21;
+              _context4.next = 23;
               break;
             }
             (0, _performance.startMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
@@ -354,7 +354,7 @@ var DocumentService = /*#__PURE__*/function () {
             isLastTrConfirmed = false;
           case 8:
             if (isLastTrConfirmed) {
-              _context4.next = 19;
+              _context4.next = 21;
               break;
             }
             _this.sendStepsFromCurrentState();
@@ -371,7 +371,7 @@ var DocumentService = /*#__PURE__*/function () {
               isLastTrConfirmed = true;
             }
             if (!(!isLastTrConfirmed && count++ >= _const.ACK_MAX_TRY)) {
-              _context4.next = 17;
+              _context4.next = 19;
               break;
             }
             if (_this.onSyncUpError) {
@@ -384,48 +384,54 @@ var DocumentService = /*#__PURE__*/function () {
                 version: (0, _prosemirrorCollab.getVersion)(state)
               });
             }
+            unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(function (step) {
+              return (0, _utils.getStepUGCFreeDetails)(step);
+            });
+            (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendErrorEvent({
+              unconfirmedStepsInfo: unconfirmedStepsInfoUGCRemoved
+            }, "Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached");
             throw new Error("Can't sync up with Collab Service");
-          case 17:
+          case 19:
             _context4.next = 8;
             break;
-          case 19:
+          case 21:
             measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.SUCCESS, {
+            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.SUCCESS, {
               latency: measure === null || measure === void 0 ? void 0 : measure.duration,
               // upon success, emit the total number of unconfirmed steps we synced
               numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
             });
-          case 21:
-            _context4.next = 29;
-            break;
           case 23:
-            _context4.prev = 23;
+            _context4.next = 31;
+            break;
+          case 25:
+            _context4.prev = 25;
             _context4.t0 = _context4["catch"](1);
             _measure3 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
+            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
               latency: _measure3 === null || _measure3 === void 0 ? void 0 : _measure3.duration,
               numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
             });
-            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendErrorEvent(_context4.t0, 'Error while committing unconfirmed steps');
+            (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(_context4.t0, 'Error while committing unconfirmed steps');
             throw _context4.t0;
-          case 29:
+          case 31:
           case "end":
             return _context4.stop();
         }
-      }, _callee4, null, [[1, 23]]);
+      }, _callee4, null, [[1, 25]]);
     })));
     (0, _defineProperty2.default)(this, "onStepRejectedError", function () {
-      var _this$analyticsHelper20;
+      var _this$analyticsHelper21;
       _this.stepRejectCounter++;
       logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
-      (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO, {
+      (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(_const.EVENT_ACTION.SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO, {
         count: _this.stepRejectCounter
       });
       var maxRetries = _this.aggressiveCatchup ? _this.failedStepsBeforeCatchupOnPublish : _provider.MAX_STEP_REJECTED_ERROR;
       if (_this.stepRejectCounter >= maxRetries) {
-        var _this$analyticsHelper21;
+        var _this$analyticsHelper22;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(_provider.MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
-        (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(_const.EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO);
+        (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(_const.EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO);
         _this.throttledCatchup();
       } else {
         // If committing steps failed try again automatically in 1s
@@ -497,9 +503,9 @@ var DocumentService = /*#__PURE__*/function () {
             }, 100);
           }
         } catch (error) {
-          var _this$analyticsHelper22;
+          var _this$analyticsHelper23;
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
-          (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendErrorEvent(error, 'Error while processing steps');
+          (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendErrorEvent(error, 'Error while processing steps');
           this.throttledCatchup();
         }
       }

package/dist/cjs/helpers/utils.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getSubProduct = exports.getProduct = exports.createLogger = void 0;
+exports.getSubProduct = exports.getStepUGCFreeDetails = exports.getProduct = exports.createLogger = void 0;
 exports.sleep = sleep;
 var createLogger = function createLogger(prefix) {
   var color = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'blue';
@@ -30,4 +30,30 @@ var getSubProduct = function getSubProduct(productInfo) {
   var _productInfo$subProdu;
   return (_productInfo$subProdu = productInfo === null || productInfo === void 0 ? void 0 : productInfo.subProduct) !== null && _productInfo$subProdu !== void 0 ? _productInfo$subProdu : !!(productInfo !== null && productInfo !== void 0 && productInfo.product) ? 'none' : 'unknown';
 };
-exports.getSubProduct = getSubProduct;
+exports.getSubProduct = getSubProduct;
+// Get as step info which is known not to contain user generated content.
+var getStepUGCFreeDetails = function getStepUGCFreeDetails(step) {
+  var _stepJson$slice, _stepJson$slice2;
+  var stepJson;
+  try {
+    stepJson = step.toJSON();
+  } catch (e) {
+    return {
+      type: 'unknown',
+      contentTypes: '',
+      stepSizeInBytes: Buffer.byteLength(JSON.stringify(step))
+    };
+  }
+  var contentTypes = '';
+  if ((_stepJson$slice = stepJson.slice) !== null && _stepJson$slice !== void 0 && _stepJson$slice.content && Array.isArray((_stepJson$slice2 = stepJson.slice) === null || _stepJson$slice2 === void 0 ? void 0 : _stepJson$slice2.content)) {
+    contentTypes = stepJson.slice.content.map(function (c) {
+      return (c === null || c === void 0 ? void 0 : c.type) || 'unknown';
+    }).join(', ');
+  }
+  return {
+    type: stepJson.stepType || 'unknown',
+    contentTypes: contentTypes,
+    stepSizeInBytes: Buffer.byteLength(JSON.stringify(step))
+  };
+};
+exports.getStepUGCFreeDetails = getStepUGCFreeDetails;

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.2.0";
+var version = "9.2.2";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/cjs/version.json

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

package/dist/es2019/document/document-service.js

@@ -1,7 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { getVersion, sendableSteps } from '@atlaskit/prosemirror-collab';
-import { createLogger, sleep } from '../helpers/utils';
+import { createLogger, getStepUGCFreeDetails, sleep } from '../helpers/utils';
 import throttle from 'lodash/throttle';
 import { throttledCommitStep } from '../provider/commit-step';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
@@ -284,7 +284,7 @@ export class DocumentService {
       const unconfirmedSteps = this.getUnconfirmedSteps();
       try {
         if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
-          var _this$analyticsHelper17;
+          var _this$analyticsHelper18;
           startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
           let count = 0;
           // We use origins here as steps can be rebased. When steps are rebased a new step is created.
@@ -305,6 +305,7 @@ export class DocumentService {
               isLastTrConfirmed = true;
             }
             if (!isLastTrConfirmed && count++ >= ACK_MAX_TRY) {
+              var _this$getUnconfirmedS, _this$analyticsHelper17;
               if (this.onSyncUpError) {
                 const state = this.getState();
                 this.onSyncUpError({
@@ -315,39 +316,43 @@ export class DocumentService {
                   version: getVersion(state)
                 });
               }
+              const unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(step => getStepUGCFreeDetails(step));
+              (_this$analyticsHelper17 = this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendErrorEvent({
+                unconfirmedStepsInfo: unconfirmedStepsInfoUGCRemoved
+              }, "Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached");
               throw new Error("Can't sync up with Collab Service");
             }
           }
           const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-          (_this$analyticsHelper17 = this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
+          (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
             // upon success, emit the total number of unconfirmed steps we synced
             numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
           });
         }
       } catch (error) {
-        var _this$analyticsHelper18, _this$analyticsHelper19;
+        var _this$analyticsHelper19, _this$analyticsHelper20;
         const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-        (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
+        (_this$analyticsHelper19 = this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
           latency: measure === null || measure === void 0 ? void 0 : measure.duration,
           numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
         });
-        (_this$analyticsHelper19 = this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendErrorEvent(error, 'Error while committing unconfirmed steps');
+        (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(error, 'Error while committing unconfirmed steps');
         throw error;
       }
     });
     _defineProperty(this, "onStepRejectedError", () => {
-      var _this$analyticsHelper20;
+      var _this$analyticsHelper21;
       this.stepRejectCounter++;
       logger(`Steps rejected (tries=${this.stepRejectCounter})`);
-      (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
+      (_this$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
         count: this.stepRejectCounter
       });
       let maxRetries = this.aggressiveCatchup ? this.failedStepsBeforeCatchupOnPublish : MAX_STEP_REJECTED_ERROR;
       if (this.stepRejectCounter >= maxRetries) {
-        var _this$analyticsHelper21;
+        var _this$analyticsHelper22;
         logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
-        (_this$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
+        (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
         this.throttledCatchup();
       } else {
         // If committing steps failed try again automatically in 1s
@@ -411,9 +416,9 @@ export class DocumentService {
           setTimeout(() => this.sendStepsFromCurrentState(), 100);
         }
       } catch (error) {
-        var _this$analyticsHelper22;
+        var _this$analyticsHelper23;
         logger(`Processing steps failed with error: ${error}. Triggering catch up call.`);
-        (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendErrorEvent(error, 'Error while processing steps');
+        (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendErrorEvent(error, 'Error while processing steps');
         this.throttledCatchup();
       }
     }

package/dist/es2019/helpers/utils.js

@@ -16,4 +16,29 @@ export const getProduct = productInfo => {
 export const getSubProduct = productInfo => {
   var _productInfo$subProdu;
   return (_productInfo$subProdu = productInfo === null || productInfo === void 0 ? void 0 : productInfo.subProduct) !== null && _productInfo$subProdu !== void 0 ? _productInfo$subProdu : !!(productInfo !== null && productInfo !== void 0 && productInfo.product) ? 'none' : 'unknown';
+};
+// Get as step info which is known not to contain user generated content.
+export const getStepUGCFreeDetails = step => {
+  var _stepJson$slice, _stepJson$slice2;
+  let stepJson;
+  try {
+    stepJson = step.toJSON();
+  } catch (e) {
+    return {
+      type: 'unknown',
+      contentTypes: '',
+      stepSizeInBytes: Buffer.byteLength(JSON.stringify(step))
+    };
+  }
+  let contentTypes = '';
+  if ((_stepJson$slice = stepJson.slice) !== null && _stepJson$slice !== void 0 && _stepJson$slice.content && Array.isArray((_stepJson$slice2 = stepJson.slice) === null || _stepJson$slice2 === void 0 ? void 0 : _stepJson$slice2.content)) {
+    contentTypes = stepJson.slice.content.map(c => {
+      return (c === null || c === void 0 ? void 0 : c.type) || 'unknown';
+    }).join(', ');
+  }
+  return {
+    type: stepJson.stepType || 'unknown',
+    contentTypes,
+    stepSizeInBytes: Buffer.byteLength(JSON.stringify(step))
+  };
 };

package/dist/es2019/version-wrapper.js

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

package/dist/es2019/version.json

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

package/dist/esm/document/document-service.js

@@ -7,7 +7,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { getVersion, sendableSteps } from '@atlaskit/prosemirror-collab';
-import { createLogger, sleep } from '../helpers/utils';
+import { createLogger, getStepUGCFreeDetails, sleep } from '../helpers/utils';
 import throttle from 'lodash/throttle';
 import { throttledCommitStep } from '../provider/commit-step';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
@@ -327,14 +327,14 @@ export var DocumentService = /*#__PURE__*/function () {
      * @throws {Error} Couldn't sync the steps after retrying 30 times
      */
     _defineProperty(this, "commitUnconfirmedSteps", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4() {
-      var unconfirmedSteps, _this$analyticsHelper17, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, state, measure, _this$analyticsHelper18, _this$analyticsHelper19, _measure3;
+      var unconfirmedSteps, _this$analyticsHelper18, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, _this$analyticsHelper17, state, unconfirmedStepsInfoUGCRemoved, measure, _this$analyticsHelper19, _this$analyticsHelper20, _measure3;
       return _regeneratorRuntime.wrap(function _callee4$(_context4) {
         while (1) switch (_context4.prev = _context4.next) {
           case 0:
             unconfirmedSteps = _this.getUnconfirmedSteps();
             _context4.prev = 1;
             if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
-              _context4.next = 21;
+              _context4.next = 23;
               break;
             }
             startMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
@@ -347,7 +347,7 @@ export var DocumentService = /*#__PURE__*/function () {
             isLastTrConfirmed = false;
           case 8:
             if (isLastTrConfirmed) {
-              _context4.next = 19;
+              _context4.next = 21;
               break;
             }
             _this.sendStepsFromCurrentState();
@@ -364,7 +364,7 @@ export var DocumentService = /*#__PURE__*/function () {
               isLastTrConfirmed = true;
             }
             if (!(!isLastTrConfirmed && count++ >= ACK_MAX_TRY)) {
-              _context4.next = 17;
+              _context4.next = 19;
               break;
             }
             if (_this.onSyncUpError) {
@@ -377,48 +377,54 @@ export var DocumentService = /*#__PURE__*/function () {
                 version: getVersion(state)
               });
             }
+            unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(function (step) {
+              return getStepUGCFreeDetails(step);
+            });
+            (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendErrorEvent({
+              unconfirmedStepsInfo: unconfirmedStepsInfoUGCRemoved
+            }, "Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached");
             throw new Error("Can't sync up with Collab Service");
-          case 17:
+          case 19:
             _context4.next = 8;
             break;
-          case 19:
+          case 21:
             measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
+            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.SUCCESS, {
               latency: measure === null || measure === void 0 ? void 0 : measure.duration,
               // upon success, emit the total number of unconfirmed steps we synced
               numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
             });
-          case 21:
-            _context4.next = 29;
-            break;
           case 23:
-            _context4.prev = 23;
+            _context4.next = 31;
+            break;
+          case 25:
+            _context4.prev = 25;
             _context4.t0 = _context4["catch"](1);
             _measure3 = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
+            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendActionEvent(EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, EVENT_STATUS.FAILURE, {
               latency: _measure3 === null || _measure3 === void 0 ? void 0 : _measure3.duration,
               numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
             });
-            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.sendErrorEvent(_context4.t0, 'Error while committing unconfirmed steps');
+            (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendErrorEvent(_context4.t0, 'Error while committing unconfirmed steps');
             throw _context4.t0;
-          case 29:
+          case 31:
           case "end":
             return _context4.stop();
         }
-      }, _callee4, null, [[1, 23]]);
+      }, _callee4, null, [[1, 25]]);
     })));
     _defineProperty(this, "onStepRejectedError", function () {
-      var _this$analyticsHelper20;
+      var _this$analyticsHelper21;
       _this.stepRejectCounter++;
       logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
-      (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
+      (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.SEND_STEPS_RETRY, EVENT_STATUS.INFO, {
         count: _this.stepRejectCounter
       });
       var maxRetries = _this.aggressiveCatchup ? _this.failedStepsBeforeCatchupOnPublish : MAX_STEP_REJECTED_ERROR;
       if (_this.stepRejectCounter >= maxRetries) {
-        var _this$analyticsHelper21;
+        var _this$analyticsHelper22;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
-        (_this$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
+        (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
         _this.throttledCatchup();
       } else {
         // If committing steps failed try again automatically in 1s
@@ -490,9 +496,9 @@ export var DocumentService = /*#__PURE__*/function () {
             }, 100);
           }
         } catch (error) {
-          var _this$analyticsHelper22;
+          var _this$analyticsHelper23;
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
-          (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendErrorEvent(error, 'Error while processing steps');
+          (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.sendErrorEvent(error, 'Error while processing steps');
           this.throttledCatchup();
         }
       }

package/dist/esm/helpers/utils.js

@@ -20,4 +20,29 @@ export var getProduct = function getProduct(productInfo) {
 export var getSubProduct = function getSubProduct(productInfo) {
   var _productInfo$subProdu;
   return (_productInfo$subProdu = productInfo === null || productInfo === void 0 ? void 0 : productInfo.subProduct) !== null && _productInfo$subProdu !== void 0 ? _productInfo$subProdu : !!(productInfo !== null && productInfo !== void 0 && productInfo.product) ? 'none' : 'unknown';
+};
+// Get as step info which is known not to contain user generated content.
+export var getStepUGCFreeDetails = function getStepUGCFreeDetails(step) {
+  var _stepJson$slice, _stepJson$slice2;
+  var stepJson;
+  try {
+    stepJson = step.toJSON();
+  } catch (e) {
+    return {
+      type: 'unknown',
+      contentTypes: '',
+      stepSizeInBytes: Buffer.byteLength(JSON.stringify(step))
+    };
+  }
+  var contentTypes = '';
+  if ((_stepJson$slice = stepJson.slice) !== null && _stepJson$slice !== void 0 && _stepJson$slice.content && Array.isArray((_stepJson$slice2 = stepJson.slice) === null || _stepJson$slice2 === void 0 ? void 0 : _stepJson$slice2.content)) {
+    contentTypes = stepJson.slice.content.map(function (c) {
+      return (c === null || c === void 0 ? void 0 : c.type) || 'unknown';
+    }).join(', ');
+  }
+  return {
+    type: stepJson.stepType || 'unknown',
+    contentTypes: contentTypes,
+    stepSizeInBytes: Buffer.byteLength(JSON.stringify(step))
+  };
 };

package/dist/esm/version-wrapper.js

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

package/dist/esm/version.json

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

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

@@ -192,7 +192,7 @@ type SendStepsRetryAnalyticsEvent = {
     eventAction: EVENT_ACTION.SEND_STEPS_RETRY;
     attributes: {
         documentAri: string;
-        eventStatus: EVENT_STATUS.SUCCESS;
+        eventStatus: EVENT_STATUS.INFO;
         count: number;
     };
 };
@@ -200,7 +200,7 @@ type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
     eventAction: EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY;
     attributes: {
         documentAri: string;
-        eventStatus: EVENT_STATUS.SUCCESS;
+        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;

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

@@ -1,5 +1,12 @@
 import type { ProductInformation } from '../types';
+import type { Step as ProseMirrorStep } from '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;
 export declare const getSubProduct: (productInfo?: ProductInformation) => string;
+export type UGCFreeStepDetails = {
+    type: string;
+    contentTypes: string;
+    stepSizeInBytes?: number;
+};
+export declare const getStepUGCFreeDetails: (step: ProseMirrorStep) => UGCFreeStepDetails;

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

@@ -192,7 +192,7 @@ type SendStepsRetryAnalyticsEvent = {
     eventAction: EVENT_ACTION.SEND_STEPS_RETRY;
     attributes: {
         documentAri: string;
-        eventStatus: EVENT_STATUS.SUCCESS;
+        eventStatus: EVENT_STATUS.INFO;
         count: number;
     };
 };
@@ -200,7 +200,7 @@ type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
     eventAction: EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY;
     attributes: {
         documentAri: string;
-        eventStatus: EVENT_STATUS.SUCCESS;
+        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;

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

@@ -1,5 +1,12 @@
 import type { ProductInformation } from '../types';
+import type { Step as ProseMirrorStep } from '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;
 export declare const getSubProduct: (productInfo?: ProductInformation) => string;
+export type UGCFreeStepDetails = {
+    type: string;
+    contentTypes: string;
+    stepSizeInBytes?: number;
+};
+export declare const getStepUGCFreeDetails: (step: ProseMirrorStep) => UGCFreeStepDetails;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.2.0",
+  "version": "9.2.2",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -63,7 +63,7 @@
   "devDependencies": {
     "@atlaskit/adf-schema": "^25.8.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-test-helpers": "^18.5.0",
+    "@atlaskit/editor-test-helpers": "^18.6.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/prosemirror-model": "^1.11.0",
     "@types/prosemirror-state": "^1.2.0",