Add support of fast-fail crash capturing (#828)

* Add fast fail crash to sample

* Update scripts to include wer module

* Add wer module loading

* Update script

* Update changelog

* Add limitations

* Update SentryPlaygroundUtils.cpp

* Update build-deps.ps1

* Update README.md

* Update README.md

Author: tustanivsky

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add support of fast-fail crash capturing ([#828](https://github.com/getsentry/sentry-unreal/pull/828))
+
 ### Dependencies
 
 - Bump Cocoa SDK (iOS and Mac) from v8.46.0 to v8.47.0 ([#823](https://github.com/getsentry/sentry-unreal/pull/823))

README.md

@@ -64,6 +64,8 @@ sudo apt-get install -y libstdc++6
 
 - Plugin supports Linux arm64 platform for UE 5.0 and newer.
 
+- Fast-fail crash capturing is currently supported only in packaged game builds when using the `github` plugin version. When a fast-fail crash occurs the `HandleBeforeSend` hook will not be invoked and any custom event pre-processing will be skipped. Also, captured fast-fail crash events will not include UE-specific tags or context.
+
 ## Development
 
 Please see the [contribution guide](./CONTRIBUTING.md).

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

@@ -48,14 +48,6 @@ void PrintVerboseLog(sentry_level_t level, const char* message, va_list args, vo
 
 	FString MessageBuf = FString(buffer);
 
-	// The WER (Windows Error Reporting) module (crashpad_wer.dll) can't be distributed along with other Sentry binaries
-	// within the plugin package due to some UE Marketplace restrictions. Its absence doesn't affect crash capturing
-	// and the corresponding warning can be disregarded
-	if (MessageBuf.Equals(TEXT("crashpad WER handler module not found")))
-	{
-		return;
-	}
-
 #if !NO_LOGGING
 	const FName SentryCategoryName(LogSentrySdk.GetCategoryName());
 #else

plugin-dev/Source/Sentry/Sentry.Build.cs

@@ -101,6 +101,7 @@ public Sentry(ReadOnlyTargetRules Target) : base(Target)
 			if (CrashpadExists)
 			{
 				RuntimeDependencies.Add(Path.Combine(PlatformBinariesPath, "crashpad_handler.exe"), Path.Combine(WindowsThirdPartyPath, "bin", "crashpad_handler.exe"));
+				RuntimeDependencies.Add(Path.Combine(PlatformBinariesPath, "crashpad_wer.dll"), Path.Combine(WindowsThirdPartyPath, "bin", "crashpad_wer.dll"));
 
 				PublicAdditionalLibraries.Add(Path.Combine(WindowsThirdPartyPath, "lib", "crashpad_compat.lib"));
 				PublicAdditionalLibraries.Add(Path.Combine(WindowsThirdPartyPath, "lib", "crashpad_snapshot.lib"));

sample/Content/UI/W_SentryDemo.uasset

@@ -4,6 +4,10 @@
 #include "Misc/FileHelper.h"
 #include "Misc/Paths.h"
 
+#if PLATFORM_MICROSOFT
+#include "Microsoft/WindowsHWrapper.h"
+#endif
+
 void USentryPlaygroundUtils::Terminate(ESentryAppTerminationType Type)
 {
 	switch (Type)
@@ -32,6 +36,13 @@ void USentryPlaygroundUtils::Terminate(ESentryAppTerminationType Type)
 				*addrPtr = 10;
 			}
 			break;
+		case ESentryAppTerminationType::FastFail:
+			{
+#if PLATFORM_MICROSOFT
+				RaiseFailFastException(nullptr, nullptr, 0);
+#endif
+			}
+			break;
 		case ESentryAppTerminationType::Assert:
 			{
 				char *assertPtr = nullptr;

sample/Source/SentryPlayground/SentryPlaygroundUtils.cpp

@@ -11,6 +11,7 @@ enum class ESentryAppTerminationType : uint8
 	ArrayOutOfBounds,
 	BadFunctionPtr,
 	InvalidMemoryAccess,
+	FastFail,
 	Assert,
 	Ensure
 };

sample/Source/SentryPlayground/SentryPlaygroundUtils.h

@@ -130,6 +130,7 @@ function buildSentryNative()
 
     Get-ChildItem -Path "$modulesDir/sentry-native/install/lib" -Filter "*.lib" -Recurse | Copy-Item -Destination $nativeOutDirLibs
     Copy-Item "$modulesDir/sentry-native/install/bin/crashpad_handler.exe" -Destination $nativeOutDirBinaries
+    Copy-Item "$modulesDir/sentry-native/install/bin/crashpad_wer.dll" -Destination $nativeOutDirBinaries
     Copy-Item "$modulesDir/sentry-native/install/include/sentry.h" -Destination $nativeOutDirIncludes
 }
 
@@ -171,4 +172,4 @@ else
     {
         buildPlatformDependency($platform)
     }
-}
+}

scripts/build-deps.ps1

@@ -17,4 +17,5 @@ mkdir "${sentryArtifactsDestination}/lib"
 
 cp ${sentryNativeRoot}/install/lib/*.lib ${sentryArtifactsDestination}/lib
 cp ${sentryNativeRoot}/install/bin/crashpad_handler.exe ${sentryArtifactsDestination}/bin/crashpad_handler.exe
+cp ${sentryNativeRoot}/install/bin/crashpad_wer.dll ${sentryArtifactsDestination}/bin/crashpad_wer.dll
 cp ${sentryNativeRoot}/install/include/sentry.h ${sentryArtifactsDestination}/include/sentry.h

scripts/build-win64-crashpad.sh

@@ -24,6 +24,7 @@ function packFiles([string] $publishingPlatform)
             'upload-debug-symbols-win.bat',
             'upload-debug-symbols.sh',
             'crashpad_handler.exe'
+            'crashpad_wer.dll'
         )
     }
 

scripts/packaging/pack.ps1

@@ -414,6 +414,7 @@ Source/ThirdParty/Win64/Breakpad/include/sentry.h
 Source/ThirdParty/Win64/Breakpad/lib/breakpad_client.lib
 Source/ThirdParty/Win64/Breakpad/lib/sentry.lib
 Source/ThirdParty/Win64/Crashpad/bin/crashpad_handler.exe
+Source/ThirdParty/Win64/Crashpad/bin/crashpad_wer.dll
 Source/ThirdParty/Win64/Crashpad/include/sentry.h
 Source/ThirdParty/Win64/Crashpad/lib/crashpad_client.lib
 Source/ThirdParty/Win64/Crashpad/lib/crashpad_compat.lib

scripts/packaging/package-github.snapshot

@@ -21,11 +21,18 @@ function testFiles([string] $publishingPlatform)
         exit 2
     }
 
-    $packages = Get-ChildItem "$projectRoot/sentry-unreal-*-$publishingPlatform.zip"
+    # TODO: Extract this functionality to share between `test-contents.ps1` and `pack.ps1`
+    # See https://github.com/getsentry/sentry-unreal/issues/820 for more details.
+    $pluginSpec = Get-Content "plugin-dev/Sentry.uplugin"
+    $version = [regex]::Match("$pluginSpec", '"VersionName": "([^"]+)"').Groups[1].Value
+
+    Write-Host "Searching version $version release packages..."
+
+    $packages = Get-ChildItem -Path "$projectRoot/*" -Include "sentry-unreal-$version-engine*-$publishingPlatform.zip"
     $expectedPackagesCount = (Get-Content "$PSScriptRoot/engine-versions.txt").Length
     if ($packages.Length -ne $expectedPackagesCount)
     {
-        throw "Invalid number of packages - expected $expectedPackagesCount, got $packages"
+        throw "Invalid number of packages - expected $expectedPackagesCount, got $($packages.Length)"
     }
 
     foreach ($packageFile in $packages)