@atlaskit/editor-plugin-analytics 1.8.10 → 1.8.11

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-analytics
 
+## 1.8.11
+
+### Patch Changes
+
+- [#149100](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/149100)
+  [`1ea6c6083e836`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/1ea6c6083e836) -
+  [ED-23460] Queue events fired via `editor-plugin-analytics` actions, add warning to `sharedState`
+  functions to use `actions` instead.
+
 ## 1.8.10
 
 ### Patch Changes

package/dist/cjs/plugin.js

@@ -10,13 +10,13 @@ var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = require("react");
 var _steps = require("@atlaskit/adf-schema/steps");
-var _types = require("@atlaskit/analytics-listeners/types");
 var _useAnalyticsEvents2 = require("@atlaskit/analytics-next/useAnalyticsEvents");
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _isPerformanceApiAvailable = require("@atlaskit/editor-common/is-performance-api-available");
 var _measureRender = require("@atlaskit/editor-common/performance/measure-render");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _attachPayloadIntoTransaction = require("./analytics-api/attach-payload-into-transaction");
+var _consts = require("./consts");
 var _pluginKey = require("./plugin-key");
 var _undoRedoInputSource = require("./undo-redo-input-source");
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
@@ -106,6 +106,7 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
     options = _ref3$config === void 0 ? {} : _ref3$config,
     api = _ref3.api;
   var featureFlags = (api === null || api === void 0 || (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
+  var analyticsEventPropQueue = new Set();
   return {
     name: 'analytics',
     getSharedState: function getSharedState(editorState) {
@@ -128,13 +129,17 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
     },
     actions: {
       attachAnalyticsEvent: function attachAnalyticsEvent(payload) {
-        var channel = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _types.FabricChannel.editor;
+        var channel = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _consts.editorAnalyticsChannel;
         return function (tr) {
           var _api$analytics$shared, _api$analytics;
           var _ref5 = (_api$analytics$shared = api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.sharedState.currentState()) !== null && _api$analytics$shared !== void 0 ? _api$analytics$shared : {},
             createAnalyticsEvent = _ref5.createAnalyticsEvent,
             attachAnalyticsEvent = _ref5.attachAnalyticsEvent;
           if (!tr || !createAnalyticsEvent || !attachAnalyticsEvent) {
+            analyticsEventPropQueue.add({
+              payload: payload,
+              channel: channel
+            });
             return false;
           }
           attachAnalyticsEvent({
@@ -150,6 +155,9 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
         var _ref6 = (_api$analytics$shared2 = api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.sharedState.currentState()) !== null && _api$analytics$shared2 !== void 0 ? _api$analytics$shared2 : {},
           createAnalyticsEvent = _ref6.createAnalyticsEvent;
         if (!createAnalyticsEvent) {
+          analyticsEventPropQueue.add({
+            payload: payload
+          });
           return;
         }
         (0, _analytics.fireAnalyticsEvent)(createAnalyticsEvent)({
@@ -168,6 +176,17 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
           createAnalyticsEvent: createAnalyticsEvent
         });
         dispatch(tr);
+
+        // Attach all analytics events to the transaction
+        analyticsEventPropQueue.forEach(function (_ref8) {
+          var _createAnalyticsEvent;
+          var payload = _ref8.payload,
+            channel = _ref8.channel;
+          (_createAnalyticsEvent = createAnalyticsEvent(payload)) === null || _createAnalyticsEvent === void 0 || _createAnalyticsEvent.fire(channel !== null && channel !== void 0 ? channel : _consts.editorAnalyticsChannel);
+        });
+
+        // Clear the queue
+        analyticsEventPropQueue.clear();
       }, [createAnalyticsEvent, editorView]);
     },
     pmPlugins: function pmPlugins() {
@@ -178,10 +197,10 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
         }
       }];
     },
-    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref8) {
-      var originalTransaction = _ref8.originalTransaction,
-        transactions = _ref8.transactions,
-        newEditorState = _ref8.newEditorState;
+    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref9) {
+      var originalTransaction = _ref9.originalTransaction,
+        transactions = _ref9.transactions,
+        newEditorState = _ref9.newEditorState;
       var pluginState = _pluginKey.analyticsPluginKey.getState(newEditorState);
       if (!pluginState || !pluginState.createAnalyticsEvent) {
         return;
@@ -202,9 +221,9 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
       }
       var createAnalyticsEvent = pluginState.createAnalyticsEvent;
       var undoAnaltyicsEventTransformer = (0, _undoRedoInputSource.generateUndoRedoInputSoucePayload)(originalTransaction);
-      steps.forEach(function (_ref9) {
-        var payload = _ref9.payload,
-          channel = _ref9.channel;
+      steps.forEach(function (_ref10) {
+        var payload = _ref10.payload,
+          channel = _ref10.channel;
         var nextPayload = undoAnaltyicsEventTransformer(payload);
         (0, _analytics.fireAnalyticsEvent)(createAnalyticsEvent)({
           payload: nextPayload,
@@ -214,10 +233,10 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
     }
   };
 };
-function extendPayload(_ref10) {
-  var payload = _ref10.payload,
-    duration = _ref10.duration,
-    distortedDuration = _ref10.distortedDuration;
+function extendPayload(_ref11) {
+  var payload = _ref11.payload,
+    duration = _ref11.duration,
+    distortedDuration = _ref11.distortedDuration;
   return _objectSpread(_objectSpread({}, payload), {}, {
     attributes: _objectSpread(_objectSpread({}, payload.attributes), {}, {
       duration: duration,

package/dist/es2019/plugin.js

@@ -1,12 +1,12 @@
 import { useLayoutEffect } from 'react';
 import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
-import { FabricChannel } from '@atlaskit/analytics-listeners/types';
 import { useAnalyticsEvents } from '@atlaskit/analytics-next/useAnalyticsEvents';
 import { ACTION, EVENT_TYPE, fireAnalyticsEvent, getAnalyticsEventsFromTransaction } from '@atlaskit/editor-common/analytics';
 import { isPerformanceAPIAvailable } from '@atlaskit/editor-common/is-performance-api-available';
 import { measureRender } from '@atlaskit/editor-common/performance/measure-render';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { createAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
+import { editorAnalyticsChannel } from './consts';
 import { analyticsPluginKey } from './plugin-key';
 import { generateUndoRedoInputSoucePayload } from './undo-redo-input-source';
 function createPlugin(options, featureFlags) {
@@ -84,6 +84,7 @@ const analyticsPlugin = ({
 }) => {
   var _api$featureFlags;
   const featureFlags = (api === null || api === void 0 ? void 0 : (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
+  const analyticsEventPropQueue = new Set();
   return {
     name: 'analytics',
     getSharedState: editorState => {
@@ -106,13 +107,17 @@ const analyticsPlugin = ({
       };
     },
     actions: {
-      attachAnalyticsEvent: (payload, channel = FabricChannel.editor) => tr => {
+      attachAnalyticsEvent: (payload, channel = editorAnalyticsChannel) => tr => {
         var _api$analytics$shared, _api$analytics;
         const {
           createAnalyticsEvent,
           attachAnalyticsEvent
         } = (_api$analytics$shared = api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.sharedState.currentState()) !== null && _api$analytics$shared !== void 0 ? _api$analytics$shared : {};
         if (!tr || !createAnalyticsEvent || !attachAnalyticsEvent) {
+          analyticsEventPropQueue.add({
+            payload,
+            channel: channel
+          });
           return false;
         }
         attachAnalyticsEvent({
@@ -128,6 +133,9 @@ const analyticsPlugin = ({
           createAnalyticsEvent
         } = (_api$analytics$shared2 = api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.sharedState.currentState()) !== null && _api$analytics$shared2 !== void 0 ? _api$analytics$shared2 : {};
         if (!createAnalyticsEvent) {
+          analyticsEventPropQueue.add({
+            payload
+          });
           return;
         }
         fireAnalyticsEvent(createAnalyticsEvent)({
@@ -152,6 +160,18 @@ const analyticsPlugin = ({
           createAnalyticsEvent
         });
         dispatch(tr);
+
+        // Attach all analytics events to the transaction
+        analyticsEventPropQueue.forEach(({
+          payload,
+          channel
+        }) => {
+          var _createAnalyticsEvent;
+          (_createAnalyticsEvent = createAnalyticsEvent(payload)) === null || _createAnalyticsEvent === void 0 ? void 0 : _createAnalyticsEvent.fire(channel !== null && channel !== void 0 ? channel : editorAnalyticsChannel);
+        });
+
+        // Clear the queue
+        analyticsEventPropQueue.clear();
       }, [createAnalyticsEvent, editorView]);
     },
     pmPlugins() {

package/dist/esm/plugin.js

@@ -7,13 +7,13 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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) { _defineProperty(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; }
 import { useLayoutEffect } from 'react';
 import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
-import { FabricChannel } from '@atlaskit/analytics-listeners/types';
 import { useAnalyticsEvents } from '@atlaskit/analytics-next/useAnalyticsEvents';
 import { ACTION, EVENT_TYPE, fireAnalyticsEvent as _fireAnalyticsEvent, getAnalyticsEventsFromTransaction } from '@atlaskit/editor-common/analytics';
 import { isPerformanceAPIAvailable } from '@atlaskit/editor-common/is-performance-api-available';
 import { measureRender } from '@atlaskit/editor-common/performance/measure-render';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { createAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
+import { editorAnalyticsChannel } from './consts';
 import { analyticsPluginKey } from './plugin-key';
 import { generateUndoRedoInputSoucePayload } from './undo-redo-input-source';
 function createPlugin(options, featureFlags) {
@@ -98,6 +98,7 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
     options = _ref3$config === void 0 ? {} : _ref3$config,
     api = _ref3.api;
   var featureFlags = (api === null || api === void 0 || (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
+  var analyticsEventPropQueue = new Set();
   return {
     name: 'analytics',
     getSharedState: function getSharedState(editorState) {
@@ -120,13 +121,17 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
     },
     actions: {
       attachAnalyticsEvent: function attachAnalyticsEvent(payload) {
-        var channel = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : FabricChannel.editor;
+        var channel = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : editorAnalyticsChannel;
         return function (tr) {
           var _api$analytics$shared, _api$analytics;
           var _ref5 = (_api$analytics$shared = api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.sharedState.currentState()) !== null && _api$analytics$shared !== void 0 ? _api$analytics$shared : {},
             createAnalyticsEvent = _ref5.createAnalyticsEvent,
             attachAnalyticsEvent = _ref5.attachAnalyticsEvent;
           if (!tr || !createAnalyticsEvent || !attachAnalyticsEvent) {
+            analyticsEventPropQueue.add({
+              payload: payload,
+              channel: channel
+            });
             return false;
           }
           attachAnalyticsEvent({
@@ -142,6 +147,9 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
         var _ref6 = (_api$analytics$shared2 = api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.sharedState.currentState()) !== null && _api$analytics$shared2 !== void 0 ? _api$analytics$shared2 : {},
           createAnalyticsEvent = _ref6.createAnalyticsEvent;
         if (!createAnalyticsEvent) {
+          analyticsEventPropQueue.add({
+            payload: payload
+          });
           return;
         }
         _fireAnalyticsEvent(createAnalyticsEvent)({
@@ -160,6 +168,17 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
           createAnalyticsEvent: createAnalyticsEvent
         });
         dispatch(tr);
+
+        // Attach all analytics events to the transaction
+        analyticsEventPropQueue.forEach(function (_ref8) {
+          var _createAnalyticsEvent;
+          var payload = _ref8.payload,
+            channel = _ref8.channel;
+          (_createAnalyticsEvent = createAnalyticsEvent(payload)) === null || _createAnalyticsEvent === void 0 || _createAnalyticsEvent.fire(channel !== null && channel !== void 0 ? channel : editorAnalyticsChannel);
+        });
+
+        // Clear the queue
+        analyticsEventPropQueue.clear();
       }, [createAnalyticsEvent, editorView]);
     },
     pmPlugins: function pmPlugins() {
@@ -170,10 +189,10 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
         }
       }];
     },
-    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref8) {
-      var originalTransaction = _ref8.originalTransaction,
-        transactions = _ref8.transactions,
-        newEditorState = _ref8.newEditorState;
+    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref9) {
+      var originalTransaction = _ref9.originalTransaction,
+        transactions = _ref9.transactions,
+        newEditorState = _ref9.newEditorState;
       var pluginState = analyticsPluginKey.getState(newEditorState);
       if (!pluginState || !pluginState.createAnalyticsEvent) {
         return;
@@ -194,9 +213,9 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
       }
       var createAnalyticsEvent = pluginState.createAnalyticsEvent;
       var undoAnaltyicsEventTransformer = generateUndoRedoInputSoucePayload(originalTransaction);
-      steps.forEach(function (_ref9) {
-        var payload = _ref9.payload,
-          channel = _ref9.channel;
+      steps.forEach(function (_ref10) {
+        var payload = _ref10.payload,
+          channel = _ref10.channel;
         var nextPayload = undoAnaltyicsEventTransformer(payload);
         _fireAnalyticsEvent(createAnalyticsEvent)({
           payload: nextPayload,
@@ -206,10 +225,10 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
     }
   };
 };
-export function extendPayload(_ref10) {
-  var payload = _ref10.payload,
-    duration = _ref10.duration,
-    distortedDuration = _ref10.distortedDuration;
+export function extendPayload(_ref11) {
+  var payload = _ref11.payload,
+    duration = _ref11.duration,
+    distortedDuration = _ref11.distortedDuration;
   return _objectSpread(_objectSpread({}, payload), {}, {
     attributes: _objectSpread(_objectSpread({}, payload.attributes), {}, {
       duration: duration,

package/dist/types/plugin.d.ts

@@ -10,7 +10,15 @@ export interface AnalyticsPluginOptions {
 export type AnalyticsPlugin = NextEditorPlugin<'analytics', {
     pluginConfiguration: AnalyticsPluginOptions;
     sharedState: {
+        /**
+         * **Warning:** Do not use this directly. Use the `analyticsPlugin.actions`
+         * instead, as it will properly queue all events.
+         */
         createAnalyticsEvent: CreateUIAnalyticsEvent | null;
+        /**
+         * **Warning:** Do not use this directly. Use the `analyticsPlugin.actions`
+         * instead, as it will properly queue all events.
+         */
         attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
         performanceTracking: PerformanceTracking | undefined;
     };

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

@@ -10,7 +10,15 @@ export interface AnalyticsPluginOptions {
 export type AnalyticsPlugin = NextEditorPlugin<'analytics', {
     pluginConfiguration: AnalyticsPluginOptions;
     sharedState: {
+        /**
+         * **Warning:** Do not use this directly. Use the `analyticsPlugin.actions`
+         * instead, as it will properly queue all events.
+         */
         createAnalyticsEvent: CreateUIAnalyticsEvent | null;
+        /**
+         * **Warning:** Do not use this directly. Use the `analyticsPlugin.actions`
+         * instead, as it will properly queue all events.
+         */
         attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
         performanceTracking: PerformanceTracking | undefined;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-analytics",
-	"version": "1.8.10",
+	"version": "1.8.11",
 	"description": "Analytics plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -34,7 +34,7 @@
 		"@atlaskit/adf-schema": "^40.9.0",
 		"@atlaskit/analytics-listeners": "^8.11.0",
 		"@atlaskit/analytics-next": "^10.1.0",
-		"@atlaskit/editor-common": "^93.0.0",
+		"@atlaskit/editor-common": "^93.2.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.2.0",
 		"@atlaskit/editor-prosemirror": "6.0.0",
 		"@atlaskit/editor-tables": "^2.8.0",