feat(nextjs): added webpack treeshaking flags as config #18359
Merged
+487
−13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
size-limit report 📦
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
logaretm
force-pushed
the
awad/js-1222-add-treeshaking-options-for-webpack
branch
2 times, most recently
from
bf5a673 to
66aa19c
Compare
Contributor
There was a problem hiding this comment.
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
debugLogstodebugLoggingfor consistency - Added
tracing,excludeReplayIframe,excludeReplayShadowDOM, andexcludeReplayCompressionWorkertree-shaking options - Refactored webpack configuration to use a dedicated
setupTreeshakingFromConfigfunction 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.
logaretm
force-pushed
the
awad/js-1222-add-treeshaking-options-for-webpack
branch
from
03e070a to
e66a724
Compare
![sentry[bot]](https://avatars.githubusercontent.com/u/1396951?s=60&v=4){kind=small}
packages/nextjs/test/config/webpack/constructWebpackConfig.test.ts
Outdated
Show resolved
Hide resolved
packages/nextjs/test/config/webpack/constructWebpackConfig.test.ts
Outdated
Show resolved
Hide resolved
Base automatically changed from
awad/js-1111-deprecate-top-level-webpack-options
to
develop
December 5, 2025 15:21
logaretm
force-pushed
the
awad/js-1222-add-treeshaking-options-for-webpack
branch
from
e66a724 to
c8832af
Compare
packages/nextjs/test/config/webpack/constructWebpackConfig.test.ts
Outdated
Show resolved
Hide resolved
logaretm
force-pushed
the
awad/js-1222-add-treeshaking-options-for-webpack
branch
from
de51fb2 to
daa72ef
Compare
logaretm
force-pushed
the
awad/js-1222-add-treeshaking-options-for-webpack
branch
from
daa72ef to
261ad56
Compare
Member
|
@logaretm make sure to add a section in the changelog for this 🙏 |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
logaretm
force-pushed
the
awad/js-1222-add-treeshaking-options-for-webpack
branch
from
261ad56 to
825cf35
Compare
| expect(treeshakePlugin.definitions).not.toHaveProperty('__SENTRY_TRACING__'); | ||
| expect(treeshakePlugin.definitions).not.toHaveProperty('__RRWEB_EXCLUDE_SHADOW_DOM__'); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
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.
logaretm
deleted the
awad/js-1222-add-treeshaking-options-for-webpack
branch
logaretm
added a commit
to getsentry/sentry-docs
that referenced
this pull request
Dec 18, 2025
# 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Closes #18417