feat: Add Sentry to the bundler plugins (#224)

Author: nsdeschenes

.changeset/green-goats-thank.md

@@ -0,0 +1,15 @@
+---
+"@codecov/nextjs-webpack-plugin": minor
+"@codecov/bundler-plugin-core": minor
+"@codecov/remix-vite-plugin": minor
+"@codecov/solidstart-plugin": minor
+"@codecov/sveltekit-plugin": minor
+"@codecov/webpack-plugin": minor
+"@codecov/rollup-plugin": minor
+"@codecov/astro-plugin": minor
+"@codecov/nuxt-plugin": minor
+"@codecov/vite-plugin": minor
+"@codecov/bundle-analyzer": minor
+---
+
+Add Sentry to the bundler plugins to start collecting issues and telemetry

.changeset/wise-toys-hug.md

@@ -0,0 +1,14 @@
+---
+"@codecov/nextjs-webpack-plugin": patch
+"@codecov/bundler-plugin-core": patch
+"@codecov/remix-vite-plugin": patch
+"@codecov/solidstart-plugin": patch
+"@codecov/sveltekit-plugin": patch
+"@codecov/webpack-plugin": patch
+"@codecov/rollup-plugin": patch
+"@codecov/astro-plugin": patch
+"@codecov/nuxt-plugin": patch
+"@codecov/vite-plugin": patch
+---
+
+Fix issue not using the correct webpack in the nextjs plugin

integration-tests/fixtures/generate-bundle-stats/astro/astro-base.config.mjs

@@ -26,6 +26,7 @@ export default defineConfig({
       bundleName: "test-astro-v4",
       uploadToken: "test-token",
       apiUrl: process.env.API_URL,
+      telemetry: false,
     }),
   ],
 });

integration-tests/fixtures/generate-bundle-stats/nextjs/next-base.config.mjs

@@ -10,6 +10,7 @@ export default {
         uploadToken: "test-token",
         apiUrl: process.env.API_URL,
         webpack: options.webpack,
+        telemetry: false,
         debug: true,
       }),
     );

integration-tests/fixtures/generate-bundle-stats/nuxt/nuxt-base.config.ts

@@ -11,6 +11,7 @@ const config: ReturnType<typeof defineNuxtConfig> = defineNuxtConfig({
         bundleName: "test-nuxt-v3",
         uploadToken: "test-token",
         apiUrl: process.env.API_URL,
+        telemetry: false,
       },
     ],
   ],

integration-tests/fixtures/generate-bundle-stats/remix/vite-base.config.ts

@@ -26,6 +26,7 @@ export default defineConfig({
       bundleName: "test-remix-v2",
       uploadToken: "test-token",
       apiUrl: process.env.API_URL,
+      telemetry: false,
     }),
   ],
 });

integration-tests/fixtures/generate-bundle-stats/rollup/rollup-base.config.cjs

@@ -22,6 +22,7 @@ module.exports = defineConfig({
       bundleName: "test-rollup-v3",
       uploadToken: "test-token",
       apiUrl: process.env.API_URL,
+      telemetry: false,
     }),
   ],
 });

integration-tests/fixtures/generate-bundle-stats/solidstart/app-base.config.ts

@@ -22,6 +22,7 @@ export default defineConfig({
         bundleName: "test-solidstart-v1",
         uploadToken: "test-token",
         apiUrl: process.env.API_URL,
+        telemetry: false,
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
       }) as any,
     ],

integration-tests/fixtures/generate-bundle-stats/sveltekit/vite-base.config.ts

@@ -22,6 +22,7 @@ export default defineConfig({
       bundleName: "test-sveltekit-v2",
       uploadToken: "test-token",
       apiUrl: process.env.API_URL,
+      telemetry: false,
     }),
   ],
 });

integration-tests/fixtures/generate-bundle-stats/vite/vite-base.config.ts

@@ -24,6 +24,7 @@ export default defineConfig({
       bundleName: "test-vite-v5",
       uploadToken: "test-token",
       apiUrl: process.env.API_URL,
+      telemetry: false,
     }),
   ],
 });

integration-tests/fixtures/generate-bundle-stats/webpack/webpack-base.config.cjs

@@ -19,6 +19,7 @@ module.exports = {
       bundleName: "test-webpack-v5",
       uploadToken: "test-token",
       apiUrl: process.env.API_URL,
+      telemetry: false,
     }),
   ],
 };

packages/astro-plugin/src/astro-bundle-analysis/__tests__/astroBundleAnalysisPlugin.test.ts

@@ -2,6 +2,11 @@ import { Output } from "@codecov/bundler-plugin-core";
 import { describe, it, expect } from "vitest";
 import { astroBundleAnalysisPlugin } from "../astroBundleAnalysisPlugin";
 
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_NAME = __PACKAGE_NAME__ as string;
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
+
 describe("astroBundleAnalysisPlugin", () => {
   describe("when called", () => {
     it("returns a plugin object", () => {
@@ -15,7 +20,10 @@ describe("astroBundleAnalysisPlugin", () => {
           enableBundleAnalysis: true,
           retryCount: 1,
           uploadToken: "test-token",
+          telemetry: false,
         }),
+        pluginName: PLUGIN_NAME,
+        pluginVersion: PLUGIN_VERSION,
       });
 
       expect(plugin).toMatchSnapshot();

packages/astro-plugin/src/astro-bundle-analysis/astroBundleAnalysisPlugin.ts

@@ -5,11 +5,6 @@ import {
 } from "@codecov/bundler-plugin-core";
 import { getBundleName } from "./getBundleName";
 
-// @ts-expect-error this value is being replaced by rollup
-const PLUGIN_NAME = __PACKAGE_NAME__ as string;
-// @ts-expect-error this value is being replaced by rollup
-const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
-
 interface AstroBundleAnalysisArgs extends BundleAnalysisUploadPluginArgs {
   target: "client" | "server";
 }
@@ -21,10 +16,12 @@ type AstroBundleAnalysisPlugin = (
 export const astroBundleAnalysisPlugin: AstroBundleAnalysisPlugin = ({
   output,
   target,
+  pluginName,
+  pluginVersion,
 }) => ({
   version: output.version,
-  name: PLUGIN_NAME,
-  pluginVersion: PLUGIN_VERSION,
+  name: pluginName,
+  pluginVersion,
   vite: {
     generateBundle(this, options) {
       // TODO - remove this once we hard fail on not having a bundle name
@@ -46,7 +43,7 @@ export const astroBundleAnalysisPlugin: AstroBundleAnalysisPlugin = ({
       output.lockBundleName();
 
       // manually set this to avoid resetting in the vite plugin
-      output.setPlugin(PLUGIN_NAME, PLUGIN_VERSION);
+      output.setPlugin(pluginName, pluginVersion);
     },
   },
 });

packages/astro-plugin/src/index.ts

@@ -5,15 +5,19 @@ import {
   checkNodeVersion,
   Output,
   handleErrors,
+  createSentryInstance,
+  telemetryPlugin,
 } from "@codecov/bundler-plugin-core";
 import { _internal_viteBundleAnalysisPlugin } from "@codecov/vite-plugin";
 import { type AstroIntegration } from "astro";
 import { type PluginOption } from "vite";
 
 import { astroBundleAnalysisPlugin } from "./astro-bundle-analysis/astroBundleAnalysisPlugin";
 
-// @ts-expect-error - This is a placeholder for the package name.
+// @ts-expect-error this value is being replaced by rollup
 const PLUGIN_NAME = __PACKAGE_NAME__ as string;
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
 
 interface AstroPluginFactoryOptions extends Options {
   // type can be found from the AstroIntegration type
@@ -37,12 +41,35 @@ const astroPluginFactory = createVitePlugin<AstroPluginFactoryOptions, true>(
     }
 
     const plugins: UnpluginOptions[] = [];
-    const output = new Output(normalizedOptions.options);
     const options = normalizedOptions.options;
+    const sentryConfig = createSentryInstance({
+      telemetry: options.telemetry,
+      isDryRun: options.dryRun,
+      pluginName: PLUGIN_NAME,
+      pluginVersion: PLUGIN_VERSION,
+      options,
+      bundler: unpluginMetaContext.framework,
+      metaFramework: "astro",
+    });
+    const output = new Output(options, sentryConfig);
     if (options.enableBundleAnalysis) {
       plugins.push(
-        astroBundleAnalysisPlugin({ output, target }),
-        _internal_viteBundleAnalysisPlugin({ output }),
+        telemetryPlugin({
+          sentryClient: sentryConfig.sentryClient,
+          sentryScope: sentryConfig.sentryScope,
+          telemetry: options.telemetry,
+        }),
+        astroBundleAnalysisPlugin({
+          output,
+          target,
+          pluginName: PLUGIN_NAME,
+          pluginVersion: PLUGIN_VERSION,
+        }),
+        _internal_viteBundleAnalysisPlugin({
+          output,
+          pluginName: PLUGIN_NAME,
+          pluginVersion: PLUGIN_VERSION,
+        }),
       );
     }
 

packages/bundler-plugin-core/package.json

@@ -41,6 +41,7 @@
   "dependencies": {
     "@actions/core": "^1.10.1",
     "@actions/github": "^6.0.0",
+    "@sentry/core": "^8.42.0",
     "chalk": "4.1.2",
     "semver": "^7.5.4",
     "unplugin": "^1.10.1",

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

@@ -1,3 +1,4 @@
+import { type Client, type Scope } from "@sentry/core";
 import {
   type Asset,
   type BundleAnalysisUploadPlugin,
@@ -22,6 +23,12 @@ import {
   Output,
   red,
 } from "./utils";
+import {
+  createSentryInstance,
+  telemetryPlugin,
+  safeFlushTelemetry,
+  setTelemetryDataOnScope,
+} from "./sentry/telemetry.ts";
 
 export type {
   Asset,
@@ -36,6 +43,8 @@ export type {
   NormalizedOptions,
   ProviderUtilInputs,
   UploadOverrides,
+  Client as SentryClient,
+  Scope as SentryScope,
 };
 
 export {
@@ -47,4 +56,8 @@ export {
   normalizePath,
   Output,
   red,
+  createSentryInstance,
+  telemetryPlugin,
+  safeFlushTelemetry,
+  setTelemetryDataOnScope,
 };