Add traces sampling function support for Windows and Linux (#1057)

* Rework creating transaction with options

* Add trace sampler support for Windows/Linux

* Format code

* Move global ref under platform define

* Clean up

* Update changelog

* Update package snapshot

* Reset global static pointer on subsystem close

* Remove static global subsystem pointer

* Format code

* Add engine null check

* Format code

* Add tests

* Update packeage snapshot

* Format code

---------

Co-authored-by: Sentry Github Bot <bot+github-bot@sentry.io>

Author: 2 people

CHANGELOG.md

@@ -10,11 +10,14 @@
   - `CaptureUserFeedback` function in `SentrySubsystem` replaced with `CaptureFeedback`
   - `CreateSentryUserFeedback` function in `SentryLibrary` replaced with `CreateSentryFeedback`
 - On Windows and Linux, `ToString` function of `SentryId` class now returns the ID without dashes
+- `StartTransactionWithContextAndOptions` function in `SentrySubsystem` now accepts `FSentryTransactionOptions` struct instead of string map
+- `GetCustomSamplingContext` function in `SentrySamplingContext` now returns `TMap<FString, FSentryVariant>` instead of string map
 
 ### Features
 
 - Add functionality to give/revoke user consent for crash uploads ([#1053](https://github.com/getsentry/sentry-unreal/pull/1053))
 - Add new API for capturing user feedback ([#1051](https://github.com/getsentry/sentry-unreal/pull/1051))
+- Add Traces sampling function support for Windows and Linux ([#1057](https://github.com/getsentry/sentry-unreal/pull/1057))
 - Read `DSN`, `Environment` and `Release` options from environment variables ([#1054](https://github.com/getsentry/sentry-unreal/pull/1054))
 
 ### Dependencies

plugin-dev/Source/Sentry/Private/Android/AndroidSentrySamplingContext.cpp

@@ -24,15 +24,15 @@ TSharedPtr<ISentryTransactionContext> FAndroidSentrySamplingContext::GetTransact
 	return MakeShareable(new FAndroidSentryTransactionContext(*transactionContext));
 }
 
-TMap<FString, FString> FAndroidSentrySamplingContext::GetCustomSamplingContext() const
+TMap<FString, FSentryVariant> FAndroidSentrySamplingContext::GetCustomSamplingContext() const
 {
 	auto customSamplingContext = CallObjectMethod<jobject>(GetCustomSamplingContextMethod);
 	if (!customSamplingContext)
-		return TMap<FString, FString>();
+		return TMap<FString, FSentryVariant>();
 
 	FSentryJavaObjectWrapper NativeCustomSamplingContext(SentryJavaClasses::CustomSamplingContext, *customSamplingContext);
 	FSentryJavaMethod GetDataMethod = NativeCustomSamplingContext.GetMethod("getData", "()Ljava/util/Map;");
 
 	auto data = NativeCustomSamplingContext.CallObjectMethod<jobject>(GetDataMethod);
-	return FAndroidSentryConverters::StringMapToUnreal(*data);
+	return FAndroidSentryConverters::VariantMapToUnreal(*data);
 }

plugin-dev/Source/Sentry/Private/Android/AndroidSentrySamplingContext.h

@@ -14,7 +14,7 @@ class FAndroidSentrySamplingContext : public ISentrySamplingContext, public FSen
 	void SetupClassMethods();
 
 	virtual TSharedPtr<ISentryTransactionContext> GetTransactionContext() const override;
-	virtual TMap<FString, FString> GetCustomSamplingContext() const override;
+	virtual TMap<FString, FSentryVariant> GetCustomSamplingContext() const override;
 
 private:
 	FSentryJavaMethod GetTransactionContextMethod;

plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.cpp

@@ -297,12 +297,12 @@ TSharedPtr<ISentryTransaction> FAndroidSentrySubsystem::StartTransactionWithCont
 	return StartTransactionWithContext(context);
 }
 
-TSharedPtr<ISentryTransaction> FAndroidSentrySubsystem::StartTransactionWithContextAndOptions(TSharedPtr<ISentryTransactionContext> context, const TMap<FString, FString>& options)
+TSharedPtr<ISentryTransaction> FAndroidSentrySubsystem::StartTransactionWithContextAndOptions(TSharedPtr<ISentryTransactionContext> context, const FSentryTransactionOptions& options)
 {
 	TSharedPtr<FAndroidSentryTransactionContext> transactionContextAndroid = StaticCastSharedPtr<FAndroidSentryTransactionContext>(context);
 
 	TSharedPtr<FAndroidSentryTransactionOptions> transactionOptionsAndroid = MakeShareable(new FAndroidSentryTransactionOptions());
-	transactionOptionsAndroid->SetCustomSamplingContext(options);
+	transactionOptionsAndroid->SetCustomSamplingContext(options.CustomSamplingContext);
 
 	auto transaction = FSentryJavaObjectWrapper::CallStaticObjectMethod<jobject>(SentryJavaClasses::Sentry, "startTransaction", "(Lio/sentry/TransactionContext;Lio/sentry/TransactionOptions;)Lio/sentry/ITransaction;",
 		transactionContextAndroid->GetJObject(), transactionOptionsAndroid->GetJObject());

plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.h

@@ -37,7 +37,7 @@ class FAndroidSentrySubsystem : public ISentrySubsystem
 	virtual TSharedPtr<ISentryTransaction> StartTransaction(const FString& name, const FString& operation) override;
 	virtual TSharedPtr<ISentryTransaction> StartTransactionWithContext(TSharedPtr<ISentryTransactionContext> context) override;
 	virtual TSharedPtr<ISentryTransaction> StartTransactionWithContextAndTimestamp(TSharedPtr<ISentryTransactionContext> context, int64 timestamp) override;
-	virtual TSharedPtr<ISentryTransaction> StartTransactionWithContextAndOptions(TSharedPtr<ISentryTransactionContext> context, const TMap<FString, FString>& options) override;
+	virtual TSharedPtr<ISentryTransaction> StartTransactionWithContextAndOptions(TSharedPtr<ISentryTransactionContext> context, const FSentryTransactionOptions& options) override;
 	virtual TSharedPtr<ISentryTransactionContext> ContinueTrace(const FString& sentryTrace, const TArray<FString>& baggageHeaders) override;
 
 	virtual void HandleAssert() override;

plugin-dev/Source/Sentry/Private/Android/AndroidSentryTransactionOptions.cpp

@@ -16,14 +16,14 @@ void FAndroidSentryTransactionOptions::SetupClassMethods()
 	SetCustomSamplingContextMethod = GetMethod("setCustomSamplingContext", "(Lio/sentry/CustomSamplingContext;)V");
 }
 
-void FAndroidSentryTransactionOptions::SetCustomSamplingContext(const TMap<FString, FString>& data)
+void FAndroidSentryTransactionOptions::SetCustomSamplingContext(const TMap<FString, FSentryVariant>& data)
 {
 	FSentryJavaObjectWrapper NativeCustomSamplingContext(SentryJavaClasses::CustomSamplingContext, "()V");
 	FSentryJavaMethod SetMethod = NativeCustomSamplingContext.GetMethod("set", "(Ljava/lang/String;Ljava/lang/Object;)V");
 
 	for (const auto& dataItem : data)
 	{
-		NativeCustomSamplingContext.CallMethod<void>(SetMethod, *GetJString(dataItem.Key), *GetJString(dataItem.Value));
+		NativeCustomSamplingContext.CallMethod<void>(SetMethod, *GetJString(dataItem.Key), FAndroidSentryConverters::VariantToNative(dataItem.Value)->GetJObject());
 	}
 
 	CallMethod<void>(SetCustomSamplingContextMethod, NativeCustomSamplingContext.GetJObject());

plugin-dev/Source/Sentry/Private/Android/AndroidSentryTransactionOptions.h

@@ -2,6 +2,8 @@
 
 #pragma once
 
+#include "SentryVariant.h"
+
 #include "Infrastructure/AndroidSentryJavaObjectWrapper.h"
 
 class FAndroidSentryTransactionOptions : public FSentryJavaObjectWrapper
@@ -11,7 +13,7 @@ class FAndroidSentryTransactionOptions : public FSentryJavaObjectWrapper
 
 	void SetupClassMethods();
 
-	void SetCustomSamplingContext(const TMap<FString, FString>& data);
+	void SetCustomSamplingContext(const TMap<FString, FSentryVariant>& data);
 
 private:
 	FSentryJavaMethod SetCustomSamplingContextMethod;

plugin-dev/Source/Sentry/Private/Apple/AppleSentrySamplingContext.cpp

@@ -22,9 +22,9 @@ TSharedPtr<ISentryTransactionContext> FAppleSentrySamplingContext::GetTransactio
 	return MakeShareable(new FAppleSentryTransactionContext(SamplingContext.transactionContext));
 }
 
-TMap<FString, FString> FAppleSentrySamplingContext::GetCustomSamplingContext() const
+TMap<FString, FSentryVariant> FAppleSentrySamplingContext::GetCustomSamplingContext() const
 {
-	return FAppleSentryConverters::StringMapToUnreal(SamplingContext.customSamplingContext);
+	return FAppleSentryConverters::VariantMapToUnreal(SamplingContext.customSamplingContext);
 }
 
 SentrySamplingContext* FAppleSentrySamplingContext::GetNativeObject()

plugin-dev/Source/Sentry/Private/Apple/AppleSentrySamplingContext.h

@@ -13,7 +13,7 @@ class FAppleSentrySamplingContext : public ISentrySamplingContext
 	virtual ~FAppleSentrySamplingContext() override;
 
 	virtual TSharedPtr<ISentryTransactionContext> GetTransactionContext() const override;
-	virtual TMap<FString, FString> GetCustomSamplingContext() const override;
+	virtual TMap<FString, FSentryVariant> GetCustomSamplingContext() const override;
 
 	SentrySamplingContext* GetNativeObject();
 

plugin-dev/Source/Sentry/Private/Apple/AppleSentrySubsystem.cpp

@@ -387,12 +387,12 @@ TSharedPtr<ISentryTransaction> FAppleSentrySubsystem::StartTransactionWithContex
 	return StartTransactionWithContext(context);
 }
 
-TSharedPtr<ISentryTransaction> FAppleSentrySubsystem::StartTransactionWithContextAndOptions(TSharedPtr<ISentryTransactionContext> context, const TMap<FString, FString>& options)
+TSharedPtr<ISentryTransaction> FAppleSentrySubsystem::StartTransactionWithContextAndOptions(TSharedPtr<ISentryTransactionContext> context, const FSentryTransactionOptions& options)
 {
 	TSharedPtr<FAppleSentryTransactionContext> transactionContextIOS = StaticCastSharedPtr<FAppleSentryTransactionContext>(context);
 
 	id<SentrySpan> transaction = [SENTRY_APPLE_CLASS(SentrySDK) startTransactionWithContext:transactionContextIOS->GetNativeObject()
-																	  customSamplingContext:FAppleSentryConverters::StringMapToNative(options)];
+																	  customSamplingContext:FAppleSentryConverters::VariantMapToNative(options.CustomSamplingContext)];
 
 	return MakeShareable(new FAppleSentryTransaction(transaction));
 }