Call core dump from the report a bug button

[dshaw]

The enhanced core dump capability was released in v0.22.3. It can be invoked by the keyboard shortcut Shift-META-. (period).

There are at least 6 5 user elements that enable, or imply that they enable, the user to report a bug:

1. Lower right controls: "Report a bug" link
2. Help menu: "Report a bug" link
3. User sidebar menu: "Report a bug" button
4. Error page: "Report Bug" button
5. App header refresh button: "Refresh and report - Send us data on how you got stuck"
6. Onboarding 12/12 Future Work: "open issues on GitHub"

1-3 and 6 all link to https://github.com/KittyCAD/modeling-app/issues/new/choose .

4 links to https://github.com/KittyCAD/modeling-app/issues/new .

5 refreshes the app/page and actually doesn't report any data.

Which, if any, of these elements should invoke a core dump?

NOTE: since bug reporting is handled on an external page on GitHub, it's not practical to further fork decisions for the user based on their needs. The user is already presented with an option for most of the above using https://github.com/KittyCAD/modeling-app/issues/new/choose where they have the option to file a structured bug report or a blank GitHub issue. A core dump is a third path to report a bug with its own template that's defined within the core dump feature and is precompiled for the user after it is generated. See #2736 #2650 #2316 for examples.

4 and 5 probably have the closest correlation to user expectations but each has pretty heavy caveats:

4. Error page: "Report Bug" button caveats

• What , if any, app state is actually available when on the error page is displayed?

5. App header refresh button: "Refresh and report - Send us data on how you got stuck"

• This feature was introduced to provide a user with an escape hatch if the app becomes unusable for any reason. The most likely reason is a catastrophic JavaScript runtime error that blocks JavaScript execution. Will we be able to execute a JavaScript call that would intercept the refresh, run the core dump Promise, then refresh the page on completion. A popup window should appear when the core dump has finished being prepared.