feat: mfs implementation

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

Author: achingbrain

README.md

@@ -233,7 +233,8 @@ Creates and returns an instance of an IPFS node. Use the `options` argument to s
         - `hop` (object)
             - `enabled` (boolean): Make this node a relay (other nodes can connect *through* it). (Default: `false`)
             - `active` (boolean): Make this an *active* relay node. Active relay nodes will attempt to dial a destination peer even if that peer is not yet connected to the relay. (Default: `false`)
-            
+    - `mfs` (boolean): Enables Mutable File System commands - see `jsipfs files --help` for more (Default: `false`)
+
 - `config` (object) Modify the default IPFS node config. Find the Node.js defaults at [`src/core/runtime/config-nodejs.js`](https://github.com/ipfs/js-ipfs/tree/master/src/core/runtime/config-nodejs.js) and the browser defaults at [`src/core/runtime/config-browser.js`](https://github.com/ipfs/js-ipfs/tree/master/src/core/runtime/config-browser.js). This object will be *merged* with the default config; it will not replace it.
 
 - `libp2p` (object) add custom modules to the libp2p stack of your node

package.json

@@ -73,7 +73,7 @@
     "expose-loader": "~0.7.5",
     "form-data": "^2.3.2",
     "hat": "~0.0.3",
-    "interface-ipfs-core": "~0.65.7",
+    "interface-ipfs-core": "~0.66.2",
     "ipfsd-ctl": "~0.34.0",
     "lodash": "^4.17.10",
     "mocha": "^5.1.1",
@@ -109,6 +109,7 @@
     "ipfs-bitswap": "~0.20.0",
     "ipfs-block": "~0.7.1",
     "ipfs-block-service": "~0.14.0",
+    "ipfs-mfs": "~0.0.1",
     "ipfs-multipart": "~0.1.0",
     "ipfs-repo": "~0.20.0",
     "ipfs-unixfs": "~0.1.14",

src/cli/bin.js

@@ -5,8 +5,6 @@
 const yargs = require('yargs')
 const updateNotifier = require('update-notifier')
 const readPkgUp = require('read-pkg-up')
-const fs = require('fs')
-const path = require('path')
 const utils = require('./utils')
 const print = utils.print
 
@@ -18,10 +16,6 @@ updateNotifier({
 
 const args = process.argv.slice(2)
 
-// Determine if the first argument is a sub-system command
-const commandNames = fs.readdirSync(path.join(__dirname, 'commands'))
-const isCommand = commandNames.includes(`${args[0]}.js`)
-
 const cli = yargs
   .option('silent', {
     desc: 'Write no output',
@@ -34,14 +28,6 @@ const cli = yargs
     type: 'string',
     default: ''
   })
-  .commandDir('commands', {
-    // Only include the commands for the sub-system we're using, or include all
-    // if no sub-system command has been passed.
-    include (path, filename) {
-      if (!isCommand) return true
-      return `${args[0]}.js` === filename
-    }
-  })
   .epilog(utils.ipfsPathHelp)
   .demandCommand(1)
   .fail((msg, err, yargs) => {
@@ -56,27 +42,15 @@ const cli = yargs
     yargs.showHelp()
   })
 
-// If not a sub-system command then load the top level aliases
-if (!isCommand) {
-  // NOTE: This creates an alias of
-  // `jsipfs files {add, get, cat}` to `jsipfs {add, get, cat}`.
-  // This will stay until https://github.com/ipfs/specs/issues/98 is resolved.
-  const addCmd = require('./commands/files/add')
-  const catCmd = require('./commands/files/cat')
-  const getCmd = require('./commands/files/get')
-  const aliases = [addCmd, catCmd, getCmd]
-  aliases.forEach((alias) => {
-    cli.command(alias.command, alias.describe, alias.builder, alias.handler)
-  })
-}
-
 // Need to skip to avoid locking as these commands
 // don't require a daemon
 if (args[0] === 'daemon' || args[0] === 'init') {
   cli
     .help()
     .strict()
     .completion()
+    .command(require('./commands/daemon'))
+    .command(require('./commands/init'))
     .parse(args)
 } else {
   // here we have to make a separate yargs instance with
@@ -86,10 +60,37 @@ if (args[0] === 'daemon' || args[0] === 'init') {
     if (err) {
       throw err
     }
+
     utils.getIPFS(argv, (err, ipfs, cleanup) => {
       if (err) { throw err }
 
+      const enableMfs = ipfs._options && ipfs._options.EXPERIMENTAL && ipfs._options && ipfs._options.EXPERIMENTAL.mfs
+
+      if (enableMfs) {
+        require('ipfs-mfs/cli')(cli)
+      }
+
+      // NOTE: This creates an alias of
+      // `jsipfs files {add, get, cat}` to `jsipfs {add, get, cat}`.
+      // This will stay until https://github.com/ipfs/specs/issues/98 is resolved.
+      const addCmd = require('./commands/files/add')
+      const catCmd = require('./commands/files/cat')
+      const getCmd = require('./commands/files/get')
+      const aliases = [addCmd, catCmd, getCmd]
+      aliases.forEach((alias) => {
+        cli.command(alias)
+      })
+
       cli
+        .commandDir('commands', {
+          visit: (commandObject, pathToFile, filename) => {
+            if (commandObject.command === 'files <command>' && enableMfs) {
+              return null
+            }
+
+            return commandObject
+          }
+        })
         .help()
         .strict()
         .completion()

src/cli/commands/dag/get.js

@@ -41,7 +41,7 @@ module.exports = {
       // * reads as 'agree in'
       if (node._json) {
         delete node._json.multihash
-        node._json.data = '0x' + node._json.data.toString('hex')
+        node._json.data = node._json.data.toString('base64')
         print(JSON.stringify(node._json))
         return
       }

src/cli/commands/files/get.js

@@ -30,6 +30,7 @@ function fileHandler (dir) {
         callback(err)
       } else {
         const fullFilePath = path.join(dir, file.path)
+
         if (file.content) {
           file.content
             .pipe(fs.createWriteStream(fullFilePath))

src/cli/utils.js

@@ -51,7 +51,8 @@ exports.getIPFS = (argv, callback) => {
     start: false,
     pass: argv.pass,
     EXPERIMENTAL: {
-      pubsub: true
+      pubsub: true,
+      mfs: Boolean(process.env.IPFS_MFS)
     }
   })
 

src/core/components/index.js

@@ -23,3 +23,4 @@ exports.dht = require('./dht')
 exports.dns = require('./dns')
 exports.key = require('./key')
 exports.stats = require('./stats')
+exports.mfs = require('ipfs-mfs/core')

src/core/config.js

@@ -16,7 +16,8 @@ const schema = Joi.object().keys({
   EXPERIMENTAL: Joi.object().keys({
     pubsub: Joi.boolean(),
     sharding: Joi.boolean(),
-    dht: Joi.boolean()
+    dht: Joi.boolean(),
+    mfs: Joi.boolean()
   }).allow(null),
   config: Joi.object().keys({
     Addresses: Joi.object().keys({

src/core/index.js

@@ -120,6 +120,16 @@ class IPFS extends EventEmitter {
     if (this._options.EXPERIMENTAL.relay) {
       this.log('EXPERIMENTAL Relay is enabled')
     }
+    if (this._options.EXPERIMENTAL.mfs) {
+      this.log('EXPERIMENTAL mfs is enabled')
+      const mfs = components.mfs(this)
+
+      Object.keys(mfs).forEach(key => {
+        if (mfs.hasOwnProperty(key)) {
+          this.files[key] = mfs[key]
+        }
+      })
+    }
 
     this.state = require('./state')(this)
 

src/http/index.js

@@ -71,7 +71,8 @@ function HttpApi (repo, config, cliArgs) {
             EXPERIMENTAL: {
               pubsub: cliArgs && cliArgs.enablePubsubExperiment,
               dht: cliArgs && cliArgs.enableDhtExperiment,
-              sharding: cliArgs && cliArgs.enableShardingExperiment
+              sharding: cliArgs && cliArgs.enableShardingExperiment,
+              mfs: cliArgs && cliArgs.enableMfsExperiment
             },
             libp2p: libp2p
           })

test/cli/file.js

@@ -4,15 +4,15 @@
 const expect = require('chai').expect
 const runOnAndOff = require('../utils/on-and-off')
 const file = 'QmR56UJmAaZLXLdTT1ALrE9vVqV8soUEekm9BMd4FnuYqV'
-const dir = 'QmYmW4HiZhotsoSqnv2o1oUusvkRM8b9RweBoH7ao5nki2'
+const dir = 'Qmaj2NmcyAXT8dFmZRRytE12wpcaHADzbChKToMEjBsj5Z'
 
 describe('file ls', () => runOnAndOff((thing) => {
   let ipfs
 
   before(function () {
     this.timeout(50 * 1000)
     ipfs = thing.ipfs
-    return ipfs('files add -r test/fixtures/test-data/recursive-get-dir')
+    return ipfs('add -r test/fixtures/test-data/recursive-get-dir')
   })
 
   it('prints a filename', () => {
@@ -27,9 +27,9 @@ describe('file ls', () => runOnAndOff((thing) => {
     return ipfs(`file ls ${dir}`)
       .then((out) => expect(out).to.eql(
         `This functionality is deprecated, and will be removed in future versions. If possible, please use 'ipfs ls' instead.\n` +
-        'QmQQHYDwAQms78fPcvx1uFFsfho23YJNoewfLbi9AtdyJ9\n' +
+        'QmamKEPmEH9RUsqRQsfNf5evZQDQPYL9KXg1ADeT7mkHkT\n' +
         'QmPkWYfSLCEBLZu7BZt4kigGDMe3cpogMbeVf97gN2xJDN\n' +
-        'Qma13ZrhKG52MWnwtZ6fMD8jGj8d4Q9sJgn5xtKgeZw5uz\n' +
+        'QmUqyZtPmsRy1U5Mo8kz2BAMmk1hfJ7yW1KAFTMB2odsFv\n' +
         'QmUhUuiTKkkK8J6JZ9zmj8iNHPuNfGYcszgRumzhHBxEEU\n' +
         'QmR56UJmAaZLXLdTT1ALrE9vVqV8soUEekm9BMd4FnuYqV\n'
       ))