Fix automatic game log attachment (Android) (#309)

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- Fix automatic game log attachment (Android) ([#309](https://github.com/getsentry/sentry-unreal/pull/309))
+
 ### Dependencies
 
 - Bump Java SDK (Android) from v6.23.0 to v6.24.0 ([#312](https://github.com/getsentry/sentry-unreal/pull/312))

plugin-dev/Source/Sentry/Private/Android/Java/SentryBridgeJava.java

@@ -3,8 +3,6 @@
 package io.sentry.unreal;
 
 import android.app.Activity;
-import android.content.pm.PackageInfo;
-import android.content.pm.PackageManager;
 
 import androidx.annotation.NonNull;
 
@@ -13,6 +11,7 @@
 
 import io.sentry.Attachment;
 import io.sentry.Breadcrumb;
+import io.sentry.Hint;
 import io.sentry.IHub;
 import io.sentry.Scope;
 import io.sentry.ScopeCallback;
@@ -33,6 +32,7 @@ public static void init(
 			final String releaseName,
 			final String environment,
 			final String gameLogPath,
+			final String gameBackupLogPath,
 			final boolean enableAutoSessionTracking,
 			final long sessionTimeout,
 			final boolean enableStackTrace) {
@@ -45,15 +45,24 @@ public void configure(SentryAndroidOptions options) {
 				options.setEnableAutoSessionTracking(enableAutoSessionTracking);
 				options.setSessionTrackingIntervalMillis(sessionTimeout);
 				options.setAttachStacktrace(enableStackTrace);
-			}
-		});
-
-		Sentry.configureScope(new ScopeCallback() {
-			@Override
-			public void run(@NonNull Scope scope) {
-				if(!gameLogPath.isEmpty()) {
-					scope.addAttachment(new Attachment(gameLogPath));
-				}
+				options.setBeforeSend(new SentryOptions.BeforeSendCallback() {
+					@Override
+					public SentryEvent execute(SentryEvent event, Hint hint) {
+						if(event.isCrashed() && event.isErrored())
+						{
+							if(!gameBackupLogPath.isEmpty()) {
+								hint.addAttachment(new Attachment(gameBackupLogPath));
+							}
+						}
+						else
+						{
+							if(!gameLogPath.isEmpty()) {
+								hint.addAttachment(new Attachment(gameLogPath));
+							}
+						}
+						return event;
+					}
+				});
 			}
 		});
 	}

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

@@ -20,27 +20,30 @@
 #include "Infrastructure/SentryConvertorsAndroid.h"
 #include "Infrastructure/SentryJavaClasses.h"
 
-#include "GenericPlatform/GenericPlatformOutputDevices.h"
-#include "HAL/FileManager.h"
+#include "Utils/SentryFileUtils.h"
 
 void SentrySubsystemAndroid::InitWithSettings(const USentrySettings* settings)
 {
 	const FString LogFilePath = settings->EnableAutoLogAttachment
-		? IFileManager::Get().ConvertToAbsolutePathForExternalAppForRead(*FGenericPlatformOutputDevices::GetAbsoluteLogFilename())
-		: FString();
+		? SentryFileUtils::GetGameLogPath()
+		: FString("");
 
+	const FString BackupLogFilePath = settings->EnableAutoLogAttachment
+		? SentryFileUtils::GetGameLogBackupPath()
+		: FString("");
 
 	const FString ReleaseName = settings->OverrideReleaseName
 		? settings->Release
 		: settings->GetFormattedReleaseName();
 
 	FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::SentryBridgeJava, 
-		"init", "(Landroid/app/Activity;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;ZJZ)V",
+		"init", "(Landroid/app/Activity;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;ZJZ)V",
 		FJavaWrapper::GameActivityThis,
 		*FSentryJavaObjectWrapper::GetJString(settings->DsnUrl),
 		*FSentryJavaObjectWrapper::GetJString(ReleaseName),
 		*FSentryJavaObjectWrapper::GetJString(settings->Environment),
 		*FSentryJavaObjectWrapper::GetJString(LogFilePath),
+		*FSentryJavaObjectWrapper::GetJString(BackupLogFilePath),
 		settings->EnableAutoSessionTracking,
 		(jlong)settings->SessionTimeout,
 		settings->EnableStackTrace);

plugin-dev/Source/Sentry/Private/Utils/SentryFileUtils.cpp

@@ -0,0 +1,45 @@
+// Copyright (c) 2023 Sentry. All Rights Reserved.
+
+#include "SentryFileUtils.h"
+#include "SentryDefines.h"
+
+#include "HAL/FileManager.h"
+#include "GenericPlatform/GenericPlatformOutputDevices.h"
+#include "Misc/Paths.h"
+
+struct FSentrySortFileByDatePredicate
+{
+	bool operator()(const FString& A, const FString& B) const
+	{
+		const FDateTime TimestampA = IFileManager::Get().GetTimeStamp(*A);
+		const FDateTime TimestampB = IFileManager::Get().GetTimeStamp(*B);
+		return TimestampB < TimestampA;
+	}
+};
+
+FString SentryFileUtils::GetGameLogPath()
+{
+	return IFileManager::Get().ConvertToAbsolutePathForExternalAppForRead(*FGenericPlatformOutputDevices::GetAbsoluteLogFilename());
+}
+
+FString SentryFileUtils::GetGameLogBackupPath()
+{
+	TArray<FString> GameLogBackupFiles;
+	IFileManager::Get().FindFiles(GameLogBackupFiles, *FString::Printf(TEXT("%s*-backup-*.*"), *FPaths::ProjectLogDir()), true, false);
+
+	if(GameLogBackupFiles.IsEmpty())
+	{
+		UE_LOG(LogSentrySdk, Log, TEXT("There are no game log backups available."));
+		return FString("");
+	}
+
+	for (int i = 0; i < GameLogBackupFiles.Num(); ++i)
+	{
+		FString GameLogFullPath = IFileManager::Get().ConvertToAbsolutePathForExternalAppForRead(*(FPaths::ProjectLogDir() / GameLogBackupFiles[i]));
+		GameLogBackupFiles[i] = GameLogFullPath;
+	}
+
+	GameLogBackupFiles.Sort(FSentrySortFileByDatePredicate());
+
+	return GameLogBackupFiles[0];
+}

plugin-dev/Source/Sentry/Private/Utils/SentryFileUtils.h

@@ -0,0 +1,12 @@
+// Copyright (c) 2023 Sentry. All Rights Reserved.
+
+#pragma once
+
+#include "CoreMinimal.h"
+
+class SentryFileUtils
+{
+public:
+	static FString GetGameLogPath();
+	static FString GetGameLogBackupPath();
+};

scripts/packaging/package.snapshot

@@ -118,6 +118,9 @@ Source/Sentry/Private/Tests/SentryBreadcrumb.spec.cpp
 Source/Sentry/Private/Tests/SentryEvent.spec.cpp
 Source/Sentry/Private/Tests/SentrySubsystem.spec.cpp
 Source/Sentry/Private/Tests/SentryUser.spec.cpp
+Source/Sentry/Private/Utils/
+Source/Sentry/Private/Utils/SentryFileUtils.cpp
+Source/Sentry/Private/Utils/SentryFileUtils.h
 Source/Sentry/Public/
 Source/Sentry/Public/SentryAttachment.h
 Source/Sentry/Public/SentryBreadcrumb.h