feat: Allow passing of meta-framework as telemetry data (#539)

getsentry · May 31, 2024 · 45c7f1c · 45c7f1c
1 parent f22747b
commit 45c7f1c
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 0 deletions.
diff --git a/packages/bundler-plugin-core/src/options-mapping.ts b/packages/bundler-plugin-core/src/options-mapping.ts
@@ -29,6 +29,11 @@ export function normalizeUserOptions(userOptions: UserOptions) {
     },
     bundleSizeOptimizations: userOptions.bundleSizeOptimizations,
     reactComponentAnnotation: userOptions.reactComponentAnnotation,
+    _metaOptions: {
+      telemetry: {
+        metaFramework: userOptions._metaOptions?.telemetry?.metaFramework,
+      },
+    },
     moduleMetadata: userOptions.moduleMetadata || userOptions._experiments?.moduleMetadata,
     _experiments: userOptions._experiments ?? {},
   };

diff --git a/packages/bundler-plugin-core/src/sentry/telemetry.ts b/packages/bundler-plugin-core/src/sentry/telemetry.ts
@@ -95,6 +95,8 @@ export function setTelemetryDataOnHub(options: NormalizedOptions, hub: Hub, bund
   hub.setTag("node", process.version);
   hub.setTag("platform", process.platform);
 
+  hub.setTag("meta-framework", options._metaOptions.telemetry.metaFramework ?? "none");
+
   hub.setTags({
     organization: org,
     project,

diff --git a/packages/bundler-plugin-core/src/types.ts b/packages/bundler-plugin-core/src/types.ts
@@ -358,6 +358,16 @@ export interface Options {
      * Example value: `[sentry-webpack-plugin (client)]`
      */
     loggerPrefixOverride?: string;
+
+    /**
+     * Arbitrary telemetry items.
+     */
+    telemetry?: {
+      /**
+       * The meta framework using the plugin.
+       */
+      metaFramework?: string;
+    };
   };
 }
 

diff --git a/packages/bundler-plugin-core/test/option-mappings.test.ts b/packages/bundler-plugin-core/test/option-mappings.test.ts
@@ -27,6 +27,11 @@ describe("normalizeUserOptions()", () => {
       silent: false,
       telemetry: true,
       _experiments: {},
+      _metaOptions: {
+        telemetry: {
+          metaFramework: undefined,
+        },
+      },
       url: "https://sentry.io",
     });
   });
@@ -73,6 +78,11 @@ describe("normalizeUserOptions()", () => {
       silent: false,
       telemetry: true,
       _experiments: {},
+      _metaOptions: {
+        telemetry: {
+          metaFramework: undefined,
+        },
+      },
       url: "https://sentry.io",
     });
   });