feat: integrate ipfs-repo-migrations tool

Related to: #1115

Author: AuHau

.aegir.js

@@ -10,7 +10,7 @@ const preloadNode = MockPreloadNode.createNode()
 const echoServer = EchoServer.createServer()
 
 module.exports = {
-  bundlesize: { maxSize: '685kB' },
+  bundlesize: { maxSize: '689kB' },
   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 tool that automatically migrate the version of your IPFS repository when new version is available.
+
+**For tools that build on top of `js-ipfs` and run mainly 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": "github:ipfs/js-ipfs-repo#feat/repo-migrations",
     "ipfs-unixfs": "~0.1.16",
     "ipfs-unixfs-exporter": "^0.38.0",
     "ipfs-unixfs-importer": "^0.40.0",

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
     }

src/core/runtime/repo-browser.js

@@ -2,7 +2,7 @@
 
 const IPFSRepo = require('ipfs-repo')
 
-module.exports = (dir) => {
-  const repoPath = dir || 'ipfs'
-  return new IPFSRepo(repoPath)
+module.exports = (options) => {
+  const repoPath = options.repo || 'ipfs'
+  return new IPFSRepo(repoPath, { autoMigrate: options.repoAutoMigrate })
 }

src/core/runtime/repo-nodejs.js

@@ -4,8 +4,8 @@ const os = require('os')
 const IPFSRepo = require('ipfs-repo')
 const path = require('path')
 
-module.exports = (dir) => {
-  const repoPath = dir || path.join(os.homedir(), '.jsipfs')
+module.exports = (options) => {
+  const repoPath = options.repo || path.join(os.homedir(), '.jsipfs')
 
-  return new IPFSRepo(repoPath)
+  return new IPFSRepo(repoPath, { autoMigrate: options.repoAutoMigrate })
 }