feat(nextjs): Add bundleSizeOptimizations to build options (#13323)

Extend options that can be added to `withSentryConfig` part of #13012 --------- Co-authored-by: Luca Forstner <[email protected]>
getsentry · Sep 2, 2024 · 318c163 · 318c163
1 parent 01165db
commit 318c163
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 1 deletion.
diff --git a/packages/nextjs/src/config/types.ts b/packages/nextjs/src/config/types.ts
@@ -307,6 +307,50 @@ export type SentryBuildOptions = {
     };
   };
 
+  /**
+   * Options to configure various bundle size optimizations related to the Sentry SDK.
+   */
+  bundleSizeOptimizations?: {
+    /**
+     * If set to `true`, the Sentry SDK will attempt to tree-shake (remove) any debugging code within itself during the build.
+     * Note that the success of this depends on tree shaking being enabled in your build tooling.
+     *
+     * Setting this option to `true` will disable features like the SDK's `debug` option.
+     */
+    excludeDebugStatements?: boolean;
+
+    /**
+     * If set to `true`, the Sentry SDK will attempt to tree-shake (remove) code within itself that is related to tracing and performance monitoring.
+     * Note that the success of this depends on tree shaking being enabled in your build tooling.
+     * **Notice:** Do not enable this when you're using any performance monitoring-related SDK features (e.g. `Sentry.startTransaction()`).
+     */
+    excludeTracing?: boolean;
+
+    /**
+     * If set to `true`, the Sentry SDK will attempt to tree-shake (remove) code related to the SDK's Session Replay Shadow DOM recording functionality.
+     * Note that the success of this depends on tree shaking being enabled in your build tooling.
+     *
+     * This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.
+     */
+    excludeReplayShadowDom?: boolean;
+
+    /**
+     * If set to `true`, the Sentry SDK will attempt to tree-shake (remove) code related to the SDK's Session Replay `iframe` recording functionality.
+     * Note that the success of this depends on tree shaking being enabled in your build tooling.
+     *
+     * You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay.
+     */
+    excludeReplayIframe?: boolean;
+
+    /**
+     * If set to `true`, the Sentry SDK will attempt to tree-shake (remove) code related to the SDK's Session Replay's Compression Web Worker.
+     * Note that the success of this depends on tree shaking being enabled in your build tooling.
+     *
+     * **Notice:** You should only use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option.
+     */
+    excludeReplayWorker?: boolean;
+  };
+
   /**
    * Options related to react component name annotations.
    * Disabled by default, unless a value is set for this option.

diff --git a/packages/nextjs/src/config/webpack.ts b/packages/nextjs/src/config/webpack.ts
@@ -37,7 +37,7 @@ let showedMissingGlobalErrorWarningMsg = false;
  *   - `plugins`, to add SentryWebpackPlugin
  *
  * @param userNextConfig The user's existing nextjs config, as passed to `withSentryConfig`
- * @param userSentryWebpackPluginOptions The user's SentryWebpackPlugin config, as passed to `withSentryConfig`
+ * @param userSentryOptions The user's SentryWebpackPlugin config, as passed to `withSentryConfig`
  * @returns The function to set as the nextjs config's `webpack` value
  */
 export function constructWebpackConfigFunction(

diff --git a/packages/nextjs/src/config/webpackPluginOptions.ts b/packages/nextjs/src/config/webpackPluginOptions.ts
@@ -97,6 +97,9 @@ export function getWebpackPluginOptions(
       deploy: sentryBuildOptions.release?.deploy,
       ...sentryBuildOptions.unstable_sentryWebpackPluginOptions?.release,
     },
+    bundleSizeOptimizations: {
+      ...sentryBuildOptions.bundleSizeOptimizations,
+    },
     _metaOptions: {
       loggerPrefixOverride: `[@sentry/nextjs - ${prefixInsert}]`,
       telemetry: {

diff --git a/packages/nextjs/test/config/webpack/webpackPluginOptions.test.ts b/packages/nextjs/test/config/webpack/webpackPluginOptions.test.ts
@@ -108,6 +108,23 @@ describe('getWebpackPluginOptions()', () => {
     });
   });
 
+  it('forwards bundleSizeOptimization options', () => {
+    const buildContext = generateBuildContext({ isServer: false });
+    const generatedPluginOptions = getWebpackPluginOptions(buildContext, {
+      bundleSizeOptimizations: {
+        excludeTracing: true,
+        excludeReplayShadowDom: false,
+      },
+    });
+
+    expect(generatedPluginOptions).toMatchObject({
+      bundleSizeOptimizations: {
+        excludeTracing: true,
+        excludeReplayShadowDom: false,
+      },
+    });
+  });
+
   it('returns the right `assets` and `ignore` values during the server build', () => {
     const buildContext = generateBuildContext({ isServer: true });
     const generatedPluginOptions = getWebpackPluginOptions(buildContext, {});