@atlaskit/collab-provider 9.37.0 → 9.37.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/collab-provider
 
+## 9.37.2
+
+### Patch Changes
+
+- [#129573](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/129573)
+  [`9e66ad571558c`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/9e66ad571558c) -
+  To heavily sample the collab-provider.telepointer performance portal SLO
+
+## 9.37.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.37.0
 
 ### Minor Changes

package/dist/cjs/analytics/performance.js

@@ -3,9 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.measureMap = exports.isPerformanceAPIAvailable = exports.MEASURE_NAME = void 0;
+exports.shouldTelepointerBeSampled = exports.measureMap = exports.isPerformanceAPIAvailable = exports.MEASURE_NAME = void 0;
 exports.startMeasure = startMeasure;
 exports.stopMeasure = stopMeasure;
+// Initialize the random sampling rate
+var TELEPOINTER_SAMPLE_RATE = 0.0001;
 var MEASURE_NAME = exports.MEASURE_NAME = /*#__PURE__*/function (MEASURE_NAME) {
   MEASURE_NAME["SOCKET_CONNECT"] = "socketConnect";
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
@@ -79,4 +81,13 @@ function clearMeasure(measureName) {
   performance.clearMarks("".concat(measureName, "::start"));
   performance.clearMarks("".concat(measureName, "::end"));
   performance.clearMeasures(measureName);
-}
+}
+var shouldTelepointerBeSampled = exports.shouldTelepointerBeSampled = function shouldTelepointerBeSampled() {
+  return (
+    // At peak usage, telepointer we had 200M events per day. The goal is to sample 1:10000 of the events. (20k per day)
+    // Math.random() generates a random floating-point number between 0 (inclusive) and 1 (exclusive).
+    // The condition Math.random() < TELEPOINTER_SAMPLE_RATE (0.0001) will be true approximately 0.01% of the time.
+    // This means that approximately 1 in 10,000 events will be sampled.
+    Math.random() < TELEPOINTER_SAMPLE_RATE
+  );
+};

package/dist/cjs/provider/index.js

@@ -31,6 +31,7 @@ var _internalErrors = require("../errors/internal-errors");
 var _const = require("../helpers/const");
 var _featureFlags = require("../feature-flags");
 var _api = require("../api/api");
+var _performance = require("../analytics/performance");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 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); }; }
@@ -434,7 +435,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         if ((data === null || data === void 0 ? void 0 : data.type) === 'telepointer') {
           this.channel.broadcast('participant:telepointer', _objectSpread(_objectSpread({}, basePayload), {}, {
             selection: data.selection
-          }), (0, _telepointersHelper.telepointerCallback)(this.config.documentAri));
+          }), (0, _performance.shouldTelepointerBeSampled)() ? (0, _telepointersHelper.telepointerCallback)(this.config.documentAri) : undefined);
         } else if ((data === null || data === void 0 ? void 0 : data.type) === 'activity:join' || (data === null || data === void 0 ? void 0 : data.type) === 'activity:ack') {
           this.channel.broadcast((data === null || data === void 0 ? void 0 : data.type) === 'activity:join' ? 'participant:activity-join' : 'participant:activity-ack', _objectSpread(_objectSpread({}, basePayload), {}, {
             activity: data.activity

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "9.37.0";
+var version = exports.version = "9.37.2";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/analytics/performance.js

@@ -1,3 +1,5 @@
+// Initialize the random sampling rate
+const TELEPOINTER_SAMPLE_RATE = 0.0001;
 export let MEASURE_NAME = /*#__PURE__*/function (MEASURE_NAME) {
   MEASURE_NAME["SOCKET_CONNECT"] = "socketConnect";
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
@@ -69,4 +71,10 @@ function clearMeasure(measureName) {
   performance.clearMarks(`${measureName}::start`);
   performance.clearMarks(`${measureName}::end`);
   performance.clearMeasures(measureName);
-}
+}
+export const shouldTelepointerBeSampled = () =>
+// At peak usage, telepointer we had 200M events per day. The goal is to sample 1:10000 of the events. (20k per day)
+// Math.random() generates a random floating-point number between 0 (inclusive) and 1 (exclusive).
+// The condition Math.random() < TELEPOINTER_SAMPLE_RATE (0.0001) will be true approximately 0.01% of the time.
+// This means that approximately 1 in 10,000 events will be sampled.
+Math.random() < TELEPOINTER_SAMPLE_RATE;

package/dist/es2019/provider/index.js

@@ -15,6 +15,7 @@ import { INTERNAL_ERROR_CODE } from '../errors/internal-errors';
 import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { getCollabProviderFeatureFlag } from '../feature-flags';
 import { Api } from '../api/api';
+import { shouldTelepointerBeSampled } from '../analytics/performance';
 const logger = createLogger('Provider', 'black');
 const OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
@@ -372,7 +373,7 @@ export class Provider extends Emitter {
         this.channel.broadcast('participant:telepointer', {
           ...basePayload,
           selection: data.selection
-        }, telepointerCallback(this.config.documentAri));
+        }, shouldTelepointerBeSampled() ? telepointerCallback(this.config.documentAri) : undefined);
       } else if ((data === null || data === void 0 ? void 0 : data.type) === 'activity:join' || (data === null || data === void 0 ? void 0 : data.type) === 'activity:ack') {
         this.channel.broadcast((data === null || data === void 0 ? void 0 : data.type) === 'activity:join' ? 'participant:activity-join' : 'participant:activity-ack', {
           ...basePayload,

package/dist/es2019/version-wrapper.js

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

package/dist/esm/analytics/performance.js

@@ -1,3 +1,5 @@
+// Initialize the random sampling rate
+var TELEPOINTER_SAMPLE_RATE = 0.0001;
 export var MEASURE_NAME = /*#__PURE__*/function (MEASURE_NAME) {
   MEASURE_NAME["SOCKET_CONNECT"] = "socketConnect";
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
@@ -71,4 +73,13 @@ function clearMeasure(measureName) {
   performance.clearMarks("".concat(measureName, "::start"));
   performance.clearMarks("".concat(measureName, "::end"));
   performance.clearMeasures(measureName);
-}
+}
+export var shouldTelepointerBeSampled = function shouldTelepointerBeSampled() {
+  return (
+    // At peak usage, telepointer we had 200M events per day. The goal is to sample 1:10000 of the events. (20k per day)
+    // Math.random() generates a random floating-point number between 0 (inclusive) and 1 (exclusive).
+    // The condition Math.random() < TELEPOINTER_SAMPLE_RATE (0.0001) will be true approximately 0.01% of the time.
+    // This means that approximately 1 in 10,000 events will be sampled.
+    Math.random() < TELEPOINTER_SAMPLE_RATE
+  );
+};

package/dist/esm/provider/index.js

@@ -28,6 +28,7 @@ import { INTERNAL_ERROR_CODE } from '../errors/internal-errors';
 import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { getCollabProviderFeatureFlag } from '../feature-flags';
 import { Api } from '../api/api';
+import { shouldTelepointerBeSampled } from '../analytics/performance';
 var logger = createLogger('Provider', 'black');
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
 
@@ -427,7 +428,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         if ((data === null || data === void 0 ? void 0 : data.type) === 'telepointer') {
           this.channel.broadcast('participant:telepointer', _objectSpread(_objectSpread({}, basePayload), {}, {
             selection: data.selection
-          }), telepointerCallback(this.config.documentAri));
+          }), shouldTelepointerBeSampled() ? telepointerCallback(this.config.documentAri) : undefined);
         } else if ((data === null || data === void 0 ? void 0 : data.type) === 'activity:join' || (data === null || data === void 0 ? void 0 : data.type) === 'activity:ack') {
           this.channel.broadcast((data === null || data === void 0 ? void 0 : data.type) === 'activity:join' ? 'participant:activity-join' : 'participant:activity-ack', _objectSpread(_objectSpread({}, basePayload), {}, {
             activity: data.activity

package/dist/esm/version-wrapper.js

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

package/dist/types/analytics/performance.d.ts

@@ -13,3 +13,4 @@ export declare function stopMeasure(measureName: MEASURE_NAME, analyticsHelper:
     duration: number;
     startTime: number;
 } | undefined;
+export declare const shouldTelepointerBeSampled: () => boolean;

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

@@ -13,3 +13,4 @@ export declare function stopMeasure(measureName: MEASURE_NAME, analyticsHelper:
     duration: number;
     startTime: number;
 } | undefined;
+export declare const shouldTelepointerBeSampled: () => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "9.37.0",
+	"version": "9.37.2",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -38,13 +38,13 @@
 	},
 	"dependencies": {
 		"@atlaskit/analytics-gas-types": "^5.1.0",
-		"@atlaskit/analytics-listeners": "^8.10.0",
-		"@atlaskit/editor-common": "^87.6.0",
+		"@atlaskit/analytics-listeners": "^8.11.0",
+		"@atlaskit/editor-common": "^87.10.0",
 		"@atlaskit/editor-json-transformer": "^8.18.0",
 		"@atlaskit/editor-prosemirror": "5.0.1",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
 		"@atlaskit/prosemirror-collab": "^0.9.0",
-		"@atlaskit/ufo": "^0.2.0",
+		"@atlaskit/ufo": "^0.3.0",
 		"@atlaskit/util-service-support": "^6.2.0",
 		"@babel/runtime": "^7.0.0",
 		"eventemitter2": "^4.1.0",