fix(replay): Do not mangle _metadata in client options
#6600
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
billyvg
approved these changes
Dec 21, 2022
AbhiPrasad
approved these changes
Dec 21, 2022
size-limit report 📦
|
lforst
approved these changes
Dec 21, 2022
Lms24
added a commit
that referenced
this pull request
Jan 4, 2023
Add a new method to the `Client` interface: `getSdkMetadata`. We can use this method in the Replay package to avoid accessing `client.getOptions()._metadata`, which previously caused broken CDN bundles which we hot-fixed with #6600. This change now properly fixes this issue by simply not accessing this "private" field anymore.
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 working on #6514 I missed that we access a "private" field in
client.getOptions()._metadatato retrieve the SDK name. This had the consequence that - once again - we mangled a cross-package field we shouldn't (_metadata) in our CDN bundles which caused the SDK name to not be included in the replay event and envelope.This caused minified CDN bundles to send incomplete replay event envelopes to Sentry and as a consequence, they were not processed (correctly) and hence users didn't get incoming replays.
This PR excludes the
_metadatafield from being mangled. Before merging this, I wanna see how much bundle size increase this causes. If it's too much, we can also revert #6514.h/t @souredoutlook for raising this issue.