feat: integrate ipfs-repo-migrations tool (#2527)

Resolves: #1115

Supersedes: #2044

Depends on:

* [x] ipfs/js-ipfs-repo#202

Author: AuHau

.aegir.js

@@ -11,7 +11,7 @@ const preloadNode = MockPreloadNode.createNode()
 const echoServer = EchoServer.createServer()
 
 module.exports = {
-  bundlesize: { maxSize: '685kB' },
+  bundlesize: { maxSize: '650kB' },
   webpack: {
     resolve: {
       mainFields: ['browser', 'main'],

README.md

@@ -284,6 +284,18 @@ Example:
 const node = await IPFS.create({ repo: '/var/ipfs/data' })
 ```
 
+##### `options.repoAutoMigrate`
+
+| Type | Default |
+|------|---------|
+| boolean | `true` |
+
+`js-ipfs` comes bundled with a tool that automatically migrates your IPFS repository when a new version is available.
+
+**For apps that build on top of `js-ipfs` and run in the browser environment, be aware that disabling automatic
+migrations leaves the user with no way to run the migrations because there is no CLI in the browser. In such
+a case, you should provide a way to trigger migrations manually.**
+
 ##### `options.init`
 
 | Type | Default |

package.json

@@ -104,7 +104,7 @@
     "ipfs-http-response": "~0.4.0",
     "ipfs-mfs": "^0.13.0",
     "ipfs-multipart": "^0.2.0",
-    "ipfs-repo": "^0.28.1",
+    "ipfs-repo": "^0.29.0",
     "ipfs-unixfs": "~0.1.16",
     "ipfs-unixfs-exporter": "^0.38.0",
     "ipfs-unixfs-importer": "^0.40.0",

src/cli/bin.js

@@ -26,6 +26,7 @@ if (!semver.satisfies(process.versions.node, pkg.engines.node)) {
 const YargsPromise = require('yargs-promise')
 const updateNotifier = require('update-notifier')
 const debug = require('debug')('ipfs:cli')
+const { errors: { InvalidRepoVersionError } } = require('ipfs-repo')
 const parser = require('./parser')
 const commandAlias = require('./command-alias')
 const { print } = require('./utils')
@@ -50,13 +51,19 @@ cli
   })
   .catch(({ error, argv }) => {
     getIpfs = argv && argv.getIpfs
+
+    if (error.code === InvalidRepoVersionError.code) {
+      error.message = 'Incompatible repo version. Migration needed. Pass --migrate for automatic migration'
+    }
+
     if (error.message) {
       print(error.message)
       debug(error)
     } else {
       print('Unknown error, please re-run the command with DEBUG=ipfs:cli to see debug output')
       debug(error)
     }
+
     process.exit(1)
   })
   .finally(() => {

src/cli/commands/daemon.js

@@ -73,6 +73,7 @@ module.exports = {
         config,
         silent: argv.silent,
         repo: process.env.IPFS_PATH,
+        repoAutoMigrate: argv.migrate,
         offline: argv.offline,
         pass: argv.pass,
         preload: { enabled: argv.enablePreload },
@@ -96,10 +97,8 @@ module.exports = {
           print(`Web UI available at ${toUri(apiServer.info.ma)}/webui`)
         })
       } catch (err) {
-        if (err.code === 'ENOENT' && err.message.match(/uninitialized/i)) {
-          print('Error: no initialized ipfs repo found in ' + repoPath)
-          print('please run: jsipfs init')
-          process.exit(1)
+        if (err.code === 'ERR_REPO_NOT_INITIALIZED' || err.message.match(/uninitialized/i)) {
+          err.message = 'no initialized ipfs repo found in ' + repoPath + '\nplease run: jsipfs init'
         }
         throw err
       }

src/cli/daemon.js

@@ -54,17 +54,8 @@ class Daemon {
     }
 
     // start the daemon
-    const ipfsOpts = Object.assign({ }, { init: true, start: true, libp2p }, this._options)
-    const ipfs = new IPFS(ipfsOpts)
-
-    await new Promise((resolve, reject) => {
-      ipfs.once('error', err => {
-        this._log('error starting core', err)
-        err.code = 'ENOENT'
-        reject(err)
-      })
-      ipfs.once('start', resolve)
-    })
+    const ipfsOpts = Object.assign({}, { init: true, start: true, libp2p }, this._options)
+    const ipfs = await IPFS.create(ipfsOpts)
 
     this._ipfs = ipfs
 

src/cli/parser.js

@@ -19,6 +19,11 @@ const parser = yargs
     type: 'string',
     default: ''
   })
+  .option('migrate', {
+    desc: 'Enable/disable automatic repo migrations',
+    type: 'boolean',
+    default: false
+  })
   .epilog(utils.ipfsPathHelp)
   .demandCommand(1)
   .fail((msg, err, yargs) => {

src/cli/utils.js

@@ -4,9 +4,7 @@ const fs = require('fs')
 const os = require('os')
 const multiaddr = require('multiaddr')
 const path = require('path')
-const debug = require('debug')
-const log = debug('cli')
-log.error = debug('cli:error')
+const log = require('debug')('ipfs:cli:utils')
 const Progress = require('progress')
 const byteman = require('byteman')
 const promisify = require('promisify-es6')
@@ -47,6 +45,7 @@ exports.getIPFS = (argv, callback) => {
   const IPFS = require('../core')
   const node = new IPFS({
     silent: argv.silent,
+    repoAutoMigrate: argv.migrate,
     repo: exports.getRepoPath(),
     init: false,
     start: false,
@@ -60,7 +59,7 @@ exports.getIPFS = (argv, callback) => {
   })
 
   node.on('error', (err) => {
-    throw err
+    callback(err)
   })
 
   node.once('ready', () => {

src/core/config.js

@@ -28,6 +28,7 @@ const s = superstruct({
 const configSchema = s({
   repo: optional(s('object|string')),
   repoOwner: 'boolean?',
+  repoAutoMigrate: 'boolean?',
   preload: s({
     enabled: 'boolean?',
     addresses: optional(s(['multiaddr'])),

src/core/index.js

@@ -70,7 +70,7 @@ class IPFS extends EventEmitter {
 
     if (typeof options.repo === 'string' ||
         options.repo === undefined) {
-      this._repo = defaultRepo(options.repo)
+      this._repo = defaultRepo(options)
     } else {
       this._repo = options.repo
     }