Migrate debug symbol upload to Python script

.github/workflows/test-linux.yml

@@ -109,6 +109,10 @@ jobs:
         # sentry-native requires write access to sample project directory in order to initialize itself properly
         run: docker exec -w /workspace/checkout unreal chmod -R +x sample
 
+      - name: Set execute permission for Python3
+        # Python3 is needed for post-build symbol upload script
+        run: docker exec --user root unreal chmod +x /home/ue4/UnrealEngine/Engine/Binaries/ThirdParty/Python3/Linux/bin/python3
+
       - name: Update engine's build configuration
         run: |
           docker exec unreal bash -c "
@@ -119,8 +123,17 @@ jobs:
         id: run-tests
         env:
           EDITOR_BINARY: ${{ inputs.unreal-version == '4.27' && 'UE4Editor' || 'UnrealEditor' }}
+          SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY: true
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
+          SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
         run: |
-          docker exec -w /workspace/checkout/sample unreal /home/ue4/UnrealEngine/Engine/Build/BatchFiles/RunUAT.sh BuildCookRun \
+          docker exec -w /workspace/checkout/sample \
+            -e SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY="$SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY" \
+            -e SENTRY_AUTH_TOKEN="$SENTRY_AUTH_TOKEN" \
+            -e SENTRY_ORG="$SENTRY_ORG" \
+            -e SENTRY_PROJECT="$SENTRY_PROJECT" \
+            unreal /home/ue4/UnrealEngine/Engine/Build/BatchFiles/RunUAT.sh BuildCookRun \
             -project=/workspace/checkout/sample/SentryPlayground.uproject \
             -archivedirectory=/workspace/checkout/sample/Builds \
             -platform=Linux \

.github/workflows/test-windows.yml

@@ -61,8 +61,17 @@ jobs:
         id: run-tests
         env:
           EDITOR_BINARY: ${{ inputs.unreal-version == '4.27' && 'UE4Editor.exe' || 'UnrealEditor.exe' }}
+          SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY: true
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
+          SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
         run: |
-          docker exec unreal C:\UnrealEngine\Engine\Build\BatchFiles\RunUAT.bat BuildCookRun `
+          docker exec `
+            -e SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY="$env:SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY" `
+            -e SENTRY_AUTH_TOKEN="$env:SENTRY_AUTH_TOKEN" `
+            -e SENTRY_ORG="$env:SENTRY_ORG" `
+            -e SENTRY_PROJECT="$env:SENTRY_PROJECT" `
+            unreal C:\UnrealEngine\Engine\Build\BatchFiles\RunUAT.bat BuildCookRun `
             -project=C:/workspace/checkout/sample/SentryPlayground.uproject `
             -archivedirectory=C:/workspace/checkout/sample/Builds `
             -platform=Win64 `

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - Add screenshot capturing for ensure/assert events on Android ([#1097](https://github.com/getsentry/sentry-unreal/pull/1097))
 - Add level-specific logging methods (LogDebug, LogInfo, LogWarning, LogError, LogFatal) to match other Sentry SDKs ([#1110](https://github.com/getsentry/sentry-unreal/pull/1110))
+- Migrated debug symbol upload to unified Python-based implementation to improve stability ([#1114](https://github.com/getsentry/sentry-unreal/pull/1114))
 
 ### Fixes
 

plugin-dev/Scripts/post-build-steps-linux.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+TARGET_PLATFORM="$1"
+TARGET_NAME="$2"
+TARGET_TYPE="$3"
+TARGET_CONFIGURATION="$4"
+PROJECT_FILE="$5"
+PLUGIN_DIR="$6"
+ENGINE_DIR="$7"
+
+# Grant execute permissions to sentry-cli binary (FAB version of the plugin doesn't preserve file permissions)
+if [ -f "$PLUGIN_DIR/Source/ThirdParty/CLI/sentry-cli-Linux-x86_64" ]; then
+  chmod +x "$PLUGIN_DIR/Source/ThirdParty/CLI/sentry-cli-Linux-x86_64"
+fi
+
+# Call Python script for debug symbol upload
+"$ENGINE_DIR/Binaries/ThirdParty/Python3/Linux/bin/python3" "$PLUGIN_DIR/Scripts/upload-debug-symbols.py" \
+  "$TARGET_PLATFORM" "$TARGET_NAME" "$TARGET_TYPE" "$TARGET_CONFIGURATION" "$PROJECT_FILE" "$PLUGIN_DIR"

plugin-dev/Scripts/post-build-steps-mac.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+TARGET_PLATFORM="$1"
+TARGET_NAME="$2"
+TARGET_TYPE="$3"
+TARGET_CONFIGURATION="$4"
+PROJECT_FILE="$5"
+PLUGIN_DIR="$6"
+ENGINE_DIR="$7"
+
+# Copy sentry.dylib to plugin's Binaries/Mac dir if it doesn't exist there to ensure FAB version of the plugin works correctly
+# Epic obfuscates any extra binaries when pre-building the plugin
+if [ "$TARGET_PLATFORM" = "Mac" ] && [ ! -f "$PLUGIN_DIR/Binaries/Mac/sentry.dylib" ]; then
+  cp "$PLUGIN_DIR/Source/ThirdParty/Mac/bin/sentry.dylib" "$PLUGIN_DIR/Binaries/Mac/sentry.dylib"
+fi
+
+# Grant execute permissions to sentry-cli binary (FAB version of the plugin doesn't preserve file permissions)
+if [ -f "$PLUGIN_DIR/Source/ThirdParty/CLI/sentry-cli-Darwin-universal" ]; then
+  chmod +x "$PLUGIN_DIR/Source/ThirdParty/CLI/sentry-cli-Darwin-universal"
+fi
+
+# Call Python script for debug symbol upload
+"$ENGINE_DIR/Binaries/ThirdParty/Python3/Mac/bin/python3" "$PLUGIN_DIR/Scripts/upload-debug-symbols.py" \
+  "$TARGET_PLATFORM" "$TARGET_NAME" "$TARGET_TYPE" "$TARGET_CONFIGURATION" "$PROJECT_FILE" "$PLUGIN_DIR"

plugin-dev/Scripts/post-build-steps-win.bat

@@ -0,0 +1,37 @@
+@echo off
+
+setlocal enabledelayedexpansion
+
+set "TARGET_PLATFORM=%~1"
+set "TARGET_NAME=%~2"
+set "TARGET_TYPE=%~3"
+set "TARGET_CONFIGURATION=%~4"
+set "PROJECT_FILE=%~5"
+set "PLUGIN_DIR=%~6"
+set "ENGINE_DIR=%~7"
+
+REM Copy crashpad handler executable to plugin's Binaries\Linux dir if it doesn't exist there
+REM This enables cross-compilation for Linux on Windows with FAB version of the plugin
+set "CRASHPAD_HANDLER_LINUX=%PLUGIN_DIR%\Binaries\Linux\crashpad_handler"
+if "%TARGET_PLATFORM%"=="Linux" (
+  if not exist "%CRASHPAD_HANDLER_LINUX%" (
+    if not exist "%PLUGIN_DIR%\Binaries\Linux\" (mkdir "%PLUGIN_DIR%\Binaries\Linux")
+    xcopy "%PLUGIN_DIR%\Source\ThirdParty\Linux\bin\*" "%PLUGIN_DIR%\Binaries\Linux\" /F /R /Y /I
+  )
+)
+
+REM Copy crashpad handler executable to plugin's Binaries\Win64 dir if it doesn't exist there
+REM Epic obfuscates any extra binaries when pre-building the plugin for FAB
+set "CRASHPAD_HANDLER_WIN=%PLUGIN_DIR%\Binaries\Win64\crashpad_handler.exe"
+if "%TARGET_PLATFORM%"=="Win64" (
+  if not exist "%CRASHPAD_HANDLER_WIN%" (
+    if not exist "%PLUGIN_DIR%\Binaries\Win64\" (mkdir "%PLUGIN_DIR%\Binaries\Win64")
+    xcopy "%PLUGIN_DIR%\Source\ThirdParty\Win64\bin\*" "%PLUGIN_DIR%\Binaries\Win64\" /F /R /Y /I
+  )
+)
+
+REM Call Python script for debug symbol upload
+"%ENGINE_DIR%\Binaries\ThirdParty\Python3\Win64\python.exe" "%PLUGIN_DIR%\Scripts\upload-debug-symbols.py" ^
+  %TARGET_PLATFORM% %TARGET_NAME% %TARGET_TYPE% %TARGET_CONFIGURATION% "%PROJECT_FILE%" "%PLUGIN_DIR%"
+
+endlocal