@atlaskit/reactions 21.3.4 → 21.4.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/reactions
 
+## 21.4.0
+
+### Minor Changes
+
+- [`34155ee7563`](https://bitbucket.org/atlassian/atlassian-frontend/commits/34155ee7563) - add sampling for 2 ufo experiences to reduce volume of analytics
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 21.3.4
 
 ### Patch Changes

package/dist/cjs/analytics/constants.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SAMPLING_RATE_REACTIONS_RENDERED_EXP = void 0;
+// This rate is used in fetching emoji resource
+var SAMPLING_RATE_REACTIONS_RENDERED_EXP = 0.02;
+exports.SAMPLING_RATE_REACTIONS_RENDERED_EXP = SAMPLING_RATE_REACTIONS_RENDERED_EXP;

package/dist/cjs/analytics/ufo.js

@@ -3,10 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ReactionsRendered = exports.ReactionsRemove = exports.ReactionsAdd = exports.ReactionDetailsFetch = exports.PickerRender = exports.ExperienceName = exports.ComponentName = void 0;
+exports.sampledReactionsRendered = exports.ReactionsRendered = exports.ReactionsRemove = exports.ReactionsAdd = exports.ReactionDetailsFetch = exports.PickerRender = exports.ExperienceName = exports.ComponentName = void 0;
 
 var _ufo = require("@atlaskit/ufo");
 
+var _emoji = require("@atlaskit/emoji");
+
 /**
  * Helper method for create the config type for an individual/Concurrent experience
  * @param componentName
@@ -78,4 +80,10 @@ var ReactionDetailsFetch = new _ufo.ConcurrentExperience(ExperienceName.REACTION
 
 exports.ReactionDetailsFetch = ReactionDetailsFetch;
 var ReactionsRemove = new _ufo.ConcurrentExperience(ExperienceName.REACTION_REMOVED, createExperienceConfig(ComponentName.REACTIONS, _ufo.ExperienceTypes.Experience, _ufo.ExperiencePerformanceTypes.InlineResult));
-exports.ReactionsRemove = ReactionsRemove;
+exports.ReactionsRemove = ReactionsRemove;
+
+var sampledReactionsRendered = function sampledReactionsRendered(instanceId) {
+  return (0, _emoji.withSampling)(ReactionsRendered.getInstance(instanceId));
+};
+
+exports.sampledReactionsRendered = sampledReactionsRendered;

package/dist/cjs/components/Counter.js

@@ -26,6 +26,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 /** @jsx jsx */
+// eslint-disable-next-line @atlaskit/design-system/no-banned-imports
 var counterTestId = 'counter-container';
 exports.counterTestId = counterTestId;
 var countStyle = (0, _core.css)({

package/dist/cjs/containers/ConnectedReactionsView.js

@@ -37,7 +37,7 @@ var ReactionsView = function ReactionsView(props) {
       store = props.store,
       containerAri = props.containerAri;
   (0, _react.useEffect)(function () {
-    experienceInstance.current = _ReactionsStore.ufoExperiences.render.getInstance(ari);
+    experienceInstance.current = _ReactionsStore.ufoExperiences.render(ari);
   }, [ari]);
   (0, _react.useEffect)(function () {
     Promise.resolve(store).then(function (_store) {

package/dist/cjs/store/ReactionsStore.js

@@ -23,6 +23,10 @@ var _batched = require("./batched");
 
 var utils = _interopRequireWildcard(require("./utils"));
 
+var _constants = require("../analytics/constants");
+
+var _ufo = require("../analytics/ufo");
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -46,9 +50,11 @@ var ufoExperiences = {
   remove: Analytics.UFO.ReactionsRemove,
 
   /**
-   * Experience when the list of reactions gets rendered
+   * Experience when the list of reactions gets rendered with sampling
    */
-  render: Analytics.UFO.ReactionsRendered,
+  render: function render(instanceId) {
+    return (0, _ufo.sampledReactionsRendered)(instanceId);
+  },
 
   /**
    * Experience when a reaction details gets fetched
@@ -220,10 +226,12 @@ var MemoryReactionsStore = /*#__PURE__*/function () {
        * TODO:
        * All reactions are usually fetched in a single call to reactions-service. Need to check why "getReactions" gets called randomly 1-2 times everytime on each fetch request despite using same containerAri.
        */
-      var exp = ufoExperiences.render.getInstance(containerAri);
+      var sampledExp = ufoExperiences.render(containerAri);
       var arisArr = aris.reduce(utils.flattenAris); // ufo start reaction experience
 
-      exp.start();
+      sampledExp.start({
+        samplingRate: _constants.SAMPLING_RATE_REACTIONS_RENDERED_EXP
+      });
 
       _this.client.getReactions(containerAri, arisArr).then(function (value) {
         Object.keys(value).map(function (ari) {
@@ -238,14 +246,14 @@ var MemoryReactionsStore = /*#__PURE__*/function () {
           Analytics.createAndFireSafe(_this.createAnalyticsEvent, Analytics.createRestSucceededEvent, 'getReactions');
         }
 
-        exp.success();
+        sampledExp.success();
       }).catch(function (error) {
         if ((0, utils.isRealErrorFromService)(error.code)) {
           if (_this.createAnalyticsEvent) {
             Analytics.createAndFireSafe(_this.createAnalyticsEvent, Analytics.createRestFailedEvent, 'getReactions', error.code);
           }
 
-          exp.failure({
+          sampledExp.failure({
             metadata: {
               error: error,
               source: 'Reaction-Store',

package/dist/cjs/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/reactions",
-	"version": "21.3.4"
+	"version": "21.4.0"
 }

package/dist/es2019/analytics/constants.js

@@ -0,0 +1,2 @@
+// This rate is used in fetching emoji resource
+export const SAMPLING_RATE_REACTIONS_RENDERED_EXP = 0.02;

package/dist/es2019/analytics/ufo.js

@@ -1,4 +1,5 @@
 import { ConcurrentExperience, UFOExperience, ExperiencePerformanceTypes, ExperienceTypes } from '@atlaskit/ufo';
+import { withSampling } from '@atlaskit/emoji';
 /**
  * Initial experience config object (deferred from @atlaskit/ufo inner types)
  * TODO: Check if possible to add this to exported types from @atlaskit/ufo
@@ -66,4 +67,5 @@ export const ReactionDetailsFetch = new ConcurrentExperience(ExperienceName.REAC
  * Experience when a reaction emoji gets removed/decrement
  */
 
-export const ReactionsRemove = new ConcurrentExperience(ExperienceName.REACTION_REMOVED, createExperienceConfig(ComponentName.REACTIONS, ExperienceTypes.Experience, ExperiencePerformanceTypes.InlineResult));
+export const ReactionsRemove = new ConcurrentExperience(ExperienceName.REACTION_REMOVED, createExperienceConfig(ComponentName.REACTIONS, ExperienceTypes.Experience, ExperiencePerformanceTypes.InlineResult));
+export const sampledReactionsRendered = instanceId => withSampling(ReactionsRendered.getInstance(instanceId));

package/dist/es2019/components/Counter.js

@@ -3,7 +3,8 @@ import { jsx, css } from '@emotion/core';
 import { N500, B400 } from '@atlaskit/theme/colors';
 import { token } from '@atlaskit/tokens';
 import React, { memo } from 'react';
-import { SlideIn, ExitingPersistence, mediumDurationMs } from '@atlaskit/motion';
+import { SlideIn, ExitingPersistence, mediumDurationMs } from '@atlaskit/motion'; // eslint-disable-next-line @atlaskit/design-system/no-banned-imports
+
 import usePreviousValue from '@atlaskit/ds-lib/use-previous-value';
 export const counterTestId = 'counter-container';
 export const countStyle = css({

package/dist/es2019/containers/ConnectedReactionsView.js

@@ -17,7 +17,7 @@ const ReactionsView = props => {
     containerAri
   } = props;
   useEffect(() => {
-    experienceInstance.current = ufoExperiences.render.getInstance(ari);
+    experienceInstance.current = ufoExperiences.render(ari);
   }, [ari]);
   useEffect(() => {
     Promise.resolve(store).then(_store => {

package/dist/es2019/store/ReactionsStore.js

@@ -4,6 +4,8 @@ import * as Types from '../types';
 import { batch, batchByKey } from './batched';
 import * as utils from './utils';
 import { isRealErrorFromService } from './utils';
+import { SAMPLING_RATE_REACTIONS_RENDERED_EXP } from '../analytics/constants';
+import { sampledReactionsRendered } from '../analytics/ufo';
 
 /**
  * Set of all available UFO experiences relating to reaction element
@@ -20,9 +22,9 @@ export const ufoExperiences = {
   remove: Analytics.UFO.ReactionsRemove,
 
   /**
-   * Experience when the list of reactions gets rendered
+   * Experience when the list of reactions gets rendered with sampling
    */
-  render: Analytics.UFO.ReactionsRendered,
+  render: instanceId => sampledReactionsRendered(instanceId),
 
   /**
    * Experience when a reaction details gets fetched
@@ -188,10 +190,12 @@ export class MemoryReactionsStore {
        * TODO:
        * All reactions are usually fetched in a single call to reactions-service. Need to check why "getReactions" gets called randomly 1-2 times everytime on each fetch request despite using same containerAri.
        */
-      const exp = ufoExperiences.render.getInstance(containerAri);
+      const sampledExp = ufoExperiences.render(containerAri);
       const arisArr = aris.reduce(utils.flattenAris); // ufo start reaction experience
 
-      exp.start();
+      sampledExp.start({
+        samplingRate: SAMPLING_RATE_REACTIONS_RENDERED_EXP
+      });
       this.client.getReactions(containerAri, arisArr).then(value => {
         Object.keys(value).map(ari => {
           const reactionsState = this.getReactionsState(containerAri, ari);
@@ -203,14 +207,14 @@ export class MemoryReactionsStore {
           Analytics.createAndFireSafe(this.createAnalyticsEvent, Analytics.createRestSucceededEvent, 'getReactions');
         }
 
-        exp.success();
+        sampledExp.success();
       }).catch(error => {
         if (isRealErrorFromService(error.code)) {
           if (this.createAnalyticsEvent) {
             Analytics.createAndFireSafe(this.createAnalyticsEvent, Analytics.createRestFailedEvent, 'getReactions', error.code);
           }
 
-          exp.failure({
+          sampledExp.failure({
             metadata: {
               error,
               source: 'Reaction-Store',

package/dist/es2019/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/reactions",
-	"version": "21.3.4"
+	"version": "21.4.0"
 }

package/dist/esm/analytics/constants.js

@@ -0,0 +1,2 @@
+// This rate is used in fetching emoji resource
+export var SAMPLING_RATE_REACTIONS_RENDERED_EXP = 0.02;

package/dist/esm/analytics/ufo.js

@@ -1,4 +1,5 @@
 import { ConcurrentExperience, UFOExperience, ExperiencePerformanceTypes, ExperienceTypes } from '@atlaskit/ufo';
+import { withSampling } from '@atlaskit/emoji';
 /**
  * Initial experience config object (deferred from @atlaskit/ufo inner types)
  * TODO: Check if possible to add this to exported types from @atlaskit/ufo
@@ -66,4 +67,7 @@ export var ReactionDetailsFetch = new ConcurrentExperience(ExperienceName.REACTI
  * Experience when a reaction emoji gets removed/decrement
  */
 
-export var ReactionsRemove = new ConcurrentExperience(ExperienceName.REACTION_REMOVED, createExperienceConfig(ComponentName.REACTIONS, ExperienceTypes.Experience, ExperiencePerformanceTypes.InlineResult));
+export var ReactionsRemove = new ConcurrentExperience(ExperienceName.REACTION_REMOVED, createExperienceConfig(ComponentName.REACTIONS, ExperienceTypes.Experience, ExperiencePerformanceTypes.InlineResult));
+export var sampledReactionsRendered = function sampledReactionsRendered(instanceId) {
+  return withSampling(ReactionsRendered.getInstance(instanceId));
+};

package/dist/esm/components/Counter.js

@@ -3,7 +3,8 @@ import { jsx, css } from '@emotion/core';
 import { N500, B400 } from '@atlaskit/theme/colors';
 import { token } from '@atlaskit/tokens';
 import React, { memo } from 'react';
-import { SlideIn, ExitingPersistence, mediumDurationMs } from '@atlaskit/motion';
+import { SlideIn, ExitingPersistence, mediumDurationMs } from '@atlaskit/motion'; // eslint-disable-next-line @atlaskit/design-system/no-banned-imports
+
 import usePreviousValue from '@atlaskit/ds-lib/use-previous-value';
 export var counterTestId = 'counter-container';
 export var countStyle = css({

package/dist/esm/containers/ConnectedReactionsView.js

@@ -15,7 +15,7 @@ var ReactionsView = function ReactionsView(props) {
       store = props.store,
       containerAri = props.containerAri;
   useEffect(function () {
-    experienceInstance.current = ufoExperiences.render.getInstance(ari);
+    experienceInstance.current = ufoExperiences.render(ari);
   }, [ari]);
   useEffect(function () {
     Promise.resolve(store).then(function (_store) {

package/dist/esm/store/ReactionsStore.js

@@ -11,6 +11,8 @@ import * as Types from '../types';
 import { batch, batchByKey } from './batched';
 import * as utils from './utils';
 import { isRealErrorFromService } from './utils';
+import { SAMPLING_RATE_REACTIONS_RENDERED_EXP } from '../analytics/constants';
+import { sampledReactionsRendered } from '../analytics/ufo';
 
 /**
  * Set of all available UFO experiences relating to reaction element
@@ -27,9 +29,11 @@ export var ufoExperiences = {
   remove: Analytics.UFO.ReactionsRemove,
 
   /**
-   * Experience when the list of reactions gets rendered
+   * Experience when the list of reactions gets rendered with sampling
    */
-  render: Analytics.UFO.ReactionsRendered,
+  render: function render(instanceId) {
+    return sampledReactionsRendered(instanceId);
+  },
 
   /**
    * Experience when a reaction details gets fetched
@@ -211,10 +215,12 @@ export var MemoryReactionsStore = /*#__PURE__*/function () {
        * TODO:
        * All reactions are usually fetched in a single call to reactions-service. Need to check why "getReactions" gets called randomly 1-2 times everytime on each fetch request despite using same containerAri.
        */
-      var exp = ufoExperiences.render.getInstance(containerAri);
+      var sampledExp = ufoExperiences.render(containerAri);
       var arisArr = aris.reduce(utils.flattenAris); // ufo start reaction experience
 
-      exp.start();
+      sampledExp.start({
+        samplingRate: SAMPLING_RATE_REACTIONS_RENDERED_EXP
+      });
 
       _this.client.getReactions(containerAri, arisArr).then(function (value) {
         Object.keys(value).map(function (ari) {
@@ -229,14 +235,14 @@ export var MemoryReactionsStore = /*#__PURE__*/function () {
           Analytics.createAndFireSafe(_this.createAnalyticsEvent, Analytics.createRestSucceededEvent, 'getReactions');
         }
 
-        exp.success();
+        sampledExp.success();
       }).catch(function (error) {
         if (isRealErrorFromService(error.code)) {
           if (_this.createAnalyticsEvent) {
             Analytics.createAndFireSafe(_this.createAnalyticsEvent, Analytics.createRestFailedEvent, 'getReactions', error.code);
           }
 
-          exp.failure({
+          sampledExp.failure({
             metadata: {
               error: error,
               source: 'Reaction-Store',

package/dist/esm/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/reactions",
-	"version": "21.3.4"
+	"version": "21.4.0"
 }

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

@@ -0,0 +1 @@
+export declare const SAMPLING_RATE_REACTIONS_RENDERED_EXP = 0.02;

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

@@ -37,3 +37,4 @@ export declare const ReactionDetailsFetch: ConcurrentExperience;
  * Experience when a reaction emoji gets removed/decrement
  */
 export declare const ReactionsRemove: ConcurrentExperience;
+export declare const sampledReactionsRendered: (instanceId: string) => import("@atlaskit/emoji").WithSamplingUFOExperience;

package/dist/types/components/UfoErrorBoundary.d.ts

@@ -1,7 +1,8 @@
 import React, { ErrorInfo } from 'react';
 import { UFOExperience } from '@atlaskit/ufo';
+import { WithSamplingUFOExperience } from '@atlaskit/emoji';
 export declare class UfoErrorBoundary extends React.Component<{
-    experiences: UFOExperience[];
+    experiences: UFOExperience[] | WithSamplingUFOExperience[];
 }> {
     componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
     render(): React.ReactNode;

package/dist/types/store/ReactionsStore.d.ts

@@ -29,9 +29,9 @@ export declare const ufoExperiences: {
      */
     remove: import("@atlaskit/ufo").ConcurrentExperience;
     /**
-     * Experience when the list of reactions gets rendered
+     * Experience when the list of reactions gets rendered with sampling
      */
-    render: import("@atlaskit/ufo").ConcurrentExperience;
+    render: (instanceId: string) => import("@atlaskit/emoji").WithSamplingUFOExperience;
     /**
      * Experience when a reaction details gets fetched
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/reactions",
-  "version": "21.3.4",
+  "version": "21.4.0",
   "description": "Reactions component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -26,13 +26,13 @@
   },
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.0.0",
-    "@atlaskit/analytics-namespaced-context": "^6.4.0",
+    "@atlaskit/analytics-namespaced-context": "^6.5.0",
     "@atlaskit/analytics-next": "^8.2.0",
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/ds-lib": "^2.0.0",
-    "@atlaskit/emoji": "^64.7.0",
+    "@atlaskit/emoji": "^65.0.0",
     "@atlaskit/icon": "^21.10.0",
-    "@atlaskit/motion": "^1.1.0",
+    "@atlaskit/motion": "^1.2.0",
     "@atlaskit/popper": "^5.0.0",
     "@atlaskit/theme": "^12.1.0",
     "@atlaskit/tokens": "^0.10.0",
@@ -50,10 +50,10 @@
   "devDependencies": {
     "@atlaskit/analytics-viewer": "^0.4.5",
     "@atlaskit/docs": "^9.0.0",
-    "@atlaskit/editor-test-helpers": "^17.0.0",
+    "@atlaskit/editor-test-helpers": "^17.1.0",
     "@atlaskit/elements-test-helpers": "^0.7.0",
     "@atlaskit/tooltip": "^17.5.0",
-    "@atlaskit/util-data-test": "^17.3.0",
+    "@atlaskit/util-data-test": "^17.4.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@atlassian/ufo": "^0.1.0",
     "@types/webpack-dev-server": "^3.11.2",