feat: allow custom ipfs binary

[hacdias]

This closes #836. With this PR, the user is now able to set their own custom IPFS binary. The option to do so is under Advanced as it is an advanced feature:

If a custom IPFS binary is set, then the 'Set Custom IPFS Binary' is replaced by 'Clear Custom IPFS Binary'.

The IPFS on PATH now obbeys to this so the ipfs binary available for the user is the one that IPFS Desktop is using, no matter if it's provided by IPFS_GO_EXEC, set by the user, or the default that is bundled with IPFS Desktop.

Setting the environment variable IPFS_GO_EXEC affects the IPFS binary used while it is set. If IPFS Desktop is restarted and that variable is no longer set, we default to either the custom user defined binary or to the bundled binary.

License: MIT
Signed-off-by: Henrique Dias [email protected]

[lidel]

(not a review, just quick feedback)

For the context, there are two things user may want to override:

• binary location
  • GUI: (this PR)
  • CLI: I think IPFS_GO_EXEC should work (refactor: remove path and ref from module args also findBin js-ipfsd-ctl#458)
• repo location
  • GUI: Advanced → Move Repo Location
  • CLI: IPFS_PATH env variable

This PR is a good opportunity to unify / double check those behaviors.

• menu items should be next to each other, perhaps separated from the rest with a line?
• expectation of persistence:
  • changes made via GUI should persist across restarts
  • changes made via CLI disappear when env variable is no longer set during next run
• this really needs tests

[hacdias]

This PR is a good opportunity to unify / double check those behaviors.

I wanted to add an information here about what we are doing about the IPFS_PATH environment variable: we are not setting a global IPFS_PATH variable. We're just overriding it when using the "IPFS on PATH" feature.

Our binary wrapper on Windows:

https://github.com/ipfs-shipyard/ipfs-desktop/blob/b9d6f188ae737e0c388656050b5d6568081c4507/src/ipfs-on-path/scripts/bin-win/ipfs.cmd#L1-L7

Our binary wrapper on other OSes:

https://github.com/ipfs-shipyard/ipfs-desktop/blob/b9d6f188ae737e0c388656050b5d6568081c4507/src/ipfs-on-path/scripts/ipfs.sh#L1-L14

menu items should be next to each other, perhaps separated from the rest with a line?

Just done.

changes made via GUI should persist across restarts

Already done.

changes made via CLI disappear when env variable is no longer set during next run

We're not setting global env vars.

this really needs tests

It does. And they're complicated. Windows, macOS and Linux.

[hacdias]

I think I interpreted you wrong @lidel! The env vars should affect IPFS Desktop. And not the opposite. About IPFS_PATH then: the variable defines a repository and then we store on the config the repository of ipfsd.path. So, if IPFS_PATH was chosen initially to be the repository on the first run, that'll be what we save on the config.

[hacdias]

@lidel tested and works on macOS and Windows. I'd like to hear some suggestions on how to automatically test this since Spectron does not allow us to test menus.

[jessicaschilling]

I'll keep quiet on the code itself but the interface LGTM 😊

[lidel]

LGTM: tested on Linux, works as expected.
Ok to merge as soon CI passes and is green.