fix(nextjs): Add sentry-cli existence check for enabling webpack plugin
#4311
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
lobsterkatie
changed the title
--ignore-scripts check for enabling webpack pluginsentry-cli existence check for enabling webpack plugin
AbhiPrasad
approved these changes
Dec 16, 2021
| // architecture-specific version of the `sentry-cli` binary. If `yarn install`, `npm install`, or `npm ci` are run | ||
| // with the `--ignore-scripts` option, this will be blocked and the missing binary will cause an error when users | ||
| // try to build their apps.) | ||
| ensureCLIBinaryExists() && |
There was a problem hiding this comment.
Should we have this check in the webpack plugin? I assume it'll also be a problem for @sentry/gatsby (which does similar things)
There was a problem hiding this comment.
It's a good point. Really we should have it in sentry-cli itself. I went ahead and implemented that, but it's currently blocked on unrelated rust errors, so I'm going to merge this in for now. Once those rust problems are fixed (and everyone, including me, is back from winter break), we can switch to that implementation.
size-limit report
|
lobsterkatie
deleted the
kmclb-nextjs-disable-webpack-plugin-if-using-ignore-scripts
branch
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.
Our nextjs SDK uses
sentry-cli(by way ofSentryWebpackPluginand@sentry/cli) to upload sourcemaps. Because binaries (like thesentry-cliexecutable) need to be compiled differently for different OSs and architectures,@sentry/cliuses a post-install script to download the correct one as part of its install process, rather than ship with all possible binaries at once.Of course, this goes awry if the post-install script isn't run, which is exactly what happens when
@sentry/cliis installed with the--ignore-scriptsoption. The resulting missing binary then causes errors which bubble up to and through our SDK to the nextjs build process, which promptly crashes.This fixes that by checking to make sure they binary has been downloaded before enabling
SentryWebpackPlugin.Fixes getsentry/sentry-cli#1085.