feat: config profile

Author: dirkmc

package.json

@@ -75,7 +75,7 @@
     "execa": "^1.0.0",
     "form-data": "^2.3.3",
     "hat": "0.0.3",
-    "interface-ipfs-core": "~0.104.0",
+    "interface-ipfs-core": "ipfs/interface-js-ipfs-core#feat/profiles",
     "ipfsd-ctl": "~0.42.0",
     "libp2p-websocket-star": "~0.10.2",
     "ncp": "^2.0.0",
@@ -120,7 +120,7 @@
     "ipfs-bitswap": "~0.24.1",
     "ipfs-block": "~0.8.1",
     "ipfs-block-service": "~0.15.1",
-    "ipfs-http-client": "^32.0.0",
+    "ipfs-http-client": "ipfs/js-ipfs-http-client#feat/profile",
     "ipfs-http-response": "~0.3.0",
     "ipfs-mfs": "~0.11.4",
     "ipfs-multipart": "~0.1.0",
@@ -142,6 +142,7 @@
     "is-pull-stream": "~0.0.0",
     "is-stream": "^2.0.0",
     "iso-url": "~0.4.6",
+    "jsondiffpatch": "~0.3.11",
     "just-flatten-it": "^2.1.0",
     "just-safe-set": "^2.1.0",
     "kind-of": "^6.0.2",

src/cli/commands/config/profile.js

@@ -0,0 +1,15 @@
+'use strict'
+
+module.exports = {
+  command: 'profile <command>',
+
+  description: 'Interact with config profiles.',
+
+  builder (yargs) {
+    return yargs
+      .commandDir('profile')
+  },
+
+  handler (argv) {
+  }
+}

src/cli/commands/config/profile/apply.js

@@ -0,0 +1,25 @@
+'use strict'
+
+const JSONDiff = require('jsondiffpatch')
+
+module.exports = {
+  command: 'apply <profile>',
+
+  describe: 'Apply profile to config',
+
+  builder: {
+    'dry-run': {
+      type: 'boolean',
+      describe: 'print difference between the current config and the config that would be generated.'
+    }
+  },
+
+  handler (argv) {
+    argv.resolve((async () => {
+      const ipfs = await argv.getIpfs()
+      const diff = await ipfs.config.profile(argv.profile, { dryRun: argv.dryRun })
+      const delta = JSONDiff.diff(diff.oldCfg, diff.newCfg)
+      return JSONDiff.formatters.console.format(delta, diff.oldCfg)
+    })())
+  }
+}

src/cli/commands/config/profile/ls.js

@@ -0,0 +1,17 @@
+'use strict'
+
+const { profiles } = require('../../../../core/components/config')
+
+module.exports = {
+  command: 'ls',
+
+  describe: 'List available config profiles',
+
+  builder: {},
+
+  handler (argv) {
+    argv.resolve((async () => {
+      return profiles.map(p => p.name + ':\n  ' + p.description).join('\n')
+    })())
+  }
+}

src/core/components/config.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const promisify = require('promisify-es6')
+const defaultConfig = require('../runtime/config-nodejs.js')()
 
 module.exports = function config (self) {
   return {
@@ -17,6 +18,94 @@ module.exports = function config (self) {
     }),
     replace: promisify((config, callback) => {
       self._repo.config.set(config, callback)
-    })
+    }),
+    profile: promisify(applyProfile)
+  }
+
+  async function applyProfile (profileName, opts, callback) {
+    if (typeof opts === 'function') {
+      callback = opts
+      opts = {}
+    }
+    const { dryRun } = opts
+
+    const profile = profiles.find(p => p.name === profileName)
+    if (!profile) {
+      return callback(new Error(`No profile with name '${profileName}' exists`))
+    }
+
+    try {
+      const oldCfg = await self.config.get()
+      const newCfg = JSON.parse(JSON.stringify(oldCfg)) // clone
+      profile.transform(newCfg)
+      if (!dryRun) {
+        await self.config.replace(newCfg)
+      }
+
+      // Scrub private key from output
+      delete oldCfg.Identity.PrivKey
+      delete newCfg.Identity.PrivKey
+
+      callback(null, { oldCfg, newCfg })
+    } catch (err) {
+      callback(new Error(`Could not apply profile '${profileName}' to config: ${err.message}`))
+    }
   }
 }
+
+const profiles = [{
+  name: 'server',
+  description: 'Disables local host discovery - recommended when running IPFS on machines with public IPv4 addresses.',
+  transform: (config) => {
+    config.Discovery.MDNS.Enabled = false
+    config.Discovery.webRTCStar.Enabled = false
+  }
+}, {
+  name: 'local-discovery',
+  description: 'Enables local host discovery - inverse of "server" profile.',
+  transform: (config) => {
+    config.Discovery.MDNS.Enabled = true
+    config.Discovery.webRTCStar.Enabled = true
+  }
+}, {
+  name: 'test',
+  description: 'Reduces external interference of IPFS daemon - for running the daemon in test environments.',
+  transform: (config) => {
+    config.Addresses.API = defaultConfig.Addresses.API ? '/ip4/127.0.0.1/tcp/0' : ''
+    config.Addresses.Gateway = defaultConfig.Addresses.Gateway ? '/ip4/127.0.0.1/tcp/0' : ''
+    config.Addresses.Swarm = defaultConfig.Addresses.Swarm.length ? ['/ip4/127.0.0.1/tcp/0'] : []
+    config.Bootstrap = []
+    config.Discovery.MDNS.Enabled = false
+    config.Discovery.webRTCStar.Enabled = false
+  }
+}, {
+  name: 'default-networking',
+  description: 'Restores default network settings - inverse of "test" profile.',
+  transform: (config) => {
+    console.log('applying default-networking')
+    console.log('setting to', defaultConfig.Addresses)
+    config.Addresses.API = defaultConfig.Addresses.API
+    config.Addresses.Gateway = defaultConfig.Addresses.Gateway
+    config.Addresses.Swarm = defaultConfig.Addresses.Swarm
+    config.Bootstrap = defaultConfig.Bootstrap
+    config.Discovery.MDNS.Enabled = defaultConfig.Discovery.MDNS.Enabled
+    config.Discovery.webRTCStar.Enabled = defaultConfig.Discovery.webRTCStar.Enabled
+  }
+}, {
+  name: 'lowpower',
+  description: 'Reduces daemon overhead on the system - recommended for low power systems.',
+  transform: (config) => {
+    config.Swarm = config.Swarm || {}
+    config.Swarm.ConnMgr = config.Swarm.ConnMgr || {}
+    config.Swarm.ConnMgr.LowWater = 20
+    config.Swarm.ConnMgr.HighWater = 40
+  }
+}, {
+  name: 'default-power',
+  description: 'Inverse of "lowpower" profile.',
+  transform: (config) => {
+    config.Swarm = defaultConfig.Swarm
+  }
+}]
+
+module.exports.profiles = profiles

src/http/api/resources/config.js

@@ -7,6 +7,8 @@ const log = debug('ipfs:http-api:config')
 log.error = debug('ipfs:http-api:config:error')
 const multipart = require('ipfs-multipart')
 const Boom = require('boom')
+const Joi = require('@hapi/joi')
+const { profiles } = require('../../../core/components/config')
 
 exports.getOrSet = {
   // pre request handler that parses the args and returns `key` & `value` which are assigned to `request.pre.args`
@@ -160,3 +162,39 @@ exports.replace = {
     return h.response()
   }
 }
+
+exports.profile = {
+  validate: {
+    query: Joi.object().keys({
+      'dry-run': Joi.boolean().default(false)
+    }).unknown()
+  },
+
+  // pre request handler that parses the args and returns `profile` which is assigned to `request.pre.args`
+  parseArgs: async function (request, h) {
+    if (!request.query.arg) {
+      throw Boom.badRequest("Argument 'profile' is required")
+    }
+
+    if (!profiles.find(p => p.name === request.query.arg)) {
+      throw Boom.badRequest("Argument 'profile' is not a valid profile name")
+    }
+
+    return { profile: request.query.arg }
+  },
+
+  handler: async function (request, h) {
+    const { ipfs } = request.server.app
+    const { profile } = request.pre.args
+    const dryRun = request.query['dry-run']
+
+    let diff
+    try {
+      diff = await ipfs.config.profile(profile, { dryRun })
+    } catch (err) {
+      throw Boom.boomify(err, { message: 'Failed to apply profile' })
+    }
+
+    return h.response({ OldCfg: diff.oldCfg, NewCfg: diff.newCfg })
+  }
+}

src/http/api/routes/config.js

@@ -31,5 +31,16 @@ module.exports = [
       ]
     },
     handler: resources.config.replace.handler
+  },
+  {
+    method: '*',
+    path: '/api/v0/config/profile/apply',
+    options: {
+      pre: [
+        { method: resources.config.profile.parseArgs, assign: 'args' }
+      ],
+      validate: resources.config.profile.validate
+    },
+    handler: resources.config.profile.handler
   }
 ]

test/cli/config.js

@@ -8,6 +8,7 @@ chai.use(dirtyChai)
 const fs = require('fs')
 const path = require('path')
 const runOnAndOff = require('../utils/on-and-off')
+const defaultConfig = require('../../src/core/runtime/config-nodejs')()
 
 describe('config', () => runOnAndOff((thing) => {
   let ipfs
@@ -97,4 +98,70 @@ describe('config', () => runOnAndOff((thing) => {
       restoreConfig()
     })
   })
+
+  describe('profile', function () {
+    this.timeout(40 * 1000)
+
+    beforeEach(() => restoreConfig())
+    after(() => restoreConfig())
+
+    it('server / local-discovery', async () => {
+      await ipfs('config profile apply server')
+      const updated = updatedConfig()
+      expect(updated.Discovery.MDNS.Enabled).to.equal(false)
+      expect(updated.Discovery.webRTCStar.Enabled).to.equal(false)
+
+      await ipfs('config profile apply local-discovery')
+      const reversed = updatedConfig()
+      expect(reversed.Discovery.MDNS.Enabled).to.equal(true)
+      expect(reversed.Discovery.webRTCStar.Enabled).to.equal(true)
+    })
+
+    it('test / default-networking', async () => {
+      await ipfs('config profile apply test')
+      const updated = updatedConfig()
+      expect(updated.Addresses.API).to.equal('/ip4/127.0.0.1/tcp/0')
+      expect(updated.Addresses.Gateway).to.equal('/ip4/127.0.0.1/tcp/0')
+      expect(updated.Addresses.Swarm).to.eql(['/ip4/127.0.0.1/tcp/0'])
+      expect(updated.Bootstrap).to.eql([])
+      expect(updated.Discovery.MDNS.Enabled).to.equal(false)
+      expect(updated.Discovery.webRTCStar.Enabled).to.equal(false)
+
+      await ipfs('config profile apply default-networking')
+      const reversed = updatedConfig()
+      expect(reversed.Addresses.API).to.equal(defaultConfig.Addresses.API)
+      expect(reversed.Addresses.Gateway).to.equal(defaultConfig.Addresses.Gateway)
+      expect(reversed.Addresses.Swarm).to.eql(defaultConfig.Addresses.Swarm)
+      expect(reversed.Bootstrap).to.eql(defaultConfig.Bootstrap)
+      expect(reversed.Discovery.MDNS.Enabled).to.equal(true)
+      expect(reversed.Discovery.webRTCStar.Enabled).to.equal(true)
+    })
+
+    it('lowpower / default-power', async () => {
+      await ipfs('config profile apply lowpower')
+      const updated = updatedConfig()
+      expect(updated.Swarm.ConnMgr.LowWater).to.equal(20)
+      expect(updated.Swarm.ConnMgr.HighWater).to.equal(40)
+
+      await ipfs('config profile apply default-power')
+      const reversed = updatedConfig()
+      expect(reversed.Swarm.ConnMgr.LowWater).to.equal(defaultConfig.Swarm.ConnMgr.LowWater)
+      expect(reversed.Swarm.ConnMgr.HighWater).to.equal(defaultConfig.Swarm.ConnMgr.HighWater)
+    })
+
+    it('--dry-run causes no change', async () => {
+      await ipfs('config profile apply --dry-run=true server')
+      const after = updatedConfig()
+      expect(after.Discovery.MDNS.Enabled).to.equal(defaultConfig.Discovery.MDNS.Enabled)
+
+      await ipfs('config profile apply --dry-run=false server')
+      const updated = updatedConfig()
+      expect(updated.Discovery.MDNS.Enabled).to.equal(false)
+    })
+
+    it('Private key does not appear in output', async () => {
+      const out = await ipfs('config profile apply server')
+      expect(out).not.includes('PrivKey')
+    })
+  })
 }))