Resolve PR comments

Author: mujacica

plugin-dev/Source/Sentry/Private/Android/Jni/AndroidSentryJni.cpp

@@ -20,7 +20,7 @@
 #include "SentryDefines.h"
 #include "SentryEvent.h"
 #include "SentryHint.h"
-#include "SentryLogData.h"
+#include "SentryLog.h"
 #include "SentrySamplingContext.h"
 #include "SentryTraceSampler.h"
 
@@ -120,10 +120,10 @@ JNI_METHOD jobject Java_io_sentry_unreal_SentryBridgeJava_onBeforeLog(JNIEnv* en
 
 	USentryBeforeLogHandler* handler = reinterpret_cast<USentryBeforeLogHandler*>(objAddr);
 
-	USentryLogData* LogDataToProcess = USentryLogData::Create(MakeShareable(new FAndroidSentryLog(logEvent)));
+	USentryLog* LogDataToProcess = USentryLog::Create(MakeShareable(new FAndroidSentryLog(logEvent)));
 	USentryHint* HintToProcess = USentryHint::Create(MakeShareable(new FAndroidSentryHint(hint)));
 
-	USentryLogData* ProcessedLogData = handler->HandleBeforeLog(LogDataToProcess);
+	USentryLog* ProcessedLogData = handler->HandleBeforeLog(LogDataToProcess);
 
 	return ProcessedLogData ? logEvent : nullptr;
 }

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

@@ -143,9 +143,9 @@ void FAppleSentrySubsystem::InitWithSettings(const USentrySettings* settings, US
 						return log;
 					}
 
-					USentryLogData* LogToProcess = USentryLogData::Create(MakeShareable(new FAppleSentryLog(log)));
+					USentryLog* LogToProcess = USentryLog::Create(MakeShareable(new FAppleSentryLog(log)));
 
-					USentryLogData* ProcessedLog = beforeLogHandler->HandleBeforeLog(LogToProcess);
+					USentryLog* ProcessedLog = beforeLogHandler->HandleBeforeLog(LogToProcess);
 
 					return ProcessedLog ? log : nullptr;
 				};

plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentrySubsystem.cpp

@@ -19,7 +19,7 @@
 #include "SentryBreadcrumb.h"
 #include "SentryDefines.h"
 #include "SentryEvent.h"
-#include "SentryLogData.h"
+#include "SentryLog.h"
 #include "SentryModule.h"
 #include "SentrySamplingContext.h"
 #include "SentrySettings.h"
@@ -124,6 +124,23 @@ static void PrintVerboseLog(sentry_level_t level, const char* message, va_list a
 	return log;
 }
 
+bool FGenericPlatformSentrySubsystem::IsCallbackSafeToRun(const FString& handlerName) const
+{
+	if (FUObjectThreadContext::Get().IsRoutingPostLoad)
+	{
+		UE_LOG(LogSentrySdk, Log, TEXT("Executing `%s` handler is not allowed during object post-loading."), *handlerName);
+		return false;
+	}
+
+	if (IsGarbageCollecting())
+	{
+		UE_LOG(LogSentrySdk, Log, TEXT("Executing `%s` handler is not allowed during garbage collection."), *handlerName);
+		return false;
+	}
+
+	return true;
+}
+
 sentry_value_t FGenericPlatformSentrySubsystem::OnBeforeSend(sentry_value_t event, void* hint, void* closure, bool isCrash)
 {
 	if (!closure || this != closure)
@@ -138,18 +155,8 @@ sentry_value_t FGenericPlatformSentrySubsystem::OnBeforeSend(sentry_value_t even
 		return event;
 	}
 
-	if (FUObjectThreadContext::Get().IsRoutingPostLoad)
+	if (!IsCallbackSafeToRun(TEXT("beforeSend")))
 	{
-		UE_LOG(LogSentrySdk, Log, TEXT("Executing `beforeSend` handler is not allowed during object post-loading."));
-		return event;
-	}
-
-	if (IsGarbageCollecting())
-	{
-		// If event is captured during garbage collection we can't instantiate UObjects safely or obtain a GC lock
-		// since it will cause a deadlock (see https://github.com/getsentry/sentry-unreal/issues/850).
-		// In this case event will be reported without calling a `beforeSend` handler.
-		UE_LOG(LogSentrySdk, Log, TEXT("Executing `beforeSend` handler is not allowed during garbage collection."));
 		return event;
 	}
 
@@ -177,17 +184,8 @@ sentry_value_t FGenericPlatformSentrySubsystem::OnBeforeBreadcrumb(sentry_value_
 		return breadcrumb;
 	}
 
-	if (FUObjectThreadContext::Get().IsRoutingPostLoad)
+	if (!IsCallbackSafeToRun(TEXT("beforeBreadcrumb")))
 	{
-		// Don't print to logs within `onBeforeBreadcrumb` handler as this can lead to creating new breadcrumb
-		return breadcrumb;
-	}
-
-	if (IsGarbageCollecting())
-	{
-		// If breadcrumb is added during garbage collection we can't instantiate UObjects safely or obtain a GC lock
-		// since there is no guarantee it will be ever freed.
-		// In this case breadcrumb will be added without calling a `beforeBreadcrumb` handler.
 		return breadcrumb;
 	}
 
@@ -212,24 +210,15 @@ sentry_value_t FGenericPlatformSentrySubsystem::OnBeforeLog(sentry_value_t log,
 		return log;
 	}
 
-	if (FUObjectThreadContext::Get().IsRoutingPostLoad)
+	if (!IsCallbackSafeToRun(TEXT("beforeLog")))
 	{
-		// Skip log processing during post load to avoid issues
 		return log;
 	}
 
-	if (IsGarbageCollecting())
-	{
-		// If breadcrumb is added during garbage collection we can't instantiate UObjects safely or obtain a GC lock
-		// since there is no guarantee it will be ever freed.
-		// In this case breadcrumb will be added without calling a `beforeBreadcrumb` handler.
-		return log;
-	}
-
-	// Create USentryLogData object using the log wrapper
-	USentryLogData* LogData = USentryLogData::Create(MakeShareable(new FGenericPlatformSentryLog(log)));
+	// Create USentryLog object using the log wrapper
+	USentryLog* LogData = USentryLog::Create(MakeShareable(new FGenericPlatformSentryLog(log)));
 
-	USentryLogData* ProcessedLogData = Handler->HandleBeforeLog(LogData);
+	USentryLog* ProcessedLogData = Handler->HandleBeforeLog(LogData);
 
 	return ProcessedLogData ? log : sentry_value_new_null();
 }
@@ -260,18 +249,8 @@ double FGenericPlatformSentrySubsystem::OnTraceSampling(const sentry_transaction
 		return parent_sampled != nullptr ? *parent_sampled : 0.0;
 	}
 
-	if (FUObjectThreadContext::Get().IsRoutingPostLoad)
-	{
-		UE_LOG(LogSentrySdk, Log, TEXT("Executing traces sampler is not allowed during object post-loading."));
-		return parent_sampled != nullptr ? *parent_sampled : 0.0;
-	}
-
-	if (IsGarbageCollecting())
+	if (!IsCallbackSafeToRun(TEXT("traceSampler")))
 	{
-		// If traces sampling happens during garbage collection we can't instantiate UObjects safely or obtain a GC lock
-		// since it will cause a deadlock (see https://github.com/getsentry/sentry-unreal/issues/850).
-		// In this case event will be reported without calling a `beforeSend` handler.
-		UE_LOG(LogSentrySdk, Log, TEXT("Executing traces sampler is not allowed during garbage collection."));
 		return parent_sampled != nullptr ? *parent_sampled : 0.0;
 	}
 
@@ -861,22 +840,22 @@ TSharedPtr<ISentryTransactionContext> FGenericPlatformSentrySubsystem::ContinueT
 	return transactionContext;
 }
 
-USentryBeforeSendHandler* FGenericPlatformSentrySubsystem::GetBeforeSendHandler()
+USentryBeforeSendHandler* FGenericPlatformSentrySubsystem::GetBeforeSendHandler() const
 {
 	return beforeSend;
 }
 
-USentryBeforeBreadcrumbHandler* FGenericPlatformSentrySubsystem::GetBeforeBreadcrumbHandler()
+USentryBeforeBreadcrumbHandler* FGenericPlatformSentrySubsystem::GetBeforeBreadcrumbHandler() const
 {
 	return beforeBreadcrumb;
 }
 
-USentryBeforeLogHandler* FGenericPlatformSentrySubsystem::GetBeforeLogHandler()
+USentryBeforeLogHandler* FGenericPlatformSentrySubsystem::GetBeforeLogHandler() const
 {
 	return beforeLog;
 }
 
-USentryTraceSampler* FGenericPlatformSentrySubsystem::GetTraceSampler()
+USentryTraceSampler* FGenericPlatformSentrySubsystem::GetTraceSampler() const
 {
 	return sampler;
 }

plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentrySubsystem.h

@@ -55,10 +55,10 @@ class FGenericPlatformSentrySubsystem : public ISentrySubsystem
 
 	virtual void HandleAssert() override {}
 
-	USentryBeforeSendHandler* GetBeforeSendHandler();
-	USentryBeforeBreadcrumbHandler* GetBeforeBreadcrumbHandler();
-	USentryBeforeLogHandler* GetBeforeLogHandler();
-	USentryTraceSampler* GetTraceSampler();
+	USentryBeforeSendHandler* GetBeforeSendHandler() const;
+	USentryBeforeBreadcrumbHandler* GetBeforeBreadcrumbHandler() const;
+	USentryBeforeLogHandler* GetBeforeLogHandler() const;
+	USentryTraceSampler* GetTraceSampler() const;
 
 	void TryCaptureScreenshot();
 	void TryCaptureGpuDump();
@@ -98,6 +98,12 @@ class FGenericPlatformSentrySubsystem : public ISentrySubsystem
 	static sentry_value_t HandleOnCrash(const sentry_ucontext_t* uctx, sentry_value_t event, void* closure);
 	static double HandleTraceSampling(const sentry_transaction_context_t* transaction_ctx, sentry_value_t custom_sampling_ctx, const int* parent_sampled, void* closure);
 
+	/**
+	 * Checks if it's safe to run callback handlers that instantiate UObjects.
+	 * Returns false if during post-load or garbage collection to prevent deadlocks.
+	 */
+	bool IsCallbackSafeToRun(const FString& handlerName) const;
+
 	USentryBeforeSendHandler* beforeSend;
 	USentryBeforeBreadcrumbHandler* beforeBreadcrumb;
 	USentryBeforeLogHandler* beforeLog;

plugin-dev/Source/Sentry/Private/SentryBeforeLogHandler.cpp

@@ -1,9 +1,9 @@
 // Copyright (c) 2025 Sentry. All Rights Reserved.
 
 #include "SentryBeforeLogHandler.h"
-#include "SentryLogData.h"
+#include "SentryLog.h"
 
-USentryLogData* USentryBeforeLogHandler::HandleBeforeLog_Implementation(USentryLogData* LogData)
+USentryLog* USentryBeforeLogHandler::HandleBeforeLog_Implementation(USentryLog* LogData)
 {
 	return LogData;
 }

plugin-dev/Source/Sentry/Private/SentryLogData.cpp renamed to plugin-dev/Source/Sentry/Private/SentryLog.cpp

@@ -1,39 +1,39 @@
 // Copyright (c) 2025 Sentry. All Rights Reserved.
 
-#include "SentryLogData.h"
+#include "SentryLog.h"
 
 #include "HAL/PlatformSentryLog.h"
 
-void USentryLogData::Initialize()
+void USentryLog::Initialize()
 {
 	NativeImpl = CreateSharedSentryLog();
 }
 
-void USentryLogData::SetMessage(const FString& InMessage)
+void USentryLog::SetMessage(const FString& InMessage)
 {
 	if (!NativeImpl)
 		return;
 
 	NativeImpl->SetMessage(InMessage);
 }
 
-FString USentryLogData::GetMessage() const
+FString USentryLog::GetMessage() const
 {
 	if (!NativeImpl)
 		return FString();
 
 	return NativeImpl->GetMessage();
 }
 
-void USentryLogData::SetLevel(ESentryLevel InLevel)
+void USentryLog::SetLevel(ESentryLevel InLevel)
 {
 	if (!NativeImpl)
 		return;
 
 	NativeImpl->SetLevel(InLevel);
 }
 
-ESentryLevel USentryLogData::GetLevel() const
+ESentryLevel USentryLog::GetLevel() const
 {
 	if (!NativeImpl)
 		return ESentryLevel::Info;

plugin-dev/Source/Sentry/Public/SentryBeforeLogHandler.h

@@ -7,7 +7,7 @@
 
 #include "SentryBeforeLogHandler.generated.h"
 
-class USentryLogData;
+class USentryLog;
 
 UCLASS(Blueprintable)
 class SENTRY_API USentryBeforeLogHandler : public UObject
@@ -16,6 +16,6 @@ class SENTRY_API USentryBeforeLogHandler : public UObject
 
 public:
 	UFUNCTION(BlueprintNativeEvent)
-	USentryLogData* HandleBeforeLog(USentryLogData* LogData);
-	virtual USentryLogData* HandleBeforeLog_Implementation(USentryLogData* LogData);
+	USentryLog* HandleBeforeLog(USentryLog* LogData);
+	virtual USentryLog* HandleBeforeLog_Implementation(USentryLog* LogData);
 };

plugin-dev/Source/Sentry/Public/SentryLogData.h renamed to plugin-dev/Source/Sentry/Public/SentryLog.h

@@ -6,15 +6,15 @@
 #include "SentryImplWrapper.h"
 #include "SentryVariant.h"
 
-#include "SentryLogData.generated.h"
+#include "SentryLog.generated.h"
 
 class ISentryLog;
 
 /**
  * Data structure representing a structured log entry for Sentry.
  */
 UCLASS(BlueprintType, NotBlueprintable, HideDropdown)
-class SENTRY_API USentryLogData : public UObject, public TSentryImplWrapper<ISentryLog, USentryLogData>
+class SENTRY_API USentryLog : public UObject, public TSentryImplWrapper<ISentryLog, USentryLog>
 {
 	GENERATED_BODY()