feat(nextjs): added webpack treeshaking flags as config by logaretm · Pull Request #18359 · getsentry/sentry-javascript

logaretm · 2025-12-01T16:01:33Z

This PR updates the Sentry Next.js integration to improve tree-shaking configuration and add new options for finer control over what SDK code is included in the final bundle.

The most significant changes are:

Added several new tree-shaking flags for better user DX.

Closes#18417

linear · 2025-12-01T16:01:36Z

JS-1222 Add treeshaking option for webpack

github-actions · 2025-12-01T16:04:30Z

size-limit report 📦

Path	Size	% Change	Change
@sentry/browser	24.81 kB	-	-
@sentry/browser - with treeshaking flags	23.3 kB	-	-
@sentry/browser (incl. Tracing)	41.55 kB	-	-
@sentry/browser (incl. Tracing, Profiling)	46.16 kB	-	-
@sentry/browser (incl. Tracing, Replay)	79.97 kB	-	-
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	69.7 kB	+0.01%	+1 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)	84.65 kB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback)	96.89 kB	-	-
@sentry/browser (incl. Feedback)	41.52 kB	-	-
@sentry/browser (incl. sendFeedback)	29.49 kB	+0.01%	+1 B 🔺
@sentry/browser (incl. FeedbackAsync)	34.48 kB	+0.01%	+1 B 🔺
@sentry/react	26.52 kB	-	-
@sentry/react (incl. Tracing)	43.76 kB	-	-
@sentry/vue	29.27 kB	-	-
@sentry/vue (incl. Tracing)	43.36 kB	-	-
@sentry/svelte	24.82 kB	-	-
CDN Bundle	27.23 kB	-	-
CDN Bundle (incl. Tracing)	42.22 kB	-	-
CDN Bundle (incl. Tracing, Replay)	78.75 kB	+0.01%	+1 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)	84.2 kB	-	-
CDN Bundle - uncompressed	80.02 kB	-	-
CDN Bundle (incl. Tracing) - uncompressed	125.37 kB	-	-
CDN Bundle (incl. Tracing, Replay) - uncompressed	241.41 kB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	254.17 kB	-	-
@sentry/nextjs (client)	45.98 kB	-	-
@sentry/sveltekit (client)	41.93 kB	-	-
@sentry/node-core	51.6 kB	-	-
@sentry/node	161.48 kB	+0.01%	+1 B 🔺
@sentry/node - without tracing	93.03 kB	-	-
@sentry/aws-serverless	108.54 kB	-0.01%	-1 B 🔽

View base workflow run

Copilot

Pull request overview

This PR enhances the Sentry Next.js SDK's tree-shaking capabilities by renaming debugLogs to debugLogging and introducing four new configuration options for fine-grained control over SDK bundle inclusion.

Key Changes:

Renamed configuration option from debugLogs to debugLogging for consistency
Added tracing, excludeReplayIframe, excludeReplayShadowDOM, and excludeReplayCompressionWorker tree-shaking options
Refactored webpack configuration to use a dedicated setupTreeshakingFromConfig function for improved maintainability

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.

File	Description
packages/nextjs/src/config/types.ts	Added type definitions and JSDoc documentation for four new tree-shaking options
packages/nextjs/src/config/webpack.ts	Extracted tree-shaking setup into a dedicated function that handles all five tree-shaking flags via webpack DefinePlugin
packages/nextjs/test/config/fixtures.ts	Updated DefinePlugin mock to accept and store definitions for test verification
packages/nextjs/test/config/webpack/constructWebpackConfig.test.ts	Added comprehensive test suite covering all tree-shaking options across different build contexts (server, client, edge)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

chargome

LGTM! Nice DX improvement

chargome · 2025-12-16T09:46:10Z

@logaretm make sure to add a section in the changelog for this 🙏

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

cursor · 2025-12-16T19:32:12Z

+ expect(treeshakePlugin.definitions).not.toHaveProperty('__SENTRY_TRACING__');
+ expect(treeshakePlugin.definitions).not.toHaveProperty('__RRWEB_EXCLUDE_SHADOW_DOM__');
+ });
+ });


Bug: Missing integration or E2E tests for feature (Bugbot Rules)
Per the review rules specified in this repository, feat PRs should include at least one integration or E2E test. This PR adds new webpack treeshaking configuration flags but only includes unit tests. Since these flags affect the actual webpack build behavior and bundle output, an integration or E2E test verifying that the treeshaking actually works as expected in a real Next.js build would provide stronger confidence in the feature. Flagged because review rules file requests this check.

# What A PR to go in tandem with getsentry/sentry-javascript#18359 once it gets merged and released. It documents the new tree-shaking options now abstracted away into `webpack.treeshake` namespace. It has a few differences to the existing tree-shaking flags under the hood: - All options are optimized to be set to `true` to take effect, unlike the flags where some had to be set to `true` and some had to be set to `false`. - Now exposed as an SDK `webpack.treeshake` build options rather than needing the user to be aware of the webpack define plugin API. Marking it as a draft to avoid merging it before the PR goes live. --------- Co-authored-by: Charly Gomez <charly.gomez@sentry.io> Co-authored-by: Sarah Mischinger <sarah@codingwriter.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

logaretm requested a review from chargome December 1, 2025 16:01

cursorBot reviewed Dec 1, 2025
View reviewed changes

Comment threadpackages/nextjs/src/config/webpack.ts Outdated
Comment threadpackages/nextjs/src/config/withSentryConfig.ts Outdated

logaretm force-pushed the awad/js-1222-add-treeshaking-options-for-webpack branch 2 times, most recently from bf5a673 to 66aa19cCompare December 4, 2025 14:44

CopilotAI review requested due to automatic review settings December 4, 2025 14:44

Copilotstarted reviewing on behalf of logaretm December 4, 2025 14:44 View session

Copilotfinished reviewing on behalf of logaretm December 4, 2025 14:47

CopilotAI reviewed Dec 4, 2025
View reviewed changes

logaretm force-pushed the awad/js-1222-add-treeshaking-options-for-webpack branch from 03e070a to e66a724Compare December 5, 2025 09:56

sentryBot reviewed Dec 5, 2025
View reviewed changes

Comment threadpackages/nextjs/test/config/webpack/constructWebpackConfig.test.ts Outdated

cursorBot reviewed Dec 5, 2025
View reviewed changes

Comment threadpackages/nextjs/test/config/webpack/constructWebpackConfig.test.ts Outdated

Base automatically changed from awad/js-1111-deprecate-top-level-webpack-options to developDecember 5, 2025 15:21

logaretm force-pushed the awad/js-1222-add-treeshaking-options-for-webpack branch from e66a724 to c8832afCompare December 5, 2025 15:23

github-actionsBot mentioned this pull request Dec 5, 2025
feat(nextjs): added webpack treeshaking flags as config #18417
Closed

logaretm linked an issue Dec 5, 2025 that may be closed by this pull request
Add treeshaking option for webpack #18326
Closed

sentryBot reviewed Dec 5, 2025
View reviewed changes

Comment threadpackages/nextjs/test/config/webpack/constructWebpackConfig.test.ts Outdated

logaretm force-pushed the awad/js-1222-add-treeshaking-options-for-webpack branch from de51fb2 to daa72efCompare December 11, 2025 16:48

logaretm mentioned this pull request Dec 11, 2025
docs(nextjs): added tree-shaking webpack config guide getsentry/sentry-docs#15790
Merged

logaretm force-pushed the awad/js-1222-add-treeshaking-options-for-webpack branch from daa72ef to 261ad56Compare December 15, 2025 14:42

cursorBot reviewed Dec 15, 2025
View reviewed changes

Comment threadpackages/nextjs/src/config/webpack.ts

chargome approved these changes Dec 16, 2025
View reviewed changes

logaretmand others added 6 commits December 16, 2025 21:25

feat: added webpack treeshaking flags
46f9d29

tests: added tests
a003650

fix: avoid adding defne plugins if no treeshake opts specified
f72b6e5

chore: comment casing
165d126
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

docs: improved comments writing style
a7a1c58

ref: rename tracing treeshake option for clarity
9f83e72

logaretm added 2 commits December 16, 2025 21:25

test: update test config names
d9a4fb9

chore: added unreleased changelog entry
825cf35

logaretm force-pushed the awad/js-1222-add-treeshaking-options-for-webpack branch from 261ad56 to 825cf35Compare December 16, 2025 19:27

cursorBot reviewed Dec 16, 2025
View reviewed changes

logaretm merged commit 99183a7 into developDec 16, 2025
68 checks passed

logaretm deleted the awad/js-1222-add-treeshaking-options-for-webpack branch December 16, 2025 19:55

github-actionsBot mentioned this pull request Dec 18, 2025
Add treeshaking option for webpack #18326
Closed

Uh oh!

Uh oh!

Conversation

logaretm commented Dec 1, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linearBot commented Dec 1, 2025

Uh oh!

github-actionsBot commented Dec 1, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chargome left a comment

Choose a reason for hiding this comment

Uh oh!

chargome commented Dec 16, 2025

Uh oh!

cursorBotDec 16, 2025

Choose a reason for hiding this comment

Bug: Missing integration or E2E tests for feature (Bugbot Rules)

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

logaretm commented Dec 1, 2025•
edited
Loading

github-actionsBot commented Dec 1, 2025•
edited
Loading