fix(replay): Fix potential broken CSS in styled-components #9234
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
Oct 12, 2023
|
We can do a release tomorrow with this. |
mydea
reviewed
Oct 13, 2023
packages/replay/src/integration.ts
Outdated
| // return true to suppress throwing the error inside of rrweb | ||
| return true; | ||
| errorHandler: (err: Error & {__rrweb__?: boolean}) => { | ||
| err.__rrweb__ = true; |
There was a problem hiding this comment.
Hmmm so one problem here is that we may throw/error on trying to set this on something that is e.g. frozen or similar. Can we instead still try-catch here and just re-throw certain kinds of exceptions, maybe?
I mean, maybe this is actually fine, but we could be getting other errors because of this, at some point, too 🤔
There was a problem hiding this comment.
Or actually, can we just do:
errorHandler: (err: Error) => {
try {
// @ts-expect-error Set this so that replay SDK can ignore errors originating from rrweb
err.__rrweb__ = true;
} catch {
// avoid any potential hazards here
}So still try-catch setting this prop, but bubble the error up to rrweb 🤔
There was a problem hiding this comment.
I updated this like this, so we can merge & release this!
NOTE: This requires a bump to rrweb library Fixes an issue where the Replay integration can potentially break applications that use `styled-components`. `styled-components` [relies on an exception being throw](https://github.com/styled-components/styled-components/blob/b7b374bb1ceff1699f7035b15881bc807110199a/packages/styled-components/src/sheet/Tag.ts#L32-L40) for CSS rules that are not supported by the browser engine. However, our SDK suppresses any exceptions thrown from within rrweb, so `styled-components` assumes that an unsupported rule was inserted successfully and increases a rule index, which causes following inserted rules to fail due to an out-of-bounds error. getsentry/rrweb#111 introduces a change the adds metadata to exceptions that occur when calling `insertRule`, and this PR will re-throw those exceptions that will then bubble up to `styled-components`. Fixes #9170
mydea
force-pushed
the
fix-replay-fix-catching-exceptions-from-insertRule
branch
from
b1876c5
to
a66168f
Compare
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.
Fixes an issue where the Replay integration can potentially break applications that use
styled-components.styled-componentsrelies on an exception being throw for CSS rules that are not supported by the browser engine. However, our SDK suppressed any exceptions thrown from within rrweb, sostyled-componentsassumes that an unsupported rule was inserted successfully and increases a rule index, which causes following inserted rules to fail due to an out-of-bounds error.This was a regression from v1 as we were always re-throwing the exception
Fixes #9170