feat: allow custom ipfs binary

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

Author: hacdias

assets/locales/en.json

@@ -40,6 +40,8 @@
   "moveRepositoryLocation": "Move Repository Location",
   "runGarbageCollector": "Run Garbage Collector",
   "selectDirectory": "Select Directory",
+  "setCustomIpfsBinary": "Set Custom IPFS Binary",
+  "clearCustomIpfsBinary": "Clear Custom IPFS Binary",
   "polkitDialog": {
     "title": "Polkit not found",
     "message": "IPFS can't be added to /usr/local/bin/ without polkit agent."
@@ -171,5 +173,17 @@
   "couldNotSaveDialog": {
     "title": "Could not write to disk",
     "message": "There was an error writing to the disk. Please try again."
+  },
+  "setCustomIpfsBinaryConfirmation": {
+    "title": "Custom IPFS binary",
+    "message": "By setting a custom IPFS, IPFS Desktop will no longer use the bundled IPFS version and will use the binary you specify. Do you wish to proceed?"
+  },
+  "setCustomIpfsBinarySuccess": {
+    "title": "Custom IPFS binary",
+    "message": "IPFS Desktop will start using the binary located at { path }. To start using it, IPFS needs to be restarted first."
+  },
+  "clearCustomIpfsBinarySuccess": {
+    "title": "Clear custom IPFS binary",
+    "message": "The custom IPFS binary was cleared. To start using the bundled IPFS version, IPFS needs to be restarted first."
   }
 }

src/custom-ipfs-binary.js

@@ -0,0 +1,89 @@
+const i18n = require('i18next')
+const { app, dialog } = require('electron')
+const { showDialog } = require('./dialogs')
+const logger = require('./common/logger')
+const store = require('./common/store')
+const dock = require('./dock')
+
+const SETTINGS_KEY = 'binaryPath'
+
+async function setCustomBinary (ctx) {
+  logger.info('[custom binary] request to change')
+  let opt = showDialog({
+    title: i18n.t('setCustomIpfsBinaryConfirmation.title'),
+    message: i18n.t('setCustomIpfsBinaryConfirmation.message'),
+    type: 'warning',
+    buttons: [
+      i18n.t('yes'),
+      i18n.t('no')
+    ]
+  })
+
+  if (opt !== 0) {
+    logger.info('[custom binary] user canceled')
+    return
+  }
+
+  const { canceled, filePaths } = await dock.run(() => dialog.showOpenDialog({
+    title: i18n.t('pickCustomIpfsBinary'),
+    defaultPath: app.getPath('home'),
+    properties: ['openFile']
+  }))
+
+  if (canceled || filePaths.length === 0) {
+    logger.info('[custom binary] user canceled')
+    return
+  }
+
+  store.set(SETTINGS_KEY, filePaths[0])
+
+  opt = showDialog({
+    title: i18n.t('setCustomIpfsBinarySuccess.title'),
+    message: i18n.t('setCustomIpfsBinarySuccess.message', { path: filePaths[0] }),
+    buttons: [
+      i18n.t('restart'),
+      i18n.t('close')
+    ]
+  })
+
+  logger.info(`[custom binary] updated to ${filePaths[0]}`)
+
+  if (opt === 0) {
+    ctx.restartIpfs()
+  }
+}
+
+function clearCustomBinary (ctx) {
+  store.delete('binaryPath')
+  logger.info('[custom binary] cleared')
+
+  const opt = showDialog({
+    title: i18n.t('clearCustomIpfsBinarySuccess.title'),
+    message: i18n.t('clearCustomIpfsBinarySuccess.message'),
+    buttons: [
+      i18n.t('restart'),
+      i18n.t('close')
+    ]
+  })
+
+  if (opt === 0) {
+    ctx.restartIpfs()
+  }
+}
+
+function hasCustomBinary () {
+  return typeof store.get(SETTINGS_KEY) === 'string'
+}
+
+function getCustomBinary () {
+  if (hasCustomBinary()) {
+    return store.get(SETTINGS_KEY)
+  }
+}
+
+module.exports = {
+  setCustomBinary,
+  clearCustomBinary,
+  hasCustomBinary,
+  getCustomBinary
+}

src/tray.js

@@ -10,6 +10,7 @@ const store = require('./common/store')
 const { IS_MAC, IS_WIN, VERSION, GO_IPFS_VERSION } = require('./common/consts')
 const moveRepositoryLocation = require('./move-repository-location')
 const runGarbageCollector = require('./run-gc')
+const { setCustomBinary, clearCustomBinary, hasCustomBinary } = require('./custom-ipfs-binary')
 
 // Notes on this: we are only supporting accelerators on macOS for now because
 // they natively work as soon as the menu opens. They don't work like that on Windows
@@ -105,6 +106,18 @@ function buildMenu (ctx) {
           label: i18n.t('runGarbageCollector'),
           click: () => { runGarbageCollector(ctx) },
           enabled: false
+        },
+        {
+          id: 'setCustomBinary',
+          label: i18n.t('setCustomIpfsBinary'),
+          click: () => { setCustomBinary(ctx) },
+          visible: false
+        },
+        {
+          id: 'clearCustomBinary',
+          label: i18n.t('clearCustomIpfsBinary'),
+          click: () => { clearCustomBinary(ctx) },
+          visible: false
         }
       ]
     },
@@ -120,7 +133,7 @@ function buildMenu (ctx) {
           click: () => { shell.openExternal('https://github.com/ipfs-shipyard/ipfs-desktop/releases') }
         },
         {
-          label: `go-ipfs ${GO_IPFS_VERSION}`,
+          label: `go-ipfs ${hasCustomBinary() ? '(custom)' : GO_IPFS_VERSION}`,
           click: () => { shell.openExternal('https://github.com/ipfs/go-ipfs/releases') }
         },
         { type: 'separator' },
@@ -217,6 +230,9 @@ module.exports = function (ctx) {
     menu.getMenuItemById('moveRepositoryLocation').enabled = !gcRunning && status !== STATUS.STOPPING_STARTED
     menu.getMenuItemById('runGarbageCollector').enabled = menu.getMenuItemById('ipfsIsRunning').visible && !gcRunning
 
+    menu.getMenuItemById('setCustomBinary').visible = !hasCustomBinary()
+    menu.getMenuItemById('clearCustomBinary').visible = hasCustomBinary()
+
     if (status === STATUS.STARTING_FINISHED) {
       tray.setImage(icon(on))
     } else {