Improve WebGL Support

Đang mở
  • Có gì không ổn?
#2,415 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 3 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
csharp, unity
Lĩnh vực
game-dev, observability-sre

Hướng nghiên cứu

Bắt đầu với các đường dẫn stack trace của WebGL trong DebugStackTrace.cs và AotHelper.cs, sau đó xem xét SentryInitialization.cs về phần tích hợp tracing khi khởi động đang bị vô hiệu hóa. Sử dụng SmokeTester.cs và thiết lập smoke testing WebGL hiện có để điều tra hành vi. Công việc được xem là hoàn tất khi có phạm vi WebGL được xác định và các bài kiểm thử bao phủ những cải tiến đã chọn về exception, logging hoặc tracing khi khởi động.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
C#
Star
294
Fork
63
Merge trung bình
3 ngày 17 giờ
Pull request đã merge (30 ngày)
26

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của getsentry/sentry-unity

Tất cả issue của getsentry/sentry-unity

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.