feat: expose onMigrationProgress option (#254)

Allows passing an `onMigrationProgress` option to get notifications of migration progress

Author: achingbrain

README.md

@@ -179,6 +179,7 @@ Arguments:
 * `path` (string, mandatory): the path for this repo
 * `options` (object, optional): may contain the following values
   * `autoMigrate` (bool, defaults to `true`): controls automatic migrations of repository.
+  * `onMigrationProgress` (function(fromVersion, toVersion, percentComplete, message)): callback function to be notified of migration progress
   * `lock` ([Lock](#lock) or string *Deprecated*): what type of lock to use. Lock has to be acquired when opening. string can be `"fs"` or `"memory"`.
   * `storageBackends` (object, optional): may contain the following values, which should each be a class implementing the [datastore interface](https://github.com/ipfs/interface-datastore#readme):
     * `root` (defaults to [`datastore-fs`](https://github.com/ipfs/js-datastore-fs#readme) in Node.js and [`datastore-level`](https://github.com/ipfs/js-datastore-level#readme) in the browser). Defines the back-end type used for gets and puts of values at the root (`repo.set()`, `repo.get()`)

package.json

@@ -64,7 +64,7 @@
     "debug": "^4.1.0",
     "err-code": "^2.0.0",
     "interface-datastore": "^2.0.0",
-    "ipfs-repo-migrations": "^4.0.0",
+    "ipfs-repo-migrations": "^5.0.1",
     "ipfs-utils": "^2.3.1",
     "ipld-block": "^0.10.0",
     "it-map": "^1.0.2",

src/index.js

@@ -334,10 +334,16 @@ class IpfsRepo {
 
     if (currentRepoVersion > toVersion) {
       log('reverting to version ' + toVersion)
-      return migrator.revert(this.path, this.options, toVersion, { ignoreLock: true })
+      return migrator.revert(this.path, this.options, toVersion, {
+        ignoreLock: true,
+        onProgress: this.options.onMigrationProgress
+      })
     } else {
       log('migrating to version ' + toVersion)
-      return migrator.migrate(this.path, this.options, toVersion, { ignoreLock: true })
+      return migrator.migrate(this.path, this.options, toVersion, {
+        ignoreLock: true,
+        onProgress: this.options.onMigrationProgress
+      })
     }
   }
 

test/migrations-test.js

@@ -94,6 +94,24 @@ module.exports = (createTempRepo) => {
       expect(migrateStub.called).to.be.true()
     })
 
+    it('should migrate with progress', async () => {
+      migrateStub.resolves()
+      repoVersionStub.value(8)
+      getLatestMigrationVersionStub.returns(9)
+
+      await repo.version.set(7)
+      await repo.close()
+
+      expect(migrateStub.called).to.be.false()
+
+      repo.options.onMigrationProgress = sinon.stub()
+
+      await repo.open()
+
+      expect(migrateStub.called).to.be.true()
+      expect(migrateStub.getCall(0).args[3]).to.have.property('onProgress', repo.options.onMigrationProgress)
+    })
+
     it('should not migrate when versions matches', async () => {
       migrateStub.resolves()
       repoVersionStub.value(8)
@@ -125,5 +143,22 @@ module.exports = (createTempRepo) => {
       expect(revertStub.called).to.be.true()
       expect(migrateStub.called).to.be.false()
     })
+
+    it('should revert with progress', async () => {
+      revertStub.resolves()
+      repoVersionStub.value(8)
+
+      await repo.version.set(9)
+      await repo.close()
+
+      expect(revertStub.called).to.be.false()
+
+      repo.options.onMigrationProgress = sinon.stub()
+
+      await repo.open()
+
+      expect(revertStub.called).to.be.true()
+      expect(revertStub.getCall(0).args[3]).to.have.property('onProgress', repo.options.onMigrationProgress)
+    })
   })
 }