feat: confirm migration of irreversible migrations

Author: AuHau

README.md

@@ -221,8 +221,8 @@ write the rest of the migration!
 
 ### Integration with js-ipfs
 
-When a new migration is created, the repo version in [`js-ipfs-repo`](https://github.com/ipfs/js-ipfs-repo) should be updated with the new version,
-together with updated version of this package. Then the updated version should be propagated to `js-ipfs`.
+When a new migration is created, new version of this package have to be released. Afterwards version of this package in [`js-ipfs-repo`](https://github.com/ipfs/js-ipfs-repo) have to be updated
+together with the repo version that `IPFSRepo` expects. Then the updated version of `js-ipfs-repo` should be propagated to `js-ipfs`.
 
 ### Tests
 

src/commands.js

@@ -5,17 +5,33 @@ const path = require('path')
 const fs = require('fs')
 const process = require('process')
 const util = require('util')
+const readline = require('readline')
 
 const writeFile = util.promisify(fs.writeFile)
 const mkdir = util.promisify(fs.mkdir)
 
 const chalk = require('chalk')
 
 const repoVersion = require('./repo/version')
+const migratorUtils = require('./utils')
 const migrator = require('./index')
 const templates = require('./migration-templates')
 const migrations = require('../migrations')
 
+function shouldContinueWithIrreversibleMigration () {
+  return new Promise((resolve, reject) => {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout
+    })
+
+    rl.question(chalk.yellow('There is irreversible migration in the migrations plan. Do you want to continue? [y/N]'), (answer) => {
+      rl.close()
+      resolve(answer === 'y')
+    })
+  })
+}
+
 function asyncClosure (fnc) {
   return function asyncWrapper ({ resolve, ...options }) {
     resolve(fnc(options))
@@ -29,11 +45,7 @@ function reportingClosure (action) {
 
 async function migrate ({ repoPath, migrations, to, dry, revertOk }) {
   repoPath = repoPath || process.env.IPFS_PATH || path.join(os.homedir(), '.jsipfs')
-
-  // Import migrations if set
-  if (migrations) {
-    migrations = require(migrations)
-  }
+  migrations = migrations === undefined ? require('../migrations') : require(migrations)
 
   if (!to) {
     to = migrator.getLatestMigrationVersion(migrations)
@@ -63,6 +75,12 @@ async function migrate ({ repoPath, migrations, to, dry, revertOk }) {
   if (version === to) {
     return chalk.yellow('Nothing to migrate! Versions matches')
   } else if (version < to) {
+    if (migratorUtils.containsIrreversibleMigration(version, to, migrations)) {
+      if (!(await shouldContinueWithIrreversibleMigration())) {
+        return 'Migration aborted'
+      }
+    }
+
     await migrator.migrate(repoPath, to, options)
   } else if (revertOk) {
     await migrator.revert(repoPath, to, options)

src/errors.js

@@ -16,21 +16,6 @@ class NonReversibleMigrationError extends Error {
 NonReversibleMigrationError.code = 'ERR_NON_REVERSIBLE_MIGRATION'
 exports.NonReversibleMigrationError = NonReversibleMigrationError
 
-/**
- * Exception raised when structure of a repo is not as expected.
- */
-class UnknownRepoStructureError extends Error {
-  constructor (message) {
-    super(message)
-    this.name = 'UnknownRepoStructureError'
-    this.code = 'ERR_UNKNOWN_REPO_STRUCTURE'
-    this.message = message
-  }
-}
-
-UnknownRepoStructureError.code = 'ERR_UNKNOWN_REPO_STRUCTURE'
-exports.UnknownRepoStructureError = UnknownRepoStructureError
-
 /**
  * Exception raised when repo is not initialized.
  */

src/index.js

@@ -3,7 +3,6 @@
 const defaultMigrations = require('../migrations')
 const repoVersion = require('./repo/version')
 const repoLock = require('./repo/lock')
-const repoInit = require('./repo/init')
 const errors = require('./errors')
 const isElectron = require('is-electron')
 
@@ -51,18 +50,14 @@ exports.getLatestMigrationVersion = getLatestMigrationVersion
  * @param {array?} options.migrations - Array of migrations to migrate. If undefined, the bundled migrations are used. Mainly for testing purpose.
  * @returns {Promise<void>}
  */
-async function migrate (path, toVersion, {ignoreLock = false, repoOptions, onProgress, isDryRun = false, migrations }) {
+async function migrate (path, toVersion, { ignoreLock = false, repoOptions, onProgress, isDryRun = false, migrations }) {
   migrations = migrations || defaultMigrations
   onProgress = onProgress || (() => {})
 
   if (!path) {
     throw new errors.RequiredParameterError('Path argument is required!')
   }
 
-  if (!(await repoInit.isRepoInitialized(path))) {
-    throw new errors.NotInitializedRepoError(`Repo in path ${path} is not initialized!`)
-  }
-
   if (!toVersion) {
     throw new errors.RequiredParameterError('toVersion argument is required!')
   }
@@ -150,10 +145,6 @@ async function revert (path, toVersion, { ignoreLock = false, repoOptions, onPro
     throw new errors.RequiredParameterError('Path argument is required!')
   }
 
-  if (!(await repoInit.isRepoInitialized(path))) {
-    throw new errors.NotInitializedRepoError(`Repo in path ${path} is not initialized!`)
-  }
-
   if (!toVersion) {
     throw new errors.RequiredParameterError('When reverting migrations, you have to specify to which version to revert!')
   }

src/repo/version.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const errors = require('../errors')
+const repoInit = require('./init')
 const Datastore = require('datastore-fs')
 
 const Key = require('interface-datastore').Key
@@ -18,13 +19,13 @@ exports.getVersion = getVersion
  * @returns {Promise<int>}
  */
 async function getVersion (path) {
+  if (!(await repoInit.isRepoInitialized(path))) {
+    throw new errors.NotInitializedRepoError(`Repo in path ${path} is not initialized!`)
+  }
+
   const store = new Datastore(path, { extension: '', createIfMissing: false })
   await store.open()
 
-  if (!await store.has(versionKey)) {
-    throw new errors.UnknownRepoStructureError('Repo does not have version file! Is the repo initialized?')
-  }
-
   const version = parseInt(await store.get(versionKey))
   await store.close()
 

src/utils.js

@@ -27,3 +27,9 @@ exports.getDatastoreAndOptions = function getDatastoreAndOptions (options, key,
     storageOptions: storageBackendOptions
   }
 }
+
+exports.containsIrreversibleMigration = function containsIrreversibleMigration (from, to, migrations) {
+  return migrations
+    .filter(migration => migration.version > from && migration.version <= to)
+    .find(migration => migration.revert === undefined) !== undefined
+}

test/index.spec.js

@@ -40,7 +40,7 @@ function createMigrations () {
 
 function createOptions () {
   return {
-    migrations: createMigrations(),
+    migrations: createMigrations()
   }
 }
 
@@ -350,7 +350,7 @@ describe('index.js', () => {
       options.ignoreLock = true
       getVersionStub.returns(2)
 
-      await expect(migrator.migrate('/some/path', 4,  options))
+      await expect(migrator.migrate('/some/path', 4, options))
         .to.eventually.be.fulfilled()
 
       expect(lockCloseStub.called).to.be.false()

test/test-migrations/migration-2/index.js

@@ -118,7 +118,6 @@ async function revert (repoPath, options, isBrowser) {
 module.exports = {
   version: 2,
   description: 'Updates config',
-  reversible: true,
   migrate,
   revert,
   newApiAddr: NEW_API_ADDRESS

test/version-test.js

@@ -16,7 +16,7 @@ const errors = require('../src/errors')
 module.exports = (setup, cleanup) => {
   it('getVersion should fail without any version in repo', async () => {
     const dir = await setup()
-    await expect(version.getVersion(dir)).to.be.eventually.rejectedWith(errors.UnknownRepoStructureError).with.property('code', errors.UnknownRepoStructureError.code)
+    await expect(version.getVersion(dir)).to.be.eventually.rejectedWith(errors.NotInitializedRepoError).with.property('code', errors.NotInitializedRepoError.code)
     return cleanup(dir)
   })
 
@@ -32,17 +32,25 @@ module.exports = (setup, cleanup) => {
 
     it('should get version number', async () => {
       // Create version file
-      const versionKey = new Key('version')
       const store = new Datastore(dir, { extension: '', createIfMissing: false })
       await store.open()
-      await store.put(versionKey, Buffer.from('7'))
+      await store.put(new Key('config'), Buffer.from('some dummy config'))
+      await store.put(new Key('version'), Buffer.from('7'))
       await store.close()
 
       expect(await version.getVersion(dir)).to.be.equal(7)
     })
 
     it('should set version number', async () => {
-      await expect(version.getVersion(dir)).to.be.eventually.rejectedWith(errors.UnknownRepoStructureError).with.property('code', errors.UnknownRepoStructureError.code)
+      await expect(version.getVersion(dir)).to.be.eventually.rejectedWith(errors.NotInitializedRepoError).with.property('code', errors.NotInitializedRepoError.code)
+
+      // Create version file
+      const store = new Datastore(dir, { extension: '', createIfMissing: false })
+      await store.open()
+      await store.put(new Key('config'), Buffer.from('some dummy config'))
+      await store.put(new Key('version'), Buffer.from('5'))
+      await store.close()
+
       await version.setVersion(dir, 7)
       expect(await version.getVersion(dir)).to.be.equal(7)
     })