fix: correct misleading action origin on paste event - rich text (con…

…tentful#1385) * fix: correct misleading action origin on paste event - rich text * test: update origin in tests * chore: remove console log * test: fixed one more occurrence
upday · Apr 3, 2023 · 23e313f · 23e313f
1 parent 08a6c49
commit 23e313f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 10 deletions.
diff --git a/cypress/integration/rich-text/RichTextEditor.Tracking.spec.ts b/cypress/integration/rich-text/RichTextEditor.Tracking.spec.ts
@@ -49,7 +49,7 @@ describe('Rich Text Editor - Tracking', { viewportHeight: 2000 }, () => {
       richText.editor.click().paste({ 'text/plain': 'Hello World!' });
 
       richText.expectTrackingValue([
-        action('paste', 'shortcut', {
+        action('paste', 'shortcut-or-viewport', {
           characterCountAfter: 12,
           characterCountBefore: 0,
           characterCountSelection: 0,
@@ -60,13 +60,13 @@ describe('Rich Text Editor - Tracking', { viewportHeight: 2000 }, () => {
       richText.editor.click().type('{enter}').paste({ 'text/plain': 'Hello World!' });
 
       richText.expectTrackingValue([
-        action('paste', 'shortcut', {
+        action('paste', 'shortcut-or-viewport', {
           characterCountAfter: 12,
           characterCountBefore: 0,
           characterCountSelection: 0,
           source: 'Unknown',
         }),
-        action('paste', 'shortcut', {
+        action('paste', 'shortcut-or-viewport', {
           characterCountAfter: 25,
           characterCountBefore: 13,
           characterCountSelection: 0,
@@ -81,7 +81,7 @@ describe('Rich Text Editor - Tracking', { viewportHeight: 2000 }, () => {
       });
 
       richText.expectTrackingValue([
-        action('paste', 'shortcut', {
+        action('paste', 'shortcut-or-viewport', {
           characterCountAfter: 5,
           characterCountBefore: 0,
           characterCountSelection: 0,
@@ -96,7 +96,7 @@ describe('Rich Text Editor - Tracking', { viewportHeight: 2000 }, () => {
       });
 
       richText.expectTrackingValue([
-        action('paste', 'shortcut', {
+        action('paste', 'shortcut-or-viewport', {
           characterCountAfter: 88,
           characterCountBefore: 0,
           characterCountSelection: 0,
@@ -111,7 +111,7 @@ describe('Rich Text Editor - Tracking', { viewportHeight: 2000 }, () => {
       });
 
       richText.expectTrackingValue([
-        action('paste', 'shortcut', {
+        action('paste', 'shortcut-or-viewport', {
           characterCountAfter: 12,
           characterCountBefore: 0,
           characterCountSelection: 0,
@@ -126,7 +126,7 @@ describe('Rich Text Editor - Tracking', { viewportHeight: 2000 }, () => {
       });
 
       richText.expectTrackingValue([
-        action('paste', 'shortcut', {
+        action('paste', 'shortcut-or-viewport', {
           characterCountAfter: 14,
           characterCountBefore: 0,
           characterCountSelection: 0,
@@ -141,7 +141,7 @@ describe('Rich Text Editor - Tracking', { viewportHeight: 2000 }, () => {
       });
 
       richText.expectTrackingValue([
-        action('paste', 'shortcut', {
+        action('paste', 'shortcut-or-viewport', {
           characterCountAfter: 5,
           characterCountBefore: 0,
           characterCountSelection: 0,
@@ -156,7 +156,7 @@ describe('Rich Text Editor - Tracking', { viewportHeight: 2000 }, () => {
       });
 
       richText.expectTrackingValue([
-        action('paste', 'shortcut', {
+        action('paste', 'shortcut-or-viewport', {
           characterCountAfter: 5,
           characterCountBefore: 0,
           characterCountSelection: 0,

diff --git a/packages/rich-text/src/plugins/Tracking/createTrackingPlugin.ts b/packages/rich-text/src/plugins/Tracking/createTrackingPlugin.ts
@@ -49,6 +49,11 @@ export interface TrackingPluginActions {
     data?: Record<string, unknown>
   ) => ReturnType<RichTextTrackingActionHandler>;
 
+  onShortcutOrViewportAction: (
+    actionName: RichTextTrackingActionName,
+    data?: Record<string, unknown>
+  ) => ReturnType<RichTextTrackingActionHandler>;
+
   onToolbarAction: (
     actionName: RichTextTrackingActionName,
     data?: Record<string, unknown>
@@ -64,6 +69,7 @@ const actionOrigin = {
   TOOLBAR: 'toolbar-icon',
   SHORTCUT: 'shortcut',
   VIEWPORT: 'viewport-interaction',
+  SHORTCUT_OR_VIEWPORT: 'shortcut-or-viewport',
   COMMAND_PALETTE: 'command-palette',
 };
 
@@ -114,6 +120,9 @@ export const createTrackingPlugin = (onAction: RichTextTrackingActionHandler): P
     onShortcutAction: (actionName: RichTextTrackingActionName, data = {}) =>
       onAction(actionName, { origin: actionOrigin.SHORTCUT, ...data }),
 
+    onShortcutOrViewportAction: (actionName: RichTextTrackingActionName, data = {}) =>
+      onAction(actionName, { origin: actionOrigin.SHORTCUT_OR_VIEWPORT, ...data }),
+
     onToolbarAction: (actionName: RichTextTrackingActionName, data = {}) =>
       onAction(actionName, { origin: actionOrigin.TOOLBAR, ...data }),
 
@@ -140,7 +149,7 @@ export const createTrackingPlugin = (onAction: RichTextTrackingActionHandler): P
           setTimeout(() => {
             const characterCountAfter = getCharacterCount(editor);
 
-            trackingActions.onShortcutAction('paste', {
+            trackingActions.onShortcutOrViewportAction('paste', {
               characterCountAfter,
               characterCountBefore,
               characterCountSelection,