feat(nextjs): Document hideSourceMaps option
#4627
Merged
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
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/sentry/sentry-docs/29m5u5r4EnVYbM1V3NjjdcWxtJ7Q |
kamilogorek
approved these changes
Jan 24, 2022
imatwawana
reviewed
Jan 24, 2022
lobsterkatie
added a commit
to getsentry/sentry-javascript
that referenced
this pull request
Jan 24, 2022
…ol` value (#4436) We currently force the value of the webpack option `devtool` to be `source-map`, in order to guarantee that the correct sourcemaps are generated during build. There is another `devtool` value[1], `hidden-source-map`, which produces the same maps (so just as good for our purposes), but without adding `sourceMappingURL` comments at the bottom of the resulting JS files. (Some users prefer this as a way not to have the browser complain when it tries to follow the `sourceMappingURL` link and comes up empty.) This PR adds an option that users can pass in their nextjs config, under the key `sentry.hideSourceMaps`. When this is set to true, the SDK will use `hidden-source-map` as the `devtool` value instead of `source-map`. Note that since this is a front-end-only problem, the option only applies to client-side builds. The new option is documented in getsentry/sentry-docs#4627. Fixes #3549. [1] https://webpack.js.org/configuration/devtool/
AbhiPrasad
reviewed
Jan 24, 2022
Co-authored-by: Abhijeet Prasad <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 documents the option added in getsentry/sentry-javascript#4436, to allow users to use
hidden-source-mapas their webpackdevtoolfor client-side builds. (With this option enabled, the same sourcemaps are generated, but the final bundles don't have asourceMappingURLcomment, effectively "hiding" the sourcemaps from the browser. Doing this prevents the browser from complaining in situations where the maps are not publicly hosted.)