@atlaskit/collab-provider 9.6.0 → 9.6.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.6.2
+
+### Patch Changes
+
+- [`2e7c3cad470`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2e7c3cad470) - Reduce stepsAdded analytics events by only sampling 10%
+
+## 9.6.1
+
+### Patch Changes
+
+- [`979e3ad2b67`](https://bitbucket.org/atlassian/atlassian-frontend/commits/979e3ad2b67) - NO-ISSUE: add data portal links and fix a broken analytics error event
+
 ## 9.6.0
 
 ### Minor Changes

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

@@ -382,7 +382,7 @@ 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$analyticsHelper19, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, _this$analyticsHelper18, state, unconfirmedStepsInfoUGCRemoved, measure, _this$analyticsHelper20, _this$analyticsHelper21, _measure3;
+      var unconfirmedSteps, _this$analyticsHelper18, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, state, unconfirmedStepsInfoUGCRemoved, _error2, measure, _this$analyticsHelper19, _this$analyticsHelper20, _measure3;
       return _regenerator.default.wrap(function _callee4$(_context4) {
         while (1) switch (_context4.prev = _context4.next) {
           case 0:
@@ -435,16 +435,16 @@ var DocumentService = /*#__PURE__*/function () {
             unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(function (step) {
               return (0, _utils.getStepUGCFreeDetails)(step);
             });
-            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.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");
+            _error2 = new _errorTypes.CantSyncUpError("Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached", {
+              unconfirmedStepsInfo: unconfirmedStepsInfoUGCRemoved ? unconfirmedStepsInfoUGCRemoved.toString() : 'Unable to generate UGC removed step info'
+            });
+            throw _error2;
           case 19:
             _context4.next = 8;
             break;
           case 21:
             measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.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
@@ -456,11 +456,11 @@ var DocumentService = /*#__PURE__*/function () {
             _context4.prev = 25;
             _context4.t0 = _context4["catch"](1);
             _measure3 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.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$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.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 31:
           case "end":
@@ -469,17 +469,17 @@ var DocumentService = /*#__PURE__*/function () {
       }, _callee4, null, [[1, 25]]);
     })));
     (0, _defineProperty2.default)(this, "onStepRejectedError", function () {
-      var _this$analyticsHelper22;
+      var _this$analyticsHelper21;
       _this.stepRejectCounter++;
       logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
-      (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.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$analyticsHelper23;
+        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$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.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
@@ -552,9 +552,9 @@ var DocumentService = /*#__PURE__*/function () {
             }, 100);
           }
         } catch (error) {
-          var _this$analyticsHelper24;
+          var _this$analyticsHelper23;
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
-          (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.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/errors/error-types.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.UpdateDocumentError = exports.SetTitleError = exports.SetMetadataError = exports.SetEditorWidthError = exports.SendTransactionError = exports.ProviderInitialisationError = exports.PROVIDER_ERROR_CODE = exports.NotInitializedError = exports.NotConnectedError = exports.NCS_ERROR_CODE = exports.INTERNAL_ERROR_CODE = exports.GetFinalAcknowledgedStateError = exports.GetCurrentStateError = exports.DestroyError = exports.CustomError = void 0;
+exports.UpdateDocumentError = exports.SetTitleError = exports.SetMetadataError = exports.SetEditorWidthError = exports.SendTransactionError = exports.ProviderInitialisationError = exports.PROVIDER_ERROR_CODE = exports.NotInitializedError = exports.NotConnectedError = exports.NCS_ERROR_CODE = exports.INTERNAL_ERROR_CODE = exports.GetFinalAcknowledgedStateError = exports.GetCurrentStateError = exports.DestroyError = exports.CustomError = exports.CantSyncUpError = void 0;
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
@@ -375,4 +375,17 @@ var UpdateDocumentError = /*#__PURE__*/function (_CustomError11) {
   }
   return (0, _createClass2.default)(UpdateDocumentError);
 }(CustomError);
-exports.UpdateDocumentError = UpdateDocumentError;
+exports.UpdateDocumentError = UpdateDocumentError;
+var CantSyncUpError = /*#__PURE__*/function (_CustomError12) {
+  (0, _inherits2.default)(CantSyncUpError, _CustomError12);
+  var _super13 = _createSuper(CantSyncUpError);
+  function CantSyncUpError(message, extraAttributes) {
+    var _this13;
+    (0, _classCallCheck2.default)(this, CantSyncUpError);
+    _this13 = _super13.call(this, message, undefined, extraAttributes);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this13), "name", 'CantSyncUpError');
+    return _this13;
+  }
+  return (0, _createClass2.default)(CantSyncUpError);
+}(CustomError);
+exports.CantSyncUpError = CantSyncUpError;

package/dist/cjs/helpers/const.js

@@ -20,12 +20,13 @@ var EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["CATCHUP_AFTER_MAX_SEND_STEPS_RETRY"] = "catchupAfterMaxSendStepsRetry";
   EVENT_ACTION["DROPPED_STEPS"] = "droppedStepInCatchup";
   return EVENT_ACTION;
-}({});
+}({}); // https://data-portal.internal.atlassian.com/analytics/registry/53724
 exports.EVENT_ACTION = EVENT_ACTION;
 var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";
   EVENT_STATUS["INFO"] = "INFO";
+  EVENT_STATUS["SUCCESS_10x_SAMPLED"] = "SUCCESS_10x_SAMPLED";
   return EVENT_STATUS;
 }({});
 exports.EVENT_STATUS = EVENT_STATUS;

package/dist/cjs/provider/commit-step.js

@@ -48,13 +48,16 @@ var commitStep = function commitStep(_ref) {
           steps: stepsWithClientAndUserId,
           version: response.version
         });
-        analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(_const.EVENT_ACTION.ADD_STEPS, _const.EVENT_STATUS.SUCCESS, {
-          type: _const.ADD_STEPS_TYPE.ACCEPTED,
-          latency: latency,
-          stepType: (0, _countBy.default)(stepsWithClientAndUserId, function (stepWithClientAndUserId) {
-            return stepWithClientAndUserId.stepType;
-          })
-        });
+        // Sample only 10% of add steps events to avoid overwhelming the analytics
+        if (Math.random() < 0.1) {
+          analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(_const.EVENT_ACTION.ADD_STEPS, _const.EVENT_STATUS.SUCCESS_10x_SAMPLED, {
+            type: _const.ADD_STEPS_TYPE.ACCEPTED,
+            latency: latency,
+            stepType: (0, _countBy.default)(stepsWithClientAndUserId, function (stepWithClientAndUserId) {
+              return stepWithClientAndUserId.stepType;
+            })
+          });
+        }
         emit('commit-status', {
           status: 'success',
           version: response.version

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.6.0";
+var version = "9.6.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.6.0",
+	"version": "9.6.2",
 	"sideEffects": false
 }

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

@@ -9,7 +9,7 @@ import { JSONTransformer } from '@atlaskit/editor-json-transformer';
 import { MAX_STEP_REJECTED_ERROR } from '../provider';
 import { catchup } from './catchup';
 import { StepQueueState } from './step-queue-state';
-import { INTERNAL_ERROR_CODE, UpdateDocumentError } from '../errors/error-types';
+import { CantSyncUpError, INTERNAL_ERROR_CODE, UpdateDocumentError } from '../errors/error-types';
 const CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
 const noop = () => {};
@@ -329,7 +329,7 @@ export class DocumentService {
       const unconfirmedSteps = this.getUnconfirmedSteps();
       try {
         if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
-          var _this$analyticsHelper19;
+          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.
@@ -350,7 +350,7 @@ export class DocumentService {
               isLastTrConfirmed = true;
             }
             if (!isLastTrConfirmed && count++ >= ACK_MAX_TRY) {
-              var _this$getUnconfirmedS, _this$analyticsHelper18;
+              var _this$getUnconfirmedS;
               if (this.onSyncUpError) {
                 const state = this.getState();
                 this.onSyncUpError({
@@ -362,42 +362,42 @@ export class DocumentService {
                 });
               }
               const unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(step => getStepUGCFreeDetails(step));
-              (_this$analyticsHelper18 = this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.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 error = new CantSyncUpError("Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached", {
+                unconfirmedStepsInfo: unconfirmedStepsInfoUGCRemoved ? unconfirmedStepsInfoUGCRemoved.toString() : 'Unable to generate UGC removed step info'
+              });
+              throw error;
             }
           }
           const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-          (_this$analyticsHelper19 = this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.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$analyticsHelper20, _this$analyticsHelper21;
+        var _this$analyticsHelper19, _this$analyticsHelper20;
         const measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, this.analyticsHelper);
-        (_this$analyticsHelper20 = this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.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$analyticsHelper21 = this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.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$analyticsHelper22;
+      var _this$analyticsHelper21;
       this.stepRejectCounter++;
       logger(`Steps rejected (tries=${this.stepRejectCounter})`);
-      (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.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$analyticsHelper23;
+        var _this$analyticsHelper22;
         logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
-        (_this$analyticsHelper23 = this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.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
@@ -462,9 +462,9 @@ export class DocumentService {
           setTimeout(() => this.sendStepsFromCurrentState(), 100);
         }
       } catch (error) {
-        var _this$analyticsHelper24;
+        var _this$analyticsHelper23;
         logger(`Processing steps failed with error: ${error}. Triggering catch up call.`);
-        (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.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/errors/error-types.js

@@ -245,4 +245,10 @@ export class UpdateDocumentError extends CustomError {
     super(message, undefined, extraAttributes);
     _defineProperty(this, "name", 'UpdateDocumentError');
   }
+}
+export class CantSyncUpError extends CustomError {
+  constructor(message, extraAttributes) {
+    super(message, undefined, extraAttributes);
+    _defineProperty(this, "name", 'CantSyncUpError');
+  }
 }

package/dist/es2019/helpers/const.js

@@ -14,11 +14,12 @@ export let EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["CATCHUP_AFTER_MAX_SEND_STEPS_RETRY"] = "catchupAfterMaxSendStepsRetry";
   EVENT_ACTION["DROPPED_STEPS"] = "droppedStepInCatchup";
   return EVENT_ACTION;
-}({});
+}({}); // https://data-portal.internal.atlassian.com/analytics/registry/53724
 export let EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";
   EVENT_STATUS["INFO"] = "INFO";
+  EVENT_STATUS["SUCCESS_10x_SAMPLED"] = "SUCCESS_10x_SAMPLED";
   return EVENT_STATUS;
 }({});
 export let ADD_STEPS_TYPE = /*#__PURE__*/function (ADD_STEPS_TYPE) {

package/dist/es2019/provider/commit-step.js

@@ -38,11 +38,14 @@ export const commitStep = ({
           steps: stepsWithClientAndUserId,
           version: response.version
         });
-        analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.SUCCESS, {
-          type: ADD_STEPS_TYPE.ACCEPTED,
-          latency,
-          stepType: countBy(stepsWithClientAndUserId, stepWithClientAndUserId => stepWithClientAndUserId.stepType)
-        });
+        // Sample only 10% of add steps events to avoid overwhelming the analytics
+        if (Math.random() < 0.1) {
+          analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.SUCCESS_10x_SAMPLED, {
+            type: ADD_STEPS_TYPE.ACCEPTED,
+            latency,
+            stepType: countBy(stepsWithClientAndUserId, stepWithClientAndUserId => stepWithClientAndUserId.stepType)
+          });
+        }
         emit('commit-status', {
           status: 'success',
           version: response.version

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.6.0";
+export const version = "9.6.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.6.0",
+	"version": "9.6.2",
 	"sideEffects": false
 }

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

@@ -15,7 +15,7 @@ import { JSONTransformer } from '@atlaskit/editor-json-transformer';
 import { MAX_STEP_REJECTED_ERROR } from '../provider';
 import { catchup } from './catchup';
 import { StepQueueState } from './step-queue-state';
-import { INTERNAL_ERROR_CODE, UpdateDocumentError } from '../errors/error-types';
+import { CantSyncUpError, INTERNAL_ERROR_CODE, UpdateDocumentError } from '../errors/error-types';
 var CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
 var noop = function noop() {};
@@ -375,7 +375,7 @@ 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$analyticsHelper19, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, _this$analyticsHelper18, state, unconfirmedStepsInfoUGCRemoved, measure, _this$analyticsHelper20, _this$analyticsHelper21, _measure3;
+      var unconfirmedSteps, _this$analyticsHelper18, count, unconfirmedTrs, lastTr, isLastTrConfirmed, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, state, unconfirmedStepsInfoUGCRemoved, _error2, measure, _this$analyticsHelper19, _this$analyticsHelper20, _measure3;
       return _regeneratorRuntime.wrap(function _callee4$(_context4) {
         while (1) switch (_context4.prev = _context4.next) {
           case 0:
@@ -428,16 +428,16 @@ export var DocumentService = /*#__PURE__*/function () {
             unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(function (step) {
               return getStepUGCFreeDetails(step);
             });
-            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 ? void 0 : _this$analyticsHelper18.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");
+            _error2 = new CantSyncUpError("Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached", {
+              unconfirmedStepsInfo: unconfirmedStepsInfoUGCRemoved ? unconfirmedStepsInfoUGCRemoved.toString() : 'Unable to generate UGC removed step info'
+            });
+            throw _error2;
           case 19:
             _context4.next = 8;
             break;
           case 21:
             measure = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 ? void 0 : _this$analyticsHelper19.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
@@ -449,11 +449,11 @@ export var DocumentService = /*#__PURE__*/function () {
             _context4.prev = 25;
             _context4.t0 = _context4["catch"](1);
             _measure3 = stopMeasure(MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 ? void 0 : _this$analyticsHelper20.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$analyticsHelper21 = _this.analyticsHelper) === null || _this$analyticsHelper21 === void 0 ? void 0 : _this$analyticsHelper21.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 31:
           case "end":
@@ -462,17 +462,17 @@ export var DocumentService = /*#__PURE__*/function () {
       }, _callee4, null, [[1, 25]]);
     })));
     _defineProperty(this, "onStepRejectedError", function () {
-      var _this$analyticsHelper22;
+      var _this$analyticsHelper21;
       _this.stepRejectCounter++;
       logger("Steps rejected (tries=".concat(_this.stepRejectCounter, ")"));
-      (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.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$analyticsHelper23;
+        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$analyticsHelper23 = _this.analyticsHelper) === null || _this$analyticsHelper23 === void 0 ? void 0 : _this$analyticsHelper23.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
@@ -545,9 +545,9 @@ export var DocumentService = /*#__PURE__*/function () {
             }, 100);
           }
         } catch (error) {
-          var _this$analyticsHelper24;
+          var _this$analyticsHelper23;
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
-          (_this$analyticsHelper24 = this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 ? void 0 : _this$analyticsHelper24.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/errors/error-types.js

@@ -361,4 +361,16 @@ export var UpdateDocumentError = /*#__PURE__*/function (_CustomError11) {
     return _this12;
   }
   return _createClass(UpdateDocumentError);
+}(CustomError);
+export var CantSyncUpError = /*#__PURE__*/function (_CustomError12) {
+  _inherits(CantSyncUpError, _CustomError12);
+  var _super13 = _createSuper(CantSyncUpError);
+  function CantSyncUpError(message, extraAttributes) {
+    var _this13;
+    _classCallCheck(this, CantSyncUpError);
+    _this13 = _super13.call(this, message, undefined, extraAttributes);
+    _defineProperty(_assertThisInitialized(_this13), "name", 'CantSyncUpError');
+    return _this13;
+  }
+  return _createClass(CantSyncUpError);
 }(CustomError);

package/dist/esm/helpers/const.js

@@ -14,11 +14,12 @@ export var EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["CATCHUP_AFTER_MAX_SEND_STEPS_RETRY"] = "catchupAfterMaxSendStepsRetry";
   EVENT_ACTION["DROPPED_STEPS"] = "droppedStepInCatchup";
   return EVENT_ACTION;
-}({});
+}({}); // https://data-portal.internal.atlassian.com/analytics/registry/53724
 export var EVENT_STATUS = /*#__PURE__*/function (EVENT_STATUS) {
   EVENT_STATUS["SUCCESS"] = "SUCCESS";
   EVENT_STATUS["FAILURE"] = "FAILURE";
   EVENT_STATUS["INFO"] = "INFO";
+  EVENT_STATUS["SUCCESS_10x_SAMPLED"] = "SUCCESS_10x_SAMPLED";
   return EVENT_STATUS;
 }({});
 export var ADD_STEPS_TYPE = /*#__PURE__*/function (ADD_STEPS_TYPE) {

package/dist/esm/provider/commit-step.js

@@ -41,13 +41,16 @@ export var commitStep = function commitStep(_ref) {
           steps: stepsWithClientAndUserId,
           version: response.version
         });
-        analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.SUCCESS, {
-          type: ADD_STEPS_TYPE.ACCEPTED,
-          latency: latency,
-          stepType: countBy(stepsWithClientAndUserId, function (stepWithClientAndUserId) {
-            return stepWithClientAndUserId.stepType;
-          })
-        });
+        // Sample only 10% of add steps events to avoid overwhelming the analytics
+        if (Math.random() < 0.1) {
+          analyticsHelper === null || analyticsHelper === void 0 ? void 0 : analyticsHelper.sendActionEvent(EVENT_ACTION.ADD_STEPS, EVENT_STATUS.SUCCESS_10x_SAMPLED, {
+            type: ADD_STEPS_TYPE.ACCEPTED,
+            latency: latency,
+            stepType: countBy(stepsWithClientAndUserId, function (stepWithClientAndUserId) {
+              return stepWithClientAndUserId.stepType;
+            })
+          });
+        }
         emit('commit-status', {
           status: 'success',
           version: response.version

package/dist/esm/version-wrapper.js

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

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

@@ -1,4 +1,4 @@
-import { DocumentUpdateErrorAttributes } from '../helpers/const';
+import { CantSyncUpErrorAttributes, DocumentUpdateErrorAttributes } from '../helpers/const';
 export declare enum INTERNAL_ERROR_CODE {
     TOKEN_PERMISSION_ERROR = "TOKEN_PERMISSION_ERROR",
     RECONNECTION_NETWORK_ISSUE = "RECONNECTION_NETWORK_ISSUE",
@@ -480,4 +480,8 @@ export declare class UpdateDocumentError extends CustomError {
     name: string;
     constructor(message: string, extraAttributes: DocumentUpdateErrorAttributes);
 }
+export declare class CantSyncUpError extends CustomError {
+    name: string;
+    constructor(message: string, extraAttributes: CantSyncUpErrorAttributes);
+}
 export {};

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

@@ -18,7 +18,8 @@ export declare enum EVENT_ACTION {
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
     FAILURE = "FAILURE",
-    INFO = "INFO"
+    INFO = "INFO",
+    SUCCESS_10x_SAMPLED = "SUCCESS_10x_SAMPLED"
 }
 export declare enum ADD_STEPS_TYPE {
     ACCEPTED = "ACCEPTED",
@@ -32,6 +33,9 @@ export type DocumentUpdateErrorAttributes = {
     docHasContent?: boolean;
     isDocContentValid?: boolean;
 };
+export type CantSyncUpErrorAttributes = {
+    unconfirmedStepsInfo: string;
+};
 export type ErrorAnalyticsEvent = {
     eventAction: EVENT_ACTION.ERROR;
     attributes: {

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

@@ -1,4 +1,4 @@
-import { DocumentUpdateErrorAttributes } from '../helpers/const';
+import { CantSyncUpErrorAttributes, DocumentUpdateErrorAttributes } from '../helpers/const';
 export declare enum INTERNAL_ERROR_CODE {
     TOKEN_PERMISSION_ERROR = "TOKEN_PERMISSION_ERROR",
     RECONNECTION_NETWORK_ISSUE = "RECONNECTION_NETWORK_ISSUE",
@@ -480,4 +480,8 @@ export declare class UpdateDocumentError extends CustomError {
     name: string;
     constructor(message: string, extraAttributes: DocumentUpdateErrorAttributes);
 }
+export declare class CantSyncUpError extends CustomError {
+    name: string;
+    constructor(message: string, extraAttributes: CantSyncUpErrorAttributes);
+}
 export {};

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

@@ -18,7 +18,8 @@ export declare enum EVENT_ACTION {
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
     FAILURE = "FAILURE",
-    INFO = "INFO"
+    INFO = "INFO",
+    SUCCESS_10x_SAMPLED = "SUCCESS_10x_SAMPLED"
 }
 export declare enum ADD_STEPS_TYPE {
     ACCEPTED = "ACCEPTED",
@@ -32,6 +33,9 @@ export type DocumentUpdateErrorAttributes = {
     docHasContent?: boolean;
     isDocContentValid?: boolean;
 };
+export type CantSyncUpErrorAttributes = {
+    unconfirmedStepsInfo: string;
+};
 export type ErrorAnalyticsEvent = {
     eventAction: EVENT_ACTION.ERROR;
     attributes: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.6.0",
+  "version": "9.6.2",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -63,7 +63,7 @@
   "devDependencies": {
     "@atlaskit/adf-schema": "^26.1.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-test-helpers": "^18.9.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",