feat: add install/enable/disable/error messages

License: MIT
Signed-off-by: Henrique Dias <hacdias@gmail.com>
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>

assets/locales/en.json

@@ -37,6 +37,7 @@
  "close": "Close",
  "ok": "OK",
  "cancel": "Cancel",
+ "enable": "Enable",
  "reportTheError": "Report the error",
  "restartIpfsDesktop": "Restart IPFS Desktop",
  "openLogs": "Open logs",
@@ -150,14 +151,53 @@
  "title": "IPFS on PATH",
  "message": "Could not add IPFS to the PATH."
  },
+ "launchAtLoginNotSupported": {
+ "title": "Error",
+ "message": "Launch at login is not supported on your platform."
+ },
+ "launchAtLoginFailed": {
+ "title": "Error",
+ "message": "Launch at login could not be enabled on your machine."
+ },
+ "enableIpfsOnPath": {
+ "title": "Enable IPFS on PATH",
+ "message": "By enabling this option, IPFS will be available on your command line as \"ipfs\". This action is reversible.",
+ "action": "Enable"
+ },
+ "disableIpfsOnPath": {
+ "title": "Disable IPFS on PATH",
+ "message": "By disabling this option, IPFS will no longer be available on your command line as \"ipfs\".",
+ "action": "Disable"
+ },
+ "enableGlobalTakeScreenshotShortcut": {
+ "title": "Enable screenshot shortcut",
+ "message": "By enabling this, the shortcut \"{ accelerator }\" will be available to take screenshots as long as IPFS Desktop is running."
+ },
+ "enableGlobalDownloadShortcut": {
+ "title": "Enable download shortcut",
+ "message": "By enabling this, the shortcut \"{ accelerator }\" will be available to download files as long as IPFS Desktop is running."
+ },
+ "installNpmOnIpfsWarning": {
+ "title": "Install npm on IPFS",
+ "message": "This experimental feature installs the \"ipfs-npm\" package on your system. It requires Node.js to be installed.",
+ "action": "Install"
+ },
+ "unableToInstallNpmOnIpfs": {
+ "title": "Error",
+ "message": "It was not possible to install \"ipfs-npm\" package on your system. Please check the logs for more information or try installing it manually by running \"npm install -g ipfs-npm\" on your command line."
+ },
+ "unableToUninstallNpmOnIpfs": {
+ "title": "Error",
+ "message": "It was not possible to uninstall \"ipfs-npm\" package on your system. Please check the logs for more information or try uninstalling it manually by running \"npm uninstall -g ipfs-npm\" on your command line."
+ },
  "settings": {
  "settings": "Settings",
  "preferences": "Preferences",
- "launchOnStartup": "Enable Launch at Login",
- "ipfsCommandLineTools": "Enable Command Line Tools",
- "takeScreenshotShortcut": "Enable Take Screenshot Shortcut",
- "downloadHashShortcut": "Enable Download Hash Shortcut",
+ "launchOnStartup": "Launch at Login",
+ "ipfsCommandLineTools": "Command Line Tools",
+ "takeScreenshotShortcut": "Global Screenshot Shortcut",
+ "downloadHashShortcut": "Global Download Shortcut",
  "experiments": "Experiments",
- "npmOnIpfs": "Enable npm on IPFS"
+ "npmOnIpfs": "npm on IPFS"
  }
 }

src/auto-launch.js

@@ -1,4 +1,5 @@
 const { app } = require('electron')
+const i18n = require('i18next')
 const os = require('os')
 const path = require('path')
 const fs = require('fs-extra')
@@ -7,6 +8,7 @@ const createToggler = require('./create-toggler')
 const logger = require('./common/logger')
 const store = require('./common/store')
 const { IS_MAC, IS_WIN } = require('./common/consts')
+const { showDialog, recoverableErrorDialog } = require('./dialogs')
 
 const CONFIG_KEY = 'autoLaunch'
 
@@ -48,21 +50,39 @@ async function disable () {
 }
 
 module.exports = async function () {
- const activate = async (value, oldValue) => {
+ const activate = async ({ newValue, oldValue, feedback }) => {
  if (process.env.NODE_ENV === 'development') {
  logger.info('[launch on startup] unavailable during development')
+
+ if (feedback) {
+ showDialog({
+ title: 'Launch at Login',
+ message: 'Not available during development.',
+ buttons: [i18n.t('close')]
+ })
+ }
+
  return
  }
 
  if (!isSupported()) {
  logger.info('[launch on startup] not supported on this platform')
+
+ if (feedback) {
+ showDialog({
+ title: i18n.t('launchAtLoginNotSupported.title'),
+ message: i18n.t('launchAtLoginNotSupported.message'),
+ buttons: [i18n.t('close')]
+ })
+ }
+
  return false
  }
 
- if (value === oldValue) return
+ if (newValue === oldValue) return
 
  try {
- if (value === true) {
+ if (newValue === true) {
  await enable()
  logger.info('[launch on startup] enabled')
  } else {
@@ -73,12 +93,21 @@ module.exports = async function () {
  return true
  } catch (err) {
  logger.error(`[launch on startup] ${err.toString()}`)
+
+ if (feedback) {
+ recoverableErrorDialog(err, {
+ title: i18n.t('launchAtLoginFailed.title'),
+ message: i18n.t('launchAtLoginFailed.message')
+ })
+ }
+
  return false
  }
  }
 
- activate(store.get(CONFIG_KEY, false))
+ activate({ newValue: store.get(CONFIG_KEY, false) })
  createToggler(CONFIG_KEY, activate)
 }
 
 module.exports.CONFIG_KEY = CONFIG_KEY
+module.exports.isSupported = isSupported

src/dialogs/errors.js

@@ -47,7 +47,7 @@ function criticalErrorDialog (e) {
 // Shows a recoverable error dialog with the default title and message.
 // Passing an options object alongside the error can be used to override
 // the title and message.
-function recoverableErrorDialog (e, options = {}) {
+function recoverableErrorDialog (e, options) {
  const cfg = {
  title: i18n.t('recoverableErrorDialog.title'),
  message: i18n.t('recoverableErrorDialog.message'),
@@ -59,12 +59,14 @@ function recoverableErrorDialog (e, options = {}) {
  ]
  }
 
- if (options.title) {
- cfg.title = options.title
- }
+ if (options) {
+ if (options.title) {
+ cfg.title = options.title
+ }
 
- if (options.message) {
- cfg.message = options.message
+ if (options.message) {
+ cfg.message = options.message
+ }
  }
 
  const option = dialog(cfg)

src/download-hash.js

@@ -88,7 +88,11 @@ async function downloadHash (ctx) {
 }
 
 module.exports = function (ctx) {
- setupGlobalShortcut(ctx, {
+ setupGlobalShortcut({
+ confirmationDialog: {
+ title: i18n.t('enableGlobalDownloadShortcut.title'),
+ message: i18n.t('enableGlobalDownloadShortcut.message', { accelerator: SHORTCUT })
+ },
  settingsOption: CONFIG_KEY,
  accelerator: SHORTCUT,
  action: () => {

src/exec-or-sudo.js

@@ -15,7 +15,7 @@ const env = {
  sudo: 'env ELECTRON_RUN_AS_NODE=1'
 }
 
-const getResult = (err, stdout, stderr, scope, failSilently) => {
+const getResult = (err, stdout, stderr, scope, failSilently, errorOptions) => {
  if (stdout) {
  logger.info(`[${scope}] sudo: stdout: ${stdout.toString().trim()}`)
  }
@@ -37,14 +37,14 @@ const getResult = (err, stdout, stderr, scope, failSilently) => {
  } else if (str.includes('User did not grant permission')) {
  dialog.showErrorBox(i18n.t('noPermissionDialog.title'), i18n.t('noPermissionDialog.message'))
  } else {
- recoverableErrorDialog(err)
+ recoverableErrorDialog(err, errorOptions)
  }
  }
 
  return false
 }
 
-module.exports = async function ({ script, scope, failSilently, trySudo = true }) {
+module.exports = async function ({ script, scope, failSilently, trySudo = true, errorOptions }) {
  const dataArg = `--data="${app.getPath('userData')}"`
  let err = null
 
@@ -61,7 +61,7 @@ module.exports = async function ({ script, scope, failSilently, trySudo = true }
 
  if (!trySudo) {
  if (!failSilently) {
- recoverableErrorDialog(err)
+ recoverableErrorDialog(err, errorOptions)
  }
 
  return false
@@ -71,7 +71,7 @@ module.exports = async function ({ script, scope, failSilently, trySudo = true }
  const command = `${env.sudo} "${process.execPath}" "${script}" ${dataArg}`
  return new Promise(resolve => {
  sudo.exec(command, { name: 'IPFS Desktop' }, (err, stdout, stderr) => {
- resolve(getResult(err, stdout, stderr, scope, failSilently))
+ resolve(getResult(err, stdout, stderr, scope, failSilently, errorOptions))
  })
  })
 }

src/ipfs-on-path/index.js

@@ -7,14 +7,49 @@ const execOrSudo = require('../exec-or-sudo')
 const logger = require('../common/logger')
 const store = require('../common/store')
 const { IS_WIN } = require('../common/consts')
-const { recoverableErrorDialog } = require('../dialogs')
+const { showDialog, recoverableErrorDialog } = require('../dialogs')
 
 const CONFIG_KEY = 'ipfsOnPath'
 
-module.exports = async function (ctx) {
- createToggler(CONFIG_KEY, async (value, oldValue) => {
- if (value === oldValue || (oldValue === null && !value)) return
- if (value === true) return run('install')
+const errorMessage = {
+ title: i18n.t('cantAddIpfsToPath.title'),
+ message: i18n.t('cantAddIpfsToPath.message')
+}
+
+module.exports = async function () {
+ createToggler(CONFIG_KEY, async ({ newValue, oldValue }) => {
+ if (newValue === oldValue || (oldValue === null && !newValue)) {
+ return
+ }
+
+ if (newValue === true) {
+ if (showDialog({
+ title: i18n.t('enableIpfsOnPath.title'),
+ message: i18n.t('enableIpfsOnPath.message'),
+ buttons: [
+ i18n.t('enableIpfsOnPath.action'),
+ i18n.t('cancel')
+ ]
+ }) !== 0) {
+ // User canceled
+ return
+ }
+
+ return run('install')
+ }
+
+ if (showDialog({
+ title: i18n.t('disableIpfsOnPath.title'),
+ message: i18n.t('disableIpfsOnPath.message'),
+ buttons: [
+ i18n.t('disableIpfsOnPath.action'),
+ i18n.t('cancel')
+ ]
+ }) !== 0) {
+ // User canceled
+ return
+ }
+
  return run('uninstall')
  })
 
@@ -56,10 +91,7 @@ async function runWindows (script, { failSilently }) {
  logger.error(`[ipfs on path] ${err.toString()}`)
 
  if (!failSilently) {
- recoverableErrorDialog(err, {
- title: i18n.t('cantAddIpfsToPath.title'),
- message: i18n.t('cantAddIpfsToPath.message')
- })
+ recoverableErrorDialog(err, errorMessage)
  }
 
  return resolve(false)
@@ -80,6 +112,7 @@ async function run (script, { trySudo = true, failSilently = false } = {}) {
  script: join(__dirname, `./scripts/${script}.js`),
  scope: 'ipfs on path',
  trySudo,
- failSilently
+ failSilently,
+ errorOptions: errorMessage
  })
 }