Skip to content

Commit

Permalink
feat: add isInitialized method
Browse files Browse the repository at this point in the history
A few places need ot know whether or not a repo has been initialized
and do so by a variety of methods - checking whether certain files
exist, etc.

This PR adds an `isInitialized()` method to the ipfs repo class to
take some of this guesswork away as the repo will know if it's been
initialized.
  • Loading branch information
achingbrain committed Feb 9, 2020
1 parent ddb2f46 commit 0c016c5
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,10 @@ Get a value at the root of the repo.

[Blocks](https://github.com/ipfs/js-ipfs-block#readme):

#### `Promise<Boolean> repo.isInitialized ()`

The returned promise resolves to `false` if the repo has not been initialized and `true` if it has.

#### `Promise repo.blocks.put (block:Block)`

* `block` should be of type [Block](https://github.com/ipfs/js-ipfs-block#readme).
Expand Down
16 changes: 16 additions & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,22 @@ class IpfsRepo {
await this.version.set(constants.repoVersion)
}

/**
* Check if the repo is already initialized.
* @returns {Promise<Boolean>}
*/
async isInitialized () {
try {
await this._openRoot()
await this._checkInitialized()
// necessary? await this.root.close()

return true
} catch (err) {
return false
}
}

/**
* Open the repo. If the repo is already open an error will be thrown.
* If the repo is not initialized it will throw an error.
Expand Down
1 change: 1 addition & 0 deletions test/browser.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ describe('IPFS Repo Tests on the Browser', () => {
require('./config-test')(repo)
require('./api-addr-test')(repo)
require('./lock-test')(repo)
require('./is-initialized')
})
28 changes: 28 additions & 0 deletions test/is-initialized.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/* eslint max-nested-callbacks: ["error", 8] */
/* eslint-env mocha */
'use strict'

const chai = require('chai')
chai.use(require('dirty-chai'))
const expect = chai.expect
const os = require('os')
const path = require('path')
const IPFSRepo = require('../src')

describe('isInitialized', () => {
let repo

beforeEach(() => {
const repoPath = path.join(os.tmpdir(), 'test-repo-for-' + Math.random())
repo = new IPFSRepo(repoPath)
})

it('should be false before initialization', async () => {
expect(await repo.isInitialized()).to.be.false()
})

it('should be true after initialization', async () => {
await repo.init({})
expect(await repo.isInitialized()).to.be.true()
})
})
1 change: 1 addition & 0 deletions test/node.js
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ describe('IPFS Repo Tests onNode.js', () => {
if (!r.init) {
require('./interop-test')(repo)
}
require('./is-initialized')
}))

require('./blockstore-utils-test')()
Expand Down

0 comments on commit 0c016c5

Please sign in to comment.