chore: Utilize app-runner for WebGL (#2572)

Author: bitsandfoxes

.github/workflows/ci.yml

@@ -189,9 +189,10 @@ jobs:
         run: ./test/Scripts.Integration.Test/add-sentry.ps1 -UnityPath "$env:UNITY_PATH" -PackagePath "test-package-release"
 
       - name: Configure Sentry
-        run: ./test/Scripts.Integration.Test/configure-sentry.ps1 -UnityPath "$env:UNITY_PATH" -Platform "$env:BUILD_PLATFORM" -CheckSymbols
+        run: ./test/Scripts.Integration.Test/configure-sentry.ps1 -UnityPath "$env:UNITY_PATH" -Platform "$env:BUILD_PLATFORM" -CheckSymbols -TestMode "integration"
         env:
           BUILD_PLATFORM: ${{ matrix.build_platform }}
+          SENTRY_DSN: ${{ secrets.SENTRY_TEST_DSN }}
 
       - name: Build Project
         run: ./test/Scripts.Integration.Test/build-project.ps1 -UnityPath "$env:UNITY_PATH" -Platform "$env:BUILD_PLATFORM" -CheckSymbols:$([System.Convert]::ToBoolean($env:CHECK_SYMBOLS)) -UnityVersion "$env:UNITY_VERSION"
@@ -219,15 +220,14 @@ jobs:
         run: |
           # Note: remove local.properties file that contains Android SDK & NDK paths in the Unity installation.
           rm -rf samples/IntegrationTest/Build/*_BackUpThisFolder_ButDontShipItWithYourGame
-          tar -cvzf test-app-runtime.tar.gz samples/IntegrationTest/Build
+          tar -cvzf test-app-webgl.tar.gz samples/IntegrationTest/Build
 
-      # Upload runtime initialization build
       - name: Upload test app
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
-          name: testapp-${{ matrix.platform }}-${{ matrix.unity-version }}-runtime
+          name: testapp-webgl-compiled-${{ matrix.unity-version }}
           if-no-files-found: error
-          path: test-app-runtime.tar.gz
+          path: test-app-webgl.tar.gz
           retention-days: 14
 
       - name: Upload IntegrationTest project on failure
@@ -325,33 +325,17 @@ jobs:
         #  - https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md
 
   smoke-test-run-webgl:
-    name: Run ${{ matrix.platform }} ${{ matrix.unity-version }} Smoke Test
+    name: Run WebGL ${{ matrix.unity-version }} Integration Test
     if: ${{ !startsWith(github.ref, 'refs/heads/release/') }}
     needs: [smoke-test-build-webgl, create-unity-matrix]
-    runs-on: ubuntu-latest
+    secrets: inherit
     strategy:
       fail-fast: false
       matrix:
         unity-version: ${{ fromJSON(needs.create-unity-matrix.outputs.unity-matrix).unity-version }}
-        platform: ["WebGL"]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Download test app artifact
-        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
-        id: download
-        with:
-          name: testapp-${{ matrix.platform }}-${{ matrix.unity-version }}-runtime
-
-      - name: Extract test app
-        run: tar -xvzf test-app-runtime.tar.gz
-
-      - name: Run (WebGL)
-        timeout-minutes: 10
-        run: |
-          pip3 install --upgrade --user selenium urllib3 requests
-          python3 scripts/smoke-test-webgl.py "samples/IntegrationTest/Build"
+    uses: ./.github/workflows/smoke-test-run-webgl.yml
+    with:
+      unity-version: ${{ matrix.unity-version }}
 
   smoke-test-build-linux:
     name: Build Linux ${{ matrix.unity-version }} Integration Test

.github/workflows/smoke-test-run-webgl.yml

@@ -0,0 +1,54 @@
+name: "IntegrationTest: Run WebGL"
+on:
+  workflow_call:
+    inputs:
+      unity-version:
+        required: true
+        type: string
+
+defaults:
+  run:
+    shell: pwsh
+
+jobs:
+  run:
+    name: WebGL ${{ inputs.unity-version }}
+    runs-on: ubuntu-latest
+    env:
+      SENTRY_TEST_DSN: ${{ secrets.SENTRY_TEST_DSN }}
+      SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - name: Initialize app-runner submodule
+        run: git submodule update --init modules/app-runner
+        shell: bash
+
+      - name: Download test app artifact
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
+        with:
+          name: testapp-webgl-compiled-${{ inputs.unity-version }}
+
+      - name: Extract test app
+        run: tar -xvzf test-app-webgl.tar.gz
+
+      - name: Install Selenium
+        run: pip3 install --upgrade selenium
+        shell: bash
+
+      - name: Run Integration Tests
+        timeout-minutes: 20
+        run: |
+          $env:SENTRY_WEBGL_BUILD_PATH = "samples/IntegrationTest/Build"
+          Invoke-Pester -Path test/IntegrationTest/Integration.Tests.WebGL.ps1 -CI
+
+      - name: Upload test results on failure
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: testapp-webgl-logs-${{ inputs.unity-version }}
+          path: |
+            test/IntegrationTest/results/
+          retention-days: 14

Directory.Build.targets

@@ -386,7 +386,7 @@ Related: https://forum.unity.com/threads/6572-debugger-agent-unable-to-listen-on
 
   <!-- Run smoke test on the WebGL player: dotnet msbuild /t:UnitySmokeTestPlayerWebGL src/Sentry.Unity -->
   <Target Name="UnitySmokeTestPlayerWebGL" Condition="'$(MSBuildProjectName)' == 'Sentry.Unity'">
-    <Exec Command="python3 -X utf8 &quot;$(RepoRoot)scripts/smoke-test-webgl.py&quot;" IgnoreStandardErrorWarningFormat="true"/>
+    <Exec Command="pwsh -Command &quot;Invoke-Pester -Path '$(RepoRoot)test/IntegrationTest/Integration.Tests.WebGL.ps1' -CI&quot;" IgnoreStandardErrorWarningFormat="true"/>
   </Target>
 
   <!-- Run PlayMode tests with dotnet msbuild /t:UnityPlayModeTest test/Sentry.Unity.Tests -->

scripts/smoke-test-webgl.py

@@ -15,6 +15,7 @@ internal class WebBackgroundWorker : IBackgroundWorker
 {
     private readonly SentryMonoBehaviour _behaviour;
     private readonly UnityWebRequestTransport _transport;
+    private int _pendingItems;
 
     public WebBackgroundWorker(SentryUnityOptions options, SentryMonoBehaviour behaviour)
     {
@@ -24,13 +25,26 @@ public WebBackgroundWorker(SentryUnityOptions options, SentryMonoBehaviour behav
 
     public bool EnqueueEnvelope(Envelope envelope)
     {
-        _behaviour.QueueCoroutine(_transport.SendEnvelopeAsync(envelope));
+        _pendingItems++;
+        _behaviour.QueueCoroutine(SendAndTrack(envelope));
         return true;
     }
 
+    private IEnumerator SendAndTrack(Envelope envelope)
+    {
+        try
+        {
+            yield return _transport.SendEnvelopeAsync(envelope);
+        }
+        finally
+        {
+            _pendingItems--;
+        }
+    }
+
     public Task FlushAsync(TimeSpan timeout) => Task.CompletedTask;
 
-    public int QueuedItems { get; }
+    public int QueuedItems => _pendingItems;
 }
 
 internal class UnityWebRequestTransport : HttpTransportBase

src/Sentry.Unity/UnityWebRequestTransport.cs

@@ -100,6 +100,11 @@ $CommonTestCases = @(
     @{ Name = "Contains OS context"; TestBlock = {
             param($TestSetup, $TestType, $SentryEvent, $RunResult)
             $SentryEvent.contexts.os | Should -Not -BeNullOrEmpty
+
+            if ($TestSetup.Platform -eq "WebGL") {
+                Set-ItResult -Skipped -Because "OS name is not available in the browser sandbox"
+                return
+            }
             $SentryEvent.contexts.os.name | Should -Not -BeNullOrEmpty
         }
     }