Merge branch 'main' into feat/linux-arm-64

# Conflicts:
#	.github/workflows/ci.yml

.github/workflows/ci.yml

@@ -137,7 +137,7 @@ jobs:
 
   test:
     name: Test UE ${{ matrix.unreal }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-latest-4-cores
 
     strategy:
       fail-fast: false
@@ -190,8 +190,6 @@ jobs:
             --network ip6net -p 80:80 \
             ghcr.io/epicgames/unreal-engine:dev-slim-${{ matrix.unreal }}.1
           docker logout ghcr.io
-          # Add the user so it has a home directory (needed for the pip cache later on)
-          docker exec --user root unreal useradd -u $uid -g $gid --create-home $user
           # Ensure CA certs are in the right directory (needed for running tests)
           docker exec --user root unreal bash -c "
             mkdir -p /etc/pki/tls/certs ;
@@ -202,12 +200,6 @@ jobs:
             chown -R $uid /home/ue4/UnrealEngine/Engine/Binaries/ThirdParty/Mono/Linux ;
             chown -R $uid /home/ue4/UnrealEngine/Engine/Binaries/ThirdParty/DotNet "
 
-      - name: Setup UE CLI
-        run: docker exec unreal bash -c '
-          pip3 install --upgrade pip ;
-          pip3 install -Iv ue4cli==0.0.54 ;
-          ue4 setroot /home/ue4/UnrealEngine '
-
       - name: Setup C++ runtime
         run: docker exec --user root unreal bash -c '
           apt-get update ;
@@ -232,16 +224,28 @@ jobs:
       - name: Run tests
         id: run-tests
         run: |
-          docker exec -w /workspace/checkout/${{ matrix.app }} unreal ue4 build
-          docker exec -w /workspace/checkout/${{ matrix.app }} unreal ue4 editor \
+          docker exec -w /workspace/checkout/${{ matrix.app }} unreal /home/ue4/UnrealEngine/Engine/Build/BatchFiles/RunUAT.sh BuildCookRun \
+            -project=/workspace/checkout/${{ matrix.app }}/SentryPlayground.uproject \
+            -archivedirectory=/workspace/checkout/${{ matrix.app }}/Builds \
+            -platform=Linux \
+            -nop4 \
+            -cook \
+            -build \
+            -stage \
+            -prereqss \
+            -package \
+            -archive
+          docker exec -w /workspace/checkout/${{ matrix.app }} unreal bash -c "
+            cp -r '/home/ue4/Library/Logs/Unreal Engine/LocalBuildLogs' Saved/Logs  "
+          docker exec -w /workspace/checkout/${{ matrix.app }} unreal /home/ue4/UnrealEngine/Engine/Binaries/Linux/UnrealEditor \
             /workspace/checkout/${{ matrix.app }}/SentryPlayground.uproject \
             -ReportExportPath=/workspace/checkout/${{ matrix.app }}/Saved/Automation \
             -ExecCmds="Automation RunTests Sentry;quit" \
             -TestExit="Automation Test Queue Empty" \
             -Unattended \
             -NoPause \
             -NoSplash \
-            -NullRHI
+            -NullRHI          
 
       - name: Collect ${{ matrix.app }} test info
         if: ${{ always() && steps.run-tests.outcome == 'failure' }}
@@ -251,16 +255,8 @@ jobs:
           path: |
             checkout/${{ matrix.app }}/Saved/Automation
 
-      - name: Build & package ${{ matrix.app }}
-        # Unreal 5.0 takes ~1 hour to build+package the app so only do it on v4.27
-        if: ${{ matrix.unreal == '4.27'}}
-        id: package-app
-        run: |
-          docker exec -w /workspace/checkout/${{ matrix.app }} unreal ue4 package
-          docker exec -w /workspace/checkout/${{ matrix.app }} unreal cp -r '/home/gh/Library/Logs/Unreal Engine/LocalBuildLogs' Saved/Logs
-
       - name: Collect ${{ matrix.app }} build info
-        if: contains(fromJson('["success", "failure"]'), steps.package-app.outcome)
+        if: contains(fromJson('["success", "failure"]'), steps.run-tests.outcome)
         uses: actions/upload-artifact@v4
         with:
           name: UE ${{ matrix.unreal }} ${{ matrix.app }} build logs

CHANGELOG.md

@@ -2,11 +2,21 @@
 
 ## Unreleased
 
+### Features
+
+- Assertions now print their callstack a log file ([#637](https://github.com/getsentry/sentry-unreal/pull/637))
+
 ### Dependencies
 
-- Bump CLI from v2.37.0 to v2.38.0 ([#663](https://github.com/getsentry/sentry-unreal/pull/663))
-  - [changelog](https://github.com/getsentry/sentry-cli/blob/master/CHANGELOG.md#2380)
-  - [diff](https://github.com/getsentry/sentry-cli/compare/2.37.0...2.38.0)
+- Bump CLI from v2.37.0 to v2.38.1 ([#663](https://github.com/getsentry/sentry-unreal/pull/663), [#670](https://github.com/getsentry/sentry-unreal/pull/670))
+  - [changelog](https://github.com/getsentry/sentry-cli/blob/master/CHANGELOG.md#2381)
+  - [diff](https://github.com/getsentry/sentry-cli/compare/2.37.0...2.38.1)
+- Bump Java SDK (Android) from v7.15.0 to v7.16.0 ([#665](https://github.com/getsentry/sentry-unreal/pull/665))
+  - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#7160)
+  - [diff](https://github.com/getsentry/sentry-java/compare/7.15.0...7.16.0)
+- Bump Cocoa SDK (iOS) from v8.38.0 to v8.39.0 ([#668](https://github.com/getsentry/sentry-unreal/pull/668))
+  - [changelog](https://github.com/getsentry/sentry-cocoa/blob/main/CHANGELOG.md#8390)
+  - [diff](https://github.com/getsentry/sentry-cocoa/compare/8.38.0...8.39.0)
 
 ## 0.20.1
 

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

@@ -32,6 +32,7 @@
 #include "GenericPlatform/GenericPlatformOutputDevices.h"
 #include "HAL/FileManager.h"
 #include "UObject/GarbageCollection.h"
+#include "Utils/SentryLogUtils.h"
 
 void SentrySubsystemApple::InitWithSettings(const USentrySettings* settings, USentryBeforeSendHandler* beforeSendHandler, USentryTraceSampler* traceSampler)
 {
@@ -205,12 +206,19 @@ USentryId* SentrySubsystemApple::CaptureAssertion(const FString& type, const FSt
 #elif PLATFORM_IOS
 	int32 framesToSkip = 5;
 #endif
+
+	SentryLogUtils::LogStackTrace(*message, ELogVerbosity::Error, framesToSkip);
+
 	return CaptureException(type, message, framesToSkip);
 }
 
 USentryId* SentrySubsystemApple::CaptureEnsure(const FString& type, const FString& message)
 {
-	return CaptureException(type, message, 6);
+	int32 framesToSkip = 6;
+
+	SentryLogUtils::LogStackTrace(*message, ELogVerbosity::Error, framesToSkip);
+
+	return CaptureException(type, message, framesToSkip);
 }
 
 void SentrySubsystemApple::CaptureUserFeedback(USentryUserFeedback* userFeedback)

plugin-dev/Source/Sentry/Private/Desktop/Infrastructure/SentryConvertorsDesktop.cpp

@@ -276,4 +276,54 @@ ELogVerbosity::Type SentryConvertorsDesktop::SentryLevelToLogVerbosity(sentry_le
 	return LogVerbosity;
 }
 
+void SentryConvertorsDesktop::SentryCrashContextToString(const sentry_ucontext_t* crashContext, TCHAR* outErrorString, int32 errorStringBufSize)
+{
+#if PLATFORM_WINDOWS
+
+	EXCEPTION_RECORD* ExceptionRecord = crashContext->exception_ptrs.ExceptionRecord;
+
+	FString ErrorString = TEXT("Unhandled Exception: ");
+
+#define HANDLE_CASE(x) case x: ErrorString += TEXT(#x); break;
+
+	switch (ExceptionRecord->ExceptionCode)
+	{
+	case EXCEPTION_ACCESS_VIOLATION:
+		ErrorString += TEXT("EXCEPTION_ACCESS_VIOLATION ");
+		if (ExceptionRecord->ExceptionInformation[0] == 0)
+		{
+			ErrorString += TEXT("reading address ");
+		}
+		else if (ExceptionRecord->ExceptionInformation[0] == 1)
+		{
+			ErrorString += TEXT("writing address ");
+		}
+		ErrorString += FString::Printf(
+#if PLATFORM_64BITS
+			TEXT("0x%016llx")
+#else
+			TEXT("0x%08x")
+#endif
+			, ExceptionRecord->ExceptionInformation[1]);
+		break;
+		HANDLE_CASE(EXCEPTION_ARRAY_BOUNDS_EXCEEDED)
+		HANDLE_CASE(EXCEPTION_DATATYPE_MISALIGNMENT)
+		HANDLE_CASE(EXCEPTION_FLT_DENORMAL_OPERAND)
+		HANDLE_CASE(EXCEPTION_FLT_DIVIDE_BY_ZERO)
+		HANDLE_CASE(EXCEPTION_FLT_INVALID_OPERATION)
+		HANDLE_CASE(EXCEPTION_ILLEGAL_INSTRUCTION)
+		HANDLE_CASE(EXCEPTION_INT_DIVIDE_BY_ZERO)
+		HANDLE_CASE(EXCEPTION_PRIV_INSTRUCTION)
+		HANDLE_CASE(EXCEPTION_STACK_OVERFLOW)
+		default:
+			ErrorString += FString::Printf(TEXT("0x%08x"), (uint32)ExceptionRecord->ExceptionCode);
+	}
+
+	FCString::Strncpy(outErrorString, *ErrorString, errorStringBufSize);
+
+#undef HANDLE_CASE
+
+#endif
+}
+
 #endif

plugin-dev/Source/Sentry/Private/Desktop/Infrastructure/SentryConvertorsDesktop.h

@@ -37,6 +37,8 @@ class SentryConvertorsDesktop
 	static FString SentryLevelToString(ESentryLevel level);
 	static TArray<uint8> SentryEnvelopeToByteArray(sentry_envelope_t* envelope);
 	static ELogVerbosity::Type SentryLevelToLogVerbosity(sentry_level_t level);
+
+	static void SentryCrashContextToString(const sentry_ucontext_t* crashContext, TCHAR* outErrorString, int32 errorStringBufSize);
 };
 
 #endif

plugin-dev/Source/Sentry/Private/Desktop/SentrySubsystemDesktop.cpp

@@ -21,6 +21,7 @@
 #include "SentryTransactionContext.h"
 #include "SentryUserFeedbackDesktop.h"
 
+#include "Utils/SentryLogUtils.h"
 #include "Utils/SentryScreenshotUtils.h"
 
 #include "Infrastructure/SentryConvertorsDesktop.h"
@@ -32,10 +33,12 @@
 
 #include "Misc/Paths.h"
 #include "Misc/ScopeLock.h"
+#include "Misc/CoreDelegates.h"
 #include "HAL/FileManager.h"
 #include "Runtime/Launch/Resources/Version.h"
 #include "GenericPlatform/GenericPlatformOutputDevices.h"
 #include "GenericPlatform/GenericPlatformCrashContext.h"
+#include "HAL/ExceptionHandling.h"
 #include "UObject/GarbageCollection.h"
 #include "UObject/UObjectThreadContext.h"
 
@@ -69,6 +72,36 @@ void PrintVerboseLog(sentry_level_t level, const char *message, va_list args, vo
 	GLog->CategorizedLogf(SentryCategoryName, SentryConvertorsDesktop::SentryLevelToLogVerbosity(level), TEXT("%s"), *MessageBuf);
 }
 
+void PrintCrashLog(const sentry_ucontext_t *uctx)
+{
+#if PLATFORM_WINDOWS
+
+	SentryConvertorsDesktop::SentryCrashContextToString(uctx, GErrorExceptionDescription, UE_ARRAY_COUNT(GErrorExceptionDescription));
+
+	const SIZE_T StackTraceSize = 65535;
+	ANSICHAR* StackTrace = (ANSICHAR*)GMalloc->Malloc(StackTraceSize);
+	StackTrace[0] = 0;
+
+	// Currently raw crash data stored in `uctx` can be utilized for stalk walking on Windows only
+	void* ProgramCounter = uctx->exception_ptrs.ExceptionRecord->ExceptionAddress;
+
+	FPlatformStackWalk::StackWalkAndDump(StackTrace, StackTraceSize, ProgramCounter);
+
+	FCString::Strncat(GErrorHist, GErrorExceptionDescription, UE_ARRAY_COUNT(GErrorHist));
+	FCString::Strncat(GErrorHist, TEXT("\r\n\r\n"), UE_ARRAY_COUNT(GErrorHist));
+	FCString::Strncat(GErrorHist, ANSI_TO_TCHAR(StackTrace), UE_ARRAY_COUNT(GErrorHist));
+
+#if !NO_LOGGING
+	FDebug::LogFormattedMessageWithCallstack(LogSentrySdk.GetCategoryName(), __FILE__, __LINE__, TEXT("=== Critical error: ==="), GErrorHist, ELogVerbosity::Error);
+#endif
+
+	GLog->Panic();
+
+	GMalloc->Free(StackTrace);
+
+#endif
+}
+
 sentry_value_t HandleBeforeSend(sentry_value_t event, void *hint, void *closure)
 {
 	SentrySubsystemDesktop* SentrySubsystem = static_cast<SentrySubsystemDesktop*>(closure);
@@ -94,6 +127,12 @@ sentry_value_t HandleBeforeSend(sentry_value_t event, void *hint, void *closure)
 
 sentry_value_t HandleBeforeCrash(const sentry_ucontext_t *uctx, sentry_value_t event, void *closure)
 {
+#if PLATFORM_WINDOWS
+	// Ensures that error message and corresponding callstack flushed to a log file (if available)
+	// before it's attached to the captured crash event and uploaded to Sentry.
+	PrintCrashLog(uctx);
+#endif
+
 	SentrySubsystemDesktop* SentrySubsystem = static_cast<SentrySubsystemDesktop*>(closure);
 	SentrySubsystem->TryCaptureScreenshot();
 
@@ -395,7 +434,15 @@ USentryId* SentrySubsystemDesktop::CaptureException(const FString& type, const F
 
 USentryId* SentrySubsystemDesktop::CaptureAssertion(const FString& type, const FString& message)
 {
-	return CaptureException(type, message, 7);
+#if PLATFORM_WINDOWS
+	int32 framesToSkip = 7;
+#else
+	int32 framesToSkip = 5;
+#endif
+
+	SentryLogUtils::LogStackTrace(*message, ELogVerbosity::Error, framesToSkip);
+
+	return CaptureException(type, message, framesToSkip);
 }
 
 USentryId* SentrySubsystemDesktop::CaptureEnsure(const FString& type, const FString& message)

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

@@ -12,7 +12,7 @@
 void FSentryOutputDevice::Serialize(const TCHAR* V, ELogVerbosity::Type Verbosity, const FName& Category)
 {
 	const FString Message = FString(V).TrimStartAndEnd();
-	if (Message.IsEmpty())
+	if (Message.IsEmpty() || Message.StartsWith(TEXT("[Callstack]")))
 	{
 		return;
 	}

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

@@ -20,6 +20,7 @@
 #include "Misc/EngineVersion.h"
 #include "Misc/CoreDelegates.h"
 #include "Misc/App.h"
+#include "Misc/AssertionMacros.h"
 #include "GenericPlatform/GenericPlatformDriver.h"
 #include "GenericPlatform/GenericPlatformMisc.h"
 

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

@@ -0,0 +1,27 @@
+// Copyright (c) 2024 Sentry. All Rights Reserved.
+
+#include "SentryLogUtils.h"
+
+#include "CoreGlobals.h"
+#include "GenericPlatform/GenericPlatformStackWalk.h"
+#include "HAL/UnrealMemory.h"
+#include "Misc/OutputDeviceRedirector.h"
+
+void SentryLogUtils::LogStackTrace(const TCHAR* Heading, const ELogVerbosity::Type LogVerbosity, int FramesToSkip)
+{
+#if !NO_LOGGING
+	const SIZE_T StackTraceSize = 65535;
+	ANSICHAR* StackTrace = (ANSICHAR*)FMemory::SystemMalloc(StackTraceSize);
+
+	{
+		StackTrace[0] = 0;
+		FGenericPlatformStackWalk::StackWalkAndDumpEx(StackTrace, StackTraceSize, FramesToSkip + 1, FGenericPlatformStackWalk::EStackWalkFlags::AccurateStackWalk);
+	}
+
+	FDebug::LogFormattedMessageWithCallstack(LogOutputDevice.GetCategoryName(), __FILE__, __LINE__, Heading, ANSI_TO_TCHAR(StackTrace), LogVerbosity);
+
+	GLog->Flush();
+
+	FMemory::SystemFree(StackTrace);
+#endif
+}

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

@@ -0,0 +1,12 @@
+// Copyright (c) 2024 Sentry. All Rights Reserved.
+
+#pragma once
+
+#include "CoreTypes.h"
+#include "Logging/LogVerbosity.h"
+
+class SentryLogUtils
+{
+public:
+	static void LogStackTrace(const TCHAR* Heading, const ELogVerbosity::Type LogVerbosity, int FramesToSkip);
+};

plugin-dev/sentry-cli.properties

@@ -1,2 +1,2 @@
-version=2.38.0
+version=2.38.1
 repo=https://github.com/getsentry/sentry-cli

scripts/build-ios.sh

@@ -6,9 +6,28 @@ export sentryArtifactsDestination=$2
 
 rm -rf "${sentryArtifactsDestination}/"*
 
-carthage build --project-directory "${sentryIosRoot}" --use-xcframeworks --no-skip-current --platform iOS
+pushd "${sentryIosRoot}"
 
-cp -R "${sentryIosRoot}/Carthage/Build/Sentry.xcframework/ios-arm64_arm64e/Sentry.framework" "${sentryArtifactsDestination}/Sentry.framework"
+xcodebuild archive \
+    -project Sentry.xcodeproj/ \
+    -scheme "Sentry" \
+    -configuration "Release" \
+    -sdk "iphoneos" \
+    -archivePath "./Carthage/archive/Sentry/iphoneos.xcarchive" \
+    CODE_SIGNING_REQUIRED=NO \
+    SKIP_INSTALL=NO \
+    CODE_SIGN_IDENTITY= \
+    CARTHAGE=YES \
+    MACH_O_TYPE="mh_dylib" \
+    ENABLE_CODE_COVERAGE=NO \
+    GCC_GENERATE_DEBUGGING_SYMBOLS="YES" \
+    OTHER_LDFLAGS="-Wl,-make_mergeable"
+
+xcodebuild -create-xcframework -framework Carthage/archive/Sentry/iphoneos.xcarchive/Products/Library/Frameworks/Sentry.framework -output Carthage/Sentry.xcframework
+
+popd
+
+cp -R "${sentryIosRoot}/Carthage/Sentry.xcframework/ios-arm64_arm64e/Sentry.framework" "${sentryArtifactsDestination}/Sentry.framework"
 
 mkdir "Sentry.embeddedframework"