feat: enable ipns over pubsub via settings menu (#1739)

* feat: enable ipns over pubsub via settings menu Part of #1647 Very similar approach to #1735 * refactor: move pubsub experiments to exp. section making it easier to find if someone edits config by hand Co-authored-by: Marcin Rataj <[email protected]>
ipfs · Jan 25, 2021 · 90b1ad1 · 90b1ad1
1 parent 204e206
commit 90b1ad1
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 2 deletions.
diff --git a/assets/locales/en.json b/assets/locales/en.json
@@ -224,6 +224,7 @@
     "launchOnStartup": "Launch at Login",
     "openWebUIAtLaunch": "Open Web UI at Launch",
     "pubsub": "Enable PubSub",
+    "namesysPubsub": "Enable IPNS over PubSub",
     "automaticGC": "Automatic Garbage Collection",
     "ipfsCommandLineTools": "Command Line Tools",
     "takeScreenshotShortcut": "Global Screenshot Shortcut",

diff --git a/src/enable-namesys-pubsub.js b/src/enable-namesys-pubsub.js
@@ -0,0 +1,54 @@
+const createToggler = require('./utils/create-toggler')
+const logger = require('./common/logger')
+const store = require('./common/store')
+const { ipcMain } = require('electron')
+
+const CONFIG_KEY = 'experiments.pubsubNamesys'
+const namesysPubsubFlag = '--enable-namesys-pubsub'
+const isEnabled = flags => flags.some(f => f === namesysPubsubFlag)
+
+function enable () {
+  const flags = store.get('ipfsConfig.flags', [])
+  if (!isEnabled(flags)) {
+    flags.push(namesysPubsubFlag)
+    applyConfig(flags)
+  }
+}
+
+function disable () {
+  let flags = store.get('ipfsConfig.flags', [])
+  if (isEnabled(flags)) {
+    flags = flags.filter(item => item !== namesysPubsubFlag) // remove flag
+    applyConfig(flags)
+  }
+}
+
+function applyConfig (newFlags) {
+  store.set('ipfsConfig.flags', newFlags)
+  ipcMain.emit('ipfsConfigChanged') // trigger node restart
+}
+
+module.exports = async function () {
+  const activate = ({ newValue, oldValue }) => {
+    if (newValue === oldValue) return
+
+    try {
+      if (newValue === true) {
+        enable()
+      } else {
+        disable()
+      }
+
+      return true
+    } catch (err) {
+      logger.error(`[ipns over pubsub] ${err.toString()}`)
+
+      return false
+    }
+  }
+  activate({ newValue: store.get(CONFIG_KEY, false) })
+  createToggler(CONFIG_KEY, activate)
+  logger.info(`[ipns over pubsub] ${store.get(CONFIG_KEY, false) ? 'enabled' : 'disabled'}`)
+}
+
+module.exports.CONFIG_KEY = CONFIG_KEY
diff --git a/src/enable-pubsub.js b/src/enable-pubsub.js
@@ -3,7 +3,7 @@ const logger = require('./common/logger')
 const store = require('./common/store')
 const { ipcMain } = require('electron')
 
-const CONFIG_KEY = 'pubsub'
+const CONFIG_KEY = 'experiments.pubsub'
 const pubsubFlag = '--enable-pubsub-experiment'
 const isEnabled = flags => flags.some(f => f === pubsubFlag)
 

diff --git a/src/index.js b/src/index.js
@@ -11,6 +11,7 @@ const setupWebUI = require('./webui')
 const setupAutoLaunch = require('./auto-launch')
 const setupAutoGc = require('./automatic-gc')
 const setupPubsub = require('./enable-pubsub')
+const setupNamesysPubsub = require('./enable-namesys-pubsub')
 const setupDownloadCid = require('./download-cid')
 const setupTakeScreenshot = require('./take-screenshot')
 const setupAppMenu = require('./app-menu')
@@ -78,6 +79,7 @@ async function run () {
       setupAutoLaunch(ctx),
       setupAutoGc(ctx),
       setupPubsub(ctx),
+      setupNamesysPubsub(ctx),
       setupSecondInstance(ctx),
       // Setup global shortcuts
       setupDownloadCid(ctx),

diff --git a/src/tray.js b/src/tray.js
@@ -14,6 +14,7 @@ const { CONFIG_KEY: SCREENSHOT_KEY, SHORTCUT: SCREENSHOT_SHORTCUT, takeScreensho
 const { CONFIG_KEY: DOWNLOAD_KEY, SHORTCUT: DOWNLOAD_SHORTCUT, downloadCid } = require('./download-cid')
 const { CONFIG_KEY: AUTO_LAUNCH_KEY, isSupported: supportsLaunchAtLogin } = require('./auto-launch')
 const { CONFIG_KEY: PUBSUB_KEY } = require('./enable-pubsub')
+const { CONFIG_KEY: NAMESYS_PUBSUB_KEY } = require('./enable-namesys-pubsub')
 const { CONFIG_KEY: AUTO_GC_KEY } = require('./automatic-gc')
 const { CONFIG_KEY: IPFS_PATH_KEY } = require('./ipfs-on-path')
 const { CONFIG_KEY: NPM_IPFS_KEY } = require('./npm-on-ipfs')
@@ -27,7 +28,8 @@ const CONFIG_KEYS = [
   NPM_IPFS_KEY,
   SCREENSHOT_KEY,
   DOWNLOAD_KEY,
-  PUBSUB_KEY
+  PUBSUB_KEY,
+  NAMESYS_PUBSUB_KEY
 ]
 
 function buildCheckbox (key, label) {
@@ -136,6 +138,7 @@ function buildMenu (ctx) {
           enabled: false
         },
         buildCheckbox(PUBSUB_KEY, 'settings.pubsub'),
+        buildCheckbox(NAMESYS_PUBSUB_KEY, 'settings.namesysPubsub'),
         buildCheckbox(NPM_IPFS_KEY, 'settings.npmOnIpfs')
       ]
     },