Improve WebGL Support

Abierto
  • ¿Algo no está bien?
#2,415 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
csharp, unity
Área
game-dev, observability-sre

Línea de trabajo

Empieza por las rutas de stack trace de WebGL en DebugStackTrace.cs y AotHelper.cs, y después revisa SentryInitialization.cs para comprobar la integración deshabilitada del tracing de inicio. Usa SmokeTester.cs y la configuración existente de smoke testing de WebGL para investigar el comportamiento. El trabajo se considerará terminado cuando haya un alcance de WebGL definido y pruebas que cubran las mejoras seleccionadas de excepciones, registro o tracing de inicio.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Errors Feature Unity
Description

The SDK's WebGL support is currently limited to C#.

Current Limitations

PlayerSettings.WebGL.exceptionSupport
  • None - Not supported. See https://github.com/getsentry/sentry-unity/pull/2141 for more details.
  • Explicitly Thrown Exceptions Only - Captures and reports exceptions but misses stack trace.
  • Full Without Stacktrace - Captures and reports exceptions but misses stacktrace.
  • Full With Stacktrace- Captures and reports exception and provides a stacktrace (albeit with no line numbers due to lack of IL2CPP backend availability)
Fails to create new StackTrace()

This is happening with Explicitly Thrown Exceptions Only and Full Without Stacktrace.
The SDK fails trying to create a new SentryStackTrace. The SDK fails with Could not resolve stack frame. This is due to the DebugStackTrace failing to create a managed frame. It relies on the following snippet used in the AotHelper

var stackTrace = new StackTrace(false);
return stackTrace.GetFrame(0)?.GetMethod() is null;

To resolve this we could provide our own dedicated WebGLStackTraceFactory to create a new frame and fall back on stackFrame.ToString() instead of doing nothing. And probably skip a whole lot of other, for WebGL unnecessary checks i.e.

if (CreateFrame(stackFrame) is { } frame)
{
    yield return frame;
}
else
{
    yield return new SentryStackFrame { Function = stackFrame.ToString() };
}
Missing stack trace for LogError events

The missing stacktrace also mentioned in https://github.com/getsentry/sentry-unity/issues/2091#issuecomment-2839750715 is also related to the PlayerSettings.WebGL.exceptionSupport. When setting to FullWithStacktrace the SDK is able to provide stack traces for these events as well. Set to any other option Unity does not pass down a stack trace to the logging integration and we'd need to create a new stack trace, bringing us back to the point above.

Current Recommendation

The current recommendation is to set PlayerSettings.WebGL.exceptionSupport to Full With Stacktrace to get the most out of the SDK. Anything else will require us to build a WebGL specific integration to better handle those cases.

Future Plans

Native Support

Taken from @vaind https://github.com/getsentry/sentry-unity/issues/668#issuecomment-1099453415

Stack traces for the embedded code coming from Unity's .jslib are pretty limited. They're just not there on the error reported by the browser.

The integration could still be useful at least to get the error type/text + stack traces if they're coming from standard javascript files.

  1. Add sentry-js bundle to the sentry-unity package. The minified version should be fine: https://browser.sentry-cdn.com/10.24.0/bundle.min.js
  2. Create a PostBuild step to alter the generated index.html, adding the Sentry-javascript initialization to the beginning of <head>:
<script src="Build/bundle.js"></script>
<script>
  Sentry.init({
    dsn: "https://[email protected]/5439417",
    release: "0.1.0",
    ....
});
</script>
  1. We're already smoke testing for WebGL. Use the SmokeTester.cs to create a javascript error. The existing python server would capture and check that.
  2. [optional] Implement scope sync - requires individual functions, similar to Objective-C
Startup Tracing

Currently, the startup tracing integration is disabled for WebGL due to the UnityWebRequestTransport seemingly not being ready this early in the runtime.

https://github.com/getsentry/sentry-unity/blob/ec8cc5bd9df3a572e0323ad44b17e61c5de706c6/package-dev/Runtime/SentryInitialization.cs#L52-L58

This could be solved by creating timestamps instead of starting the spans and creating and sending the transaction after the fact.

Lenguaje dominante
C#
Estrellas
294
Forks
63
Merge medio
3 d 17 h
PR fusionados (30 d)
26

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de getsentry/sentry-unity

Todos los issues de getsentry/sentry-unity

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.