Revert scope data caching on Unreal's side

tustanivsky · tustanivsky · commit df4cbe2159ad · 2025-05-27T17:43:07.000+03:00
diff --git a/plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentryScope.cpp b/plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentryScope.cpp
@@ -14,12 +14,7 @@
 #if USE_SENTRY_NATIVE
 
 FGenericPlatformSentryScope::FGenericPlatformSentryScope()
-{
-	Scope = sentry_local_scope_new();
-}
-
-FGenericPlatformSentryScope::FGenericPlatformSentryScope(sentry_scope_t* scope)
-	: Scope(scope)
+	: Level(ESentryLevel::Debug)
 {
 }
 
@@ -29,11 +24,17 @@ FGenericPlatformSentryScope::~FGenericPlatformSentryScope()
 
 void FGenericPlatformSentryScope::AddBreadcrumb(TSharedPtr<ISentryBreadcrumb> breadcrumb)
 {
-	sentry_scope_add_breadcrumb(Scope, StaticCastSharedPtr<FGenericPlatformSentryBreadcrumb>(breadcrumb)->GetNativeObject());
+	if (Breadcrumbs.Num() >= FSentryModule::Get().GetSettings()->MaxBreadcrumbs)
+	{
+		Breadcrumbs.PopFront();
+	}
+
+	Breadcrumbs.Add(StaticCastSharedPtr<FGenericPlatformSentryBreadcrumb>(breadcrumb));
 }
 
 void FGenericPlatformSentryScope::ClearBreadcrumbs()
 {
+	Breadcrumbs.Empty();
 }
 
 void FGenericPlatformSentryScope::AddAttachment(TSharedPtr<ISentryAttachment> attachment)
@@ -48,29 +49,31 @@ void FGenericPlatformSentryScope::ClearAttachments()
 
 void FGenericPlatformSentryScope::SetTagValue(const FString& key, const FString& value)
 {
-	sentry_scope_set_tag(Scope, TCHAR_TO_UTF8(*key), TCHAR_TO_UTF8(*value));
+	Tags.Add(key, value);
+	
 }
 
 FString FGenericPlatformSentryScope::GetTagValue(const FString& key) const
 {
-	return FString();
+	if (!Tags.Contains(key))
+		return FString();
+
+	return Tags[key];
 }
 
 void FGenericPlatformSentryScope::RemoveTag(const FString& key)
 {
+	Tags.Remove(key);
 }
 
 void FGenericPlatformSentryScope::SetTags(const TMap<FString, FString>& tags)
 {
-	for (const auto& tagItem : tags)
-	{
-		SetTagValue(tagItem.Key, tagItem.Value);
-	}
+	Tags.Append(tags);
 }
 
 TMap<FString, FString> FGenericPlatformSentryScope::GetTags() const
 {
-	return TMap<FString, FString>();
+	return Tags;
 }
 
 void FGenericPlatformSentryScope::SetDist(const FString& dist)
@@ -95,62 +98,120 @@ FString FGenericPlatformSentryScope::GetEnvironment() const
 
 void FGenericPlatformSentryScope::SetFingerprint(const TArray<FString>& fingerprint)
 {
-	sentry_scope_set_fingerprints(Scope, FGenericPlatformSentryConverters::StringArrayToNative(fingerprint));
+	Fingerprint = fingerprint;
 }
 
 TArray<FString> FGenericPlatformSentryScope::GetFingerprint() const
 {
-	return TArray<FString>();
+	return Fingerprint;
 }
 
 void FGenericPlatformSentryScope::SetLevel(ESentryLevel level)
 {
-	sentry_scope_set_level(Scope, FGenericPlatformSentryConverters::SentryLevelToNative(level));
+	Level = level;
 }
 
 ESentryLevel FGenericPlatformSentryScope::GetLevel() const
 {
-	return ESentryLevel::Debug;
+	return Level;
 }
 
 void FGenericPlatformSentryScope::SetContext(const FString& key, const TMap<FString, FString>& values)
 {
-	sentry_scope_set_context(Scope, TCHAR_TO_UTF8(*key), FGenericPlatformSentryConverters::StringMapToNative(values));
+	Contexts.Add(key, values);
 }
 
 void FGenericPlatformSentryScope::RemoveContext(const FString& key)
 {
+	if (!Contexts.Contains(key))
+		return;
+
+	Contexts.Remove(key);
 }
 
 void FGenericPlatformSentryScope::SetExtraValue(const FString& key, const FString& value)
 {
-	sentry_scope_set_extra(Scope, TCHAR_TO_UTF8(*key), sentry_value_new_string(TCHAR_TO_UTF8(*value)));
+	Extra.Add(key, value);
 }
 
 FString FGenericPlatformSentryScope::GetExtraValue(const FString& key) const
 {
-	return FString();
+	if (!Extra.Contains(key))
+		return FString();
+
+	return Extra[key];
 }
 
 void FGenericPlatformSentryScope::RemoveExtra(const FString& key)
 {
+	if (!Extra.Contains(key))
+		return;
+
+	Extra.Remove(key);
 }
 
 void FGenericPlatformSentryScope::SetExtras(const TMap<FString, FString>& extras)
 {
-	for (const auto& extraItem : extras)
-	{
-		SetExtraValue(extraItem.Key, extraItem.Value);
-	}
+	Extra.Append(extras);
 }
 
 TMap<FString, FString> FGenericPlatformSentryScope::GetExtras() const
 {
-	return TMap<FString, FString>();
+	return Extra;
 }
 
 void FGenericPlatformSentryScope::Clear()
 {
+	Dist = FString();
+	Environment = FString();
+	Fingerprint.Empty();
+	Tags.Empty();
+	Extra.Empty();
+	Contexts.Empty();
+	Breadcrumbs.Empty();
+	Level = ESentryLevel::Debug;}
+
+void FGenericPlatformSentryScope::Apply(sentry_scope_t* scope)
+{
+	if (!Breadcrumbs.IsEmpty())
+	{
+		for (const auto& Breadcrumb : Breadcrumbs)
+		{
+			sentry_value_t nativeBreadcrumb = Breadcrumb->GetNativeObject();
+			sentry_scope_add_breadcrumb(scope, nativeBreadcrumb);
+		}
+	}
+
+	if (Fingerprint.Num() > 0)
+	{
+		sentry_scope_set_fingerprints(scope, FGenericPlatformSentryConverters::StringArrayToNative(Fingerprint));
+	}
+
+	if (Tags.Num() > 0)
+	{
+		for (const auto& TagItem : Tags)
+		{
+			sentry_scope_set_tag(scope, TCHAR_TO_UTF8(*TagItem.Key), TCHAR_TO_UTF8(*TagItem.Value));
+		}
+	}
+
+	if (Extra.Num() > 0)
+	{
+		for (const auto& ExtraItem : Extra)
+		{
+			sentry_scope_set_extra(scope, TCHAR_TO_UTF8(*ExtraItem.Key), sentry_value_new_string(TCHAR_TO_UTF8(*ExtraItem.Value)));
+		}
+	}
+
+	if (Contexts.Num() > 0)
+	{
+		for (const auto& ContextsItem : Contexts)
+		{
+			sentry_scope_set_context(scope, TCHAR_TO_UTF8(*ContextsItem.Key), FGenericPlatformSentryConverters::StringMapToNative(ContextsItem.Value));
+		}
+	}
+
+	sentry_scope_set_level(scope, FGenericPlatformSentryConverters::SentryLevelToNative(Level));
 }
 
 #endif
diff --git a/plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentryScope.h b/plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentryScope.h
@@ -2,6 +2,7 @@
 
 #pragma once
 
+#include "Containers/RingBuffer.h"
 #include "Convenience/GenericPlatformSentryInclude.h"
 
 #include "Interface/SentryScopeInterface.h"
@@ -15,7 +16,6 @@ class FGenericPlatformSentryScope : public ISentryScope
 {
 public:
 	FGenericPlatformSentryScope();
-	FGenericPlatformSentryScope(sentry_scope_t* scope);
 	virtual ~FGenericPlatformSentryScope() override;
 
 	virtual void AddBreadcrumb(TSharedPtr<ISentryBreadcrumb> breadcrumb) override;
@@ -44,8 +44,22 @@ class FGenericPlatformSentryScope : public ISentryScope
 	virtual TMap<FString, FString> GetExtras() const override;
 	virtual void Clear() override;
 
+	void Apply(sentry_scope_t* scope);
+
 private:
-	sentry_scope_t* Scope;
+	FString Dist;
+	FString Environment;
+
+	TArray<FString> Fingerprint;
+
+	TMap<FString, FString> Tags;
+	TMap<FString, FString> Extra;
+
+	TMap<FString, TMap<FString, FString>> Contexts;
+
+	TRingBuffer<TSharedPtr<FGenericPlatformSentryBreadcrumb>> Breadcrumbs;
+
+	ESentryLevel Level;
 };
 
 typedef FGenericPlatformSentryScope FPlatformSentryScope;
diff --git a/plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentrySubsystem.cpp b/plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentrySubsystem.cpp
@@ -403,8 +403,9 @@ TSharedPtr<ISentryId> FGenericPlatformSentrySubsystem::CaptureMessageWithScope(c
 
 	sentry_scope_t* scope = sentry_local_scope_new();
 
-	TSharedPtr<FGenericPlatformSentryScope> NewLocalScope = MakeShareable(new FGenericPlatformSentryScope(scope));
+	TSharedPtr<FGenericPlatformSentryScope> NewLocalScope = MakeShareable(new FGenericPlatformSentryScope());
 	onConfigureScope.ExecuteIfBound(NewLocalScope);
+	NewLocalScope->Apply(scope);
 
 	sentry_uuid_t id = sentry_capture_event_with_scope(nativeEvent, scope);
 	return MakeShareable(new FGenericPlatformSentryId(id));
@@ -438,8 +439,9 @@ TSharedPtr<ISentryId> FGenericPlatformSentrySubsystem::CaptureEventWithScope(TSh
 
 	sentry_scope_t* scope = sentry_local_scope_new();
 
-	TSharedPtr<FGenericPlatformSentryScope> NewLocalScope = MakeShareable(new FGenericPlatformSentryScope(scope));
+	TSharedPtr<FGenericPlatformSentryScope> NewLocalScope = MakeShareable(new FGenericPlatformSentryScope());
 	onScopeConfigure.ExecuteIfBound(NewLocalScope);
+	NewLocalScope->Apply(scope);
 
 	sentry_uuid_t id = sentry_capture_event_with_scope(nativeEvent, scope);
 	return MakeShareable(new FGenericPlatformSentryId(id));
diff --git a/plugin-dev/Source/Sentry/Private/Tests/SentryScope.spec.cpp b/plugin-dev/Source/Sentry/Private/Tests/SentryScope.spec.cpp
@@ -54,7 +54,6 @@ void SentryScopeSpec::Define()
 		TestFingerprint.Add(TEXT("F3"));
 	});
 
-#if (PLATFORM_APPLE || PLATFORM_ANDROID) && !USE_SENTRY_NATIVE
 	Describe("Scope tags", [this]()
 	{
 		It("should persist value when single item set", [this]()
@@ -116,13 +115,13 @@ void SentryScopeSpec::Define()
 		It("should persist their values", [this]()
 		{
 			SentryScope->SetLevel(ESentryLevel::Fatal);
-			SentryScope->SetDist(TestDist);
-			SentryScope->SetEnvironment(TestEnvironment);
+			// SentryScope->SetDist(TestDist);
+			// SentryScope->SetEnvironment(TestEnvironment);
 			SentryScope->SetFingerprint(TestFingerprint);
 
 			TestEqual("Scope level", SentryScope->GetLevel(), ESentryLevel::Fatal);
-			TestEqual("Scope dist", SentryScope->GetDist(), TestDist);
-			TestEqual("Scope environment", SentryScope->GetEnvironment(), TestEnvironment);
+			// TestEqual("Scope dist", SentryScope->GetDist(), TestDist);
+			// TestEqual("Scope environment", SentryScope->GetEnvironment(), TestEnvironment);
 			TestEqual("Scope fingerprint", SentryScope->GetFingerprint(), TestFingerprint);
 		});
 	});
@@ -131,22 +130,21 @@ void SentryScopeSpec::Define()
 	{
 		It("should be possible to clear", [this]()
 		{
-			SentryScope->SetDist(TestDist);
-			SentryScope->SetEnvironment(TestEnvironment);
+			// SentryScope->SetDist(TestDist);
+			// SentryScope->SetEnvironment(TestEnvironment);
 			SentryScope->SetFingerprint(TestFingerprint);
 			SentryScope->SetTags(TestTags);
 			SentryScope->SetExtras(TestExtras);
 
 			SentryScope->Clear();
 
-			TestTrue("Scope dist", SentryScope->GetDist().IsEmpty());
-			TestTrue("Scope environment", SentryScope->GetEnvironment().IsEmpty());
+			// TestTrue("Scope dist", SentryScope->GetDist().IsEmpty());
+			// TestTrue("Scope environment", SentryScope->GetEnvironment().IsEmpty());
 			TestTrue("Scope fingerprint", SentryScope->GetFingerprint().Num() == 0);
 			TestTrue("Scope tags", SentryScope->GetTags().Num() == 0);
 			TestTrue("Scope extras", SentryScope->GetExtras().Num() == 0);
 		});
 	});
-#endif
 
 #if (PLATFORM_MICROSOFT || PLATFORM_LINUX) && USE_SENTRY_NATIVE
 	Describe("Scope params", [this]()

Original file line number	Diff line number	Diff line change
`@@ -14,12 +14,7 @@`
`14`	`14`	`#if USE_SENTRY_NATIVE`
`15`	`15`
`16`	`16`	`FGenericPlatformSentryScope::FGenericPlatformSentryScope()`
`17`		`-{`
`18`		`- Scope = sentry_local_scope_new();`
`19`		`-}`
`20`		`-`
`21`		`-FGenericPlatformSentryScope::FGenericPlatformSentryScope(sentry_scope_t* scope)`
`22`		`- : Scope(scope)`
	`17`	`+ : Level(ESentryLevel::Debug)`
`23`	`18`	`{`
`24`	`19`	`}`
`25`	`20`
`@@ -29,11 +24,17 @@ FGenericPlatformSentryScope::~FGenericPlatformSentryScope()`
`29`	`24`
`30`	`25`	`void FGenericPlatformSentryScope::AddBreadcrumb(TSharedPtr<ISentryBreadcrumb> breadcrumb)`
`31`	`26`	`{`
`32`		`- sentry_scope_add_breadcrumb(Scope, StaticCastSharedPtr<FGenericPlatformSentryBreadcrumb>(breadcrumb)->GetNativeObject());`
	`27`	`+ if (Breadcrumbs.Num() >= FSentryModule::Get().GetSettings()->MaxBreadcrumbs)`
	`28`	`+ {`
	`29`	`+ Breadcrumbs.PopFront();`
	`30`	`+ }`
	`31`	`+`
	`32`	`+ Breadcrumbs.Add(StaticCastSharedPtr<FGenericPlatformSentryBreadcrumb>(breadcrumb));`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`void FGenericPlatformSentryScope::ClearBreadcrumbs()`
`36`	`36`	`{`
	`37`	`+ Breadcrumbs.Empty();`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`void FGenericPlatformSentryScope::AddAttachment(TSharedPtr<ISentryAttachment> attachment)`
`@@ -48,29 +49,31 @@ void FGenericPlatformSentryScope::ClearAttachments()`
`48`	`49`
`49`	`50`	`void FGenericPlatformSentryScope::SetTagValue(const FString& key, const FString& value)`
`50`	`51`	`{`
`51`		`- sentry_scope_set_tag(Scope, TCHAR_TO_UTF8(key), TCHAR_TO_UTF8(value));`
	`52`	`+ Tags.Add(key, value);`
	`53`	`+`
`52`	`54`	`}`
`53`	`55`
`54`	`56`	`FString FGenericPlatformSentryScope::GetTagValue(const FString& key) const`
`55`	`57`	`{`
`56`		`- return FString();`
	`58`	`+ if (!Tags.Contains(key))`
	`59`	`+ return FString();`
	`60`	`+`
	`61`	`+ return Tags[key];`
`57`	`62`	`}`
`58`	`63`
`59`	`64`	`void FGenericPlatformSentryScope::RemoveTag(const FString& key)`
`60`	`65`	`{`
	`66`	`+ Tags.Remove(key);`
`61`	`67`	`}`
`62`	`68`
`63`	`69`	`void FGenericPlatformSentryScope::SetTags(const TMap<FString, FString>& tags)`
`64`	`70`	`{`
`65`		`- for (const auto& tagItem : tags)`
`66`		`- {`
`67`		`- SetTagValue(tagItem.Key, tagItem.Value);`
`68`		`- }`
	`71`	`+ Tags.Append(tags);`
`69`	`72`	`}`
`70`	`73`
`71`	`74`	`TMap<FString, FString> FGenericPlatformSentryScope::GetTags() const`
`72`	`75`	`{`
`73`		`- return TMap<FString, FString>();`
	`76`	`+ return Tags;`
`74`	`77`	`}`
`75`	`78`
`76`	`79`	`void FGenericPlatformSentryScope::SetDist(const FString& dist)`
`@@ -95,62 +98,120 @@ FString FGenericPlatformSentryScope::GetEnvironment() const`
`95`	`98`
`96`	`99`	`void FGenericPlatformSentryScope::SetFingerprint(const TArray<FString>& fingerprint)`
`97`	`100`	`{`
`98`		`- sentry_scope_set_fingerprints(Scope, FGenericPlatformSentryConverters::StringArrayToNative(fingerprint));`
	`101`	`+ Fingerprint = fingerprint;`
`99`	`102`	`}`
`100`	`103`
`101`	`104`	`TArray<FString> FGenericPlatformSentryScope::GetFingerprint() const`
`102`	`105`	`{`
`103`		`- return TArray<FString>();`
	`106`	`+ return Fingerprint;`
`104`	`107`	`}`
`105`	`108`
`106`	`109`	`void FGenericPlatformSentryScope::SetLevel(ESentryLevel level)`
`107`	`110`	`{`
`108`		`- sentry_scope_set_level(Scope, FGenericPlatformSentryConverters::SentryLevelToNative(level));`
	`111`	`+ Level = level;`
`109`	`112`	`}`
`110`	`113`
`111`	`114`	`ESentryLevel FGenericPlatformSentryScope::GetLevel() const`
`112`	`115`	`{`
`113`		`- return ESentryLevel::Debug;`
	`116`	`+ return Level;`
`114`	`117`	`}`
`115`	`118`
`116`	`119`	`void FGenericPlatformSentryScope::SetContext(const FString& key, const TMap<FString, FString>& values)`
`117`	`120`	`{`
`118`		`- sentry_scope_set_context(Scope, TCHAR_TO_UTF8(*key), FGenericPlatformSentryConverters::StringMapToNative(values));`
	`121`	`+ Contexts.Add(key, values);`
`119`	`122`	`}`
`120`	`123`
`121`	`124`	`void FGenericPlatformSentryScope::RemoveContext(const FString& key)`
`122`	`125`	`{`
	`126`	`+ if (!Contexts.Contains(key))`
	`127`	`+ return;`
	`128`	`+`
	`129`	`+ Contexts.Remove(key);`
`123`	`130`	`}`
`124`	`131`
`125`	`132`	`void FGenericPlatformSentryScope::SetExtraValue(const FString& key, const FString& value)`
`126`	`133`	`{`
`127`		`- sentry_scope_set_extra(Scope, TCHAR_TO_UTF8(key), sentry_value_new_string(TCHAR_TO_UTF8(value)));`
	`134`	`+ Extra.Add(key, value);`
`128`	`135`	`}`
`129`	`136`
`130`	`137`	`FString FGenericPlatformSentryScope::GetExtraValue(const FString& key) const`
`131`	`138`	`{`
`132`		`- return FString();`
	`139`	`+ if (!Extra.Contains(key))`
	`140`	`+ return FString();`
	`141`	`+`
	`142`	`+ return Extra[key];`
`133`	`143`	`}`
`134`	`144`
`135`	`145`	`void FGenericPlatformSentryScope::RemoveExtra(const FString& key)`
`136`	`146`	`{`
	`147`	`+ if (!Extra.Contains(key))`
	`148`	`+ return;`
	`149`	`+`
	`150`	`+ Extra.Remove(key);`
`137`	`151`	`}`
`138`	`152`
`139`	`153`	`void FGenericPlatformSentryScope::SetExtras(const TMap<FString, FString>& extras)`
`140`	`154`	`{`
`141`		`- for (const auto& extraItem : extras)`
`142`		`- {`
`143`		`- SetExtraValue(extraItem.Key, extraItem.Value);`
`144`		`- }`
	`155`	`+ Extra.Append(extras);`
`145`	`156`	`}`
`146`	`157`
`147`	`158`	`TMap<FString, FString> FGenericPlatformSentryScope::GetExtras() const`
`148`	`159`	`{`
`149`		`- return TMap<FString, FString>();`
	`160`	`+ return Extra;`
`150`	`161`	`}`
`151`	`162`
`152`	`163`	`void FGenericPlatformSentryScope::Clear()`
`153`	`164`	`{`
	`165`	`+ Dist = FString();`
	`166`	`+ Environment = FString();`
	`167`	`+ Fingerprint.Empty();`
	`168`	`+ Tags.Empty();`
	`169`	`+ Extra.Empty();`
	`170`	`+ Contexts.Empty();`
	`171`	`+ Breadcrumbs.Empty();`
	`172`	`+ Level = ESentryLevel::Debug;}`
	`173`	`+`
	`174`	`+void FGenericPlatformSentryScope::Apply(sentry_scope_t* scope)`
	`175`	`+{`
	`176`	`+ if (!Breadcrumbs.IsEmpty())`
	`177`	`+ {`
	`178`	`+ for (const auto& Breadcrumb : Breadcrumbs)`
	`179`	`+ {`
	`180`	`+ sentry_value_t nativeBreadcrumb = Breadcrumb->GetNativeObject();`
	`181`	`+ sentry_scope_add_breadcrumb(scope, nativeBreadcrumb);`
	`182`	`+ }`
	`183`	`+ }`
	`184`	`+`
	`185`	`+ if (Fingerprint.Num() > 0)`
	`186`	`+ {`
	`187`	`+ sentry_scope_set_fingerprints(scope, FGenericPlatformSentryConverters::StringArrayToNative(Fingerprint));`
	`188`	`+ }`
	`189`	`+`
	`190`	`+ if (Tags.Num() > 0)`
	`191`	`+ {`
	`192`	`+ for (const auto& TagItem : Tags)`
	`193`	`+ {`
	`194`	`+ sentry_scope_set_tag(scope, TCHAR_TO_UTF8(TagItem.Key), TCHAR_TO_UTF8(TagItem.Value));`
	`195`	`+ }`
	`196`	`+ }`
	`197`	`+`
	`198`	`+ if (Extra.Num() > 0)`
	`199`	`+ {`
	`200`	`+ for (const auto& ExtraItem : Extra)`
	`201`	`+ {`
	`202`	`+ sentry_scope_set_extra(scope, TCHAR_TO_UTF8(ExtraItem.Key), sentry_value_new_string(TCHAR_TO_UTF8(ExtraItem.Value)));`
	`203`	`+ }`
	`204`	`+ }`
	`205`	`+`
	`206`	`+ if (Contexts.Num() > 0)`
	`207`	`+ {`
	`208`	`+ for (const auto& ContextsItem : Contexts)`
	`209`	`+ {`
	`210`	`+ sentry_scope_set_context(scope, TCHAR_TO_UTF8(*ContextsItem.Key), FGenericPlatformSentryConverters::StringMapToNative(ContextsItem.Value));`
	`211`	`+ }`
	`212`	`+ }`
	`213`	`+`
	`214`	`+ sentry_scope_set_level(scope, FGenericPlatformSentryConverters::SentryLevelToNative(Level));`
`154`	`215`	`}`
`155`	`216`
`156`	`217`	`#endif`