Skip to content
This repository has been archived by the owner on Mar 10, 2020. It is now read-only.

Commit

Permalink
fix: code review
Browse files Browse the repository at this point in the history
  • Loading branch information
@vasco-santos
vasco-santos committed Jul 21, 2018
1 parent a94d80b commit 441a3f7
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 93 deletions.
87 changes: 47 additions & 40 deletions js/src/name/publish.js
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/* eslint-env mocha */
'use strict'

const each = require('async/each')
const hat = require('hat')

const { fixtures } = require('./utils')
const { fixture } = require('./utils')
const { spawnNodeWithId } = require('../utils/spawn')
const { getDescribe, getIt, expect } = require('../utils/mocha')

module.exports = (createCommon, options) => {
Expand All @@ -13,83 +13,90 @@ module.exports = (createCommon, options) => {
const common = createCommon()

describe('.name.publish', function () {
this.timeout(50 * 1000)

const keyName = hat()
let ipfs
let nodeId
let keyId

before(function (done) {
before(function(done) {
// CI takes longer to instantiate the daemon, so we need to increase the
// timeout for the before step
this.timeout(60 * 1000)

common.setup((err, factory) => {
expect(err).to.not.exist()

factory.spawnNode((err, node) => {
spawnNodeWithId(factory, (err, node) => {
expect(err).to.not.exist()

ipfs = node
ipfs.id().then((res) => {
expect(res.id).to.exist()

nodeId = res.id
nodeId = node.peerId.id

ipfs.key.gen(keyName, { type: 'rsa', size: 2048 }, (err, key) => {
expect(err).to.not.exist()
expect(key).to.exist()
expect(key).to.have.property('name', keyName)
expect(key).to.have.property('id')

keyId = key.id
populate()
})
})
ipfs.files.add(fixture.data, { pin: false }, done)
})
})

function populate () {
each(fixtures.files, (file, cb) => {
ipfs.files.add(file.data, { pin: false }, cb)
}, done)
}
})

after((done) => common.teardown(done))

it('name publish should publish correctly', (done) => {
const value = fixtures.files[0].cid
it('should publish an IPNS record with the default params', (done) => {
this.timeout(50 * 1000)

const value = fixture.cid

ipfs.name.publish(value, true, '1m', '10s', 'self', (err, res) => {
ipfs.name.publish(value, (err, res) => {
expect(err).to.not.exist()
expect(res).to.exist()
expect(res).to.equal(nodeId)
expect(res.Name).to.equal(nodeId)
expect(res.Value).to.equal(`/ipfs/${value}`)

done()
})
})

it('name publish should publish correctly when the file was not added but resolve is disabled', (done) => {
it('should publish correctly when the file was not added but resolve is disabled', (done) => {
this.timeout(50 * 1000)

const value = 'QmPFVLPmp9zv5Z5KUqLhe2EivAGccQW2r7M7jhVJGLZoZU'

ipfs.name.publish(value, false, '1m', '10s', 'self', (err, res) => {
const options = {
resolve: false,
lifetime: '1m',
ttl: '10s',
key: 'self',
}

ipfs.name.publish(value, options, (err, res) => {
expect(err).to.not.exist()
expect(res).to.exist()
expect(res).to.equal(nodeId)
expect(res.Name).to.equal(nodeId)
expect(res.Value).to.equal(`/ipfs/${value}`)

done()
})
})

it('name publish should publish correctly when a new key is used', (done) => {
const value = fixtures.files[0].cid
it('should recursively resolve to an IPFS hash', (done) => {
this.timeout(90 * 1000)

const value = fixture.cid
const options = {
resolve: false,
lifetime: '24h',
ttl: '10s',
key: keyName,
}

ipfs.name.publish(value, false, '24h', '10s', keyName, (err, res) => {
ipfs.key.gen(keyName, { type: 'rsa', size: 2048 }, (err, key) => {
expect(err).to.not.exist()
expect(res).to.exist()
expect(res).to.equal(keyId)

done()
ipfs.name.publish(value, options, (err, res) => {
expect(err).to.not.exist()
expect(res).to.exist()
expect(res.Name).to.equal(key.id)
expect(res.Value).to.equal(`/ipfs/${value}`)

done()
})
})
})
})
Expand Down
101 changes: 56 additions & 45 deletions js/src/name/resolve.js
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/* eslint-env mocha */
'use strict'

const each = require('async/each')
const hat = require('hat')

const { fixtures } = require('./utils')
const { fixture } = require('./utils')
const { spawnNodeWithId } = require('../utils/spawn')
const { getDescribe, getIt, expect } = require('../utils/mocha')

module.exports = (createCommon, options) => {
Expand All @@ -13,80 +13,68 @@ module.exports = (createCommon, options) => {
const common = createCommon()

describe('.name.resolve', function () {
this.timeout(50 * 1000)

const keyName = hat()
let ipfs
let nodeId
let keyId

before(function (done) {
// CI takes longer to instantiate the daemon, so we need to increase the
// timeout for the before step
this.timeout(60 * 1000)

common.setup((err, factory) => {
expect(err).to.not.exist()

factory.spawnNode((err, node) => {
spawnNodeWithId(factory, (err, node) => {
expect(err).to.not.exist()

ipfs = node
ipfs.id().then((res) => {
expect(res.id).to.exist()

nodeId = res.id

ipfs.key.gen(keyName, { type: 'rsa', size: 2048 }, (err, key) => {
expect(err).to.not.exist()
expect(key).to.exist()
expect(key).to.have.property('name', keyName)
expect(key).to.have.property('id')
nodeId = node.peerId.id

keyId = key.id
populate()
})
})
ipfs.files.add(fixture.data, { pin: false }, done)
})
})

function populate () {
each(fixtures.files, (file, cb) => {
ipfs.files.add(file.data, { pin: false }, cb)
}, done)
}
})

after((done) => common.teardown(done))

it('name resolve should resolve correctly after a publish', (done) => {
this.timeout(60 * 1000)
it('should resolve a record with the default params after a publish', (done) => {
this.timeout(50 * 1000)

const value = fixtures.files[0].cid
const value = fixture.cid

ipfs.name.publish(value, true, '1m', '10s', 'self', (err, res) => {
ipfs.name.publish(value, (err, res) => {
expect(err).to.not.exist()
expect(res).to.exist()

ipfs.name.resolve(nodeId, false, false, (err, res) => {
ipfs.name.resolve(nodeId, (err, res) => {
expect(err).to.not.exist()
expect(res).to.exist()
expect(res).to.equal(`/ipfs/${value}`)
expect(res.Path).to.equal(`/ipfs/${value}`)

done()
})
})
})

it('name resolve should not get the entry correctly if its validity time expired', (done) => {
this.timeout(60 * 1000)
it('should not get the entry if its validity time expired', (done) => {
this.timeout(50 * 1000)

const value = fixtures.files[0].cid
const value = fixture.cid
const publishOptions = {
resolve: true,
lifetime: '1ms',
ttl: '10s',
key: 'self'
}

ipfs.name.publish(value, true, '10ns', '10s', 'self', (err, res) => {
ipfs.name.publish(value, publishOptions, (err, res) => {
expect(err).to.not.exist()
expect(res).to.exist()

setTimeout(function () {
ipfs.name.resolve(nodeId, false, false, (err, res) => {
ipfs.name.resolve(nodeId, (err, res) => {
expect(err).to.exist()
expect(res).to.not.exist()

Expand All @@ -96,25 +84,48 @@ module.exports = (createCommon, options) => {
})
})

it('name resolve should should go recursively until finding an ipfs hash', (done) => {
this.timeout(60 * 1000)
it('should recursively resolve to an IPFS hash', (done) => {
this.timeout(100 * 1000)

const value = fixtures.files[0].cid
const value = fixture.cid
const publishOptions = {
resolve: true,
lifetime: '24h',
ttl: '10s',
key: 'self'
}

ipfs.name.publish(value, true, '24h', '10s', 'self', (err, res) => {
// Generate new key
ipfs.key.gen(keyName, { type: 'rsa', size: 2048 }, (err, key) => {
expect(err).to.not.exist()
expect(res).to.exist()

ipfs.name.publish(`/ipns/${nodeId}`, true, '24h', '10s', keyName, (err, res) => {
keyId = key.id

// publish ipfs
ipfs.name.publish(value, publishOptions, (err, res) => {
expect(err).to.not.exist()
expect(res).to.exist()

ipfs.name.resolve(keyId, false, true, (err, res) => {
publishOptions.key = keyName

// publish ipns with the generated key
ipfs.name.publish(`/ipns/${nodeId}`, publishOptions, (err, res) => {
expect(err).to.not.exist()
expect(res).to.exist()
expect(res).to.equal(`/ipfs/${value}`)

done()
const resolveOptions = {
nocache: false,
recursive: true
}

// recursive resolve (will get ipns first, and will resolve again to find the ipfs)
ipfs.name.resolve(keyId, resolveOptions, (err, res) => {
expect(err).to.not.exist()
expect(res).to.exist()
expect(res.Path).to.equal(`/ipfs/${value}`)

done()
})
})
})
})
Expand Down
11 changes: 3 additions & 8 deletions js/src/name/utils.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@

const loadFixture = require('aegir/fixtures')

exports.fixtures = Object.freeze({
files: Object.freeze([Object.freeze({
data: loadFixture('js/test/fixtures/testfile.txt', 'interface-ipfs-core'),
cid: 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP'
}), Object.freeze({
data: loadFixture('js/test/fixtures/test-folder/files/hello.txt', 'interface-ipfs-core'),
cid: 'QmY9cxiHqTFoWamkQVkpmmqzBrY3hCBEL2XNu3NtX74Fuu'
})])
exports.fixture = Object.freeze({
data: loadFixture('js/test/fixtures/testfile.txt', 'interface-ipfs-core'),
cid: 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP'
})

0 comments on commit 441a3f7

Please sign in to comment.