core dump from settings and hot key

[jessfraz]

we should allow a user to "core dump" the app information into a zip file from the settings

HOTKEY is command + shift + .

this information should include:

• version of the app
• operating system
• Add client state to coredump #2338
• a screenshot of the current app at time of hot key for core dump
• auto populate gh issue
• Call core dump from the report a bug button #2738
• make work in editor
• console log

cc @franknoirot @Irev-Dev for any other relevant state and @paultag for any webrtc data we might want to collect

then users can just upload this data to github and we can look it over, will make our lives so much easier

[paultag]

Core must-have WebRTC metrics I'd love in a tombstone like this via the WebRTC metrics JavaScript stubs:

• packetsLost
• framesReceived/s
• frameWidth
• frameHeight
• framesPerSecond
• keyFramesDecoded
• framesDropped
• pauseCount
• totalPausesDuration
• freezeCount
• totalFreezesDuration
• pliCount

I don't know offhand how to get the following (but I want to see if we can):

• decoderImplementation
• powerEfficientDecoder

[paultag]

Specific javascript breadcrums for the above:

We likely need to pull the RTCStatsReport via the RTCPeerConnection.getStats() call, which is accessible from this.pc? and this.mediaStream in engineConnection.js; an example of collecting some of the stats we report via the WebSocket connection is here

[Irev-Dev]

There should be a way to grab all fo the xstate history,
There are a few singleton classes that are probably easy to just serialise and dump out as well.

[franknoirot]

What about Ctrl + Shift + Mod + ? for the keyboard shortcut?

Here's the settings, state and history I'd be thinking, plus the ZIP folder layout:

• manifest.json
  • app version (available as a lib value, we display in Settings.tsx)
  • timestamp
  • browser
  • isTauri
  • OS
• screenshot.png
• connection/
  • (everything Paul mentioned above)
  • missing pause stats from above
• singletons/ (the classes Kurt mentioned above)
  • KclSingleton
  • SceneInfra
  • EngineCommandManager
  • SceneEntitiesManager
  • EditorManager
• xstate/
  • modelingMachine XState context & history
  • settingsMachine XState context & history
  • authMachine XState context & history
  • homeMachine XState context & history (if in Tauri)
  • commandBarMachine XState context & history

[dshaw]

EngineCommandManager singleton implemented in the branch coredump-clientstate

[dshaw]

I'm pretty sure the last item, console.log, is fully implemented in #2653. To validate. Open the developer console in the browser, then trigger a core dump with Shift-META-.. There are a couple console entries that let you know that things are happening. If there are any errors, that will output to the console. When the core dump is complete a JavaScript object representation of the core dump is logged followed by a stringified version which can be copied directly from the console and inspected.

I went ahead and ticked it off. Please revert if there are any further expectations not fulfilled in the v0.22.3 release.

@jessfraz Did you have anything else in mind?

[jessfraz]

the last thing (integrating into the button) has its own issue so ill close this thanks @dshaw !