ipfs / ipfs-desktop

An unobtrusive and user-friendly desktop application for IPFS on Windows, Mac and Linux.
https://docs.ipfs.tech/install/ipfs-desktop/
MIT License
6.02k stars 864 forks source link

Cross-platform log retrieval UX/UI bug #1996

Open SgtPooki opened 2 years ago

SgtPooki commented 2 years ago

Describe the bug

There are no instructions for getting the logs for a macOS IPFS-Desktop user.

To Reproduce

In the bug template, users are advised to get logs from the GUI, or via path in linux:

<!-- 
ATTACH LOGS

If possible:
1. From the "IPFS icon" menu in your menubar/system tray, go to `Advanced` → `Open Logs Directory` *(for Linux users who do not have this menu, logs can be found in `$HOME/.config/IPFS Desktop` )*
2. Find `*.log` files
3. Attach `error.log` and `combined.log` to this issue.
-->

Expected behavior

  1. GUI should have menu link to get logs on all platforms
  2. Paths to logs should be visible in UI on all platforms.

Screenshots

https://user-images.githubusercontent.com/1173416/156029095-9b9afac8-2d32-484e-8c37-70462553572c.mp4

Additional context

╰─ ✔ ❯ ls ~/Library/Application\ Support/IPFS\ Desktop/**/*.log
/Users/sgtpooki/Library/Application Support/IPFS Desktop/IndexedDB/webui_-_0.indexeddb.leveldb/000009.log
/Users/sgtpooki/Library/Application Support/IPFS Desktop/Local Storage/leveldb/000012.log
/Users/sgtpooki/Library/Application Support/IPFS Desktop/Session Storage/000003.log
/Users/sgtpooki/Library/Application Support/IPFS Desktop/combined.log
/Users/sgtpooki/Library/Application Support/IPFS Desktop/error.log
lidel commented 2 years ago

We have a context menu behind the menubar icon on the right:

image

These options do not seem to be exposed via the top menu on macOS, which is a bug.

The fix is updating darwin section of ./src/app-menu.js – would you be interested in submitting a PR with fix @SgtPooki ?

SgtPooki commented 2 years ago

@lidel i'll assign myself but it'll be a bit until I can get to it.

SgtPooki commented 2 years ago

Starting work on this now

SgtPooki commented 2 years ago

related to https://github.com/ipfs/ipfs-desktop/pull/770