feat: ipfs init --profile option

Author: dirkmc

src/cli/commands/init.js

@@ -5,12 +5,15 @@ const print = utils.print
 
 module.exports = {
   command: 'init [config] [options]',
-  describe: 'Initialize a local IPFS node',
+  describe: 'Initialize a local IPFS node\n\n' +
+    'If you are going to run IPFS in a server environment, you may want to ' +
+    `initialize it using the 'server' profile.\n\n` +
+    'For the list of available profiles run `jsipfs config profile ls`',
   builder (yargs) {
     return yargs
       .epilog(utils.ipfsPathHelp)
       .positional('config', {
-        describe: 'Node config, this should JSON and will be merged with the default config. Check https://github.com/ipfs/js-ipfs#optionsconfig',
+        describe: 'Node config, this should be JSON and will be merged with the default config. See https://github.com/ipfs/js-ipfs#optionsconfig',
         type: 'string'
       })
       .option('bits', {
@@ -29,6 +32,11 @@ module.exports = {
         type: 'string',
         describe: 'Pre-generated private key to use for the repo'
       })
+      .option('profile', {
+        alias: 'p',
+        type: 'string',
+        describe: `Apply profile settings to config. Multiple profiles can be separated by ','`
+      })
   },
 
   handler (argv) {
@@ -53,6 +61,7 @@ module.exports = {
           bits: argv.bits,
           privateKey: argv.privateKey,
           emptyRepo: argv.emptyRepo,
+          profile: argv.profile,
           pass: argv.pass,
           log: print
         })

src/core/components/init.js

@@ -17,6 +17,7 @@ const IPNS = require('../ipns')
 const OfflineDatastore = require('../ipns/routing/offline-datastore')
 
 const addDefaultAssets = require('./init-assets')
+const { profiles } = require('./config')
 
 module.exports = function init (self) {
   return promisify((opts, callback) => {
@@ -61,6 +62,21 @@ module.exports = function init (self) {
     opts.log = opts.log || function () {}
 
     const config = mergeOptions(defaultConfig(), self._options.config)
+
+    // Apply profiles (eg "server,lowpower") to config
+    if (opts.profile) {
+      const profileNames = opts.profile.split(',')
+      for (const profileName of profileNames) {
+        const profile = profiles.find(p => p.name === profileName)
+        if (!profile) {
+          return done(new Error(`Could not find profile with name '${profileName}'`))
+        }
+
+        self.log(`applying profile ${profileName}`)
+        profile.transform(config)
+      }
+    }
+
     let privateKey
 
     waterfall([

test/cli/init.js

@@ -25,6 +25,11 @@ describe('init', function () {
       return !f.startsWith('.')
     })
   }
+
+  const repoConfSync = (p) => {
+    return JSON.parse(fs.readFileSync(path.join(repoPath, 'config')))
+  }
+
   beforeEach(() => {
     repoPath = os.tmpdir() + '/ipfs-' + hat()
     ipfs = ipfsExec(repoPath)
@@ -67,6 +72,31 @@ describe('init', function () {
     })
   })
 
+  it('profile', async function () {
+    this.timeout(40 * 1000)
+
+    await ipfs('init --profile lowpower')
+    expect(repoConfSync().Swarm.ConnMgr.LowWater).to.equal(20)
+  })
+
+  it('profile multiple', async function () {
+    this.timeout(40 * 1000)
+
+    await ipfs('init --profile server,lowpower')
+    expect(repoConfSync().Discovery.MDNS.Enabled).to.equal(false)
+    expect(repoConfSync().Swarm.ConnMgr.LowWater).to.equal(20)
+  })
+
+  it('profile non-existent', async function () {
+    this.timeout(40 * 1000)
+
+    try {
+      await ipfs('init --profile doesnt-exist')
+    } catch (err) {
+      expect(err.stdout).includes('Could not find profile')
+    }
+  })
+
   it('should present ipfs path help when option help is received', function (done) {
     this.timeout(100 * 1000)