feat(gatsby): Upload source maps automatically when sentry-cli is configured #4109
Conversation
iker-barriocanal
requested review from
sl0thentr0py and
smeubank
and removed request for
a team
size-limit report
|
|
@AbhiPrasad I'm working on them. The previous approach should still work the same way it does now, so I don't think docs are a blocker to land this PR. |
| errorHandler(err, invokeErr) { | ||
| const { message } = err; | ||
| if (message.includes('organization slug is required') || message.includes('project slug is required')) { | ||
| return; |
There was a problem hiding this comment.
Does this still log the error if we do an early return?
There was a problem hiding this comment.
@iker-barriocanal Feel like we need a way to tell users about misconfigured sentry-cli without it being blocking. Can we take advantage of the debug flag somehow?
There was a problem hiding this comment.
What do you mean exactly? Telling users when they haven't correctly configured sentry-cli? If this is the case:
- Enabling
debugwill generate too much noise, and they can always customize this by settingSENTRY_LOG_LEVELenv var, see configuration values. - The code to check whether the file and its values are correct would be too complex and too hard to maintain for the value it provides. Are we planning to check if a sentry-cli config file exists? Or, checking the format is correct? Or, checking if the values are correct (need to ask Sentry whether the org exists)?
Considering sentry-cli has proper docs, failing doesn't have major consequences (not uploading source maps for a misconfiguration, which they can read the docs of, or try to have their own config, can retry as many times as they wish at no cost (not a production issue)...), and we can update Gatsby docs if the process is clear enough, I don't think it's worth it to provide additional checks. I'd rather remove this UX improvement over adding it and potentially provide a worse UX.
Note that I might have misunderstood what you meant.
There was a problem hiding this comment.
I just wanted to avoid situations where someone forgets to set an org slug, and doesn't understand why source maps uploading isn't working for gatsby (since the error is being swallowed).
I think we should add to docs how user's can define their own custom config with the webpack plugin.
There was a problem hiding this comment.
It's a good point, but I don't think it's worth covering it in this context. As for the docs, we link to the Sentry Webpack docs here; although these sections could be improved, is there anything specific you have in mind?
Follow-up to #4064.
When
sentry-cliis configured, source maps are automatically uploaded without requiring additional configuration from the user. When it's not, they aren't uploaded (doesn't break builds). The user can also define a custom configuration (ingatsby-node.js), which is higher priority than the one the SDK defines.