fix(nextjs): Correctly handle functional next config in withSentryConfig
#3698
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
size-limit report
|
AbhiPrasad
approved these changes
Jun 17, 2021
| @@ -17,6 +17,11 @@ export type NextConfigObject = { | |||
| [key: string]: unknown; | |||
| }; | |||
|
|
|||
| export type NextConfigFunction = ( | |||
| phase: string, | |||
There was a problem hiding this comment.
this could be an interesting thing to experiment with in the future, like for ex. we construct different webpack configs based on dev/prod/export (if I'm understanding this correctly). https://github.com/vercel/next.js/blob/canary/packages/next/next-server/lib/constants.ts#L1-L4
There was a problem hiding this comment.
You are. I think we might wait if/until it proves a problem, though, as I don't believe those things influence the parts of the config we muck with.
9 tasks
lobsterkatie
added a commit
that referenced
this pull request
Jun 30, 2021
This is a bunch of prep work pulled out of an upcoming PR, which will add the option to disable the `SentryWebpackPlugin` for both server and client builds. The changes in this PR are mostly cosmetic, with the aim of making the code more readable. The only substantive changes are: - When modifying the webpack config options, we now clone the config object we're given. - We now ensure that the `userNextConfig` passed to `constructWebpackConfigFunction` is an object. (We've been treating it like one, but in fact it's also possible for it to be given as a function. This is a change which should have been included in #3698.)
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.
To set up Sentry, we tell users to end their
next.config.jsfiles withmodule.exports = withSentryConfig(moduleExports, SentryWebpackPluginOptions);,where
moduleExportsis what was the user'smodule.exportsbefore they added Sentry - in other words, all of their other config for their next app.According to the next docs, that config can take the form either of an object or a function which returns an object. We've been correctly handling the first case, but not the second. This fixes that by checking if
moduleExportsis a function, and if so, running that function before merging in the user config, so that in either case we know we're merging in an object.Fixes https://github.com/getsentry/sentry-docs/issues/3723.
Fixes ricokahler/next-plugin-preval#42.