Adding check if repo is initialized

License: MIT
Signed-off-by: Adam Uhlir <uhlir.a@gmail.com>

Author: AuHau

src/errors.js

@@ -24,3 +24,15 @@ class UnknownRepoStructure extends Error {
   }
 }
 exports.UnknownRepoStructure = UnknownRepoStructure
+
+/**
+ * Exception raised when repo is not initialized.
+ */
+class NotInitializedRepo extends Error {
+  constructor (message) {
+    super(message)
+    this.name = 'NotInitializedRepo'
+    this.message = message
+  }
+}
+exports.NotInitializedRepo = NotInitializedRepo

src/index.js

@@ -3,17 +3,19 @@
 const defaultMigrations = require('../migrations')
 const repoVersion = require('./repo/version')
 const repoLock = require('./repo/lock')
+const repoInit = require('./repo/init')
 const isBrowser = require('./option-node')
 const errors = require('./errors')
-const debug = require('debug')
 
-const log = debug('js-ipfs-repo-migrations:migrator')
+const log = require('debug')('js-ipfs-repo-migrations:migrator')
 
 exports.getCurrentRepoVersion = repoVersion.getVersion
+exports.errors = errors
 
 /**
  * Returns the version of latest migration.
  *
+ * @param {array?} migrations - Array of migrations to consider. If undefined, the bundled migrations are used. Mainly for testing purpose.
  * @returns {int}
  */
 function getLatestMigrationVersion (migrations) {
@@ -48,6 +50,10 @@ async function migrate (path, toVersion, progressCb, isDryRun, migrations) {
     throw new Error('Path argument is required!')
   }
 
+  if (!(await repoInit.isRepoInitialized(path))) {
+    throw new errors.NotInitializedRepo(`Repo in path ${path} is not initialized!`)
+  }
+
   if (toVersion && (!Number.isInteger(toVersion) || toVersion <= 0)) {
     throw new Error('Version has to be positive integer!')
   }
@@ -75,21 +81,20 @@ async function migrate (path, toVersion, progressCb, isDryRun, migrations) {
       if (toVersion !== undefined && migration.version > toVersion) {
         break
       }
+      if (migration.version <= currentVersion) {
+        continue
+      }
 
-      if (migration.version > currentVersion) {
-        counter++
-        log(`Migrating version ${migration.version}`)
-        if (!isDryRun) {
-          try {
-            await migration.migrate(path, isBrowser)
-          } catch (e) {
-            e.message = `During migration to version ${migration.version} exception was raised: ${e.message}`
-            throw e
-          }
-        }
-        typeof progressCb === 'function' && progressCb(migration, counter, totalMigrations) // Reports on migration process
-        log(`Migrating to version ${migration.version} finished`)
+      counter++
+      log(`Migrating version ${migration.version}`)
+      try {
+        if (!isDryRun) await migration.migrate(path, isBrowser)
+      } catch (e) {
+        e.message = `During migration to version ${migration.version} exception was raised: ${e.message}`
+        throw e
       }
+      typeof progressCb === 'function' && progressCb(migration, counter, totalMigrations) // Reports on migration process
+      log(`Migrating to version ${migration.version} finished`)
     }
 
     if (!isDryRun) await repoVersion.setVersion(path, toVersion || getLatestMigrationVersion(migrations))
@@ -121,6 +126,10 @@ async function revert (path, toVersion, progressCb, isDryRun, migrations) {
     throw new Error('Path argument is required!')
   }
 
+  if (!(await repoInit.isRepoInitialized(path))) {
+    throw new errors.NotInitializedRepo(`Repo in path ${path} is not initialized!`)
+  }
+
   if (!toVersion) {
     throw new Error('When reverting migrations, you have to specify to which version to revert!')
   }
@@ -135,7 +144,7 @@ async function revert (path, toVersion, progressCb, isDryRun, migrations) {
     return
   }
 
-  if (currentVersion < toVersion){
+  if (currentVersion < toVersion) {
     log(`Current repo's version (${currentVersion} is lower then toVersion (${toVersion}), nothing to revert.`)
     return
   }
@@ -158,20 +167,20 @@ async function revert (path, toVersion, progressCb, isDryRun, migrations) {
         break
       }
 
-      if (migration.version <= currentVersion) {
-        counter++
-        log(`Reverting migration version ${migration.version}`)
-        if (!isDryRun) {
-          try {
-            await migration.revert(path, isBrowser)
-          } catch (e) {
-            e.message = `During reversion to version ${migration.version} exception was raised: ${e.message}`
-            throw e
-          }
-        }
-        typeof progressCb === 'function' && progressCb(migration, counter, totalMigrations) // Reports on migration process
-        log(`Reverting to version ${migration.version} finished`)
+      if (migration.version > currentVersion) {
+        continue
+      }
+
+      counter++
+      log(`Reverting migration version ${migration.version}`)
+      try {
+        if (!isDryRun) await migration.revert(path, isBrowser)
+      } catch (e) {
+        e.message = `During reversion to version ${migration.version} exception was raised: ${e.message}`
+        throw e
       }
+      typeof progressCb === 'function' && progressCb(migration, counter, totalMigrations) // Reports on migration process
+      log(`Reverting to version ${migration.version} finished`)
     }
 
     if (!isDryRun) await repoVersion.setVersion(path, toVersion)
@@ -199,17 +208,16 @@ function verifyReversibility (migrations, fromVersion, toVersion) {
       break
     }
 
-    if (migration.version >= toVersion) {
-      migrationCounter++
+    if (migration.version > toVersion) {
+      if (!migration.reversible) return { reversible: false, version: migration.version }
 
-      if (!migration.reversible)
-        return { reversible: false, version: migration.version }
+      migrationCounter++
     }
   }
 
-  if (migrationCounter !== (fromVersion - toVersion)){
-    throw new Error('There are missing migration to perform the reversion!')
+  if (migrationCounter !== (fromVersion - toVersion)) {
+    throw new Error(`There are missing migration to perform the reversion! ${migrationCounter}/${(fromVersion - toVersion)}`)
   }
 
-    return { reversible: true, version: undefined }
+  return { reversible: true, version: undefined }
 }

src/repo/init.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const Datastore = require('datastore-fs')
+const log = require('debug')('js-ipfs-repo-migrations:repo:init')
+
+const Key = require('interface-datastore').Key
+
+const versionKey = new Key('/version')
+const configKey = new Key('/config')
+
+exports.isRepoInitialized = async function isRepoInitialized (path) {
+  let root
+  try {
+    root = new Datastore(path, { extension: '', createIfMissing: false })
+
+    const versionCheck = await root.has(versionKey)
+    const configCheck = await root.has(configKey)
+    if (!versionCheck || !configCheck) {
+      log(`Version entry present: ${versionCheck}`)
+      log(`Config entry present: ${configCheck}`)
+      return false
+    }
+
+    return true
+  } catch (e) {
+    log('While checking if repo is initialized error was thrown: ' + e.message)
+    return false
+  } finally {
+    if (root !== undefined) await root.close()
+  }
+}

test/browser.js

@@ -25,4 +25,8 @@ describe('Browser specific tests', () => {
   describe('version tests', () => {
     require('./version-test')(repoSetup, repoCleanup)
   })
+
+  describe('init tests', () => {
+    require('./init-test')(repoSetup, repoCleanup)
+  })
 })

test/index.spec.js

@@ -5,12 +5,13 @@ const chai = require('chai')
 chai.use(require('dirty-chai'))
 const expect = chai.expect
 const sinon = require('sinon')
-const chaiAsPromised = require("chai-as-promised")
+const chaiAsPromised = require('chai-as-promised')
 chai.use(chaiAsPromised)
 
 const migrator = require('../src/index')
 const repoVersion = require('../src/repo/version')
 const repoLock = require('../src/repo/lock')
+const repoInit = require('../src/repo/init')
 
 function createMigrations () {
   return [
@@ -45,24 +46,31 @@ describe('index.js', () => {
   let getVersionStub
   let setVersionStub
   let lockStub
+  let initStub
   let lockCloseStub
 
   beforeEach(() => {
     // Reset all stubs
     sinon.reset()
 
+    initStub.resolves(true)
+    lockCloseStub.resolves()
+    lockStub.resolves({ close: lockCloseStub })
+  })
+
+  before(() => {
     getVersionStub = sinon.stub(repoVersion, 'getVersion')
     setVersionStub = sinon.stub(repoVersion, 'setVersion')
     lockCloseStub = sinon.stub()
-    lockCloseStub.resolves()
     lockStub = sinon.stub(repoLock, 'lock')
-    lockStub.resolves({ close: lockCloseStub })
+    initStub = sinon.stub(repoInit, 'isRepoInitialized')
   })
 
-  afterEach(() => {
+  after(() => {
     getVersionStub.restore()
     setVersionStub.restore()
     lockStub.restore()
+    initStub.restore()
   })
 
   it('get version of the latest migration', () => {
@@ -110,7 +118,7 @@ describe('index.js', () => {
       expect(lockStub.called).to.be.false()
     })
 
-    it('should not rever if current repo version is lower then toVersion', async () => {
+    it('should not revert if current repo version is lower then toVersion', async () => {
       getVersionStub.returns(2)
       const migrationsMock = createMigrations()
 
@@ -148,6 +156,46 @@ describe('index.js', () => {
       expect(migrationsMock[0].revert.called).to.be.false()
     })
 
+    it('should revert one migration as expected', async () => {
+      const migrationsMock = createMigrations()
+      getVersionStub.returns(2)
+
+      await expect(migrator.revert('/some/path', 1, undefined, undefined, migrationsMock))
+        .to.eventually.be.fulfilled()
+
+      expect(lockCloseStub.calledOnce).to.be.true()
+      expect(lockStub.calledOnce).to.be.true()
+      expect(setVersionStub.calledOnceWith('/some/path', 1)).to.be.true()
+
+      // Checking migrations
+      expect(migrationsMock[3].revert.called).to.be.false()
+      expect(migrationsMock[2].revert.called).to.be.false()
+      expect(migrationsMock[1].revert.calledOnce).to.be.true()
+      expect(migrationsMock[0].revert.called).to.be.false()
+    })
+
+    it('should reversion with one migration', async () => {
+      const migrationsMock = [
+        {
+          version: 2,
+          reversible: true,
+          migrate: sinon.stub().resolves(),
+          revert: sinon.stub().resolves()
+        }
+      ]
+      getVersionStub.returns(2)
+
+      await expect(migrator.revert('/some/path', 1, undefined, undefined, migrationsMock))
+        .to.eventually.be.fulfilled()
+
+      expect(lockCloseStub.calledOnce).to.be.true()
+      expect(lockStub.calledOnce).to.be.true()
+      expect(setVersionStub.calledOnceWith('/some/path', 1)).to.be.true()
+
+      // Checking migrations
+      expect(migrationsMock[0].revert.calledOnce).to.be.true()
+    })
+
     it('should not have any side-effects when in dry run', async () => {
       const migrationsMock = createMigrations()
       getVersionStub.returns(4)

test/init-test.js

@@ -0,0 +1,57 @@
+/* eslint-env mocha */
+'use strict'
+
+const chai = require('chai')
+chai.use(require('dirty-chai'))
+const expect = chai.expect
+
+const Datastore = require('datastore-fs')
+const Key = require('interface-datastore').Key
+const repoInit = require('../src/repo/init')
+
+module.exports = (setup, cleanup) => {
+  let dir
+
+  beforeEach(async () => {
+    dir = await setup()
+  })
+  afterEach(() =>
+    cleanup(dir)
+  )
+
+  it('should return true with valid initialized repo', async () => {
+    const versionKey = new Key('version')
+    const configKey = new Key('config')
+    const store = new Datastore(dir, { extension: '', createIfMissing: false })
+    await store.open()
+    await store.put(versionKey, Buffer.from('7'))
+    await store.put(configKey, '')
+    await store.close()
+
+    expect(await repoInit.isRepoInitialized(dir)).to.be.true()
+  })
+
+  it('should return false with missing version key', async () => {
+    const configKey = new Key('config')
+    const store = new Datastore(dir, { extension: '', createIfMissing: false })
+    await store.open()
+    await store.put(configKey, '')
+    await store.close()
+
+    expect( await repoInit.isRepoInitialized(dir)).to.be.false()
+  })
+
+  it('should return false with missing config key', async () => {
+    const versionKey = new Key('version')
+    const store = new Datastore(dir, { extension: '', createIfMissing: false })
+    await store.open()
+    await store.put(versionKey, '')
+    await store.close()
+
+    expect(await repoInit.isRepoInitialized(dir)).to.be.false()
+  })
+
+  it('should return false if the repo does not exists', async () => {
+    return expect(await repoInit.isRepoInitialized('/some/random/dirrr')).to.be.false()
+  })
+}

test/lock-test.js

@@ -12,7 +12,7 @@ module.exports = (locker, setup, cleanup) => {
   describe('version 7 and bellow', () => {
     let dir
 
-    beforeEach(async () => {dir = await setup()})
+    beforeEach(async () => { dir = await setup() })
     afterEach(() => cleanup(dir))
 
     it('should return lock object', async () => {

test/node.js

@@ -34,4 +34,8 @@ describe('Node specific tests', () => {
   describe('version tests', () => {
     require('./version-test')(repoSetup, repoCleanup)
   })
+
+  describe('init tests', () => {
+    require('./init-test')(repoSetup, repoCleanup)
+  })
 })

test/version-test.js

@@ -45,6 +45,5 @@ module.exports = (setup, cleanup) => {
       await version.setVersion(dir, 7)
       expect(await version.getVersion(dir)).to.be.equal(7)
     })
-
   })
 }