@atlaskit/editor-core 179.1.2 → 180.1.0

package/dist/es2019/editor-next/utils/sendDurationAnalytics.js

@@ -0,0 +1,40 @@
+import { EditorExperience } from '@atlaskit/editor-common/ufo';
+import { ACTION_SUBJECT, EVENT_TYPE, fireAnalyticsEvent } from '@atlaskit/editor-common/analytics';
+/**
+ *
+ * Util function to be used with the Editor component to send duration analytics
+ *
+ * @param action
+ * @param props
+ * @param getExperienceStore return the ExperienceStore of the Editor
+ * @param getCreateAnalyticsEvent return the CreateUIAnalyticsEvent of the Editor
+ * @returns
+ */
+export default function sendDurationAnalytics(action, props, getExperienceStore, createAnalyticsEvent) {
+  return async (duration, startTime) => {
+    var _props$featureFlags;
+    const contextIdentifier = await props.contextIdentifierProvider;
+    const objectId = contextIdentifier === null || contextIdentifier === void 0 ? void 0 : contextIdentifier.objectId;
+    if (createAnalyticsEvent) {
+      fireAnalyticsEvent(createAnalyticsEvent)({
+        payload: {
+          action,
+          actionSubject: ACTION_SUBJECT.EDITOR,
+          attributes: {
+            duration,
+            startTime,
+            objectId
+          },
+          eventType: EVENT_TYPE.OPERATIONAL
+        }
+      });
+    }
+    if ((_props$featureFlags = props.featureFlags) !== null && _props$featureFlags !== void 0 && _props$featureFlags.ufo) {
+      const experienceStore = getExperienceStore();
+      experienceStore === null || experienceStore === void 0 ? void 0 : experienceStore.mark(EditorExperience.loadEditor, action, startTime + duration);
+      experienceStore === null || experienceStore === void 0 ? void 0 : experienceStore.addMetadata(EditorExperience.loadEditor, {
+        objectId
+      });
+    }
+  };
+}

package/dist/es2019/editor-next/utils/trackEditorActions.js

@@ -0,0 +1,78 @@
+import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+/**
+ *
+ * Util function to be used with the Editor to track the EditorActions prop
+ *
+ * @param editorActions
+ * @param performanceTracking
+ * @param handleAnalyticsEvent
+ * @returns
+ */
+export default function trackEditorActions(editorActions, performanceTracking, handleAnalyticsEvent) {
+  var _performanceTracking$;
+  if (performanceTracking !== null && performanceTracking !== void 0 && (_performanceTracking$ = performanceTracking.contentRetrievalTracking) !== null && _performanceTracking$ !== void 0 && _performanceTracking$.enabled) {
+    const DEFAULT_SAMPLING_RATE = 100;
+    const getValue = editorActions.getValue.bind(editorActions);
+    if (!editorActions._contentRetrievalTracking) {
+      editorActions._contentRetrievalTracking = {
+        samplingCounters: {
+          success: 1,
+          failure: 1
+        },
+        getValueTracked: false
+      };
+    }
+    const {
+      _contentRetrievalTracking: {
+        samplingCounters,
+        getValueTracked
+      }
+    } = editorActions;
+    if (!getValueTracked) {
+      const getValueWithTracking = async () => {
+        try {
+          var _performanceTracking$2, _performanceTracking$3;
+          const value = await getValue();
+          if (samplingCounters.success === ((_performanceTracking$2 = performanceTracking === null || performanceTracking === void 0 ? void 0 : (_performanceTracking$3 = performanceTracking.contentRetrievalTracking) === null || _performanceTracking$3 === void 0 ? void 0 : _performanceTracking$3.successSamplingRate) !== null && _performanceTracking$2 !== void 0 ? _performanceTracking$2 : DEFAULT_SAMPLING_RATE)) {
+            handleAnalyticsEvent({
+              payload: {
+                action: ACTION.EDITOR_CONTENT_RETRIEVAL_PERFORMED,
+                actionSubject: ACTION_SUBJECT.EDITOR,
+                attributes: {
+                  success: true
+                },
+                eventType: EVENT_TYPE.OPERATIONAL
+              }
+            });
+            samplingCounters.success = 0;
+          }
+          samplingCounters.success++;
+          return value;
+        } catch (err) {
+          var _performanceTracking$4, _performanceTracking$5;
+          if (samplingCounters.failure === ((_performanceTracking$4 = performanceTracking === null || performanceTracking === void 0 ? void 0 : (_performanceTracking$5 = performanceTracking.contentRetrievalTracking) === null || _performanceTracking$5 === void 0 ? void 0 : _performanceTracking$5.failureSamplingRate) !== null && _performanceTracking$4 !== void 0 ? _performanceTracking$4 : DEFAULT_SAMPLING_RATE)) {
+            var _performanceTracking$6;
+            handleAnalyticsEvent({
+              payload: {
+                action: ACTION.EDITOR_CONTENT_RETRIEVAL_PERFORMED,
+                actionSubject: ACTION_SUBJECT.EDITOR,
+                attributes: {
+                  success: false,
+                  errorInfo: err.toString(),
+                  errorStack: performanceTracking !== null && performanceTracking !== void 0 && (_performanceTracking$6 = performanceTracking.contentRetrievalTracking) !== null && _performanceTracking$6 !== void 0 && _performanceTracking$6.reportErrorStack ? err.stack : undefined
+                },
+                eventType: EVENT_TYPE.OPERATIONAL
+              }
+            });
+            samplingCounters.failure = 0;
+          }
+          samplingCounters.failure++;
+          throw err;
+        }
+      };
+      editorActions.getValue = getValueWithTracking;
+      editorActions._contentRetrievalTracking.getValueTracked = true;
+    }
+  }
+  return editorActions;
+}