Use variant for global context

tustanivsky · tustanivsky · commit 311943f3489d · 2025-06-20T15:55:16.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,12 @@
 
 ### Breaking Changes
 
-- The "Value" suffix has been removed from the get/set function names for tags and extras in `SentryScope`.
-- The get/set functions for contexts and extras in `SentryScope` now accept a variant type instead of string for the value.
-- The get/set functions for arbitrary data in `SentryBreadcrumb` now accept a variant type instead of string for the value.
+- "Value" suffix has been removed from the get/set function names for tags and extras in `SentryScope`.
+- Type of input parameters in certain public API functions was changed from `FString` to `FSentryVariant`:
+  - Get/Set functions for contexts and extras in `SentryScope`
+  - Get/Set functions for arbitrary data in `SentryBreadcrumb`
+  - `AddBreadcrumbWithParams` and `SentContext` functions in `SentrySubsystem`
+  - `CreateSentryBreadcrumb` function in `SentryLibrary`
 
 ## 1.0.0-beta.3
 
diff --git a/plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.cpp b/plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.cpp
@@ -196,10 +196,10 @@ void FAndroidSentrySubsystem::RemoveUser()
 	FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::Sentry, "setUser", "(Lio/sentry/protocol/User;)V", nullptr);
 }
 
-void FAndroidSentrySubsystem::SetContext(const FString& key, const TMap<FString, FString>& values)
+void FAndroidSentrySubsystem::SetContext(const FString& key, const TMap<FString, FSentryVariant>& values)
 {
 	FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::SentryBridgeJava, "setContext", "(Ljava/lang/String;Ljava/util/HashMap;)V",
-		*FSentryJavaObjectWrapper::GetJString(key), FAndroidSentryConverters::StringMapToNative(values)->GetJObject());
+		*FSentryJavaObjectWrapper::GetJString(key), FAndroidSentryConverters::VariantMapToNative(values)->GetJObject());
 }
 
 void FAndroidSentrySubsystem::SetTag(const FString& key, const FString& value)
diff --git a/plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.h b/plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.h
@@ -22,7 +22,7 @@ class FAndroidSentrySubsystem : public ISentrySubsystem
 	virtual void CaptureUserFeedback(TSharedPtr<ISentryUserFeedback> userFeedback) override;
 	virtual void SetUser(TSharedPtr<ISentryUser> user) override;
 	virtual void RemoveUser() override;
-	virtual void SetContext(const FString& key, const TMap<FString, FString>& values) override;
+	virtual void SetContext(const FString& key, const TMap<FString, FSentryVariant>& values) override;
 	virtual void SetTag(const FString& key, const FString& value) override;
 	virtual void RemoveTag(const FString& key) override;
 	virtual void SetLevel(ESentryLevel level) override;
diff --git a/plugin-dev/Source/Sentry/Private/Apple/AppleSentrySubsystem.cpp b/plugin-dev/Source/Sentry/Private/Apple/AppleSentrySubsystem.cpp
@@ -289,10 +289,10 @@ void FAppleSentrySubsystem::RemoveUser()
 	[SentrySDK setUser:nil];
 }
 
-void FAppleSentrySubsystem::SetContext(const FString& key, const TMap<FString, FString>& values)
+void FAppleSentrySubsystem::SetContext(const FString& key, const TMap<FString, FSentryVariant>& values)
 {
 	[SentrySDK configureScope:^(SentryScope* scope) {
-		[scope setContextValue:FAppleSentryConverters::StringMapToNative(values) forKey:key.GetNSString()];
+		[scope setContextValue:FAppleSentryConverters::VariantMapToNative(values) forKey:key.GetNSString()];
 	}];
 }
 
diff --git a/plugin-dev/Source/Sentry/Private/Apple/AppleSentrySubsystem.h b/plugin-dev/Source/Sentry/Private/Apple/AppleSentrySubsystem.h
@@ -22,7 +22,7 @@ class FAppleSentrySubsystem : public ISentrySubsystem
 	virtual void CaptureUserFeedback(TSharedPtr<ISentryUserFeedback> userFeedback) override;
 	virtual void SetUser(TSharedPtr<ISentryUser> user) override;
 	virtual void RemoveUser() override;
-	virtual void SetContext(const FString& key, const TMap<FString, FString>& values) override;
+	virtual void SetContext(const FString& key, const TMap<FString, FSentryVariant>& values) override;
 	virtual void SetTag(const FString& key, const FString& value) override;
 	virtual void RemoveTag(const FString& key) override;
 	virtual void SetLevel(ESentryLevel level) override;
diff --git a/plugin-dev/Source/Sentry/Private/GenericPlatform/CrashReporter/GenericPlatformSentryCrashReporter.cpp b/plugin-dev/Source/Sentry/Private/GenericPlatform/CrashReporter/GenericPlatformSentryCrashReporter.cpp
@@ -4,6 +4,7 @@
 
 #include "GenericPlatform/CrashReporter/GenericPlatformSentryCrashContext.h"
 #include "GenericPlatform/GenericPlatformSentryUser.h"
+#include "GenericPlatform/Infrastructure/GenericPlatformSentryConverters.h"
 
 #include "SentryDefines.h"
 
@@ -70,13 +71,13 @@ void FGenericPlatformSentryCrashReporter::RemoveUser()
 	UpdateCrashReporterConfig();
 }
 
-void FGenericPlatformSentryCrashReporter::SetContext(const FString& key, const TMap<FString, FString>& values)
+void FGenericPlatformSentryCrashReporter::SetContext(const FString& key, const TMap<FString, FSentryVariant>& values)
 {
 	TSharedPtr<FJsonObject> valuesConfig = MakeShareable(new FJsonObject);
 
 	for (auto it = values.CreateConstIterator(); it; ++it)
 	{
-		valuesConfig->SetStringField(it.Key(), it.Value());
+		valuesConfig->Values.Add(it.Key(), FGenericPlatformSentryConverters::VariantToJsonValue(it.Value()));
 	}
 
 	TSharedPtr<FJsonObject> contextConfig;
diff --git a/plugin-dev/Source/Sentry/Private/GenericPlatform/CrashReporter/GenericPlatformSentryCrashReporter.h b/plugin-dev/Source/Sentry/Private/GenericPlatform/CrashReporter/GenericPlatformSentryCrashReporter.h
@@ -3,6 +3,7 @@
 #pragma once
 
 #include "CoreMinimal.h"
+#include "SentryVariant.h"
 
 #if USE_SENTRY_NATIVE
 
@@ -19,7 +20,7 @@ class FGenericPlatformSentryCrashReporter
 	void SetEnvironment(const FString& environment);
 	void SetUser(TSharedPtr<FGenericPlatformSentryUser> user);
 	void RemoveUser();
-	void SetContext(const FString& key, const TMap<FString, FString>& values);
+	void SetContext(const FString& key, const TMap<FString, FSentryVariant>& values);
 	void SetTag(const FString& key, const FString& value);
 	void RemoveTag(const FString& key);
 
diff --git a/plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentrySubsystem.cpp b/plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentrySubsystem.cpp
@@ -499,9 +499,9 @@ void FGenericPlatformSentrySubsystem::RemoveUser()
 	}
 }
 
-void FGenericPlatformSentrySubsystem::SetContext(const FString& key, const TMap<FString, FString>& values)
+void FGenericPlatformSentrySubsystem::SetContext(const FString& key, const TMap<FString, FSentryVariant>& values)
 {
-	sentry_set_context(TCHAR_TO_UTF8(*key), FGenericPlatformSentryConverters::StringMapToNative(values));
+	sentry_set_context(TCHAR_TO_UTF8(*key), FGenericPlatformSentryConverters::VariantMapToNative(values));
 
 	if (crashReporter)
 	{
diff --git a/plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentrySubsystem.h b/plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentrySubsystem.h
@@ -33,7 +33,7 @@ class FGenericPlatformSentrySubsystem : public ISentrySubsystem
 	virtual void CaptureUserFeedback(TSharedPtr<ISentryUserFeedback> userFeedback) override;
 	virtual void SetUser(TSharedPtr<ISentryUser> user) override;
 	virtual void RemoveUser() override;
-	virtual void SetContext(const FString& key, const TMap<FString, FString>& values) override;
+	virtual void SetContext(const FString& key, const TMap<FString, FSentryVariant>& values) override;
 	virtual void SetTag(const FString& key, const FString& value) override;
 	virtual void RemoveTag(const FString& key) override;
 	virtual void SetLevel(ESentryLevel level) override;
diff --git a/plugin-dev/Source/Sentry/Private/GenericPlatform/Infrastructure/GenericPlatformSentryConverters.cpp b/plugin-dev/Source/Sentry/Private/GenericPlatform/Infrastructure/GenericPlatformSentryConverters.cpp
@@ -361,4 +361,66 @@ ELogVerbosity::Type FGenericPlatformSentryConverters::SentryLevelToLogVerbosity(
 	return LogVerbosity;
 }
 
+TSharedPtr<FJsonValue> FGenericPlatformSentryConverters::VariantToJsonValue(const FSentryVariant& variant)
+{
+	switch (variant.GetType())
+	{
+	case ESentryVariantType::Integer:
+		return MakeShareable(new FJsonValueNumber(variant.GetValue<int32>()));
+	case ESentryVariantType::Float:
+		return MakeShareable(new FJsonValueNumber(variant.GetValue<float>()));
+	case ESentryVariantType::Bool:
+		return MakeShareable(new FJsonValueBoolean(variant.GetValue<bool>()));
+	case ESentryVariantType::String:
+		return MakeShareable(new FJsonValueString(variant.GetValue<FString>()));
+	case ESentryVariantType::Array:
+		return VariantArrayToJsonValue(variant.GetValue<TArray<FSentryVariant>>());
+	case ESentryVariantType::Map:
+		return VariantMapToJsonValue(variant.GetValue<TMap<FString, FSentryVariant>>());
+	default:
+		return MakeShareable(new FJsonValueNull());
+	}
+}
+
+TSharedPtr<FJsonValue> FGenericPlatformSentryConverters::VariantArrayToJsonValue(const TArray<FSentryVariant>& array)
+{
+	TArray<TSharedPtr<FJsonValue>> jsonArray;
+
+	for (auto it = array.CreateConstIterator(); it; ++it)
+	{
+		const FSentryVariant& variant = *it;
+		TSharedPtr<FJsonValue> jsonValue = VariantToJsonValue(variant);
+		if (jsonValue.IsValid())
+		{
+			jsonArray.Add(jsonValue);
+		}
+	}
+
+	return MakeShareable(new FJsonValueArray(jsonArray));
+}
+
+TSharedPtr<FJsonValue> FGenericPlatformSentryConverters::VariantMapToJsonValue(const TMap<FString, FSentryVariant>& map)
+{
+	TSharedPtr<FJsonObject> jsonObject = MakeShareable(new FJsonObject);
+
+	for (auto it = map.CreateConstIterator(); it; ++it)
+	{
+		const FString& key = it.Key();
+		const FSentryVariant& variant = it.Value();
+
+		if (variant.GetType() == ESentryVariantType::Empty)
+		{
+			continue;
+		}
+
+		TSharedPtr<FJsonValue> jsonValue = VariantToJsonValue(variant);
+		if (jsonValue.IsValid())
+		{
+			jsonObject->SetField(key, jsonValue);
+		}
+	}
+
+	return MakeShareable(new FJsonValueObject(jsonObject));
+}
+
 #endif
diff --git a/plugin-dev/Source/Sentry/Private/GenericPlatform/Infrastructure/GenericPlatformSentryConverters.h b/plugin-dev/Source/Sentry/Private/GenericPlatform/Infrastructure/GenericPlatformSentryConverters.h
@@ -10,6 +10,8 @@
 
 #if USE_SENTRY_NATIVE
 
+class FJsonValue;
+
 class FGenericPlatformSentryConverters
 {
 public:
@@ -36,6 +38,9 @@ class FGenericPlatformSentryConverters
 	static FString SentryLevelToString(ESentryLevel level);
 	static TArray<uint8> SentryEnvelopeToByteArray(sentry_envelope_t* envelope);
 	static ELogVerbosity::Type SentryLevelToLogVerbosity(sentry_level_t level);
+	static TSharedPtr<FJsonValue> VariantToJsonValue(const FSentryVariant& variant);
+	static TSharedPtr<FJsonValue> VariantArrayToJsonValue(const TArray<FSentryVariant>& array);
+	static TSharedPtr<FJsonValue> VariantMapToJsonValue(const TMap<FString, FSentryVariant>& map);
 };
 
 #endif
diff --git a/plugin-dev/Source/Sentry/Private/Interface/SentrySubsystemInterface.h b/plugin-dev/Source/Sentry/Private/Interface/SentrySubsystemInterface.h
@@ -43,7 +43,7 @@ class ISentrySubsystem
 	virtual void CaptureUserFeedback(TSharedPtr<ISentryUserFeedback> userFeedback) = 0;
 	virtual void SetUser(TSharedPtr<ISentryUser> user) = 0;
 	virtual void RemoveUser() = 0;
-	virtual void SetContext(const FString& key, const TMap<FString, FString>& values) = 0;
+	virtual void SetContext(const FString& key, const TMap<FString, FSentryVariant>& values) = 0;
 	virtual void SetTag(const FString& key, const FString& value) = 0;
 	virtual void RemoveTag(const FString& key) = 0;
 	virtual void SetLevel(ESentryLevel level) = 0;
diff --git a/plugin-dev/Source/Sentry/Private/Null/NullSentrySubsystem.h b/plugin-dev/Source/Sentry/Private/Null/NullSentrySubsystem.h
@@ -25,7 +25,7 @@ class FNullSentrySubsystem : public ISentrySubsystem
 	virtual void SetUser(TSharedPtr<ISentryUser> user) override {}
 	virtual void RemoveUser() override {}
 	virtual void ConfigureScope(const FSentryScopeDelegate& onConfigureScope) override {}
-	virtual void SetContext(const FString& key, const TMap<FString, FString>& values) override {}
+	virtual void SetContext(const FString& key, const TMap<FString, FSentryVariant>& values) override {}
 	virtual void SetTag(const FString& key, const FString& value) override {}
 	virtual void RemoveTag(const FString& key) override {}
 	virtual void SetLevel(ESentryLevel level) override {}
diff --git a/plugin-dev/Source/Sentry/Private/SentrySubsystem.cpp b/plugin-dev/Source/Sentry/Private/SentrySubsystem.cpp
@@ -375,7 +375,7 @@ void USentrySubsystem::RemoveUser()
 	SubsystemNativeImpl->RemoveUser();
 }
 
-void USentrySubsystem::SetContext(const FString& Key, const TMap<FString, FString>& Values)
+void USentrySubsystem::SetContext(const FString& Key, const TMap<FString, FSentryVariant>& Values)
 {
 	check(SubsystemNativeImpl);
 
@@ -549,7 +549,7 @@ void USentrySubsystem::AddDefaultContext()
 		return;
 	}
 
-	TMap<FString, FString> DefaultContext;
+	TMap<FString, FSentryVariant> DefaultContext;
 	DefaultContext.Add(TEXT("Engine version"), FEngineVersion::Current().ToString(EVersionComponent::Changelist));
 	DefaultContext.Add(TEXT("Plugin version"), FSentryModule::Get().GetPluginVersion());
 	DefaultContext.Add(TEXT("Is Marketplace version"), LexToString(FSentryModule::Get().IsMarketplaceVersion()));
@@ -575,7 +575,7 @@ void USentrySubsystem::AddGpuContext()
 
 	FGPUDriverInfo GpuDriverInfo = FPlatformMisc::GetGPUDriverInfo(FPlatformMisc::GetPrimaryGPUBrand());
 
-	TMap<FString, FString> GpuContext;
+	TMap<FString, FSentryVariant> GpuContext;
 	GpuContext.Add(TEXT("name"), GpuDriverInfo.DeviceDescription);
 	GpuContext.Add(TEXT("vendor_name"), GpuDriverInfo.ProviderName);
 	GpuContext.Add(TEXT("driver_version"), GpuDriverInfo.UserDriverVersion);
@@ -594,7 +594,7 @@ void USentrySubsystem::AddDeviceContext()
 
 	const FPlatformMemoryConstants& MemoryConstants = FPlatformMemory::GetConstants();
 
-	TMap<FString, FString> DeviceContext;
+	TMap<FString, FSentryVariant> DeviceContext;
 	DeviceContext.Add(TEXT("cpu_description"), FPlatformMisc::GetCPUBrand());
 	DeviceContext.Add(TEXT("number_of_cores"), FString::FromInt(FPlatformMisc::NumberOfCores()));
 	DeviceContext.Add(TEXT("number_of_cores_including_hyperthreads"), FString::FromInt(FPlatformMisc::NumberOfCoresIncludingHyperthreads()));
diff --git a/plugin-dev/Source/Sentry/Public/SentrySubsystem.h b/plugin-dev/Source/Sentry/Public/SentrySubsystem.h
@@ -189,7 +189,7 @@ class SENTRY_API USentrySubsystem : public UEngineSubsystem
 	 * @param Values Context values.
 	 */
 	UFUNCTION(BlueprintCallable, Category = "Sentry")
-	void SetContext(const FString& Key, const TMap<FString, FString>& Values);
+	void SetContext(const FString& Key, const TMap<FString, FSentryVariant>& Values);
 
 	/**
 	 * Sets global tag - key/value string pair which will be attached to every event.

Original file line number	Diff line number	Diff line change
`@@ -196,10 +196,10 @@ void FAndroidSentrySubsystem::RemoveUser()`
`196`	`196`	`FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::Sentry, "setUser", "(Lio/sentry/protocol/User;)V", nullptr);`
`197`	`197`	`}`
`198`	`198`
`199`		`-void FAndroidSentrySubsystem::SetContext(const FString& key, const TMap<FString, FString>& values)`
	`199`	`+void FAndroidSentrySubsystem::SetContext(const FString& key, const TMap<FString, FSentryVariant>& values)`
`200`	`200`	`{`
`201`	`201`	`FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::SentryBridgeJava, "setContext", "(Ljava/lang/String;Ljava/util/HashMap;)V",`
`202`		`- *FSentryJavaObjectWrapper::GetJString(key), FAndroidSentryConverters::StringMapToNative(values)->GetJObject());`
	`202`	`+ *FSentryJavaObjectWrapper::GetJString(key), FAndroidSentryConverters::VariantMapToNative(values)->GetJObject());`
`203`	`203`	`}`
`204`	`204`
`205`	`205`	`void FAndroidSentrySubsystem::SetTag(const FString& key, const FString& value)`
Original file line number	Diff line number	Diff line change
`@@ -289,10 +289,10 @@ void FAppleSentrySubsystem::RemoveUser()`
`289`	`289`	`[SentrySDK setUser:nil];`
`290`	`290`	`}`
`291`	`291`
`292`		`-void FAppleSentrySubsystem::SetContext(const FString& key, const TMap<FString, FString>& values)`
	`292`	`+void FAppleSentrySubsystem::SetContext(const FString& key, const TMap<FString, FSentryVariant>& values)`
`293`	`293`	`{`
`294`	`294`	`[SentrySDK configureScope:^(SentryScope* scope) {`
`295`		`- [scope setContextValue:FAppleSentryConverters::StringMapToNative(values) forKey:key.GetNSString()];`
	`295`	`+ [scope setContextValue:FAppleSentryConverters::VariantMapToNative(values) forKey:key.GetNSString()];`
`296`	`296`	`}];`
`297`	`297`	`}`
`298`	`298`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`#include "GenericPlatform/CrashReporter/GenericPlatformSentryCrashContext.h"`
`6`	`6`	`#include "GenericPlatform/GenericPlatformSentryUser.h"`
	`7`	`+#include "GenericPlatform/Infrastructure/GenericPlatformSentryConverters.h"`
`7`	`8`
`8`	`9`	`#include "SentryDefines.h"`
`9`	`10`
`@@ -70,13 +71,13 @@ void FGenericPlatformSentryCrashReporter::RemoveUser()`
`70`	`71`	`UpdateCrashReporterConfig();`
`71`	`72`	`}`
`72`	`73`
`73`		`-void FGenericPlatformSentryCrashReporter::SetContext(const FString& key, const TMap<FString, FString>& values)`
	`74`	`+void FGenericPlatformSentryCrashReporter::SetContext(const FString& key, const TMap<FString, FSentryVariant>& values)`
`74`	`75`	`{`
`75`	`76`	`TSharedPtr<FJsonObject> valuesConfig = MakeShareable(new FJsonObject);`
`76`	`77`
`77`	`78`	`for (auto it = values.CreateConstIterator(); it; ++it)`
`78`	`79`	`{`
`79`		`- valuesConfig->SetStringField(it.Key(), it.Value());`
	`80`	`+ valuesConfig->Values.Add(it.Key(), FGenericPlatformSentryConverters::VariantToJsonValue(it.Value()));`
`80`	`81`	`}`
`81`	`82`
`82`	`83`	`TSharedPtr<FJsonObject> contextConfig;`
Original file line number	Diff line number	Diff line change
`@@ -499,9 +499,9 @@ void FGenericPlatformSentrySubsystem::RemoveUser()`
`499`	`499`	`}`
`500`	`500`	`}`
`501`	`501`
`502`		`-void FGenericPlatformSentrySubsystem::SetContext(const FString& key, const TMap<FString, FString>& values)`
	`502`	`+void FGenericPlatformSentrySubsystem::SetContext(const FString& key, const TMap<FString, FSentryVariant>& values)`
`503`	`503`	`{`
`504`		`- sentry_set_context(TCHAR_TO_UTF8(*key), FGenericPlatformSentryConverters::StringMapToNative(values));`
	`504`	`+ sentry_set_context(TCHAR_TO_UTF8(*key), FGenericPlatformSentryConverters::VariantMapToNative(values));`
`505`	`505`
`506`	`506`	`if (crashReporter)`
`507`	`507`	`{`