feat: support annotated components in touch evetns

vaind · vaind · commit b063a5edd22c · 2024-06-18T13:26:23.000+02:00
diff --git a/samples/expo/babel.config.js b/samples/expo/babel.config.js
@@ -1,4 +1,6 @@
-module.exports = function(api) {
+const componentAnnotatePlugin = require('@sentry/babel-plugin-component-annotate');
+
+module.exports = function (api) {
   api.cache(false);
   return {
     presets: ['babel-preset-expo'],
@@ -11,6 +13,7 @@ module.exports = function(api) {
           },
         },
       ],
+      componentAnnotatePlugin,
     ],
   };
 };
diff --git a/samples/expo/package.json b/samples/expo/package.json
@@ -33,6 +33,7 @@
   "devDependencies": {
     "@babel/core": "^7.20.0",
     "@babel/preset-env": "7.1.6",
+    "@sentry/babel-plugin-component-annotate": "^2.18.0",
     "@types/node": "20.10.4"
   },
   "overrides": {
diff --git a/samples/expo/yarn.lock b/samples/expo/yarn.lock
@@ -2413,6 +2413,11 @@
     component-type "^1.2.1"
     join-component "^1.1.0"
 
+"@sentry/babel-plugin-component-annotate@^2.18.0":
+  version "2.18.0"
+  resolved "https://registry.yarnpkg.com/@sentry/babel-plugin-component-annotate/-/babel-plugin-component-annotate-2.18.0.tgz#3bee98f94945643b0762ceed1f6cca60db52bdbd"
+  integrity sha512-9L4RbhS3WNtc/SokIhc0dwgcvs78YSQPakZejsrIgnzLzCi8mS6PeT+BY0+QCtsXxjd1egM8hqcJeB0lukBkXA==
+
 "@sideway/address@^4.1.3":
   version "4.1.4"
   resolved "https://registry.yarnpkg.com/@sideway/address/-/address-4.1.4.tgz#03dccebc6ea47fdc226f7d3d1ad512955d4783f0"
diff --git a/samples/react-native/babel.config.js b/samples/react-native/babel.config.js
@@ -1,3 +1,5 @@
+const componentAnnotatePlugin = require('@sentry/babel-plugin-component-annotate');
+
 module.exports = {
   presets: ['module:@react-native/babel-preset'],
   plugins: [
@@ -9,5 +11,6 @@ module.exports = {
         },
       },
     ],
+    componentAnnotatePlugin,
   ],
 };
diff --git a/samples/react-native/package.json b/samples/react-native/package.json
@@ -43,6 +43,7 @@
     "@react-native/eslint-config": "^0.73.1",
     "@react-native/metro-config": "^0.73.1",
     "@react-native/typescript-config": "^0.73.1",
+    "@sentry/babel-plugin-component-annotate": "^2.18.0",
     "@types/react": "^18.2.65",
     "@types/react-native-vector-icons": "^6.4.18",
     "@types/react-test-renderer": "^18.0.0",
diff --git a/samples/react-native/yarn.lock b/samples/react-native/yarn.lock
@@ -3127,6 +3127,11 @@
     color "^4.2.3"
     warn-once "^0.1.0"
 
+"@sentry/babel-plugin-component-annotate@^2.18.0":
+  version "2.18.0"
+  resolved "https://registry.yarnpkg.com/@sentry/babel-plugin-component-annotate/-/babel-plugin-component-annotate-2.18.0.tgz#3bee98f94945643b0762ceed1f6cca60db52bdbd"
+  integrity sha512-9L4RbhS3WNtc/SokIhc0dwgcvs78YSQPakZejsrIgnzLzCi8mS6PeT+BY0+QCtsXxjd1egM8hqcJeB0lukBkXA==
+
 "@sideway/address@^4.1.3":
   version "4.1.4"
   resolved "https://registry.yarnpkg.com/@sideway/address/-/address-4.1.4.tgz#03dccebc6ea47fdc226f7d3d1ad512955d4783f0"
diff --git a/src/js/touchevents.tsx b/src/js/touchevents.tsx
@@ -2,7 +2,7 @@ import { addBreadcrumb, getCurrentHub } from '@sentry/core';
 import type { SeverityLevel } from '@sentry/types';
 import { logger } from '@sentry/utils';
 import * as React from 'react';
-import type { GestureResponderEvent} from 'react-native';
+import type { GestureResponderEvent } from 'react-native';
 import { StyleSheet, View } from 'react-native';
 
 import { createIntegration } from './integrations/factory';
@@ -53,6 +53,9 @@ const DEFAULT_BREADCRUMB_TYPE = 'user';
 const DEFAULT_MAX_COMPONENT_TREE_SIZE = 20;
 
 const SENTRY_LABEL_PROP_KEY = 'sentry-label';
+const SENTRY_COMPONENT_PROP_KEY = 'data-sentry-component';
+const SENTRY_ELEMENT_PROP_KEY = 'data-sentry-element';
+const SENTRY_FILE_PROP_KEY = 'data-sentry-source-file';
 
 interface ElementInstance {
   elementType?: {
@@ -63,6 +66,13 @@ interface ElementInstance {
   return?: ElementInstance;
 }
 
+interface TouchedComponentInfo {
+  name?: string;
+  label?: string;
+  element?: string;
+  file?: string;
+}
+
 interface PrivateGestureResponderEvent extends GestureResponderEvent {
   _targetInst?: ElementInstance;
 }
@@ -71,7 +81,6 @@ interface PrivateGestureResponderEvent extends GestureResponderEvent {
  * Boundary to log breadcrumbs for interaction events.
  */
 class TouchEventBoundary extends React.Component<TouchEventBoundaryProps> {
-
   public static displayName: string = '__Sentry.TouchEventBoundary';
   public static defaultProps: Partial<TouchEventBoundaryProps> = {
     breadcrumbCategory: DEFAULT_BREADCRUMB_CATEGORY,
@@ -113,18 +122,17 @@ class TouchEventBoundary extends React.Component<TouchEventBoundaryProps> {
   /**
    * Logs the touch event given the component tree names and a label.
    */
-  private _logTouchEvent(
-    componentTreeNames: string[],
-    activeLabel?: string
-  ): void {
+  private _logTouchEvent(touchPath: TouchedComponentInfo[], label?: string): void {
     const level = 'info' as SeverityLevel;
+
+    const root = touchPath[0];
+    const detail = label ? label : `${root.name}${root.file ? ` (${root.file})` : ''}`;
+
     const crumb = {
       category: this.props.breadcrumbCategory,
-      data: { componentTree: componentTreeNames },
+      data: { path: touchPath },
       level: level,
-      message: activeLabel
-        ? `Touch event within element: ${activeLabel}`
-        : 'Touch event within component tree',
+      message: `Touch event within element: ${detail}`,
       type: this.props.breadcrumbType,
     };
     addBreadcrumb(crumb);
@@ -147,7 +155,7 @@ class TouchEventBoundary extends React.Component<TouchEventBoundaryProps> {
     return ignoreNames.some(
       (ignoreName: string | RegExp) =>
         (typeof ignoreName === 'string' && name === ignoreName) ||
-        (ignoreName instanceof RegExp && name.match(ignoreName))
+        (ignoreName instanceof RegExp && name.match(ignoreName)),
     );
   }
 
@@ -166,77 +174,80 @@ class TouchEventBoundary extends React.Component<TouchEventBoundaryProps> {
     }
 
     let currentInst: ElementInstance | undefined = e._targetInst;
-
-    let activeLabel: string | undefined;
-    let activeDisplayName: string | undefined;
-    const componentTreeNames: string[] = [];
+    const touchPath: TouchedComponentInfo[] = [];
 
     while (
       currentInst &&
       // maxComponentTreeSize will always be defined as we have a defaultProps. But ts needs a check so this is here.
       this.props.maxComponentTreeSize &&
-      componentTreeNames.length < this.props.maxComponentTreeSize
+      touchPath.length < this.props.maxComponentTreeSize
     ) {
       if (
         // If the loop gets to the boundary itself, break.
-        currentInst.elementType?.displayName ===
-        TouchEventBoundary.displayName
+        currentInst.elementType?.displayName === TouchEventBoundary.displayName
       ) {
         break;
       }
 
-      const props = currentInst.memoizedProps;
+      const props = currentInst.memoizedProps ?? {};
+      const info: TouchedComponentInfo = {};
+      if (typeof props[SENTRY_COMPONENT_PROP_KEY] === 'string' && props[SENTRY_COMPONENT_PROP_KEY].length > 0) {
+        info.name = props[SENTRY_COMPONENT_PROP_KEY];
+      }
+      if (typeof props[SENTRY_ELEMENT_PROP_KEY] === 'string' && props[SENTRY_ELEMENT_PROP_KEY].length > 0) {
+        info.element = props[SENTRY_ELEMENT_PROP_KEY];
+      }
+      if (typeof props[SENTRY_FILE_PROP_KEY] === 'string' && props[SENTRY_FILE_PROP_KEY].length > 0) {
+        info.file = props[SENTRY_FILE_PROP_KEY];
+      }
+
       const labelValue =
-        typeof props?.[SENTRY_LABEL_PROP_KEY] !== 'undefined'
-          ? `${props[SENTRY_LABEL_PROP_KEY]}`
-        // For some reason type narrowing doesn't work as expected with indexing when checking it all in one go in
-        // the "check-label" if sentence, so we have to assign it to a variable here first
-          : (typeof this.props.labelName === 'string') ? props?.[this.props.labelName] : undefined;
-
-      // Check the label first
-      if (labelValue && typeof labelValue === 'string') {
-        if (this._pushIfNotIgnored(componentTreeNames, labelValue)) {
-          if (!activeLabel) {
-            activeLabel = labelValue;
-          }
-        }
-      } else if (currentInst.elementType) {
-        const { elementType } = currentInst;
-
-        // Check display name
-        if (elementType.displayName) {
-          if (this._pushIfNotIgnored(componentTreeNames, elementType.displayName)) {
-            if (!activeDisplayName) {
-              activeDisplayName = elementType.displayName;
-            }
-          }
-        }
+        typeof props[SENTRY_LABEL_PROP_KEY] === 'string'
+          ? props[SENTRY_LABEL_PROP_KEY]
+          : // For some reason type narrowing doesn't work as expected with indexing when checking it all in one go in
+          // the "check-label" if sentence, so we have to assign it to a variable here first
+          typeof this.props.labelName === 'string'
+          ? props[this.props.labelName]
+          : undefined;
+
+      if (typeof labelValue === 'string' && labelValue.length > 0) {
+        info.label = labelValue;
+      }
+
+      if (!info.name && currentInst.elementType?.displayName) {
+        info.name = currentInst.elementType?.displayName;
       }
 
+      this._pushIfNotIgnored(touchPath, info);
+
       currentInst = currentInst.return;
     }
 
-    const finalLabel = activeLabel ?? activeDisplayName;
-
-    if (componentTreeNames.length > 0 || finalLabel) {
-      this._logTouchEvent(componentTreeNames, finalLabel);
+    const label = touchPath.find(info => info.label)?.label;
+    if (touchPath.length > 0) {
+      this._logTouchEvent(touchPath, label);
     }
 
     this._tracingIntegration?.startUserInteractionTransaction({
-      elementId: activeLabel,
+      elementId: label,
       op: UI_ACTION_TOUCH,
     });
   }
 
   /**
    * Pushes the name to the componentTreeNames array if it is not ignored.
    */
-  private _pushIfNotIgnored(componentTreeNames: string[], name: string, file?: string): boolean {
-    const value = file ? `${name} (${file})` : name;
-    if (this._isNameIgnored(value)) {
+  private _pushIfNotIgnored(touchPath: TouchedComponentInfo[], value: TouchedComponentInfo): boolean {
+    if (!value.name && !value.label) {
+      return false;
+    }
+    if (value.name && this._isNameIgnored(value.name)) {
+      return false;
+    }
+    if (value.label && this._isNameIgnored(value.label)) {
       return false;
     }
-    componentTreeNames.push(value);
+    touchPath.push(value);
     return true;
   }
 }
@@ -249,9 +260,9 @@ class TouchEventBoundary extends React.Component<TouchEventBoundaryProps> {
 const withTouchEventBoundary = (
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   InnerComponent: React.ComponentType<any>,
-  boundaryProps?: TouchEventBoundaryProps
+  boundaryProps?: TouchEventBoundaryProps,
 ): React.FunctionComponent => {
-  const WrappedComponent: React.FunctionComponent = (props) => (
+  const WrappedComponent: React.FunctionComponent = props => (
     <TouchEventBoundary {...(boundaryProps ?? {})}>
       <InnerComponent {...props} />
     </TouchEventBoundary>
diff --git a/test/touchevents.test.tsx b/test/touchevents.test.tsx
@@ -5,7 +5,7 @@ import * as core from '@sentry/core';
 import type { SeverityLevel } from '@sentry/types';
 
 import { TouchEventBoundary } from '../src/js/touchevents';
-import { getDefaultTestClientOptions,TestClient } from './mocks/client';
+import { getDefaultTestClientOptions, TestClient } from './mocks/client';
 
 describe('TouchEventBoundary._onTouchStart', () => {
   let addBreadcrumb: jest.SpyInstance;
@@ -101,7 +101,7 @@ describe('TouchEventBoundary._onTouchStart', () => {
     expect(addBreadcrumb).toBeCalledWith({
       category: defaultProps.breadcrumbCategory,
       data: {
-        componentTree: ['View', 'Connect(View)', 'LABEL!'],
+        path: [{ name: 'View' }, { name: 'Connect(View)' }, { label: 'LABEL!' }],
       },
       level: 'info' as SeverityLevel,
       message: 'Touch event within element: LABEL!',
@@ -160,15 +160,15 @@ describe('TouchEventBoundary._onTouchStart', () => {
     expect(addBreadcrumb).toBeCalledWith({
       category: defaultProps.breadcrumbCategory,
       data: {
-        componentTree: ['Styled(View2)', 'Styled(View)'],
+        path: [{ name: 'Styled(View)' }],
       },
       level: 'info' as SeverityLevel,
       message: 'Touch event within element: Styled(View)',
       type: defaultProps.breadcrumbType,
     });
   });
 
-  it('maxComponentTreeSize', () => {
+  it('maxpathSize', () => {
     const { defaultProps } = TouchEventBoundary;
     const boundary = new TouchEventBoundary({
       ...defaultProps,
@@ -210,11 +210,73 @@ describe('TouchEventBoundary._onTouchStart', () => {
     expect(addBreadcrumb).toBeCalledWith({
       category: defaultProps.breadcrumbCategory,
       data: {
-        componentTree: ['Connect(View)', 'Styled(View)'],
+        path: [{ label: 'Connect(View)' }, { name: 'Styled(View)' }],
       },
       level: 'info' as SeverityLevel,
       message: 'Touch event within element: Connect(View)',
       type: defaultProps.breadcrumbType,
     });
   });
+
+  // see https://docs.sentry.io/platforms/javascript/guides/react/features/component-names/
+  it('uses custom names provided by babel plugin', () => {
+    const { defaultProps } = TouchEventBoundary;
+    const boundary = new TouchEventBoundary(defaultProps);
+
+    const event = {
+      _targetInst: {
+        elementType: {
+          displayName: 'View',
+        },
+        memoizedProps: {
+          'data-sentry-component': 'Screen',
+          'data-sentry-element': 'AnimatedNativeScreen',
+          'data-sentry-source-file': 'screen.tsx',
+        },
+        return: {
+          elementType: {
+            displayName: 'Text',
+          },
+          return: {
+            memoizedProps: {
+              'custom-sentry-label-name': 'Connect(View)',
+              'data-sentry-component': 'MyView',
+              'data-sentry-source-file': 'myview.tsx',
+            },
+            return: {
+              elementType: {
+                displayName: 'Styled(View)',
+              },
+              return: {
+                memoizedProps: {
+                  'data-sentry-component': 'Happy',
+                  'data-sentry-element': 'View',
+                  'data-sentry-source-file': 'happyview.js',
+                },
+              },
+            },
+          },
+        },
+      },
+    };
+
+    // @ts-expect-error Calling private member
+    boundary._onTouchStart(event);
+
+    expect(addBreadcrumb).toBeCalledWith({
+      category: defaultProps.breadcrumbCategory,
+      data: {
+        path: [
+          { element: 'AnimatedNativeScreen', file: 'screen.tsx', name: 'Screen' },
+          { name: 'Text' },
+          { file: 'myview.tsx', name: 'MyView' },
+          { name: 'Styled(View)' },
+          { element: 'View', file: 'happyview.js', name: 'Happy' },
+        ],
+      },
+      level: 'info' as SeverityLevel,
+      message: 'Touch event within element: Screen (screen.tsx)',
+      type: defaultProps.breadcrumbType,
+    });
+  });
 });
