feat: Track major version for Vite and Rollup (#867)

* feat: Track major version for Vite and Rollup

* Fix types

Author: timfish

package.json

@@ -37,6 +37,6 @@
   },
   "volta": {
     "node": "18.20.8",
-    "yarn": "1.22.19"
+    "yarn": "1.22.22"
   }
 }

packages/bundler-plugin-core/src/build-plugin-manager.ts

@@ -124,6 +124,10 @@ export function createSentryBuildPluginManager(
      * E.g. `webpack` or `nextjs` or `turbopack`
      */
     buildTool: string;
+    /**
+     * E.g. `5` for webpack v5 or `4` for Rollup v4
+     */
+    buildToolMajorVersion?: string;
     /**
      * E.g. `[sentry-webpack-plugin]` or `[@sentry/nextjs]`
      */
@@ -195,7 +199,8 @@ export function createSentryBuildPluginManager(
   const { sentryScope, sentryClient } = createSentryInstance(
     options,
     shouldSendTelemetry,
-    bundlerPluginMetaContext.buildTool
+    bundlerPluginMetaContext.buildTool,
+    bundlerPluginMetaContext.buildToolMajorVersion
   );
 
   const { release, environment = DEFAULT_ENVIRONMENT } = sentryClient.getOptions();

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

@@ -47,6 +47,7 @@ interface SentryUnpluginFactoryOptions {
     webpack_forceExitOnBuildComplete?: boolean
   ) => UnpluginOptions;
   bundleSizeOptimizationsPlugin: (buildFlags: SentrySDKBuildFlags) => UnpluginOptions;
+  getBundlerMajorVersion?: () => string | undefined;
 }
 
 /**
@@ -57,13 +58,15 @@ export function sentryUnpluginFactory({
   componentNameAnnotatePlugin,
   debugIdUploadPlugin,
   bundleSizeOptimizationsPlugin,
+  getBundlerMajorVersion,
 }: SentryUnpluginFactoryOptions): UnpluginInstance<Options | undefined, true> {
   return createUnplugin<Options | undefined, true>((userOptions = {}, unpluginMetaContext) => {
     const sentryBuildPluginManager = createSentryBuildPluginManager(userOptions, {
       loggerPrefix:
         userOptions._metaOptions?.loggerPrefixOverride ??
         `[sentry-${unpluginMetaContext.framework}-plugin]`,
       buildTool: unpluginMetaContext.framework,
+      buildToolMajorVersion: getBundlerMajorVersion?.(),
     });
 
     const {

packages/bundler-plugin-core/src/options-mapping.ts

@@ -76,7 +76,6 @@ export type NormalizedOptions = {
   _metaOptions: {
     telemetry: {
       metaFramework: string | undefined;
-      bundlerMajorVersion: string | undefined;
     };
   };
   applicationKey: string | undefined;

packages/bundler-plugin-core/src/sentry/telemetry.ts

@@ -14,7 +14,8 @@ const stackParser = createStackParser(nodeStackLineParser());
 export function createSentryInstance(
   options: NormalizedOptions,
   shouldSendTelemetry: Promise<boolean>,
-  buildTool: string
+  buildTool: string,
+  buildToolMajorVersion: string | undefined
 ): { sentryScope: Scope; sentryClient: Client } {
   const clientOptions: ServerRuntimeClientOptions = {
     platform: "node",
@@ -56,15 +57,16 @@ export function createSentryInstance(
   const scope = new Scope();
   scope.setClient(client);
 
-  setTelemetryDataOnScope(options, scope, buildTool);
+  setTelemetryDataOnScope(options, scope, buildTool, buildToolMajorVersion);
 
   return { sentryScope: scope, sentryClient: client };
 }
 
 export function setTelemetryDataOnScope(
   options: NormalizedOptions,
   scope: Scope,
-  buildTool: string
+  buildTool: string,
+  buildToolMajorVersion?: string
 ): void {
   const { org, project, release, errorHandler, sourcemaps, reactComponentAnnotation } = options;
 
@@ -111,7 +113,9 @@ export function setTelemetryDataOnScope(
     bundler: buildTool,
   });
 
-  scope.setTag("bundler-major-version", options._metaOptions.telemetry.bundlerMajorVersion);
+  if (buildToolMajorVersion) {
+    scope.setTag("bundler-major-version", buildToolMajorVersion);
+  }
 
   scope.setUser({ id: org });
 }

packages/integration-tests/fixtures/telemetry/telemetry.test.ts

@@ -112,6 +112,7 @@ test("rollup bundle telemetry", async () => {
                 "react-annotate": false,
                 "meta-framework": "none",
                 "application-key-set": false,
+                "bundler-major-version": "2",
                 bundler: "rollup",
               }),
               sdk: expect.objectContaining({

packages/integration-tests/jest.config.js

@@ -3,4 +3,5 @@ module.exports = {
   transform: {
     "^.+\\.(t|j)sx?$": ["@swc/jest"],
   },
+  transformIgnorePatterns: ["!node_modules/"],
 };

packages/rollup-plugin/src/index.ts

@@ -9,6 +9,7 @@ import {
   createComponentNameAnnotateHooks,
   Logger,
 } from "@sentry/bundler-plugin-core";
+import { createRequire } from "node:module";
 import type { UnpluginOptions } from "unplugin";
 
 function rollupComponentNameAnnotatePlugin(
@@ -48,11 +49,26 @@ function rollupBundleSizeOptimizationsPlugin(
   };
 }
 
+function getRollupMajorVersion(): string | undefined {
+  try {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - Rollup already transpiles this for us
+    const req = createRequire(import.meta.url);
+    const rollup = req("rollup") as { VERSION?: string };
+    return rollup.VERSION?.split(".")[0];
+  } catch (err) {
+    // do nothing, we'll just not report a version
+  }
+
+  return undefined;
+}
+
 const sentryUnplugin = sentryUnpluginFactory({
   injectionPlugin: rollupInjectionPlugin,
   componentNameAnnotatePlugin: rollupComponentNameAnnotatePlugin,
   debugIdUploadPlugin: rollupDebugIdUploadPlugin,
   bundleSizeOptimizationsPlugin: rollupBundleSizeOptimizationsPlugin,
+  getBundlerMajorVersion: getRollupMajorVersion,
 });
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages/vite-plugin/src/index.ts

@@ -9,6 +9,7 @@ import {
   createComponentNameAnnotateHooks,
   Logger,
 } from "@sentry/bundler-plugin-core";
+import { createRequire } from "node:module";
 import { UnpluginOptions, VitePlugin } from "unplugin";
 
 function viteInjectionPlugin(injectionCode: CodeInjection, debugIds: boolean): UnpluginOptions {
@@ -52,11 +53,26 @@ function viteBundleSizeOptimizationsPlugin(
   };
 }
 
+function getViteMajorVersion(): string | undefined {
+  try {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - Rollup already transpiles this for us
+    const req = createRequire(import.meta.url);
+    const vite = req("vite") as { version?: string };
+    return vite.version?.split(".")[0];
+  } catch (err) {
+    // do nothing, we'll just not report a version
+  }
+
+  return undefined;
+}
+
 const sentryUnplugin = sentryUnpluginFactory({
   injectionPlugin: viteInjectionPlugin,
   componentNameAnnotatePlugin: viteComponentNameAnnotatePlugin,
   debugIdUploadPlugin: viteDebugIdUploadPlugin,
   bundleSizeOptimizationsPlugin: viteBundleSizeOptimizationsPlugin,
+  getBundlerMajorVersion: getViteMajorVersion,
 });
 
 export const sentryVitePlugin = (options?: Options): VitePlugin[] => {

packages/webpack-plugin/src/index.ts

@@ -8,42 +8,14 @@ const BannerPlugin = webpack4or5?.BannerPlugin || webpack4or5?.default?.BannerPl
 
 const DefinePlugin = webpack4or5?.DefinePlugin || webpack4or5?.default?.DefinePlugin;
 
-// Detect webpack major version for telemetry (helps differentiate webpack 4 vs 5 usage)
-function getWebpackMajorVersion(): string | undefined {
-  try {
-    const webpack = webpack4or5 as unknown as
-      | { version?: string; default?: { version?: string } }
-      | undefined;
-    const version = webpack?.version ?? webpack?.default?.version;
-    const webpackMajorVersion = version?.split(".")[0]; // "4" or "5"
-    return webpackMajorVersion;
-  } catch (error) {
-    return undefined;
-  }
-}
-
-const webpackMajorVersion = getWebpackMajorVersion();
-
 const sentryUnplugin = sentryWebpackUnpluginFactory({
   BannerPlugin,
   DefinePlugin,
 });
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const sentryWebpackPlugin: (options?: SentryWebpackPluginOptions) => any = (options) => {
-  const enhancedOptions: SentryWebpackPluginOptions = {
-    ...options,
-    _metaOptions: {
-      ...options?._metaOptions,
-      telemetry: {
-        ...options?._metaOptions?.telemetry,
-        bundlerMajorVersion:
-          options?._metaOptions?.telemetry?.bundlerMajorVersion ?? webpackMajorVersion,
-      },
-    },
-  };
-  return sentryUnplugin.webpack(enhancedOptions);
-};
+export const sentryWebpackPlugin: (options?: SentryWebpackPluginOptions) => any =
+  sentryUnplugin.webpack;
 
 export { sentryCliBinaryExists } from "@sentry/bundler-plugin-core";