feat(bundler): Add Node bundler plugins (#22125)

This PR adds Node.js specific bundler plugins that can be accessed
directly as named exports on the `@sentry/node` package.

- `@sentry/node/vite`
- `@sentry/node/rollup`
- `@sentry/node/webpack`
- `@sentry/node/esbuild`

These essentially combine the regular Sentry bundler plugins (debug ids
+ sourcemap upload) with the orchestrion injection plugins including all
the default instrumentations. Framework SDKs can use these and
optionally pass down additional instrumentations but this option is
hidden in the jsdocs.

Author: timfish

packages/node/package.json

@@ -52,12 +52,64 @@
       "require": {
         "default": "./build/cjs/preload.js"
       }
+    },
+    "./vite": {
+      "import": {
+        "types": "./build/types/bundler-plugin/vite.d.ts",
+        "default": "./build/esm/bundler-plugin/vite.js"
+      },
+      "require": {
+        "types": "./build/types/bundler-plugin/vite.d.ts",
+        "default": "./build/cjs/bundler-plugin/vite.js"
+      }
+    },
+    "./rollup": {
+      "import": {
+        "types": "./build/types/bundler-plugin/rollup.d.ts",
+        "default": "./build/esm/bundler-plugin/rollup.js"
+      },
+      "require": {
+        "types": "./build/types/bundler-plugin/rollup.d.ts",
+        "default": "./build/cjs/bundler-plugin/rollup.js"
+      }
+    },
+    "./webpack": {
+      "import": {
+        "types": "./build/types/bundler-plugin/webpack.d.ts",
+        "default": "./build/esm/bundler-plugin/webpack.js"
+      },
+      "require": {
+        "types": "./build/types/bundler-plugin/webpack.d.ts",
+        "default": "./build/cjs/bundler-plugin/webpack.js"
+      }
+    },
+    "./esbuild": {
+      "import": {
+        "types": "./build/types/bundler-plugin/esbuild.d.ts",
+        "default": "./build/esm/bundler-plugin/esbuild.js"
+      },
+      "require": {
+        "types": "./build/types/bundler-plugin/esbuild.d.ts",
+        "default": "./build/cjs/bundler-plugin/esbuild.js"
+      }
     }
   },
   "typesVersions": {
     "<5.0": {
       "build/types/index.d.ts": [
         "build/types-ts3.8/index.d.ts"
+      ],
+      "vite": [
+        "build/types-ts3.8/bundler-plugin/vite.d.ts"
+      ],
+      "rollup": [
+        "build/types-ts3.8/bundler-plugin/rollup.d.ts"
+      ],
+      "webpack": [
+        "build/types-ts3.8/bundler-plugin/webpack.d.ts"
+      ],
+      "esbuild": [
+        "build/types-ts3.8/bundler-plugin/esbuild.d.ts"
       ]
     }
   },
@@ -73,6 +125,7 @@
     "@sentry/node-core": "10.67.0",
     "@sentry/opentelemetry": "10.67.0",
     "@sentry/server-utils": "10.67.0",
+    "@sentry/bundler-plugins": "10.67.0",
     "import-in-the-middle": "^3.0.0"
   },
   "devDependencies": {

packages/node/rollup.npm.config.mjs

@@ -9,7 +9,17 @@ export default [
   ...makeOtelLoaders('./build', 'otel', { injectDiagnosticsChannel: true }),
   ...makeNPMConfigVariants(
     makeBaseNPMConfig({
-      entrypoints: ['src/index.ts', 'src/init.ts', 'src/preload.ts'],
+      entrypoints: [
+        'src/index.ts',
+        'src/init.ts',
+        'src/preload.ts',
+        // Combined Sentry bundler plugins + orchestrion code transform, exposed
+        // via the `@sentry/node/{vite,rollup,webpack,esbuild}` subpath exports.
+        'src/bundler-plugin/vite.ts',
+        'src/bundler-plugin/rollup.ts',
+        'src/bundler-plugin/webpack.ts',
+        'src/bundler-plugin/esbuild.ts',
+      ],
       packageSpecificConfig: {
         external: [/^@sentry\/opentelemetry/],
         output: {

packages/node/src/bundler-plugin/esbuild.ts

@@ -0,0 +1,39 @@
+import { sentryEsbuildPlugin as sentryEsbuildBundlerPlugin } from '@sentry/bundler-plugins/esbuild';
+import type { SentryEsbuildPluginOptions as SentryEsbuildPluginOptionsBase } from '@sentry/bundler-plugins/esbuild';
+import { sentryOrchestrionPlugin } from '@sentry/server-utils/orchestrion/esbuild';
+
+export type SentryEsbuildPluginOptions = SentryEsbuildPluginOptionsBase & {
+  /**
+   * @ignore This is for internal use only when this plugin is consumed by a framework SDK
+   */
+  instrumentations?: NonNullable<Parameters<typeof sentryOrchestrionPlugin>[0]>['instrumentations'];
+};
+
+type EsbuildPlugin = ReturnType<typeof sentryOrchestrionPlugin>;
+
+/**
+ * esbuild plugin that bundles the Sentry esbuild bundler plugin (source maps,
+ * release injection, …) together with the code transformer
+ * (build-time `diagnostics_channel` instrumentation for Node libraries).
+ *
+ * It is a drop-in replacement for `@sentry/bundler-plugins/esbuild` and accepts
+ * the same options.
+ * @example
+ * ```ts
+ * // build.mjs
+ * import { sentryEsbuildPlugin } from '@sentry/node/esbuild';
+ * await esbuild.build({ plugins: [sentryEsbuildPlugin({ org: '…', project: '…' })] });
+ * ```
+ */
+export function sentryEsbuildPlugin(options?: SentryEsbuildPluginOptions): EsbuildPlugin {
+  const bundlerPlugin = sentryEsbuildBundlerPlugin(options) as EsbuildPlugin;
+  const orchestrionPlugin = sentryOrchestrionPlugin(options);
+
+  return {
+    name: 'sentry-node-esbuild',
+    async setup(build): Promise<void> {
+      await bundlerPlugin.setup(build);
+      await orchestrionPlugin.setup(build);
+    },
+  };
+}

packages/node/src/bundler-plugin/rollup.ts

@@ -0,0 +1,31 @@
+import { sentryRollupPlugin as sentryRollupBundlerPlugin } from '@sentry/bundler-plugins/rollup';
+import type { SentryRollupPluginOptions as SentryRollupPluginOptionsBase } from '@sentry/bundler-plugins/rollup';
+import { sentryOrchestrionPlugin } from '@sentry/server-utils/orchestrion/rollup';
+
+export type SentryRollupPluginOptions = SentryRollupPluginOptionsBase & {
+  /**
+   * @ignore This is for internal use only when this plugin is consumed by a framework SDK
+   */
+  instrumentations?: NonNullable<Parameters<typeof sentryOrchestrionPlugin>[0]>['instrumentations'];
+};
+
+type RollupPlugin = ReturnType<typeof sentryOrchestrionPlugin>;
+
+/**
+ * Rollup plugin that bundles the Sentry Rollup bundler plugin (source maps,
+ * release injection, bundle size optimizations, …) together with the
+ * code transformer (build-time `diagnostics_channel` instrumentation
+ * for Node libraries).
+ *
+ * It is a drop-in replacement for `@sentry/bundler-plugins/rollup` and accepts
+ * the same options.
+ * @example
+ * ```ts
+ * // rollup.config.js
+ * import { sentryRollupPlugin } from '@sentry/node/rollup';
+ * export default { plugins: [sentryRollupPlugin({ org: '…', project: '…' })] };
+ * ```
+ */
+export function sentryRollupPlugin(options?: SentryRollupPluginOptions): RollupPlugin[] {
+  return [...sentryRollupBundlerPlugin(options), sentryOrchestrionPlugin(options)];
+}

packages/node/src/bundler-plugin/vite.ts

@@ -0,0 +1,32 @@
+import { sentryVitePlugin as sentryViteBundlerPlugin } from '@sentry/bundler-plugins/vite';
+import type { SentryVitePluginOptions as SentryVitePluginOptionsBase } from '@sentry/bundler-plugins/vite';
+import { sentryOrchestrionPlugin } from '@sentry/server-utils/orchestrion/vite';
+
+export type SentryVitePluginOptions = SentryVitePluginOptionsBase & {
+  /**
+   * @ignore This is for internal use only when this plugin is consumed by a framework SDK
+   */
+  instrumentations?: NonNullable<Parameters<typeof sentryOrchestrionPlugin>[0]>['instrumentations'];
+};
+
+type VitePlugin = ReturnType<typeof sentryOrchestrionPlugin>;
+
+/**
+ * Vite plugin that bundles the Sentry Vite bundler plugin (source maps, release
+ * injection, bundle size optimizations, …) together with the code
+ * transformer (build-time `diagnostics_channel` instrumentation for Node
+ * libraries).
+ *
+ * It is a drop-in replacement for `@sentry/bundler-plugins/vite` and accepts the
+ * same options.
+ *
+ * @example
+ * ```ts
+ * // vite.config.ts
+ * import { sentryVitePlugin } from '@sentry/node/vite';
+ * export default { plugins: [sentryVitePlugin({ org: '…', project: '…' })] };
+ * ```
+ */
+export function sentryVitePlugin(options?: SentryVitePluginOptions): VitePlugin[] {
+  return [...sentryViteBundlerPlugin(options), sentryOrchestrionPlugin(options)];
+}

packages/node/src/bundler-plugin/webpack.ts

@@ -0,0 +1,40 @@
+import { sentryWebpackPlugin as sentryWebpackBundlerPlugin } from '@sentry/bundler-plugins/webpack';
+import type { SentryWebpackPluginOptions as SentryWebpackPluginOptionsBase } from '@sentry/bundler-plugins/webpack';
+import { sentryOrchestrionWebpackPlugin } from '@sentry/server-utils/orchestrion/webpack';
+
+export type SentryWebpackPluginOptions = SentryWebpackPluginOptionsBase & {
+  /**
+   * @ignore This is for internal use only when this plugin is consumed by a framework SDK
+   */
+  instrumentations?: NonNullable<Parameters<typeof sentryOrchestrionWebpackPlugin>[0]>['instrumentations'];
+};
+
+type WebpackCompiler = Parameters<ReturnType<typeof sentryWebpackBundlerPlugin>['apply']>[0];
+
+/**
+ * webpack plugin that bundles the Sentry webpack bundler plugin (source maps,
+ * release injection, …) together with the code transformer
+ * (build-time `diagnostics_channel` instrumentation for Node libraries).
+ *
+ * It is a drop-in replacement for `@sentry/bundler-plugins/webpack` and accepts
+ * the same options.
+ * @example
+ * ```ts
+ * // webpack.config.mjs
+ * import { sentryWebpackPlugin } from '@sentry/node/webpack';
+ * export default { plugins: [sentryWebpackPlugin({ org: '…', project: '…' })] };
+ * ```
+ */
+export function sentryWebpackPlugin(options?: SentryWebpackPluginOptions): {
+  apply: (compiler: WebpackCompiler) => void;
+} {
+  const bundlerPlugin = sentryWebpackBundlerPlugin(options) as { apply: (compiler: WebpackCompiler) => void };
+  const orchestrionPlugin = sentryOrchestrionWebpackPlugin(options) as { apply: (compiler: WebpackCompiler) => void };
+
+  return {
+    apply(compiler: WebpackCompiler): void {
+      bundlerPlugin.apply(compiler);
+      orchestrionPlugin.apply(compiler);
+    },
+  };
+}