Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WebGL JavaScript & native error handling #668

Open
vaind opened this issue Mar 30, 2022 · 4 comments
Open

WebGL JavaScript & native error handling #668

vaind opened this issue Mar 30, 2022 · 4 comments
Labels
WebGL

Comments

@vaind
Copy link
Collaborator

vaind commented Mar 30, 2022

After the dotnet WebGL support is merged in #657, we can add support for javascript errors. There are two main approaches, the selection of the best one is part of this issue:

  1. either include sentry-javascript and let it do the reporting
  2. or implement the error handlers same as sentry-javascript does but forward errors to dotnet via wasm calls (if that's even possible - there's a list of all native functions available in development build sources)

In both cases, we would need to add an editor script that updates the generated JS sources (that supports both development & release builds, the latter including compression).

There's already a button to trigger a JS error - look for ThrowJavaScript(), enable it in NativeSupportScene.cs - but there would likely need to be more, e.g. to also include it in the SmokeTest.

As a related topic, we should check whether the selected approach also covers errors in the native code that are unhandled - you can reproduce those within the "Native Samples" scene in the sample repo.
@vaind vaind mentioned this issue Mar 30, 2022
Merged
5 tasks
@vaind
Copy link
Collaborator Author

vaind commented Mar 30, 2022

Additional off-topic TODO: warn/error out during build when "com.unity.modules.unitywebrequest": "1.0.0" package is disabled - otherwise Unity just throws a vague error: Cannot create web request without initializing the system that I couldn't get any useful resolution for by googling

It requires the build script to be present so sounds like a good time to do it in a single PR.

@bruno-garcia
Copy link
Member

either include sentry-javascript and let it do the reporting

I think this is the preferred solution as it's our largest SDK and has a lot of development going on there.

@vaind
Copy link
Collaborator Author

vaind commented Apr 14, 2022 •
edited
Loading

I've tried to integrate the browser bundle.js and it kinda works, as in the event is reported to sentry.io, however, I'm not sure how to get any stack trace info, because the scripts are loaded as blobs, which are, in case of a release build, also compressed...

Maybe we'd need to create a custom integration that does the stack parsing.

unity-web.zip

@vaind
Copy link
Collaborator Author

vaind commented Apr 14, 2022 •
edited
Loading

OK, so the stack traces for the embedded code coming from Unity .jslib are pretty limited but I don't think there's much we can do, 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.

What we would need to do is:

  1. Add sentry-js bundle to the sentry-unity package (either in repo or in CI) - I guess we're fine with including only the minified version, regardless of what kind of app user builds: https://browser.sentry-cdn.com/6.19.6/bundle.min.js
  2. Create a PostBuild integration 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://94677106febe46b88b9b9ae5efd18a00@o447951.ingest.sentry.io/5439417",
    release: "0.1.0",
    ....
  });
</script>
  3. Make some kind of integration test: I think we could use SmokeTester.cs to launch the javascript error sample we already have in the example app. The existing WebGL python server would capture and check that.
  4. [optional] Implement scope sync - requires individual functions, similar to objective-c

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
WebGL
Projects
.NET & Gaming
Status: No status
Mobile & Cross Platform SDK
Archived in project
Milestone
No milestone
Development

No branches or pull requests
3 participants
@bruno-garcia @vaind @bitsandfoxes