fix(utils): Normalize when serializing envelope #5851
Merged
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
AbhiPrasad
reviewed
Sep 29, 2022
| // In case, despite all our efforts to keep `payload` circular-dependency-free, `JSON.strinify()` still | ||
| // fails, we try again after normalizing it again with infinite normalization depth. This of course has a | ||
| // performance impact but in this case a performance hit is better than throwing. | ||
| stringifiedPayload = JSON.stringify(normalize(payload)); |
There was a problem hiding this comment.
Do you think we should throw an error to Sentry as well here? Maybe attach the event_id so folks can report back about why this is happening (like we can inspect the fully normalized payload).
There was a problem hiding this comment.
It would be nice to log, what parts of the payload contained the circular reference, just so we can close these gaps. We discussed some ideas:
- Capture an additional exception here with the circ-dep path and let users report back to us.
- Set a specific field in
extraand show a warning on the Sentry product to report back to us. - Set a specific field in the payload with the circ-dep path and log that field in relay.
size-limit report 📦
|
AbhiPrasad
approved these changes
Sep 29, 2022
This was referenced Sep 29, 2022
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.
Since #2809 keeps being necrobumped I decided to look into it once more.
Apparently unnormalized data keeps slipping through up until we serialize envelopes. This causes the
JSON.stringifycall to fail and throw, right before we were about to report an error event. Not ideal.My proposed fix for now - and I am definitely not all for it - is to simply wrap the
JSON.stringifycall in a try-catch and normalize the entire payload with infinite recursion depth once more, in case that call fails.This has an obvious performance impact, especially since we know that when
JSON.stringifyfails, it has some unnormalized data that might be very big and recursive - potentially even sending payloads that are too big.