web_panic_report

Crates.io	web_panic_report
lib.rs	web_panic_report
version	0.3.0
source	src
created_at	2024-03-17 16:55:06.001188
updated_at	2024-08-15 12:05:51.107865
description	A panic hook which replaces an HTML element with a bug report form.
homepage
repository	https://github.com/loopystudios/web_panic_report
max_upload_size
id	1176645
size	122,489

Thierry Berger (Vrixyz)

documentation

README

Web Panic Report

A panic hook which replaces an HTML element with a bug report form.

[!WARNING] The goal of this project is NOT to provide a full-fledge error reporting and analytics, only to help provide a framework to report panic conditions.

Quickstart to run demo:

# Make sure the Rust toolchain supports the wasm32 target
rustup target add wasm32-unknown-unknown

# Install `wasm-server-runner` for the example
cargo install wasm-server-runner

WASM_SERVER_RUNNER_CUSTOM_INDEX_HTML=examples/index.html cargo run --target wasm32-unknown-unknown --example simple

There is also a web demo available here.

Demo

Usage

[!IMPORTANT] On release mode, debug symbols are stripped. You will need to enable them manually if you want useful stack traces for production builds.

Add the following to your Cargo.toml
[profile.release]
debug = true

Ensure your web page is served with a container element that will be replaced with the bug report form.

<body>
  <div id="my-container" style="width: 400px; height: 400px;">
    /** Content that is replaced here on panic, like a game canvas */
  </div>
</body>

Then, set the panic hook at the beginning of your program on web.

fn main() {
    #[cfg(target_arch = "wasm32")]
    web_panic_report::set_default_hook_with("my-container", |panic_info| {
        // Send the panic info to your backend here.
        // This is triggered when the user clicks "Send Report"
    });
}

You can also use a custom bug report form. See the custom example.

Alternatives

console_error_panic_hook - Only outputs stack trace to the console.

Minimum supported Rust Version (MSRV)

This version of Web Panic Report has been verified to compile with Rust 1.75 and later.

Future versions of Web Panic Report might increase the Rust version requirement. It will not be treated as a breaking change and as such can even happen with small patch releases.

Click here if compiling fails.

As time has passed, some of Web Panic Report's dependencies could have released versions with a higher Rust requirement. If you encounter a compilation issue due to a dependency and don't want to upgrade your Rust toolchain, then you could downgrade the dependency.

# Use the problematic dependency's name and version
cargo update -p package_name --precise 0.1.1

Community

All Loopy projects and development happens in the Loopy Discord. The discord is open to the public.

Contributions are welcome by pull request. The Rust code of conduct applies.

License

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 16