feat: WebGL - dotnet support (#657)

* feat: JS error example

* chore: webgl sample - disable compression

* fix: SentryWebGL version info sources

* fix: WebGL BackgroundWorker implementation & sample packages

* feat: implement WebGL with a custom HttpMessageHandler

* refactor: change WebGL implementation to override HttpTransport

* chore: update WebGL sample test code

* feat: update SmokeTest for WebGL

* test: webgl smoke test script

* fix: compilation on Unity 2019

* test: finalize webGL test scripts

* ci: add WebGL smoke test to CI

* refactor: update WebGL to use HttpTransportBase

* refactor: WebGL - use latest sentry-dotnet APIs

* fix: disable async file IO on WebGL

* ci: change docker image name to the new one with WebGL

* fix: compilation on Unity 2020+

* refactor: move WebRequest transport to its own file

* chore: update package snapshot

* refactor: improve HttpRequestMessage stream type support

* chore: update broken python packages on CI

* chore: fix WebGL smoke test on CI

* fix: SmokeTester GetTestArg when in the editor

* chore: skip unity shader errors on webgl smoke test

* fixup: chore: skip unity shader errors on webgl smoke test

Co-authored-by: Bruno Garcia <[email protected]>
Co-authored-by: Stefan Jandl <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -197,6 +197,18 @@ jobs:
           path: samples/artifacts/builds/Android
           if-no-files-found: error
 
+      - name: Build WebGL Player
+        run: |
+          docker exec unity dotnet msbuild /t:UnityConfigureSentryOptions /p:TestDsn=http://[email protected]:8000/12345 /p:Configuration=Release /p:OutDir=other src/Sentry.Unity
+          docker exec unity dotnet msbuild /t:UnityBuildPlayerWebGL /p:Configuration=Release /p:OutDir=other src/Sentry.Unity
+
+      - name: Upload WebGL Build
+        uses: actions/upload-artifact@v2
+        with:
+          name: testapp-webgl-${{ matrix.unity-version }}
+          path: samples/artifacts/builds/WebGL
+          if-no-files-found: error
+
   package-validation:
     needs: [build]
     name: UPM Package validation
@@ -453,3 +465,26 @@ jobs:
             $runtime = "iOS " + $runtime
           }
           ./Scripts/smoke-test-ios.ps1 Test "$runtime"
+
+  webgl-smoke-test:
+    needs: [build]
+    name: Run WebGL Unity ${{ matrix.unity-version }} Smoke Test
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        unity-version: ['2019', '2020', '2021']
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+
+      - name: Download test app artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: testapp-webgl-${{ matrix.unity-version }}
+          path: samples/artifacts/builds/WebGL
+
+      - run: pip3 install --upgrade --user selenium urllib3 requests
+
+      - run: python3 scripts/smoke-test-webgl.py
+        timeout-minutes: 10

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features
 
+- WebGL - .NET support ([#657](https://github.com/getsentry/sentry-unity/pull/657))
 - Capture `Debug.LogError()` and `Debug.LogException()` also on background threads ([#673](https://github.com/getsentry/sentry-unity/pull/673))
 
 - Adding override for Sentry CLI URL ([#666](https://github.com/getsentry/sentry-unity/pull/666))

Directory.Build.targets

@@ -254,6 +254,20 @@ Related: https://forum.unity.com/threads/6572-debugger-agent-unable-to-listen-on
     <!-- <Error Condition="!Exists('$(IOSBuildPath)')" Text="iOS build not found. Did something go wrong?"></Error> -->
   </Target>
 
+  <!-- Build a WebGL player: dotnet msbuild /t:UnityBuildPlayerWebGL src/Sentry.Unity -->
+  <Target Name="UnityBuildPlayerWebGL" DependsOnTargets="FindUnity" Condition="'$(MSBuildProjectName)' == 'Sentry.Unity'">
+    <Error Condition="$(UnityRoot) == ''" Text="Couldn't find Unity."></Error>
+
+    <Message Importance="High" Text="Building the sample player for WebGL." />
+
+    <Exec Command="$(UnityExec) -quit -batchmode -nographics -logFile - -projectPath $(UnitySampleProjectPath) -executeMethod Builder.BuildWebGLPlayer -buildPath $(PlayerBuildPath)WebGL" IgnoreStandardErrorWarningFormat="true" />
+  </Target>
+
+  <!-- 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"/>
+  </Target>
+
   <!-- If Unity Library Project doesn't exist, create a Unity project. We use this project to restore packages needed to build
   this solution without using the sample project which depends on the output of this build. -->
   <Target Name="UnityCreatePackages" Condition="!Exists('$(UnityPackageProject)') AND '$(MSBuildProjectName)' == 'Sentry.Unity'" AfterTargets="FindUnity">

package-dev/Runtime/SentryInitialization.cs

@@ -5,6 +5,8 @@
 #define SENTRY_NATIVE_ANDROID
 #elif UNITY_STANDALONE_WIN && ENABLE_IL2CPP
 #define SENTRY_NATIVE_WINDOWS
+#elif UNITY_WEBGL
+#define SENTRY_WEBGL
 #endif
 #endif
 
@@ -17,6 +19,8 @@
 using Sentry.Unity.Android;
 #elif SENTRY_NATIVE_WINDOWS
 using Sentry.Unity.Native;
+#elif SENTRY_WEBGL
+using Sentry.Unity.WebGL;
 #endif
 
 [assembly: AlwaysLinkAssembly]
@@ -39,6 +43,8 @@ public static void Init()
                 SentryNativeAndroid.Configure(options, sentryUnityInfo);
 #elif SENTRY_NATIVE_WINDOWS
                 SentryNative.Configure(options);
+#elif SENTRY_WEBGL
+                SentryWebGL.Configure(options);
 #endif
 
                 SentryUnity.Init(options);

samples/unity-of-bugs/Assets/Editor/Builder.cs

@@ -67,6 +67,7 @@ public static void BuildIl2CPPPlayer(BuildTarget target, BuildTargetGroup group)
     public static void BuildLinuxIl2CPPPlayer() => BuildIl2CPPPlayer(BuildTarget.StandaloneLinux64, BuildTargetGroup.Standalone);
     public static void BuildAndroidIl2CPPPlayer() => BuildIl2CPPPlayer(BuildTarget.Android, BuildTargetGroup.Android);
     public static void BuildIOSPlayer() => BuildIl2CPPPlayer(BuildTarget.iOS, BuildTargetGroup.iOS);
+    public static void BuildWebGLPlayer() => BuildIl2CPPPlayer(BuildTarget.WebGL, BuildTargetGroup.WebGL);
 
     private static void SetupSentryOptions(Dictionary<string, string> args)
     {