@atlaskit/editor-plugin-metrics 1.1.0 → 2.0.0

package/.eslintrc.js

@@ -1,14 +1,14 @@
 module.exports = {
 	rules: {
-	  '@typescript-eslint/no-duplicate-imports': 'error',
-	  '@typescript-eslint/no-explicit-any': 'error',
+		'@typescript-eslint/no-duplicate-imports': 'error',
+		'@typescript-eslint/no-explicit-any': 'error',
 	},
 	overrides: [
-	  {
-		files: ['**/__tests__/**/*.{js,ts,tsx}', '**/examples/**/*.{js,ts,tsx}'],
-		rules: {
-		  '@typescript-eslint/no-explicit-any': 'off',
+		{
+			files: ['**/__tests__/**/*.{js,ts,tsx}', '**/examples/**/*.{js,ts,tsx}'],
+			rules: {
+				'@typescript-eslint/no-explicit-any': 'off',
+			},
 		},
-	  },
 	],
-  };
+};

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-metrics
 
+## 2.0.0
+
+### Major Changes
+
+- [#105399](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/105399)
+  [`ed98e34b5912b`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ed98e34b5912b) -
+  ED-26234 Fire analytics at end of editor session
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 1.1.0
 
 ### Minor Changes

package/dist/cjs/metricsPlugin.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.metricsPlugin = void 0;
 var _main = require("./pm-plugins/main");
+var _analytics = require("./pm-plugins/utils/analytics");
 /**
  * Metrics plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
@@ -29,43 +30,18 @@ var metricsPlugin = exports.metricsPlugin = function metricsPlugin(_ref) {
             return tr;
           }
           var newTr = tr;
+          var pluginState = api === null || api === void 0 ? void 0 : api.metrics.sharedState.currentState();
+          if (pluginState && pluginState.totalActionCount > 0 && pluginState.activeSessionTime > 0) {
+            var payloadToSend = (0, _analytics.getAnalyticsPayload)({
+              pluginState: pluginState
+            });
+            api === null || api === void 0 || api.analytics.actions.attachAnalyticsEvent(payloadToSend)(newTr);
+          }
           newTr.setMeta(_main.metricsKey, {
             stopActiveSession: true
           });
           return newTr;
         };
-      },
-      fireSessionAnalytics: function fireSessionAnalytics() {
-        return function (_ref3) {
-          var tr = _ref3.tr;
-          if (!api) {
-            return tr;
-          }
-          var state = api.metrics.sharedState.currentState();
-          if (!state) {
-            return tr;
-          }
-
-          // const eventAttributes = {
-          // 	efficiency: {
-          // 		totalActiveTime: state.activeSessionTime || 0,
-          // 		totalActionCount: state.totalActionCount || 0,
-          // 		actionTypeCount: state.actionTypeCount,
-          // 		totalInactiveTime:
-          // 			Date.now() - (state.editSessionStartTime || 0) - (state.activeSessionTime || 0),
-          // 	},
-          // TODO: Add effectiveness attributes
-          // effectiveness: {
-          // 	undoCount: 0,
-          // 	repeatedActionCount: 0,
-          // 	safeInsertCount: 0,
-          // },
-          // };
-
-          // fire analytics event
-          // api.analytics.actions.attachAnalyticsEvent({});
-          return tr;
-        };
       }
     },
     getSharedState: function getSharedState(editorState) {

package/dist/cjs/pm-plugins/main.js

@@ -6,27 +6,31 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.metricsKey = exports.initialPluginState = exports.createPlugin = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _bindEventListener = require("bind-event-listener");
 var _steps = require("@atlaskit/adf-schema/steps");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _utils = require("@atlaskit/editor-common/utils");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _activeSessionTimer = require("./utils/active-session-timer");
+var _analytics = require("./utils/analytics");
+var _isNonTextUndo = require("./utils/isNonTextUndo");
 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; }
 var metricsKey = exports.metricsKey = new _state.PluginKey('metricsPlugin');
 var initialPluginState = exports.initialPluginState = {
-  editSessionStartTime: undefined,
   intentToStartEditTime: undefined,
   lastSelection: undefined,
   activeSessionTime: 0,
   totalActionCount: 0,
+  contentSizeChanged: 0,
   timeOfLastTextInput: undefined,
   actionTypeCount: {
     textInputCount: 0,
     nodeInsertionCount: 0,
     nodeAttributeChangeCount: 0,
     contentMovedCount: 0,
-    nodeDeletionCount: 0
+    nodeDeletionCount: 0,
+    undoCount: 0
   }
 };
 var createPlugin = exports.createPlugin = function createPlugin(api) {
@@ -35,23 +39,28 @@ var createPlugin = exports.createPlugin = function createPlugin(api) {
     key: metricsKey,
     state: {
       init: function init() {
-        return _objectSpread(_objectSpread({}, initialPluginState), {}, {
-          editSessionStartTime: performance.now()
-        });
+        return initialPluginState;
       },
-      apply: function apply(tr, pluginState) {
+      // eslint-disable-next-line @typescript-eslint/max-params
+      apply: function apply(tr, pluginState, oldState, newState) {
         var meta = tr.getMeta(metricsKey);
         var intentToStartEditTime = (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime;
         if (meta && meta.stopActiveSession) {
-          // console.log('stopActiveSession');
-          return _objectSpread(_objectSpread({}, pluginState), {}, {
-            intentToStartEditTime: undefined,
-            lastSelection: undefined
-          });
+          return initialPluginState;
         }
         if (!intentToStartEditTime) {
-          return pluginState;
+          if (tr.docChanged && !tr.getMeta('replaceDocument')) {
+            intentToStartEditTime = performance.now();
+          } else {
+            return pluginState;
+          }
         }
+        var undoCount = (0, _isNonTextUndo.isNonTextUndo)(tr) ? 1 : 0;
+        var newActionTypeCount = pluginState.actionTypeCount ? _objectSpread(_objectSpread({}, pluginState.actionTypeCount), {}, {
+          undoCount: pluginState.actionTypeCount.undoCount + undoCount
+        }) : _objectSpread(_objectSpread({}, initialPluginState.actionTypeCount), {}, {
+          undoCount: undoCount
+        });
         var canIgnoreTr = function canIgnoreTr() {
           return !tr.steps.every(function (e) {
             return e instanceof _steps.AnalyticsStep;
@@ -60,36 +69,64 @@ var createPlugin = exports.createPlugin = function createPlugin(api) {
         if (tr.docChanged && canIgnoreTr()) {
           var now = performance.now();
           timer.startTimer();
-
+          var actionTypeCount = pluginState.actionTypeCount,
+            timeOfLastTextInput = pluginState.timeOfLastTextInput,
+            totalActionCount = pluginState.totalActionCount,
+            activeSessionTime = pluginState.activeSessionTime;
           // If previous and current action is text insertion, then don't increase total action count
           var isActionTextInput = (0, _utils.isTextInput)(tr);
+          var newActiveSessionTime = activeSessionTime + (now - intentToStartEditTime);
+          var newTextInputCount = isActionTextInput ? actionTypeCount.textInputCount + 1 : actionTypeCount.textInputCount;
+          var newTotalActionCount = pluginState.totalActionCount + 1;
           if (pluginState.timeOfLastTextInput && isActionTextInput) {
-            return _objectSpread(_objectSpread({}, pluginState), {}, {
-              activeSessionTime: pluginState.activeSessionTime + (now - pluginState.timeOfLastTextInput),
-              totalActionCount: pluginState.totalActionCount,
-              timeOfLastTextInput: now
-            });
+            newActiveSessionTime = activeSessionTime + (now - (timeOfLastTextInput || 0));
+            newTextInputCount = actionTypeCount.textInputCount;
+            newTotalActionCount = totalActionCount;
           }
-
-          // TODO: Add actionTypeCount
-          return _objectSpread(_objectSpread({}, pluginState), {}, {
-            activeSessionTime: pluginState.activeSessionTime + (now - intentToStartEditTime),
-            totalActionCount: pluginState.totalActionCount + 1,
-            timeOfLastTextInput: isActionTextInput ? now : undefined
+          var newPluginState = _objectSpread(_objectSpread({}, pluginState), {}, {
+            activeSessionTime: newActiveSessionTime,
+            totalActionCount: newTotalActionCount,
+            timeOfLastTextInput: isActionTextInput ? now : undefined,
+            contentSizeChanged: pluginState.contentSizeChanged + (newState.doc.content.size - oldState.doc.content.size),
+            actionTypeCount: _objectSpread(_objectSpread({}, newActionTypeCount), {}, {
+              textInputCount: newTextInputCount
+            })
           });
+          return newPluginState;
         }
         return _objectSpread(_objectSpread({}, pluginState), {}, {
           lastSelection: (meta === null || meta === void 0 ? void 0 : meta.newSelection) || pluginState.lastSelection,
-          intentToStartEditTime: (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime
+          intentToStartEditTime: intentToStartEditTime,
+          actionTypeCount: newActionTypeCount
         });
       }
     },
-    view: function view() {
+    view: function view(_view) {
+      var fireAnalyticsEvent = function fireAnalyticsEvent() {
+        var pluginState = metricsKey.getState(_view.state);
+        if (!pluginState) {
+          return;
+        }
+        var payloadToSend = (0, _analytics.getAnalyticsPayload)({
+          pluginState: pluginState
+        });
+        if (pluginState && pluginState.totalActionCount > 0 && pluginState.activeSessionTime > 0) {
+          api === null || api === void 0 || api.analytics.actions.fireAnalyticsEvent(payloadToSend, undefined, {
+            immediate: true
+          });
+        }
+      };
+      var unbindBeforeUnload = (0, _bindEventListener.bind)(window, {
+        type: 'beforeunload',
+        listener: function listener() {
+          fireAnalyticsEvent();
+        }
+      });
       return {
         destroy: function destroy() {
-          var _api$metrics;
-          api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.fireSessionAnalytics());
+          fireAnalyticsEvent();
           timer.cleanupTimer();
+          unbindBeforeUnload();
         }
       };
     },

package/dist/cjs/pm-plugins/utils/active-session-timer.js

@@ -8,6 +8,7 @@ exports.ActiveSessionTimer = void 0;
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var ACTIVE_SESSION_IDLE_TIME = 5000;
 var ActiveSessionTimer = exports.ActiveSessionTimer = /*#__PURE__*/(0, _createClass2.default)(function ActiveSessionTimer(api) {
   var _this = this;
   (0, _classCallCheck2.default)(this, ActiveSessionTimer);
@@ -16,14 +17,14 @@ var ActiveSessionTimer = exports.ActiveSessionTimer = /*#__PURE__*/(0, _createCl
       clearTimeout(_this.timerId);
     }
     _this.timerId = window.setTimeout(function () {
+      if (_this.api) {
+        var _this$api$metrics;
+        _this.api.core.actions.execute((_this$api$metrics = _this.api.metrics) === null || _this$api$metrics === void 0 ? void 0 : _this$api$metrics.commands.stopActiveSession());
+      }
       _this.cleanupTimer();
-    }, 3000);
+    }, ACTIVE_SESSION_IDLE_TIME);
   });
   (0, _defineProperty2.default)(this, "cleanupTimer", function () {
-    if (_this.api) {
-      var _this$api$metrics;
-      _this.api.core.actions.execute((_this$api$metrics = _this.api.metrics) === null || _this$api$metrics === void 0 ? void 0 : _this$api$metrics.commands.stopActiveSession());
-    }
     if (_this.timerId) {
       clearTimeout(_this.timerId);
       _this.timerId = null;

package/dist/cjs/pm-plugins/utils/analytics.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getPayloadAttributes = exports.getAnalyticsPayload = void 0;
+var _analytics = require("@atlaskit/editor-common/analytics");
+var getPayloadAttributes = exports.getPayloadAttributes = function getPayloadAttributes(_ref) {
+  var pluginState = _ref.pluginState,
+    contentSizeChanged = _ref.contentSizeChanged;
+  return {
+    efficiency: {
+      totalActiveTime: pluginState.activeSessionTime,
+      totalActionCount: pluginState.totalActionCount,
+      actionByTypeCount: pluginState.actionTypeCount
+    },
+    effectiveness: {
+      undoCount: pluginState.actionTypeCount.undoCount,
+      repeatedActionCount: 0,
+      safeInsertCount: 0
+    },
+    contentSizeChanged: contentSizeChanged
+  };
+};
+var getAnalyticsPayload = exports.getAnalyticsPayload = function getAnalyticsPayload(_ref2) {
+  var pluginState = _ref2.pluginState;
+  return {
+    action: _analytics.ACTION.ENDED,
+    actionSubject: _analytics.ACTION_SUBJECT.ACTIVITY_SESSION,
+    actionSubjectId: _analytics.ACTION_SUBJECT_ID.ACTIVITY,
+    attributes: {
+      efficiency: {
+        totalActiveTime: pluginState.activeSessionTime,
+        totalActionCount: pluginState.totalActionCount,
+        actionByTypeCount: pluginState.actionTypeCount
+      },
+      effectiveness: {
+        undoCount: pluginState.actionTypeCount.undoCount,
+        repeatedActionCount: 0,
+        safeInsertCount: 0
+      },
+      contentSizeChanged: pluginState.contentSizeChanged
+    },
+    eventType: _analytics.EVENT_TYPE.TRACK
+  };
+};

package/dist/cjs/pm-plugins/utils/isNonTextUndo.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isNonTextUndo = void 0;
+var _transform = require("@atlaskit/editor-prosemirror/transform");
+var isNonTextUndo = exports.isNonTextUndo = function isNonTextUndo(tr) {
+  if (tr.getMeta('undoRedoPlugin$') === undefined) {
+    return false;
+  }
+  var hasNonTextChange = false;
+  tr.steps.forEach(function (step) {
+    if (step instanceof _transform.ReplaceStep) {
+      var slice = step.slice;
+      if (slice.content) {
+        slice.content.forEach(function (node) {
+          if (node.type.name !== 'text') {
+            hasNonTextChange = true;
+          }
+        });
+      }
+    } else {
+      hasNonTextChange = true;
+    }
+  });
+  return hasNonTextChange;
+};

package/dist/es2019/metricsPlugin.js

@@ -1,4 +1,5 @@
 import { createPlugin, initialPluginState, metricsKey } from './pm-plugins/main';
+import { getAnalyticsPayload } from './pm-plugins/utils/analytics';
 /**
  * Metrics plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
@@ -21,41 +22,17 @@ export const metricsPlugin = ({
         return tr;
       }
       const newTr = tr;
+      const pluginState = api === null || api === void 0 ? void 0 : api.metrics.sharedState.currentState();
+      if (pluginState && pluginState.totalActionCount > 0 && pluginState.activeSessionTime > 0) {
+        const payloadToSend = getAnalyticsPayload({
+          pluginState
+        });
+        api === null || api === void 0 ? void 0 : api.analytics.actions.attachAnalyticsEvent(payloadToSend)(newTr);
+      }
       newTr.setMeta(metricsKey, {
         stopActiveSession: true
       });
       return newTr;
-    },
-    fireSessionAnalytics: () => ({
-      tr
-    }) => {
-      if (!api) {
-        return tr;
-      }
-      const state = api.metrics.sharedState.currentState();
-      if (!state) {
-        return tr;
-      }
-
-      // const eventAttributes = {
-      // 	efficiency: {
-      // 		totalActiveTime: state.activeSessionTime || 0,
-      // 		totalActionCount: state.totalActionCount || 0,
-      // 		actionTypeCount: state.actionTypeCount,
-      // 		totalInactiveTime:
-      // 			Date.now() - (state.editSessionStartTime || 0) - (state.activeSessionTime || 0),
-      // 	},
-      // TODO: Add effectiveness attributes
-      // effectiveness: {
-      // 	undoCount: 0,
-      // 	repeatedActionCount: 0,
-      // 	safeInsertCount: 0,
-      // },
-      // };
-
-      // fire analytics event
-      // api.analytics.actions.attachAnalyticsEvent({});
-      return tr;
     }
   },
   getSharedState(editorState) {

package/dist/es2019/pm-plugins/main.js

@@ -1,22 +1,26 @@
+import { bind } from 'bind-event-listener';
 import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { isTextInput } from '@atlaskit/editor-common/utils';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { ActiveSessionTimer } from './utils/active-session-timer';
+import { getAnalyticsPayload } from './utils/analytics';
+import { isNonTextUndo } from './utils/isNonTextUndo';
 export const metricsKey = new PluginKey('metricsPlugin');
 export const initialPluginState = {
-  editSessionStartTime: undefined,
   intentToStartEditTime: undefined,
   lastSelection: undefined,
   activeSessionTime: 0,
   totalActionCount: 0,
+  contentSizeChanged: 0,
   timeOfLastTextInput: undefined,
   actionTypeCount: {
     textInputCount: 0,
     nodeInsertionCount: 0,
     nodeAttributeChangeCount: 0,
     contentMovedCount: 0,
-    nodeDeletionCount: 0
+    nodeDeletionCount: 0,
+    undoCount: 0
   }
 };
 export const createPlugin = api => {
@@ -25,62 +29,97 @@ export const createPlugin = api => {
     key: metricsKey,
     state: {
       init: () => {
-        return {
-          ...initialPluginState,
-          editSessionStartTime: performance.now()
-        };
+        return initialPluginState;
       },
-      apply(tr, pluginState) {
+      // eslint-disable-next-line @typescript-eslint/max-params
+      apply(tr, pluginState, oldState, newState) {
         const meta = tr.getMeta(metricsKey);
-        const intentToStartEditTime = (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime;
+        let intentToStartEditTime = (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime;
         if (meta && meta.stopActiveSession) {
-          // console.log('stopActiveSession');
-          return {
-            ...pluginState,
-            intentToStartEditTime: undefined,
-            lastSelection: undefined
-          };
+          return initialPluginState;
         }
         if (!intentToStartEditTime) {
-          return pluginState;
+          if (tr.docChanged && !tr.getMeta('replaceDocument')) {
+            intentToStartEditTime = performance.now();
+          } else {
+            return pluginState;
+          }
         }
+        const undoCount = isNonTextUndo(tr) ? 1 : 0;
+        const newActionTypeCount = pluginState.actionTypeCount ? {
+          ...pluginState.actionTypeCount,
+          undoCount: pluginState.actionTypeCount.undoCount + undoCount
+        } : {
+          ...initialPluginState.actionTypeCount,
+          undoCount
+        };
         const canIgnoreTr = () => !tr.steps.every(e => e instanceof AnalyticsStep);
         if (tr.docChanged && canIgnoreTr()) {
           const now = performance.now();
           timer.startTimer();
-
+          const {
+            actionTypeCount,
+            timeOfLastTextInput,
+            totalActionCount,
+            activeSessionTime
+          } = pluginState;
           // If previous and current action is text insertion, then don't increase total action count
           const isActionTextInput = isTextInput(tr);
+          let newActiveSessionTime = activeSessionTime + (now - intentToStartEditTime);
+          let newTextInputCount = isActionTextInput ? actionTypeCount.textInputCount + 1 : actionTypeCount.textInputCount;
+          let newTotalActionCount = pluginState.totalActionCount + 1;
           if (pluginState.timeOfLastTextInput && isActionTextInput) {
-            return {
-              ...pluginState,
-              activeSessionTime: pluginState.activeSessionTime + (now - pluginState.timeOfLastTextInput),
-              totalActionCount: pluginState.totalActionCount,
-              timeOfLastTextInput: now
-            };
+            newActiveSessionTime = activeSessionTime + (now - (timeOfLastTextInput || 0));
+            newTextInputCount = actionTypeCount.textInputCount;
+            newTotalActionCount = totalActionCount;
           }
-
-          // TODO: Add actionTypeCount
-          return {
+          const newPluginState = {
             ...pluginState,
-            activeSessionTime: pluginState.activeSessionTime + (now - intentToStartEditTime),
-            totalActionCount: pluginState.totalActionCount + 1,
-            timeOfLastTextInput: isActionTextInput ? now : undefined
+            activeSessionTime: newActiveSessionTime,
+            totalActionCount: newTotalActionCount,
+            timeOfLastTextInput: isActionTextInput ? now : undefined,
+            contentSizeChanged: pluginState.contentSizeChanged + (newState.doc.content.size - oldState.doc.content.size),
+            actionTypeCount: {
+              ...newActionTypeCount,
+              textInputCount: newTextInputCount
+            }
           };
+          return newPluginState;
         }
         return {
           ...pluginState,
           lastSelection: (meta === null || meta === void 0 ? void 0 : meta.newSelection) || pluginState.lastSelection,
-          intentToStartEditTime: (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime
+          intentToStartEditTime,
+          actionTypeCount: newActionTypeCount
         };
       }
     },
-    view() {
+    view(view) {
+      const fireAnalyticsEvent = () => {
+        const pluginState = metricsKey.getState(view.state);
+        if (!pluginState) {
+          return;
+        }
+        const payloadToSend = getAnalyticsPayload({
+          pluginState
+        });
+        if (pluginState && pluginState.totalActionCount > 0 && pluginState.activeSessionTime > 0) {
+          api === null || api === void 0 ? void 0 : api.analytics.actions.fireAnalyticsEvent(payloadToSend, undefined, {
+            immediate: true
+          });
+        }
+      };
+      const unbindBeforeUnload = bind(window, {
+        type: 'beforeunload',
+        listener: () => {
+          fireAnalyticsEvent();
+        }
+      });
       return {
         destroy() {
-          var _api$metrics;
-          api === null || api === void 0 ? void 0 : api.core.actions.execute(api === null || api === void 0 ? void 0 : (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.fireSessionAnalytics());
+          fireAnalyticsEvent();
           timer.cleanupTimer();
+          unbindBeforeUnload();
         }
       };
     },

package/dist/es2019/pm-plugins/utils/active-session-timer.js

@@ -1,4 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+const ACTIVE_SESSION_IDLE_TIME = 5000;
 export class ActiveSessionTimer {
   constructor(api) {
     _defineProperty(this, "startTimer", () => {
@@ -6,14 +7,14 @@ export class ActiveSessionTimer {
         clearTimeout(this.timerId);
       }
       this.timerId = window.setTimeout(() => {
+        if (this.api) {
+          var _this$api$metrics;
+          this.api.core.actions.execute((_this$api$metrics = this.api.metrics) === null || _this$api$metrics === void 0 ? void 0 : _this$api$metrics.commands.stopActiveSession());
+        }
         this.cleanupTimer();
-      }, 3000);
+      }, ACTIVE_SESSION_IDLE_TIME);
     });
     _defineProperty(this, "cleanupTimer", () => {
-      if (this.api) {
-        var _this$api$metrics;
-        this.api.core.actions.execute((_this$api$metrics = this.api.metrics) === null || _this$api$metrics === void 0 ? void 0 : _this$api$metrics.commands.stopActiveSession());
-      }
       if (this.timerId) {
         clearTimeout(this.timerId);
         this.timerId = null;

package/dist/es2019/pm-plugins/utils/analytics.js

@@ -0,0 +1,38 @@
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+export const getPayloadAttributes = ({
+  pluginState,
+  contentSizeChanged
+}) => ({
+  efficiency: {
+    totalActiveTime: pluginState.activeSessionTime,
+    totalActionCount: pluginState.totalActionCount,
+    actionByTypeCount: pluginState.actionTypeCount
+  },
+  effectiveness: {
+    undoCount: pluginState.actionTypeCount.undoCount,
+    repeatedActionCount: 0,
+    safeInsertCount: 0
+  },
+  contentSizeChanged
+});
+export const getAnalyticsPayload = ({
+  pluginState
+}) => ({
+  action: ACTION.ENDED,
+  actionSubject: ACTION_SUBJECT.ACTIVITY_SESSION,
+  actionSubjectId: ACTION_SUBJECT_ID.ACTIVITY,
+  attributes: {
+    efficiency: {
+      totalActiveTime: pluginState.activeSessionTime,
+      totalActionCount: pluginState.totalActionCount,
+      actionByTypeCount: pluginState.actionTypeCount
+    },
+    effectiveness: {
+      undoCount: pluginState.actionTypeCount.undoCount,
+      repeatedActionCount: 0,
+      safeInsertCount: 0
+    },
+    contentSizeChanged: pluginState.contentSizeChanged
+  },
+  eventType: EVENT_TYPE.TRACK
+});

package/dist/es2019/pm-plugins/utils/isNonTextUndo.js

@@ -0,0 +1,24 @@
+import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+export const isNonTextUndo = tr => {
+  if (tr.getMeta('undoRedoPlugin$') === undefined) {
+    return false;
+  }
+  let hasNonTextChange = false;
+  tr.steps.forEach(step => {
+    if (step instanceof ReplaceStep) {
+      const {
+        slice
+      } = step;
+      if (slice.content) {
+        slice.content.forEach(node => {
+          if (node.type.name !== 'text') {
+            hasNonTextChange = true;
+          }
+        });
+      }
+    } else {
+      hasNonTextChange = true;
+    }
+  });
+  return hasNonTextChange;
+};

package/dist/esm/metricsPlugin.js

@@ -1,4 +1,5 @@
 import { createPlugin, initialPluginState, metricsKey } from './pm-plugins/main';
+import { getAnalyticsPayload } from './pm-plugins/utils/analytics';
 /**
  * Metrics plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
@@ -23,43 +24,18 @@ export var metricsPlugin = function metricsPlugin(_ref) {
             return tr;
           }
           var newTr = tr;
+          var pluginState = api === null || api === void 0 ? void 0 : api.metrics.sharedState.currentState();
+          if (pluginState && pluginState.totalActionCount > 0 && pluginState.activeSessionTime > 0) {
+            var payloadToSend = getAnalyticsPayload({
+              pluginState: pluginState
+            });
+            api === null || api === void 0 || api.analytics.actions.attachAnalyticsEvent(payloadToSend)(newTr);
+          }
           newTr.setMeta(metricsKey, {
             stopActiveSession: true
           });
           return newTr;
         };
-      },
-      fireSessionAnalytics: function fireSessionAnalytics() {
-        return function (_ref3) {
-          var tr = _ref3.tr;
-          if (!api) {
-            return tr;
-          }
-          var state = api.metrics.sharedState.currentState();
-          if (!state) {
-            return tr;
-          }
-
-          // const eventAttributes = {
-          // 	efficiency: {
-          // 		totalActiveTime: state.activeSessionTime || 0,
-          // 		totalActionCount: state.totalActionCount || 0,
-          // 		actionTypeCount: state.actionTypeCount,
-          // 		totalInactiveTime:
-          // 			Date.now() - (state.editSessionStartTime || 0) - (state.activeSessionTime || 0),
-          // 	},
-          // TODO: Add effectiveness attributes
-          // effectiveness: {
-          // 	undoCount: 0,
-          // 	repeatedActionCount: 0,
-          // 	safeInsertCount: 0,
-          // },
-          // };
-
-          // fire analytics event
-          // api.analytics.actions.attachAnalyticsEvent({});
-          return tr;
-        };
       }
     },
     getSharedState: function getSharedState(editorState) {

package/dist/esm/pm-plugins/main.js

@@ -1,25 +1,29 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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) { _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 { bind } from 'bind-event-listener';
 import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { isTextInput } from '@atlaskit/editor-common/utils';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { ActiveSessionTimer } from './utils/active-session-timer';
+import { getAnalyticsPayload } from './utils/analytics';
+import { isNonTextUndo } from './utils/isNonTextUndo';
 export var metricsKey = new PluginKey('metricsPlugin');
 export var initialPluginState = {
-  editSessionStartTime: undefined,
   intentToStartEditTime: undefined,
   lastSelection: undefined,
   activeSessionTime: 0,
   totalActionCount: 0,
+  contentSizeChanged: 0,
   timeOfLastTextInput: undefined,
   actionTypeCount: {
     textInputCount: 0,
     nodeInsertionCount: 0,
     nodeAttributeChangeCount: 0,
     contentMovedCount: 0,
-    nodeDeletionCount: 0
+    nodeDeletionCount: 0,
+    undoCount: 0
   }
 };
 export var createPlugin = function createPlugin(api) {
@@ -28,23 +32,28 @@ export var createPlugin = function createPlugin(api) {
     key: metricsKey,
     state: {
       init: function init() {
-        return _objectSpread(_objectSpread({}, initialPluginState), {}, {
-          editSessionStartTime: performance.now()
-        });
+        return initialPluginState;
       },
-      apply: function apply(tr, pluginState) {
+      // eslint-disable-next-line @typescript-eslint/max-params
+      apply: function apply(tr, pluginState, oldState, newState) {
         var meta = tr.getMeta(metricsKey);
         var intentToStartEditTime = (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime;
         if (meta && meta.stopActiveSession) {
-          // console.log('stopActiveSession');
-          return _objectSpread(_objectSpread({}, pluginState), {}, {
-            intentToStartEditTime: undefined,
-            lastSelection: undefined
-          });
+          return initialPluginState;
         }
         if (!intentToStartEditTime) {
-          return pluginState;
+          if (tr.docChanged && !tr.getMeta('replaceDocument')) {
+            intentToStartEditTime = performance.now();
+          } else {
+            return pluginState;
+          }
         }
+        var undoCount = isNonTextUndo(tr) ? 1 : 0;
+        var newActionTypeCount = pluginState.actionTypeCount ? _objectSpread(_objectSpread({}, pluginState.actionTypeCount), {}, {
+          undoCount: pluginState.actionTypeCount.undoCount + undoCount
+        }) : _objectSpread(_objectSpread({}, initialPluginState.actionTypeCount), {}, {
+          undoCount: undoCount
+        });
         var canIgnoreTr = function canIgnoreTr() {
           return !tr.steps.every(function (e) {
             return e instanceof AnalyticsStep;
@@ -53,36 +62,64 @@ export var createPlugin = function createPlugin(api) {
         if (tr.docChanged && canIgnoreTr()) {
           var now = performance.now();
           timer.startTimer();
-
+          var actionTypeCount = pluginState.actionTypeCount,
+            timeOfLastTextInput = pluginState.timeOfLastTextInput,
+            totalActionCount = pluginState.totalActionCount,
+            activeSessionTime = pluginState.activeSessionTime;
           // If previous and current action is text insertion, then don't increase total action count
           var isActionTextInput = isTextInput(tr);
+          var newActiveSessionTime = activeSessionTime + (now - intentToStartEditTime);
+          var newTextInputCount = isActionTextInput ? actionTypeCount.textInputCount + 1 : actionTypeCount.textInputCount;
+          var newTotalActionCount = pluginState.totalActionCount + 1;
           if (pluginState.timeOfLastTextInput && isActionTextInput) {
-            return _objectSpread(_objectSpread({}, pluginState), {}, {
-              activeSessionTime: pluginState.activeSessionTime + (now - pluginState.timeOfLastTextInput),
-              totalActionCount: pluginState.totalActionCount,
-              timeOfLastTextInput: now
-            });
+            newActiveSessionTime = activeSessionTime + (now - (timeOfLastTextInput || 0));
+            newTextInputCount = actionTypeCount.textInputCount;
+            newTotalActionCount = totalActionCount;
           }
-
-          // TODO: Add actionTypeCount
-          return _objectSpread(_objectSpread({}, pluginState), {}, {
-            activeSessionTime: pluginState.activeSessionTime + (now - intentToStartEditTime),
-            totalActionCount: pluginState.totalActionCount + 1,
-            timeOfLastTextInput: isActionTextInput ? now : undefined
+          var newPluginState = _objectSpread(_objectSpread({}, pluginState), {}, {
+            activeSessionTime: newActiveSessionTime,
+            totalActionCount: newTotalActionCount,
+            timeOfLastTextInput: isActionTextInput ? now : undefined,
+            contentSizeChanged: pluginState.contentSizeChanged + (newState.doc.content.size - oldState.doc.content.size),
+            actionTypeCount: _objectSpread(_objectSpread({}, newActionTypeCount), {}, {
+              textInputCount: newTextInputCount
+            })
           });
+          return newPluginState;
         }
         return _objectSpread(_objectSpread({}, pluginState), {}, {
           lastSelection: (meta === null || meta === void 0 ? void 0 : meta.newSelection) || pluginState.lastSelection,
-          intentToStartEditTime: (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime
+          intentToStartEditTime: intentToStartEditTime,
+          actionTypeCount: newActionTypeCount
         });
       }
     },
-    view: function view() {
+    view: function view(_view) {
+      var fireAnalyticsEvent = function fireAnalyticsEvent() {
+        var pluginState = metricsKey.getState(_view.state);
+        if (!pluginState) {
+          return;
+        }
+        var payloadToSend = getAnalyticsPayload({
+          pluginState: pluginState
+        });
+        if (pluginState && pluginState.totalActionCount > 0 && pluginState.activeSessionTime > 0) {
+          api === null || api === void 0 || api.analytics.actions.fireAnalyticsEvent(payloadToSend, undefined, {
+            immediate: true
+          });
+        }
+      };
+      var unbindBeforeUnload = bind(window, {
+        type: 'beforeunload',
+        listener: function listener() {
+          fireAnalyticsEvent();
+        }
+      });
       return {
         destroy: function destroy() {
-          var _api$metrics;
-          api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.fireSessionAnalytics());
+          fireAnalyticsEvent();
           timer.cleanupTimer();
+          unbindBeforeUnload();
         }
       };
     },

package/dist/esm/pm-plugins/utils/active-session-timer.js

@@ -1,6 +1,7 @@
 import _createClass from "@babel/runtime/helpers/createClass";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+var ACTIVE_SESSION_IDLE_TIME = 5000;
 export var ActiveSessionTimer = /*#__PURE__*/_createClass(function ActiveSessionTimer(api) {
   var _this = this;
   _classCallCheck(this, ActiveSessionTimer);
@@ -9,14 +10,14 @@ export var ActiveSessionTimer = /*#__PURE__*/_createClass(function ActiveSession
       clearTimeout(_this.timerId);
     }
     _this.timerId = window.setTimeout(function () {
+      if (_this.api) {
+        var _this$api$metrics;
+        _this.api.core.actions.execute((_this$api$metrics = _this.api.metrics) === null || _this$api$metrics === void 0 ? void 0 : _this$api$metrics.commands.stopActiveSession());
+      }
       _this.cleanupTimer();
-    }, 3000);
+    }, ACTIVE_SESSION_IDLE_TIME);
   });
   _defineProperty(this, "cleanupTimer", function () {
-    if (_this.api) {
-      var _this$api$metrics;
-      _this.api.core.actions.execute((_this$api$metrics = _this.api.metrics) === null || _this$api$metrics === void 0 ? void 0 : _this$api$metrics.commands.stopActiveSession());
-    }
     if (_this.timerId) {
       clearTimeout(_this.timerId);
       _this.timerId = null;

package/dist/esm/pm-plugins/utils/analytics.js

@@ -0,0 +1,40 @@
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+export var getPayloadAttributes = function getPayloadAttributes(_ref) {
+  var pluginState = _ref.pluginState,
+    contentSizeChanged = _ref.contentSizeChanged;
+  return {
+    efficiency: {
+      totalActiveTime: pluginState.activeSessionTime,
+      totalActionCount: pluginState.totalActionCount,
+      actionByTypeCount: pluginState.actionTypeCount
+    },
+    effectiveness: {
+      undoCount: pluginState.actionTypeCount.undoCount,
+      repeatedActionCount: 0,
+      safeInsertCount: 0
+    },
+    contentSizeChanged: contentSizeChanged
+  };
+};
+export var getAnalyticsPayload = function getAnalyticsPayload(_ref2) {
+  var pluginState = _ref2.pluginState;
+  return {
+    action: ACTION.ENDED,
+    actionSubject: ACTION_SUBJECT.ACTIVITY_SESSION,
+    actionSubjectId: ACTION_SUBJECT_ID.ACTIVITY,
+    attributes: {
+      efficiency: {
+        totalActiveTime: pluginState.activeSessionTime,
+        totalActionCount: pluginState.totalActionCount,
+        actionByTypeCount: pluginState.actionTypeCount
+      },
+      effectiveness: {
+        undoCount: pluginState.actionTypeCount.undoCount,
+        repeatedActionCount: 0,
+        safeInsertCount: 0
+      },
+      contentSizeChanged: pluginState.contentSizeChanged
+    },
+    eventType: EVENT_TYPE.TRACK
+  };
+};

package/dist/esm/pm-plugins/utils/isNonTextUndo.js

@@ -0,0 +1,22 @@
+import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+export var isNonTextUndo = function isNonTextUndo(tr) {
+  if (tr.getMeta('undoRedoPlugin$') === undefined) {
+    return false;
+  }
+  var hasNonTextChange = false;
+  tr.steps.forEach(function (step) {
+    if (step instanceof ReplaceStep) {
+      var slice = step.slice;
+      if (slice.content) {
+        slice.content.forEach(function (node) {
+          if (node.type.name !== 'text') {
+            hasNonTextChange = true;
+          }
+        });
+      }
+    } else {
+      hasNonTextChange = true;
+    }
+  });
+  return hasNonTextChange;
+};

package/dist/types/metricsPluginType.d.ts

@@ -1,9 +1,10 @@
 import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { MetricsState } from './pm-plugins/main';
 export type MetricsPlugin = NextEditorPlugin<'metrics', {
+    dependencies: [AnalyticsPlugin];
     sharedState: MetricsState;
     commands: {
         stopActiveSession: () => EditorCommand;
-        fireSessionAnalytics: () => EditorCommand;
     };
 }>;

package/dist/types/pm-plugins/main.d.ts

@@ -4,12 +4,12 @@ import { PluginKey, Selection } from '@atlaskit/editor-prosemirror/state';
 import { type MetricsPlugin } from '../metricsPluginType';
 export declare const metricsKey: PluginKey<any>;
 export type MetricsState = {
-    editSessionStartTime?: number;
     intentToStartEditTime?: number;
     activeSessionTime: number;
     totalActionCount: number;
+    contentSizeChanged: number;
     lastSelection?: Selection;
-    actionTypeCount?: ActionByType;
+    actionTypeCount: ActionByType;
     timeOfLastTextInput?: number;
 };
 export type ActionByType = {
@@ -18,6 +18,7 @@ export type ActionByType = {
     nodeAttributeChangeCount: number;
     contentMovedCount: number;
     nodeDeletionCount: number;
+    undoCount: number;
 };
 export declare const initialPluginState: MetricsState;
 export declare const createPlugin: (api: ExtractInjectionAPI<MetricsPlugin> | undefined) => SafePlugin<MetricsState>;

package/dist/types/pm-plugins/utils/analytics.d.ts

@@ -0,0 +1,11 @@
+import { type ActiveSessionEventPayload, type ActiveSessionEventAttributes } from '@atlaskit/editor-common/analytics';
+import type { MetricsState } from '../main';
+type Props = {
+    pluginState: MetricsState;
+    contentSizeChanged: number;
+};
+export declare const getPayloadAttributes: ({ pluginState, contentSizeChanged, }: Props) => ActiveSessionEventAttributes;
+export declare const getAnalyticsPayload: ({ pluginState, }: {
+    pluginState: MetricsState;
+}) => ActiveSessionEventPayload;
+export {};

package/dist/types/pm-plugins/utils/isNonTextUndo.d.ts

@@ -0,0 +1,2 @@
+import { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+export declare const isNonTextUndo: (tr: ReadonlyTransaction) => boolean;

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

@@ -1,9 +1,12 @@
 import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { MetricsState } from './pm-plugins/main';
 export type MetricsPlugin = NextEditorPlugin<'metrics', {
+    dependencies: [
+        AnalyticsPlugin
+    ];
     sharedState: MetricsState;
     commands: {
         stopActiveSession: () => EditorCommand;
-        fireSessionAnalytics: () => EditorCommand;
     };
 }>;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -4,12 +4,12 @@ import { PluginKey, Selection } from '@atlaskit/editor-prosemirror/state';
 import { type MetricsPlugin } from '../metricsPluginType';
 export declare const metricsKey: PluginKey<any>;
 export type MetricsState = {
-    editSessionStartTime?: number;
     intentToStartEditTime?: number;
     activeSessionTime: number;
     totalActionCount: number;
+    contentSizeChanged: number;
     lastSelection?: Selection;
-    actionTypeCount?: ActionByType;
+    actionTypeCount: ActionByType;
     timeOfLastTextInput?: number;
 };
 export type ActionByType = {
@@ -18,6 +18,7 @@ export type ActionByType = {
     nodeAttributeChangeCount: number;
     contentMovedCount: number;
     nodeDeletionCount: number;
+    undoCount: number;
 };
 export declare const initialPluginState: MetricsState;
 export declare const createPlugin: (api: ExtractInjectionAPI<MetricsPlugin> | undefined) => SafePlugin<MetricsState>;

package/dist/types-ts4.5/pm-plugins/utils/analytics.d.ts

@@ -0,0 +1,11 @@
+import { type ActiveSessionEventPayload, type ActiveSessionEventAttributes } from '@atlaskit/editor-common/analytics';
+import type { MetricsState } from '../main';
+type Props = {
+    pluginState: MetricsState;
+    contentSizeChanged: number;
+};
+export declare const getPayloadAttributes: ({ pluginState, contentSizeChanged, }: Props) => ActiveSessionEventAttributes;
+export declare const getAnalyticsPayload: ({ pluginState, }: {
+    pluginState: MetricsState;
+}) => ActiveSessionEventPayload;
+export {};

package/dist/types-ts4.5/pm-plugins/utils/isNonTextUndo.d.ts

@@ -0,0 +1,2 @@
+import { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+export declare const isNonTextUndo: (tr: ReadonlyTransaction) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-metrics",
-	"version": "1.1.0",
+	"version": "2.0.0",
 	"description": "Metrics plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -25,10 +25,12 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^46.1.0",
-		"@atlaskit/editor-common": "^99.1.1",
+		"@atlaskit/editor-common": "^99.5.0",
+		"@atlaskit/editor-plugin-analytics": "^1.11.0",
 		"@atlaskit/editor-prosemirror": "6.2.1",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
-		"@babel/runtime": "^7.0.0"
+		"@babel/runtime": "^7.0.0",
+		"bind-event-listener": "^3.0.0"
 	},
 	"peerDependencies": {
 		"react": "^16.8.0"