feat: persist application logs

[cristianoventura]

Description

This PR introduces changes needed to capture caught and uncaught exceptions to a log file. This will enable us to troubleshoot issues more efficiently.

Here's an example of a log file being generated by the Studio. This includes errors raised by the proxy, IpcMain call and unhandle exceptions.

[2024-10-07 12:06:39.823] [error] mitmproxy/certs.py:112: CryptographyDeprecationWarning: Properties that return a naïve datetime object have been deprecated. Please switch to not_valid_after_utc.

[2024-10-07 12:06:39.824] [error] /Users/username/www/k6-studio/resources/mac/arm64/k6-studio-proxy: Invalid proxy mode specification: regular@AAA (invalid port: AAA)

[2024-10-07 12:08:10.704] [error] Error: Error invoking remote method 'har:open': Error: ENOENT: no such file or directory, open '/Users/username/Documents/k6-studio/Recordings/2024-10-02_17-21-55.har'

[2024-10-07 12:17:58.722] [error] Unhandled rejection ReferenceError: currentBrowserProcess_NOT_DECLARED is not defined
    at IpcMainImpl.<anonymous> (/Users/username/www/k6-studio/.vite/build/main.js:2391:3)
    at IpcMainImpl.emit (node:events:518:28)
    at WebContents.<anonymous> (node:electron/js2c/browser_init:2:82429)
    at WebContents.emit (node:events:518:28)

In addition, a button was included in the UI to allow users to retrieve the log file more easily.

How to Test

• Manually set the proxy to an invalid port and start the application
• Manually change the recording path of a generator and try to open it
• Throw exceptions in specific parts of the app and raise them from the UI

Checklist

• I have performed a self-review of my code.
• I have added tests for my changes.
• I have run linter locally (npm run lint) and all checks pass.
• I have run tests locally (npm test) and all tests pass.
• I have commented on my code, particularly in hard-to-understand areas.

Screenshots (if appropriate):

Related PR(s)/Issue(s)

Resolves #235

[Llandy3d]

We should probably add a section in the bug template asking for this 🤔

[Llandy3d]

minor nit: I think the @see are redundant and probably the link alone would suffice 🤔

[cristianoventura]

@see is part of JSDoc. I believe it wouldn't be applicable for this context, so I'll remove it!

[Llandy3d]

minor suggestion: should we shorten it with app:open-log ?
I'm not sure about this

[e-fisher]

Throw exceptions in specific parts of the app and raise them from the UI

Should it catch UI exceptions automatically? I've tried adding throw new Error('test') to Home.tsx but it wasn't logged.

If I misunderstood, and it wasn't supposed to catch UI exceptions, could we wrap App in error boundary to implement this?

[cristianoventura]

Should it catch UI exceptions automatically? I've tried adding throw new Error('test') to Home.tsx but it wasn't logged.

If I misunderstood, and it wasn't supposed to catch UI exceptions, could we wrap App in error boundary to implement this?

That was missing since I forgot to initialize the error handler in the UI, good catch! Now it should be logging those to the disk as well! The error boundary is something we're missing and would be a nice addition but since we have everything logged to disk at this point, I'll leave the error boundary for a follow-up PR.

[Llandy3d]

🙌

[e-fisher]

LGTM! 🚀