Fix threading issues capturing log messages as breadcrumbs #559
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
bitsandfoxes
approved these changes
May 22, 2024
Comment on lines
+20
to
+31
| SentryScopeDesktop::SentryScopeDesktop(const SentryScopeDesktop& Scope) | ||
| { | ||
| Dist = Scope.Dist; | ||
| Environment = Scope.Environment; | ||
| FingerprintDesktop = Scope.FingerprintDesktop; | ||
| TagsDesktop = Scope.TagsDesktop; | ||
| ExtraDesktop = Scope.ExtraDesktop; | ||
| ContextsDesktop = Scope.ContextsDesktop; | ||
| BreadcrumbsDesktop = Scope.BreadcrumbsDesktop; | ||
| LevelDesktop = Scope.LevelDesktop; | ||
| } | ||
|
|
There was a problem hiding this comment.
Where is this coming from?
There was a problem hiding this comment.
It's essential to implement a custom copy constructor for the scope class after we've introduced a critical section member.
Since FCriticalSection disables its default copy constructor using the default mechanism for scope isn't possible and results into compilation errors.
| SentryScopeDesktop::~SentryScopeDesktop() | ||
| { | ||
| } | ||
|
|
||
| void SentryScopeDesktop::AddBreadcrumb(USentryBreadcrumb* breadcrumb) | ||
| { | ||
| FScopeLock Lock(&CriticalSection); |
There was a problem hiding this comment.
That's neat, that it works like that.
| @@ -12,6 +12,7 @@ class SentrySubsystemAndroid : public ISentrySubsystem | |||
| virtual bool IsEnabled() override; | |||
| virtual ESentryCrashedLastRun IsCrashedLastRun() override; | |||
| virtual void AddBreadcrumb(USentryBreadcrumb* breadcrumb) override; | |||
There was a problem hiding this comment.
If we're no longer using the "plain" AddBreadcrumb, do we need it?
There was a problem hiding this comment.
It's still a part of the public API so I think we should leave it even though we're not using it internally 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.
This PR addresses an issue which was discovered during the discussion around #514
Since log messages, asserts, ensures, etc. can come from different threads adding breadcrumbs automatically on such events can lead to undefined results due to the following reasons:
UObjectinstance is created during garbage collectionSentryScopeDesktopbreadcrumbs storageIn order to resolve this breadcrumbs can now be captured without instancing any extra objects and some threading considerations were added.