feat: added webpack treeshaking flags

Author: logaretm

packages/nextjs/src/config/types.ts

@@ -111,7 +111,37 @@ export type SentryBuildWebpackOptions = {
     /**
      * Tree shakes Sentry SDK logger statements from the bundle. Note that this doesn't affect Sentry Logs.
      */
-    debugLogs?: boolean;
+    debugLogging?: boolean;
+
+    /**
+     * Setting this to true will tree-shake any SDK code that is related to tracing and performance monitoring.
+     */
+    tracing?: boolean;
+
+    /**
+     * Replacing this flag with true will tree shake any SDK code related to capturing iframe content with Session Replay.
+     * It's only relevant when using Session Replay. Enable this flag if you don't want to record any iframes.
+     * This has no effect if you did not add `replayIntegration`.
+     */
+    excludeReplayIframe?: boolean;
+
+    /**
+     * Replacing this flag with true will tree shake any SDK code related to capturing shadow dom elements with Session Replay.
+     * It's only relevant when using Session Replay.
+     * Enable this flag if you don't want to record any shadow dom elements.
+     * This has no effect if you did not add `replayIntegration`.
+     */
+    excludeReplayShadowDOM?: boolean;
+
+    /**
+     * Replacing this flag with true will tree shake any SDK code that's related to the included compression web worker for Session Replay.
+     * It's only relevant when using Session Replay.
+     * Enable this flag if you want to host a compression worker yourself.
+     * See Using a Custom Compression Worker for details.
+     * We don't recommend enabling this flag unless you provide a custom worker URL.
+     * This has no effect if you did not add `replayIntegration`.
+     */
+    excludeReplayCompressionWorker?: boolean;
   };
 
   /**

packages/nextjs/src/config/webpack.ts

@@ -431,13 +431,8 @@ export function constructWebpackConfigFunction({
       }
     }
 
-    if (userSentryOptions.webpack?.treeshake?.debugLogs) {
-      newConfig.plugins = newConfig.plugins || [];
-      newConfig.plugins.push(
-        new buildContext.webpack.DefinePlugin({
-          __SENTRY_DEBUG__: false,
-        }),
-      );
+    if (userSentryOptions.webpack?.treeshake) {
+      setupTreeshakingFromConfig(userSentryOptions, newConfig, buildContext);
     }
 
     // We inject a map of dependencies that the nextjs app has, as we cannot reliably extract them at runtime, sadly
@@ -915,3 +910,39 @@ function _getModules(projectDir: string): Record<string, string> {
     return {};
   }
 }
+
+/**
+ * Sets up the tree-shaking flags based on the user's configuration.
+ * https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/tree-shaking/
+ */
+function setupTreeshakingFromConfig(
+  userSentryOptions: SentryBuildOptions,
+  newConfig: WebpackConfigObjectWithModuleRules,
+  buildContext: BuildContext,
+): void {
+  const defines: Record<string, boolean> = {};
+
+  newConfig.plugins = newConfig.plugins || [];
+
+  if (userSentryOptions.webpack?.treeshake?.debugLogging) {
+    defines.__SENTRY_DEBUG__ = false;
+  }
+
+  if (userSentryOptions.webpack?.treeshake?.tracing) {
+    defines.__SENTRY_TRACING__ = false;
+  }
+
+  if (userSentryOptions.webpack?.treeshake?.excludeReplayIframe) {
+    defines.__RRWEB_EXCLUDE_IFRAME__ = true;
+  }
+
+  if (userSentryOptions.webpack?.treeshake?.excludeReplayShadowDOM) {
+    defines.__RRWEB_EXCLUDE_SHADOW_DOM__ = true;
+  }
+
+  if (userSentryOptions.webpack?.treeshake?.excludeReplayCompressionWorker) {
+    defines.__SENTRY_EXCLUDE_REPLAY_WORKER__ = true;
+  }
+
+  newConfig.plugins.push(new buildContext.webpack.DefinePlugin(defines));
+}

packages/nextjs/src/config/withSentryConfig.ts

@@ -165,10 +165,10 @@ function migrateDeprecatedWebpackOptions(userSentryOptions: SentryBuildOptions):
   // Handle treeshake.debugLogs specially since it's nested
   if (userSentryOptions.disableLogger !== undefined) {
     webpack.treeshake = webpack.treeshake || {};
-    webpack.treeshake.debugLogs = withDeprecatedFallback(
-      webpack.treeshake.debugLogs,
+    webpack.treeshake.debugLogging = withDeprecatedFallback(
+      webpack.treeshake.debugLogging,
       userSentryOptions.disableLogger,
-      deprecatedMessage('disableLogger', 'webpack.treeshake.debugLogs'),
+      deprecatedMessage('disableLogger', 'webpack.treeshake.debugLogging'),
     );
   }