feat: just a menubar #866

hacdias · 2019-03-12T22:24:21Z

I've taken a bit of time today to work on this since I really enjoyed the idea - and I liked the result very much. Don't get mistaken by the 'wip' in the title. The only thing missing are changes to the README 😄The software is workiiiiiing!

It is working on macOS and Windows. It is supposed to work better on Linux now since we don't have the issue of which 'screen' is showing (some envs would just show the menubar with options on either click).

Please read #865 for further background information. @ericronne suggested to collapse the Web UI options (from Status to Peers) into one 'Open Web UI'. Although I actually like the current configuration. Please try it out!

Wonder if in the future we wouldn't be able to ditch Electron and open Web UI on user's browser and use Qt for the menubar.

Closes Remove React from the menubar #732: we remove React completely from the app.
Closes Visualise the status of the ipfs daemon and be robust to it not stopping. #857: we now have a beautiful status information with colors!
Closes Upgrade to go-ipfs 0.4.19 #864: we updated the dependencies and go-ipfs!!
Closes Move to menubar menu only #865: well... that is what this is about.

TODO

Update README screenshot

hacdias · 2019-03-12T22:25:13Z

@ipfs-shipyard/gui I need y'all here 😄 This is a big change!

On Linux in order for changes made to individual MenuItems to take effect, you have to call setContextMenu again. Without this, updateStatus(status) in src/lib/tray.js does not update the menu. License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel

Menu did not update on Linux (i3bar), but I've found a fix (see cab400c) and it displays updated menu correctly on right-click now:

Not sure why left-click does not work, perhaps it is i3bar I use for tray.
(this should not block this PR, we can investigate this later).

Quick thoughts on menu itself:

Settings should be moved out of "Advanced" to the top level, and be in the same order as in Web UI (under "Peers"), to minimize user confusion :)
"Check for updates" could be moved to "Advanced" submenu to declutter UI a bit
Overall, I like it a lot! This change makes it feel light and snappy.

…ipfs-desktop into feat/just-menubar

hacdias · 2019-03-13T08:01:14Z

@lidel

Not sure why left-click does not work, perhaps it is i3bar I use for tray.

I think what I just pushed might fix that.

Settings should be moved out of "Advanced" to the top level, and be in the same order as in Web UI (under "Peers"), to minimize user confusion :)

Yas. Talking about that: we only have three options in settings related to Desktop. Perhaps they could be checkbox-type buttons on a Preferences sub-menu where the user could activate them and deactivate them.

"Check for updates" could be moved to "Advanced" submenu to declutter UI a bit

Yeah!

Overall, I like it a lot! This change makes it feel light and snappy.

Feels light, but it isn't light... In the future I'd like to investigate possible ways of moving out of Electron. It would be lighter and perhaps even/actually more native.

Perhaps native implementations for each OS with a C/C++/Go shared library. Thinking too much? After this is closes, I'll certainly open an issue about the nativeness of our app and what we can do to make it better. Or perhaps native apps that rely on our Node library which must be possible too.

olizilla · 2019-03-13T09:07:17Z

I really like it. I think we could drop the third divider.

something like

- IPFS is running
- About IPFS Desktop
---
- View Status
- View Files
- View Settings
---
Advanced ▸           Stop IPFS daemon
Quit                 Open repo directory
                     Open logs directory
                     Check for updates
                     _Versions_
                     IPFS Desktop 0.7-rc4
                     go-ipfs 0.4.19

We don't need to list out all peers and explore from the main navbar, just the most useful ones. Also this avoids the "am i opening the Desktop app, or the Web UI, what should I call it?" question.
Move "Stop IPFS" to the advanved menu. It should be available, but not one of the main things.
At this early stage, while we're still getting the auto update mechanism working, it's useful to have an easy way to see the versions, so push them into the advanced section too.

And what about adding a link to docs.ipfs.io? this'd draw more attention to it and encourage us to add a section on Desktop and Web UI.

olizilla · 2019-03-13T09:09:20Z

also of note, the status link isn't working for me.

hacdias · 2019-03-13T09:20:52Z

@olizilla will restructure that way! Seems a good idea.

also of note, the status link isn't working for me.

Neither for me, thanks for noticing.

hacdias · 2019-03-13T10:35:50Z

Current status:

fsdiogo · 2019-03-13T10:49:44Z

Move "Stop IPFS" to the advanced menu. It should be available, but not one of the main things.

@olizilla I don't think so, especially when you want to start the node again:

It's pretty odd finding that function buried, and having the About being the second item too. The About should be between Advanced and Quit (most of the mac apps have about before the quit).

hacdias · 2019-03-13T10:51:15Z

@fsdiogo: It's pretty odd finding that function buried, and having the About being the second item too. The About should be between Advanced and Quit (most of the mac apps have between before the quit).

Yeah, I agree with those two.

hacdias · 2019-03-13T10:52:17Z

And perhaps we could hide the versions behind 'About IPFS Desktop'. Instead of opening the repository, we could show a simple informational dialog.

fsdiogo · 2019-03-13T10:57:25Z

Hmm yeah, if that dialog is customisable we can have the links to the repos there!

olizilla · 2019-03-13T11:01:09Z

@fsdiogo I was following the example of Docker for Mac. I don't find it weird, but I don't feel strongly about it.

I don't think "Stop IPFS" should be in the main menu. A user has to restart IPFS to make a config change, but we should offer that option in the UI, when they make a config change. In the meantime we could add a "Restart IPFS" option to either the advanced, or the main menu if you feel strongly that it should be there.

My assumption is that for most users, we'd like them to be able to set their node up once (ideally just run with the defaults) and then leave IPFS running. If IPFS takes too much resources, we should limit it. We just dropped the number of open connections it'll try and make from 600+ to about 150, which should help.

hacdias · 2019-03-13T11:09:55Z

@lidel how do you feel about this?

fsdiogo · 2019-03-13T11:37:26Z

I don't think "Stop IPFS" should be in the main menu. A user has to restart IPFS to make a config change, but we should offer that option in the UI, when they make a config change. In the meantime we could add a "Restart IPFS" option to either the advanced, or the main menu if you feel strongly that it should be there.

@olizilla the idea of restarting through Web UI is great 👌 I feel strongly that it shouldn't be in the advanced, and we should have the option to Start and Stop instead of just restarting.

@hacdias as we're talking about Docker, this About window looks good don't you think?

lidel · 2019-03-13T11:38:43Z

Start/Stop/Restart actions could land under the Status item.
Web UI items also could be moved it own submenu, but personally I prefer to keep them at the top-level. I'd like "Files" to be super easy to access.
I don't like "View" and "Open" being repeated in UI, so I would just drop them from labels.

IPFS is running ▸    Restart
                     Stop
---
Status
Files
Peers
Settings  
---
Advanced ▸           Logs Directory
                     Repo Directory
                     IPFS Desktop Configuration File

About ▸              About IPFS Desktop
                     Check for Updates
                     _Versions_
                     ipfs-desktop 0.7-rc4
                     go-ipfs 0.4.19
Quit

hacdias · 2019-03-13T11:49:34Z

@fsdiogo I really like Docker's about page. Although remember: that's a native window. We can't do one as native as that one. What we could do is create a very simple web page to show. Again - it would be really nice if in the feature we could have really native apps for each platform.

@lidel I like the idea of starting/stopping and restart being under the status item.

I agree with dropping 'Open' and 'View' labels.

I personally don't like having those options under 'About'. It feels weird to me.

Another interesting thing is that on macOS we usually see 'Per Word Capitalisation' and on Windows we have 'Per sentence capitalisation'.

olizilla · 2019-03-13T12:03:21Z

I think we are zooming in on an ideal list. I like @lidel's proposal, pulling the start and restart under the status seems neat.

In general think the menu items should be things you can do, so verbs rather than nouns.

I feel strongly that actions that open directories should start with "Open" e.g " Open logs directory"
I can live with the links to the web ui sections not starting with "View", as I agree, the reptition looks odd, but in general, I'm in favour of explicit and clear over terse and more visually pleasing where menu options are concerned.
I like @fsdiogo's ask for an about dialog, but perhaps lets keep it as menu options for now to keep this PR focused.

IPFS is running ▸    Restart
                     Stop
---
Status
Files
Settings  
---
Advanced ▸           Open logs directory
                     Open respository directory
                     Open configuration file

About ▸              _Versions_
                     ipfs-desktop 0.7-rc4
                     go-ipfs 0.4.19
                     ----
                     Check for Updates...
                     View on Github

Quit

hacdias · 2019-03-13T12:10:17Z

@olizilla I agree with that disposition. What do you think @lidel @fsdiogo?

olizilla · 2019-03-13T15:26:08Z

If you can't put stop and restart under a submenu, then just inline them.

🍏 IPFS is running
Restart
Stop
---
Status
Files
Settings  
---
Advanced ▸           Open logs directory
                     Open respository directory
                     Open configuration file

About ▸              _Versions_
                     ipfs-desktop 0.7-rc4
                     go-ipfs 0.4.19
                     ----
                     Check for Updates...
                     View on Github

Quit

…ipfs-desktop into feat/just-menubar

hacdias · 2019-03-13T15:39:13Z

Done:

olizilla · 2019-03-14T08:29:14Z

README.md

+
+### IPFS daemon always running
+
+IPFS Desktop's main feature is to allow you to have the IPFS daemon always running in the background. But fear not! If you need to stop it, you can do it under the 'Advanced' options.


olizilla · 2019-03-14T08:30:18Z

src/icons/status/gen_status.sh

+  middle=$(($3 / 2))
+  center=$((middle - 1))
+
+  convert -size "$3x$3" xc:transparent \


not for this PR, but would be good to document the dependencies for running this script.

Will do later :) I can even just add a comment there or add to the README. There's something I don't really like about that: not sure if the sizes are perfect. They look good but it seems that they're not as correct as they should be. But we can take a look at that later.

olizilla

This is great! It feels so much snappier and integrated as an OS menu. This PR is really neat too.

I've left some minor feedback inline, and also, note that the "stopped" circle indicator is almost invisible on macos:

olizilla · 2019-03-14T08:58:40Z

src/lib/tray.js

+        },
+        {
+          label: i18n.t('openConfigFile'),
+          click: () => { shell.openItem(store.path) }


I'm not sure about exposing the IPFS Desktop config file to users. It's confusing that it isn't related to the much more documented IPFS config.

I'm not gonna block the PR for this, I just want to flag that my expectation here was that it'd open the IPFS config file.

Yeah, we already had that possibility. It might be useful for someone who wants to change the flags that we use to run the daemon.

olizilla · 2019-03-14T09:01:49Z

src/lib/tray.js

+  const updateStatus = data => {
+    status = data
+
+    menu.getMenuItemById('ipfsIsStarting').visible = status.starting && !status.done


How about just setting the status to one of these string values in the first place? with the collection of booleans, it's harder to be sure that we have covered every eventuality. If status can only be 1 string, then we can quickly scan the deamon init code to see all the possible values, and we can just use it directly here.

Yes, I wanted to make those constants and just compare. I'll do that in another PR.

it would be even better to just change the text and the icon... But this is not native and Electron doesn't let us do that.

hacdias · 2019-03-14T09:18:44Z

@olizilla I'll update the circle in another PR and the other things you've mentioned!

alanshaw · 2019-03-14T09:45:42Z

w00t! ship it!

lidel · 2019-03-15T17:47:58Z

Not sure why left-click does not work, perhaps it is i3bar I use for tray.
(this should not block this PR, we can investigate this later).

For the record:
I just re-tested in v0.7.0 and the issue is fixed there (menu pops up for both left and right clicks) 🚀 👍

hacdias added 5 commits March 12, 2019 21:24

wip: feat just menubar

004ced8

fix: crash after quit

2335f25

wip: remove unused files and logos

42daa25

feat: add about action

8066bd0

feat: open on left click on win32

2ee7138

ghost assigned hacdias Mar 12, 2019

ghost added the in progress label Mar 12, 2019

hacdias requested review from olizilla, lidel and fsdiogo March 12, 2019 22:25

hacdias and others added 3 commits March 12, 2019 23:46

fix: IPFS Desktop is the name of the program

dafeea4

chore: update dependencies

09413fe

fix: menu update under Linux

cab400c

On Linux in order for changes made to individual MenuItems to take effect, you have to call setContextMenu again. Without this, updateStatus(status) in src/lib/tray.js does not update the menu. License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

ghost assigned lidel Mar 13, 2019

lidel reviewed Mar 13, 2019

View reviewed changes

hacdias added 2 commits March 13, 2019 07:56

fix: show ctx menu on left click linux

242dbb1

Merge branch 'feat/just-menubar' of https://github.com/ipfs-shipyard/…

2981081

…ipfs-desktop into feat/just-menubar

hacdias mentioned this pull request Mar 13, 2019

"Nativeness" of IPFS Desktop #867

Open

hacdias added 3 commits March 13, 2019 09:34

wip: fix status and restructure menus

f55ffb2

feat: reduce functions and simplify stuff

3961b1a

docs: add some features

3cf3a47

docs: update screenshot

a684753

hacdias changed the title ~~wip: just a menubar~~ feat: just a menubar Mar 13, 2019

hacdias added 2 commits March 13, 2019 15:38

feat: update options order and add restart

b51bb85

Merge branch 'feat/just-menubar' of https://github.com/ipfs-shipyard/…

90bc410

…ipfs-desktop into feat/just-menubar

feat: go-ipfs 0.4.19

d1b2a71

olizilla reviewed Mar 14, 2019

View reviewed changes

olizilla approved these changes Mar 14, 2019

View reviewed changes

hacdias added 2 commits March 14, 2019 09:24

feat: a bit darker gray

898bd45

docs: update screenshot

2cc3ea9

hacdias merged commit 2e7fd29 into master Mar 14, 2019

hacdias deleted the feat/just-menubar branch March 14, 2019 09:42

ghost removed the in progress label Mar 14, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: just a menubar #866

feat: just a menubar #866

hacdias commented Mar 12, 2019 •

edited

Loading

hacdias commented Mar 12, 2019 •

edited

Loading

lidel left a comment •

edited

Loading

hacdias commented Mar 13, 2019 •

edited

Loading

olizilla commented Mar 13, 2019

olizilla commented Mar 13, 2019

hacdias commented Mar 13, 2019

hacdias commented Mar 13, 2019 •

edited

Loading

fsdiogo commented Mar 13, 2019 •

edited

Loading

hacdias commented Mar 13, 2019

hacdias commented Mar 13, 2019

fsdiogo commented Mar 13, 2019

olizilla commented Mar 13, 2019 •

edited

Loading

hacdias commented Mar 13, 2019

fsdiogo commented Mar 13, 2019

lidel commented Mar 13, 2019

hacdias commented Mar 13, 2019

olizilla commented Mar 13, 2019

hacdias commented Mar 13, 2019

olizilla commented Mar 13, 2019 •

edited

Loading

hacdias commented Mar 13, 2019

olizilla Mar 14, 2019

olizilla Mar 14, 2019

olizilla Mar 14, 2019

hacdias Mar 14, 2019

olizilla left a comment

olizilla Mar 14, 2019

hacdias Mar 14, 2019

olizilla Mar 14, 2019

hacdias Mar 14, 2019

hacdias Mar 14, 2019

hacdias commented Mar 14, 2019

alanshaw commented Mar 14, 2019

lidel commented Mar 15, 2019


		### IPFS daemon always running

		IPFS Desktop's main feature is to allow you to have the IPFS daemon always running in the background. But fear not! If you need to stop it, you can do it under the 'Advanced' options.

feat: just a menubar #866

feat: just a menubar #866

Conversation

hacdias commented Mar 12, 2019 • edited Loading

TODO

hacdias commented Mar 12, 2019 • edited Loading

lidel left a comment • edited Loading

Choose a reason for hiding this comment

hacdias commented Mar 13, 2019 • edited Loading

olizilla commented Mar 13, 2019

olizilla commented Mar 13, 2019

hacdias commented Mar 13, 2019

hacdias commented Mar 13, 2019 • edited Loading

fsdiogo commented Mar 13, 2019 • edited Loading

hacdias commented Mar 13, 2019

hacdias commented Mar 13, 2019

fsdiogo commented Mar 13, 2019

olizilla commented Mar 13, 2019 • edited Loading

hacdias commented Mar 13, 2019

fsdiogo commented Mar 13, 2019

lidel commented Mar 13, 2019

hacdias commented Mar 13, 2019

olizilla commented Mar 13, 2019

hacdias commented Mar 13, 2019

olizilla commented Mar 13, 2019 • edited Loading

hacdias commented Mar 13, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

olizilla left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hacdias commented Mar 14, 2019

alanshaw commented Mar 14, 2019

lidel commented Mar 15, 2019

hacdias commented Mar 12, 2019 •

edited

Loading

hacdias commented Mar 12, 2019 •

edited

Loading

lidel left a comment •

edited

Loading

hacdias commented Mar 13, 2019 •

edited

Loading

hacdias commented Mar 13, 2019 •

edited

Loading

fsdiogo commented Mar 13, 2019 •

edited

Loading

olizilla commented Mar 13, 2019 •

edited

Loading

olizilla commented Mar 13, 2019 •

edited

Loading