build(replay): Stop preserving modules #6817
Merged
Conversation
This file contains 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
size-limit report 📦
|
Lms24
commented
Jan 18, 2023
| // * build/npm/esm/node_modules/rrweb/... | ||
| // * build/npm/esm/packages/replay/... | ||
| preserveModulesRoot: path.join(process.cwd(), 'src'), | ||
| preserveModules: false, |
There was a problem hiding this comment.
While this is the default value for rollup configs; we need to set it explicitly here because makeBaseNPMConfig sets it to true.
Lms24
commented
Jan 18, 2023
| // from there. The current setting (false) prevents this, in case we want to leave it there for users to use in | ||
| // their own bundling. That said, we don't yet know for sure that that works, so come back to this. | ||
| // treeshake: 'smallest', | ||
| treeshake: false, |
There was a problem hiding this comment.
This comment was stale as we now don't even use isDebugBuild anymore in the SDKs. Hence we can permit the default mode of tree shaking again.
mydea
approved these changes
Jan 18, 2023
3 tasks
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.
Previously, when transpiling Replay, we preserved modules, just like in every other SDK of ours. In the case of Replay, however, we don't just rely on external dependencies but we want to include a patched version of rrweb in our NPM package. This lead to problems with specific bundler/build tool setups as reported in (#6690).
With this PR, we don't preserve modules any longer, meaning, everything is bundled into one
index.jsfile (similarly to CDN bundles).Just so that we're all aware: This is a breaking change for anyone who imports from explicit paths (e.g.
import { something } from '@sentry/replay/utils/test'). However, we considered this okay in the past (e.g. #6707) as it is not something we instruct people to do in our docs and it is kind of an edge case. Given that Replay isn't fully stable yet, I'd vote it's an okay change to make right now.Tested this change locally with a plain-js test app.
fixes #6690