feat: Add gather & download logs button in troubleshooting

[cdrage]

feat: Add gather & download logs button in troubleshooting

What does this PR do?

• Adds a button to collect logs which is currently only hardcoded to
  retrieve the console logs
• Adds a button to download the logs as a zip file with all logs stored
  within as a .txt file
• Shows which files have been generated and what will be zipped.

Screenshot / video of UI

Screen.Recording.2023-12-05.at.2.23.40.PM.mov

What issues does this PR fix or reference?

Closes #5048

How to test this PR?

1. Go to troubleshooting
2. Click the collect logs & download logs buttons.

[benoitf]

includes on macOS

~/Library/Logs/Podman\ Desktop/launchd-stdout.log
~/Library/Logs/Podman\ Desktop/launchd-stderr.log

[cdrage]

Ready for review!

Would like some input on how to improve the UI as well as other logs we should be collecting (Windows and Linux specifically).

In a later PR we should implement methods for extensions to add what logs they'd also like to have in the .zip

[deboer-tim]

This review is going to jump around a lot, sorry in advance. :)

+1 to all the basic parts (zip, file dialog, etc) being there. It works!

Title: I know this as 'must gather' from the past 20 years and the name kinda sticks, but like 'onboarding' I don't know if the average user knows the term. Maybe something like "Gather Log Files" would be enough with an expanded description? e.g. "Bundle all log files into a zip for future (or offline?) problem determination".

From a core/UI standpoint I don't know when we'd ever want just console logs or just system logs, plus we'll have extension logs, etc. I think it's probably simpler if index.ts just exposes a 'getLogs', and if we ever need something more fine-grained it could have optional parameters in the future.

Going a step further I think it's nice it shows you a list of files that it's going to zip and uses mono-font to list them - but I think the usage pattern is always to click one, then the other. I'm wondering if we should even bother having a Collect Logs button and exposing it through the API, or just have a single button? Or maybe a single button and it just gives you a summary of the files that it included after.

We're a desktop app, so a "Download" button is a bit out of place. Maybe just "Save"?

[jeffmaury]

Missing implementations

[cdrage]

Ready for another review 👍 / UI updated to use the new "tabbed" logs.

[cdrage]

One button: 👍🏼

I was expecting one button to also mean there is only one exposed function from main though too, e.g. something like window.saveLogsToZip(filename). All of the logic to gather console/system logs would be in here, and the UI only gets to say where to save it.

I guess implicit in the previous comment is that IMHO it would be best if the main package wasn't doing UI-things like opening the save dialog and we left this in renderer - i.e. GatherLog page would open the dialog to pick a location and then call the window function.

Done! Ready for another review. Put it down to one API call (that also gets the console logs via memoryLogs).

[deboer-tim]

Thanks for all the changes, this is much simpler and cleaner to me now. I'd still appreciate a couple more minor tweaks as listed.

[cdrage]

Updated! I've also changed for it to retain the original file name extension, and if there is none, default to .txt

[deboer-tim]

Thanks for all the changes, LGTM.

[cdrage]

@benoitf thank you for the review! implemented all the requested changes and it's ready for another 👍

[benoitf]

if you can update glitches like copyright date, formatting the license, and fileName -> filename before merging

else 👍

[cdrage]

Updated based on the changes, thank you for the reviews! Enabling auto-merge now 🎉

changes made

[benoitf]

I noticed that packages/renderer/src/lib/troubleshooting/TroubleshootingGatherLogs.svelte has no unit test