fix(nextjs): Make withSentryConfig return type match given config type
#3760
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
|
AbhiPrasad
approved these changes
Jun 29, 2021
1999
added a commit
to 1999/sentry-javascript
that referenced
this pull request
Jun 30, 2021
…transport * upstream/master: fix(tracing): Add check for document.scripts in metrics (getsentry#3766) ref(nextjs): Stop setting redundant `productionBrowserSourceMaps` in config (getsentry#3765) test: Ensure withScope and run bubble up exceptions (getsentry#3764) ref(gatsby): Default release to empty string (getsentry#3759) fix(nextjs): Make `withSentryConfig` return type match given config type (getsentry#3760) misc: Fix typos (getsentry#3763) fix(node): Enable autoSessionTracking correctly (getsentry#3758) release: 6.8.0 meta: 6.8.0 changelog feat: Enable serialization of multiple DOM attributes for breadcrumbs. (getsentry#3755) ref: Leave only valid buffer implementation (getsentry#3744)
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.
When fixing https://github.com/getsentry/sentry-docs/issues/3723, the return type of
withSentryConfigwas changed from an object to a function which returns an object, since otherwise there's no way to get thephaseanddefaultConfigarguments needed when the user passes their existing nextjs config as a function.If users follow our instructions here, and export
withSentryConfig(...)with no further modifications, this is an invisible change, since they're never dealing with its return value. But for any who do further process said value, it turns out to have been a potentially breaking change.This reverts to the old behavior (of returning an object) in cases where the existing config is an object, and only returns a function when necessary, which is to say, when the existing config is itself a function.
Fixes #3722.