Add copyable bug report generation to VolView #854
Description
Add copyable bug report generation to VolView
When errors occur, users often can't provide enough context to reproduce the issue. We should generate a structured, anonymous bug report that users can copy and paste into a GitHub issue or email.
Proposed report format
--- VolView Bug Report ---
Build: c6fb619 | vtk.js: 33.6.2, itk-wasm: 1.0.0-b.191
Browser: Chrome 138.0.7204.168 (linux)
Error:
RangeError: Start offset -1408704912 is outside the bounds of the buffer
at new Uint8Array (<anonymous>)
at Pe (itk-wasm-pipeline.worker.js:6:53774)
at S (itk-wasm-pipeline.worker.js:6:54412)
at Object.runPipeline (itk-wasm-pipeline.worker.js:6:62831)
Datasets: 1
[0] 1024×1024×256 Float32 from nii.gz (segment groups: 1)
Save format: nii.gz
--- End Report ---
What to include
| Field | Why |
|---|---|
| Library versions (vtk.js, itk-wasm) + git hash | Pin the code (__VERSIONS__ from Vite build, add git hash via git rev-parse --short HEAD) |
| Browser + OS | WASM behavior varies |
| Stack trace | Locate the bug |
| Image dimensions, VTK datatype, source format (nii.gz, dcm, etc.) | Reproduce size conditions |
| Number of datasets + segment groups | Reproduce workflow |
| Save format (vti, nii, nii.gz) | Affects code path |
What NOT to include
- File names, paths, or URLs
- Image pixel data or thumbnails
- Patient/study metadata (DICOM tags)
- Server hostnames or API keys
- Annotation content or coordinates
UX
- Show the stack trace in the notification detail/expandable area
- Add a "Copy Bug Report" button on error notifications