chore: create enum for ipcMain eventNames

src/auto-updater/index.js

@@ -5,6 +5,7 @@ const { ipcMain } = require('electron')
 const logger = require('../common/logger')
 const { showDialog } = require('../dialogs')
 const { IS_MAC, IS_WIN, IS_APPIMAGE } = require('../common/consts')
+const ipcMainEvents = require('../utils/ipcMainEvents')
 
 function isAutoUpdateSupported () {
  // atm only macOS, windows and AppImage builds support autoupdate mechanism,
@@ -140,13 +141,13 @@ function setup (ctx) {
 }
 
 async function checkForUpdates () {
- ipcMain.emit('updating')
+ ipcMain.emit(ipcMainEvents.UPDATING)
  try {
  await autoUpdater.checkForUpdates()
  } catch (_) {
  // Ignore. The errors are already handled on 'error' event.
  }
- ipcMain.emit('updatingEnded')
+ ipcMain.emit(ipcMainEvents.UPDATING_ENDED)
 }
 
 module.exports = async function (ctx) {

src/automatic-gc.js

@@ -3,6 +3,7 @@ const logger = require('./common/logger')
 const store = require('./common/store')
 const { AUTO_GARBAGE_COLLECTOR: CONFIG_KEY } = require('./common/config-keys')
 const { ipcMain } = require('electron')
+const ipcMainEvents = require('./utils/ipcMainEvents')
 
 const gcFlag = '--enable-gc'
 const isEnabled = flags => flags.some(f => f === gcFlag)
@@ -25,7 +26,7 @@ function disable () {
 
 function applyConfig (newFlags) {
  store.set('ipfsConfig.flags', newFlags)
- ipcMain.emit('ipfsConfigChanged') // trigger node restart
+ ipcMain.emit(ipcMainEvents.IPFS_CONFIG_CHANGED) // trigger node restart
 }
 
 module.exports = async function () {

src/daemon/index.js

@@ -6,6 +6,7 @@ const store = require('../common/store')
 const logger = require('../common/logger')
 const { STATUS } = require('./consts')
 const createDaemon = require('./daemon')
+const ipcMainEvents = require('../utils/ipcMainEvents')
 
 module.exports = async function (ctx) {
  let ipfsd = null
@@ -14,7 +15,7 @@ module.exports = async function (ctx) {
 
  const updateStatus = (stat, id = null) => {
  status = stat
- ipcMain.emit('ipfsd', status, id)
+ ipcMain.emit(ipcMainEvents.IPFSD, status, id)
  }
 
  const getIpfsd = async (optional = false) => {

src/enable-namesys-pubsub.js

@@ -3,6 +3,7 @@ const logger = require('./common/logger')
 const store = require('./common/store')
 const { EXPERIMENT_PUBSUB_NAMESYS: CONFIG_KEY } = require('./common/config-keys')
 const { ipcMain } = require('electron')
+const ipcMainEvents = require('./utils/ipcMainEvents')
 
 const namesysPubsubFlag = '--enable-namesys-pubsub'
 const isEnabled = flags => flags.some(f => f === namesysPubsubFlag)
@@ -25,7 +26,7 @@ function disable () {
 
 function applyConfig (newFlags) {
  store.set('ipfsConfig.flags', newFlags)
- ipcMain.emit('ipfsConfigChanged') // trigger node restart
+ ipcMain.emit(ipcMainEvents.IPFS_CONFIG_CHANGED) // trigger node restart
 }
 
 module.exports = async function () {

src/enable-pubsub.js

@@ -3,6 +3,7 @@ const logger = require('./common/logger')
 const store = require('./common/store')
 const { EXPERIMENT_PUBSUB: CONFIG_KEY } = require('./common/config-keys')
 const { ipcMain } = require('electron')
+const ipcMainEvents = require('./utils/ipcMainEvents')
 
 const pubsubFlag = '--enable-pubsub-experiment'
 const isEnabled = flags => flags.some(f => f === pubsubFlag)
@@ -25,7 +26,7 @@ function disable () {
 
 function applyConfig (newFlags) {
  store.set('ipfsConfig.flags', newFlags)
- ipcMain.emit('ipfsConfigChanged') // trigger node restart
+ ipcMain.emit(ipcMainEvents.IPFS_CONFIG_CHANGED) // trigger node restart
 }
 
 module.exports = async function () {

src/i18n.js

@@ -4,6 +4,7 @@ const i18n = require('i18next')
 const ICU = require('i18next-icu')
 const Backend = require('i18next-fs-backend')
 const store = require('./common/store')
+const ipcMainEvents = require('./utils/ipcMainEvents')
 
 module.exports = async function () {
  await i18n
@@ -30,6 +31,6 @@ module.exports = async function () {
  store.set('language', lang)
 
  await i18n.changeLanguage(lang)
- ipcMain.emit('languageUpdated', lang)
+ ipcMain.emit(ipcMainEvents.LANG_UPDATED, lang)
  })
 }

src/run-gc.js

@@ -3,6 +3,7 @@ const { ipcMain } = require('electron')
 const logger = require('./common/logger')
 const { showDialog, recoverableErrorDialog } = require('./dialogs')
 const dock = require('./utils/dock')
+const ipcMainEvents = require('./utils/ipcMainEvents')
 
 module.exports = function runGarbageCollector ({ getIpfsd }) {
  dock.run(async () => {
@@ -30,7 +31,7 @@ module.exports = function runGarbageCollector ({ getIpfsd }) {
  return
  }
 
- ipcMain.emit('gcRunning')
+ ipcMain.emit(ipcMainEvents.GC_RUNNING)
 
  try {
  const errors = []
@@ -63,6 +64,6 @@ module.exports = function runGarbageCollector ({ getIpfsd }) {
  })
  }
 
- ipcMain.emit('gcEnded')
+ ipcMain.emit(ipcMainEvents.GC_ENDED)
  })
 }

src/tray.js

@@ -6,6 +6,7 @@ const logger = require('./common/logger')
 const store = require('./common/store')
 const moveRepositoryLocation = require('./move-repository-location')
 const runGarbageCollector = require('./run-gc')
+const ipcMainEvents = require('./utils/ipcMainEvents')
 const { setCustomBinary, clearCustomBinary, hasCustomBinary } = require('./custom-ipfs-binary')
 const { STATUS } = require('./daemon')
 const { IS_MAC, IS_WIN, VERSION, GO_IPFS_VERSION } = require('./common/consts')
@@ -19,7 +20,7 @@ function buildCheckbox (key, label) {
  return {
  id: key,
  label: i18n.t(label),
- click: () => { ipcMain.emit(`toggle_${key}`) },
+ click: () => { ipcMainEvents.TOGGLE(key) },
  type: 'checkbox',
  checked: false
  }
@@ -261,8 +262,8 @@ module.exports = function (ctx) {
  tray.setContextMenu(menu)
  tray.setToolTip('IPFS Desktop')
 
- menu.on('menu-will-show', () => { ipcMain.emit('menubar-will-open') })
- menu.on('menu-will-close', () => { ipcMain.emit('menubar-will-close') })
+ menu.on('menu-will-show', () => { ipcMain.emit(ipcMainEvents.MENUBAR_OPEN) })
+ menu.on('menu-will-close', () => { ipcMain.emit(ipcMainEvents.MENUBAR_CLOSE) })
 
  updateMenu()
  }

src/utils/create-toggler.js

@@ -1,9 +1,10 @@
 const { ipcMain } = require('electron')
 const store = require('../common/store')
 const logger = require('../common/logger')
+const ipcMainEvents = require('./ipcMainEvents')
 
 module.exports = function (settingsOption, activate) {
- ipcMain.on(`toggle_${settingsOption}`, async () => {
+ ipcMain.on(ipcMainEvents.TOGGLE(settingsOption), async () => {
  const oldValue = store.get(settingsOption, null)
  const newValue = !oldValue
 
@@ -17,6 +18,6 @@ module.exports = function (settingsOption, activate) {
  // We always emit the event so any handlers for it can act upon
  // the current configuration, whether it was successfully
  // updated or not.
- ipcMain.emit('configUpdated')
+ ipcMain.emit(ipcMainEvents.CONFIG_UPDATED)
  })
 }

src/utils/ipcMainEvents.js

@@ -0,0 +1,19 @@
+const { ipcMain } = require('electron')
+
+const ipcMainEvents = Object.freeze({
+ CONFIG_UPDATED: 'configUpdated',
+ GC_ENDED: 'gcEnded',
+ GC_RUNNING: 'gcRunning',
+ IPFSD: 'ipfsd',
+ IPFS_CONFIG_CHANGED: 'ipfsConfigChanged',
+ LANG_UPDATED: 'languageUpdated',
+ MENUBAR_CLOSE: 'menubar-will-close',
+ MENUBAR_OPEN: 'menubar-will-open',
+ UPDATING: 'updating',
+ UPDATING_ENDED: 'updatingEnded',
+ TOGGLE: function (key) {
+ ipcMain.emit(`toggle_${key}`)
+ }
+})
+
+module.exports = ipcMainEvents