remove support for ignoreFiles for now but add support for ignoreComponents

Author: 0Calories

packages/babel-plugin-component-annotate/src/index.ts

@@ -48,15 +48,13 @@ const nativeSourceFileName = "dataSentrySourceFile";
 interface AnnotationOpts {
   native?: boolean;
   "annotate-fragments"?: boolean;
-  ignoreComponents?: IgnoredComponent[];
+  ignoreComponents?: string[];
 }
 
 interface AnnotationPluginPass extends PluginPass {
   opts: AnnotationOpts;
 }
 
-type IgnoredComponent = [file: string, component: string, element: string];
-
 type AnnotationPlugin = PluginObj<AnnotationPluginPass>;
 
 // We must export the plugin as default, otherwise the Babel loader will not be able to resolve it when configured using its string identifier
@@ -152,7 +150,7 @@ function functionBodyPushAttributes(
   componentName: string,
   sourceFileName: string | undefined,
   attributeNames: string[],
-  ignoredComponents: IgnoredComponent[]
+  ignoredComponents: string[]
 ) {
   let jsxNode: Babel.NodePath;
 
@@ -218,7 +216,7 @@ function processJSX(
   componentName: string | null,
   sourceFileName: string | undefined,
   attributeNames: string[],
-  ignoredComponents: IgnoredComponent[]
+  ignoredComponents: string[]
 ) {
   if (!jsxNode) {
     return;
@@ -294,7 +292,7 @@ function applyAttributes(
   componentName: string | null,
   sourceFileName: string | undefined,
   attributeNames: string[],
-  ignoredComponents: IgnoredComponent[]
+  ignoredComponents: string[]
 ) {
   const [componentAttributeName, elementAttributeName, sourceFileAttributeName] = attributeNames;
 
@@ -310,10 +308,7 @@ function applyAttributes(
   const elementName = getPathName(t, openingElement);
 
   const isAnIgnoredComponent = ignoredComponents.some(
-    (ignoredComponent) =>
-      matchesIgnoreRule(ignoredComponent[0], sourceFileName) &&
-      matchesIgnoreRule(ignoredComponent[1], componentName) &&
-      matchesIgnoreRule(ignoredComponent[2], elementName)
+    (ignoredComponent) => ignoredComponent === componentName || ignoredComponent === elementName
   );
 
   // Add a stable attribute for the element name but only for non-DOM names

packages/bundler-plugin-core/src/index.ts

@@ -29,10 +29,7 @@ import { fileDeletionPlugin } from "./plugins/sourcemap-deletion";
 
 interface SentryUnpluginFactoryOptions {
   releaseInjectionPlugin: (injectionCode: string) => UnpluginOptions;
-  componentNameAnnotatePlugin?: (
-    ignoredFiles?: string[],
-    ignoredComponents?: string[]
-  ) => UnpluginOptions;
+  componentNameAnnotatePlugin?: (ignoreComponents?: string[]) => UnpluginOptions;
   moduleMetadataInjectionPlugin: (injectionCode: string) => UnpluginOptions;
   debugIdInjectionPlugin: (logger: Logger) => UnpluginOptions;
   debugIdUploadPlugin: (upload: (buildArtifacts: string[]) => Promise<void>) => UnpluginOptions;
@@ -404,10 +401,7 @@ export function sentryUnpluginFactory({
       } else {
         componentNameAnnotatePlugin &&
           plugins.push(
-            componentNameAnnotatePlugin(
-              options.reactComponentAnnotation.ignoredFiles,
-              options.reactComponentAnnotation.ignoredComponents
-            )
+            componentNameAnnotatePlugin(options.reactComponentAnnotation.ignoreComponents)
           );
       }
     }
@@ -619,10 +613,7 @@ export function createRollupDebugIdUploadHooks(
   };
 }
 
-export function createComponentNameAnnotateHooks(
-  ignoredFiles?: string[],
-  ignoredComponents?: string[]
-) {
+export function createComponentNameAnnotateHooks(ignoreComponents?: string[]) {
   type ParserPlugins = NonNullable<
     NonNullable<Parameters<typeof transformAsync>[1]>["parserOpts"]
   >["plugins"];
@@ -641,17 +632,6 @@ export function createComponentNameAnnotateHooks(
         return null;
       }
 
-      console.log("ignored files:");
-      console.dir(ignoredFiles);
-      console.log("current file:");
-      console.log(idWithoutQueryAndHash);
-
-      const isIgnoredFile = ignoredFiles?.some((file) => idWithoutQueryAndHash.endsWith(file));
-      if (isIgnoredFile) {
-        console.log(`FOUND IGNORED FILE: ${idWithoutQueryAndHash}`);
-        return null;
-      }
-
       const parserPlugins: ParserPlugins = [];
       if (idWithoutQueryAndHash.endsWith(".jsx")) {
         parserPlugins.push("jsx");
@@ -661,7 +641,7 @@ export function createComponentNameAnnotateHooks(
 
       try {
         const result = await transformAsync(code, {
-          plugins: [[componentNameAnnotatePlugin]],
+          plugins: [[componentNameAnnotatePlugin, { ignoreComponents }]],
           filename: id,
           parserOpts: {
             sourceType: "module",

packages/bundler-plugin-core/src/types.ts

@@ -303,13 +303,14 @@ export interface Options {
      */
     enabled?: boolean;
     /**
-     * A list of strings representing local paths to files to ignore. The plugin will not perform any annotations on components in these files
+     * A list of strings representing the names of components to ignore. The plugin will not perform any annotations on these components
      */
-    ignoredFiles?: string[];
+    ignoreComponents?: string[];
+    // TODO: Support this option in the future
     /**
-     * A list of strings representing the names of components to ignore. The plugin will not perform any annotations on these components
+     * A list of strings representing local paths to files to ignore. The plugin will not perform any annotations on components in these files
      */
-    ignoredComponents?: string[];
+    // ignoreFiles?: string[];
   };
 
   /**

packages/dev-utils/src/generate-documentation-table.ts

@@ -360,19 +360,20 @@ type IncludeEntry = {
         supportedBundlers: ["webpack", "vite", "rollup"],
       },
       {
-        name: "ignoredFiles",
+        name: "ignoreComponents",
         type: "string[]",
         fullDescription:
-          "A list of strings representing local paths to files to ignore. The plugin will not perform any annotations on components in these files.",
-        supportedBundlers: ["webpack", "vite", "rollup"],
-      },
-      {
-        name: "ignoredComponents",
-        type: "string[]",
-        fullDescription:
-          "A list of strings representing the names of components to ignore. The plugin will not perform any annotations on these components.",
+          "A list of strings representing the names of components to ignore. The plugin will not perform apply `data-sentry` annotations on the DOM element for this component.",
         supportedBundlers: ["webpack", "vite", "rollup"],
       },
+      // TODO: Support this option in the future
+      // {
+      //   name: "ignoreFiles",
+      //   type: "string[]",
+      //   fullDescription:
+      //     "A list of strings representing local paths to files to ignore. The plugin will not perform any annotations on components in these files.",
+      //   supportedBundlers: ["webpack", "vite", "rollup"],
+      // },
     ],
   },
   {

packages/rollup-plugin/src/index.ts

@@ -18,13 +18,10 @@ function rollupReleaseInjectionPlugin(injectionCode: string): UnpluginOptions {
   };
 }
 
-function rollupComponentNameAnnotatePlugin(
-  ignoredFiles?: string[],
-  ignoredComponents?: string[]
-): UnpluginOptions {
+function rollupComponentNameAnnotatePlugin(ignoreComponents?: string[]): UnpluginOptions {
   return {
     name: "sentry-rollup-component-name-annotate-plugin",
-    rollup: createComponentNameAnnotateHooks(ignoredFiles, ignoredComponents),
+    rollup: createComponentNameAnnotateHooks(ignoreComponents),
   };
 }
 

packages/vite-plugin/src/index.ts

@@ -19,14 +19,11 @@ function viteReleaseInjectionPlugin(injectionCode: string): UnpluginOptions {
   };
 }
 
-function viteComponentNameAnnotatePlugin(
-  ignoredFiles?: string[],
-  ignoredComponents?: string[]
-): UnpluginOptions {
+function viteComponentNameAnnotatePlugin(ignoreComponents?: string[]): UnpluginOptions {
   return {
     name: "sentry-vite-component-name-annotate-plugin",
     enforce: "pre" as const,
-    vite: createComponentNameAnnotateHooks(ignoredFiles, ignoredComponents),
+    vite: createComponentNameAnnotateHooks(ignoreComponents),
   };
 }
 

packages/webpack-plugin/src/index.ts

@@ -47,18 +47,15 @@ function webpackReleaseInjectionPlugin(injectionCode: string): UnpluginOptions {
   };
 }
 
-function webpackComponentNameAnnotatePlugin(
-  ignoredFiles?: string[],
-  ignoredComponents?: string[]
-): UnpluginOptions {
+function webpackComponentNameAnnotatePlugin(ignoreComponents?: string[]): UnpluginOptions {
   return {
     name: "sentry-webpack-component-name-annotate-plugin",
     enforce: "pre",
     // Webpack needs this hook for loader logic, so the plugin is not run on unsupported file types
     transformInclude(id) {
       return id.endsWith(".tsx") || id.endsWith(".jsx");
     },
-    transform: createComponentNameAnnotateHooks(ignoredFiles, ignoredComponents).transform,
+    transform: createComponentNameAnnotateHooks(ignoreComponents).transform,
   };
 }