feat: config

Adds the commands `config get [Key]` and `config set <Key> <Value>`.

The config command uses the context property `onConfigUpdate` (if set) to mutate the context when a config value is updated.

License: MIT
Signed-off-by: Alan Shaw <[email protected]>

Author: Alan Shaw

Diff for: README.md

@@ -4,7 +4,25 @@
 
 Turn IPFS peers in to file sharing friends.
 
-## CLI
+## Install
+
+```sh
+npm install -g ipfs-friends
+```
+
+## Usage
+
+### CLI
+
+1. Install IPFS (JS or Go flavour).
+2. Start your daemon (with pubsub enabled):
+    ```sh
+    (js)ipfs dameon --enable-pubsub-experiment
+    ```
+3. Start friends:
+    ```sh
+    friends
+    ```
 
 ```console
 # It all starts with friends

Diff for: auto-complete.js

@@ -1,8 +1,6 @@
-const Commands = require('./commands')
-
 exports.withAutoComplete = fn => {
-  const autoComplete = s => s.includes(' ') ? [] : Object.keys(Commands)
   return function fnWithAutoComplete (ctx) {
+    const autoComplete = s => s.includes(' ') ? [] : Object.keys(ctx.commands)
     ctx.autoComplete = autoComplete
     return fn.apply(this, arguments)
   }

Diff for: commands/config.js

@@ -0,0 +1,59 @@
+const Fs = require('fs')
+const Path = require('path')
+const { promisify } = require('util')
+const Os = require('os')
+const log = require('debug')('ipfs-friends:config')
+const explain = require('explain-error')
+
+const readFile = promisify(Fs.readFile)
+const writeFile = promisify(Fs.writeFile)
+const DEFAULT_CONFIG_PATH = Path.join(Os.homedir(), '.ipfs-friends')
+
+const SubCommands = {
+  async set (ctx, key, value) {
+    log('set', key, value)
+
+    const config = await readConfig(ctx.configPath)
+    config[key] = value
+
+    await writeConfig(config, ctx.configPath)
+
+    if (ctx.onConfigUpdate) {
+      return { ctx: await ctx.onConfigUpdate(key, value) }
+    }
+  },
+
+  async get (ctx, key) {
+    log('get', key)
+    const config = await readConfig(ctx.configPath)
+    const value = key ? config[key] : config
+    return { out: value }
+  }
+}
+
+async function readConfig (path) {
+  path = path || DEFAULT_CONFIG_PATH
+  let config
+
+  try {
+    config = JSON.parse(await readFile(path))
+  } catch (err) {
+    log('failed to read config', err)
+  }
+
+  return config || {}
+}
+
+async function writeConfig (config, path) {
+  path = path || DEFAULT_CONFIG_PATH
+  try {
+    await writeFile(path, JSON.stringify(config))
+  } catch (err) {
+    throw explain(err, 'failed to write config')
+  }
+}
+
+module.exports = async function config (ctx, subCmd, ...args) {
+  if (!SubCommands[subCmd]) throw new Error(`${subCmd}: subcommand not found`)
+  return SubCommands[subCmd](ctx, ...args)
+}

Diff for: commands/index.js

@@ -1,4 +1,5 @@
 exports.add = require('./add')
+exports.config = require('./config')
 exports.dump = require('./dump')
 exports.exit = require('./exit')
 exports.help = require('./help')

Diff for: eval.js

@@ -1,10 +1,11 @@
-const debug = require('debug')('ipfs-friends:eval')
-const Commands = require('./commands')
+const log = require('debug')('ipfs-friends:eval')
 
 module.exports.evaluate = async (ctx, cmd, cmdArgs) => {
-  debug(cmd, cmdArgs)
+  log(cmd, cmdArgs)
   cmd = cmd || ''
   if (!cmd) return
-  if (!Commands[cmd]) throw new Error(`${cmd}: command not found`)
-  return Commands[cmd](ctx, ...cmdArgs)
+  if (!ctx || !ctx.commands || !ctx.commands[cmd]) {
+    throw new Error(`${cmd}: command not found`)
+  }
+  return ctx.commands[cmd](ctx, ...cmdArgs)
 }

Diff for: index.js

@@ -1,4 +1,3 @@
-const IpfsApi = require('ipfs-api')
 const Chalk = require('chalk')
 const FriendDaemon = require('./lib/friends')
 const repl = require('./repl')
@@ -12,24 +11,40 @@ module.exports = async function (opts) {
 }
 
 async function getInitialCtx () {
-  const ipfs = IpfsApi()
-  const friendDaemon = new FriendDaemon(ipfs)
-
-  friendDaemon
-    .on('message:share', ({ peerName, peerId, cid, shareName }) => {
-      console.log(`🎁 ${peerName} shared ${shareName} ${cid}`)
-    })
-    .on('message:shared', ({ peerName, peerId, shareName }) => {
-      console.log(`${peerName} got ${shareName} 🙌`)
-    })
-    .on('message:online', ({ peerName }) => {
-      console.log(`${peerName} is here ✨🎷🐩`)
-    })
-    .on('message:offline', ({ peerName }) => {
-      console.log(`${peerName} went away 👋`)
-    })
-
-  await friendDaemon.start()
-
-  return { ipfs, friendDaemon }
+  const commands = require('./commands')
+
+  const createFriendDaemon = async ipfs => {
+    const friendDaemon = new FriendDaemon(ipfs)
+
+    friendDaemon
+      .on('message:share', ({ peerName, peerId, cid, shareName }) => {
+        console.log(`🎁 ${peerName} shared ${shareName} ${cid}`)
+      })
+      .on('message:shared', ({ peerName, peerId, shareName }) => {
+        console.log(`${peerName} got ${shareName} 🙌`)
+      })
+      .on('message:online', ({ peerName }) => {
+        console.log(`${peerName} is here ✨🎷🐩`)
+      })
+      .on('message:offline', ({ peerName }) => {
+        console.log(`${peerName} went away 👋`)
+      })
+
+    await friendDaemon.start()
+
+    return friendDaemon
+  }
+
+  const onConfigUpdate = async (key, value) => {
+    if (key === 'apiAddr') {
+      const ipfs = require('ipfs-api')(value)
+      const friendDaemon = await createFriendDaemon(ipfs)
+      return { ipfs, friendDaemon }
+    }
+  }
+
+  const apiAddr = (await commands.config({}, 'get', 'apiAddr')).out
+  const ctx = await onConfigUpdate('apiAddr', apiAddr)
+
+  return Object.assign(ctx, { commands, onConfigUpdate })
 }

Diff for: lib/friends.js

@@ -4,17 +4,18 @@ const EventEmitter = require('events')
 const explain = require('explain-error')
 
 class FriendDaemon extends EventEmitter {
-  constructor (ipfs) {
+  constructor (ipfs, options) {
     super()
     this._ipfs = ipfs
     this._index = null
     this.onMessage = this.onMessage.bind(this)
+    this._options = options || {}
   }
 
   async start () {
     const ipfs = this._ipfs
     const { id } = await ipfs.id()
-    const index = await readFriends(ipfs)
+    const index = await readFriends(ipfs, { dir: this._options.dataDir })
     this.peerId = id
     this._index = index
     const peerIds = Object.keys(index)
@@ -91,7 +92,7 @@ class FriendDaemon extends EventEmitter {
     }
 
     this._index[peerId] = name
-    await writeFriends(this._ipfs, this._index)
+    await writeFriends(this._ipfs, this._index, { dir: this._options.dataDir })
     await this._ipfs.pubsub.subscribe(peerId, this.onMessage)
   }
 
@@ -127,7 +128,7 @@ class FriendDaemon extends EventEmitter {
     }
 
     delete index[peerId]
-    await writeFriends(this._ipfs, index)
+    await writeFriends(this._ipfs, index, { dir: this._options.dataDir })
     await this._ipfs.pubsub.unsubscribe(peerId, this.onMessage)
     this._index = index
   }
@@ -163,21 +164,27 @@ class FriendDaemon extends EventEmitter {
 
 module.exports = FriendDaemon
 
-async function readFriends (ipfs) {
+const DEFAULT_FRIENDS_DIR = '/friends'
+
+async function readFriends (ipfs, options) {
+  options = options || {}
+  const dir = options.dir || DEFAULT_FRIENDS_DIR
   try {
-    const index = await ipfs.files.read('/friends/index.json')
+    const index = await ipfs.files.read(dir + '/index.json')
     return JSON.parse(index)
   } catch (err) {
     log('failed to read /friends/index.json', err)
     return {}
   }
 }
 
-async function writeFriends (ipfs, index) {
+async function writeFriends (ipfs, index, options) {
+  options = options || {}
+  const dir = options.dir || DEFAULT_FRIENDS_DIR
   const data = Buffer.from(JSON.stringify(index))
 
   try {
-    await ipfs.files.write('/friends/index.json', data, {
+    await ipfs.files.write(dir + '/index.json', data, {
       create: true,
       parents: true,
       truncate: true

Diff for: print.js

@@ -1,5 +1,5 @@
 const Chalk = require('chalk')
-const debug = require('debug')('ipfs-friends:print')
+const log = require('debug')('ipfs-friends:print')
 
 module.exports = async function print (func) {
   try {
@@ -12,7 +12,7 @@ module.exports = async function print (func) {
       }
     }
   } catch (err) {
-    debug(err)
+    log(err)
     console.error(`${Chalk.red('✖')} ${err}`)
   }
 }

Diff for: repl.js

@@ -1,4 +1,4 @@
-const debug = require('debug')('ipfs-friends:repl')
+const log = require('debug')('ipfs-friends:repl')
 
 const { read } = require('./read')
 const { evaluate } = require('./eval')
@@ -17,7 +17,7 @@ module.exports = async function repl (ctx, opts) {
     const { input } = await opts.read(ctx)
     let [ cmd, ...cmdArgs ] = input.split(' ').filter(Boolean)
 
-    debug(cmd, cmdArgs)
+    log(cmd, cmdArgs)
 
     await print(async () => {
       const res = await opts.evaluate(ctx, cmd, cmdArgs)