Skip to content

Commit

Permalink
varint support to enable all the protocol codes and tests, lots of tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@daviddias
daviddias committed Mar 12, 2016
1 parent 08d7508 commit f376bed
Show file tree
Hide file tree
Showing 4 changed files with 181 additions and 12 deletions.
1 change: 1 addition & 0 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
"ip": "^1.0.2",
"lodash.filter": "^4.2.1",
"lodash.map": "^4.2.1",
"varint": "^4.0.0",
"xtend": "^4.0.1"
},
"devDependencies": {
Expand Down
23 changes: 15 additions & 8 deletions src/codec.js
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
var map = require('lodash.map')
var filter = require('lodash.filter')
// var log = console.log
var convert = require('./convert')
var protocols = require('./protocols')
var varint = require('varint')

// export codec
module.exports = {
Expand Down Expand Up @@ -40,7 +40,8 @@ function stringToStringTuples (str) {
var part = parts[p]
var proto = protocols(part)
if (proto.size === 0) {
return [part]
tuples.push([part])
return tuples
}

p++ // advance addr part
Expand All @@ -63,12 +64,19 @@ function stringTuplesToString (tuples) {
parts.push(tup[1])
}
})
if (parts[parts.length - 1] === '') {
parts.pop()
}

return '/' + parts.join('/')
}

// [[str name, str addr]... ] -> [[int code, Buffer]... ]
function stringTuplesToTuples (tuples) {
return map(tuples, function (tup) {
if (!Array.isArray(tup)) {
tup = [tup]
}
var proto = protoFromTuple(tup)
if (tup.length > 1) {
return [proto.code, convert.toBuffer(proto.code, tup[1])]
Expand All @@ -92,7 +100,7 @@ function tuplesToStringTuples (tuples) {
function tuplesToBuffer (tuples) {
return fromBuffer(Buffer.concat(map(tuples, function (tup) {
var proto = protoFromTuple(tup)
var buf = new Buffer([proto.code])
var buf = new Buffer(varint.encode(proto.code))
if (tup.length > 1) {
buf = Buffer.concat([buf, tup[1]]) // add address buffer
}
Expand All @@ -104,14 +112,15 @@ function tuplesToBuffer (tuples) {
function bufferToTuples (buf) {
var tuples = []
for (var i = 0; i < buf.length;) {
var code = buf[i]
var code = varint.decode(buf, i)

var proto = protocols(code)
if (!proto) {
throw ParseError('Invalid protocol code: ' + code)
}

var size = (proto.size / 8)
code = 0 + buf[i]
code = Number(code)
var addr = buf.slice(i + 1, i + 1 + size)
i += 1 + size
if (i > buf.length) { // did not end _exactly_ at buffer.length
Expand All @@ -120,6 +129,7 @@ function bufferToTuples (buf) {

// ok, tuple seems good.
tuples.push([code, addr])
i = i + varint.decode.bytes - 1
}
return tuples
}
Expand Down Expand Up @@ -174,8 +184,5 @@ function ParseError (str) {

function protoFromTuple (tup) {
var proto = protocols(tup[0])
if (tup.length > 1 && proto.size === 0) {
throw ParseError('tuple has address but protocol size is 0')
}
return proto
}
10 changes: 6 additions & 4 deletions src/protocols.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,12 @@ Protocols.table = [
[17, 16, 'udp'],
[33, 16, 'dccp'],
[41, 128, 'ip6'],
// these require varint:
[132, 16, 'sctp']
// [480, 0, 'http'],
// [443, 0, 'https'],
[132, 16, 'sctp'],
// these require varint for the protocol code
[302, 0, 'utp'],
[480, 0, 'http'],
[443, 0, 'https'],
[477, 0, 'websockets']
]

Protocols.names = {}
Expand Down
159 changes: 159 additions & 0 deletions tests/test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,45 @@ describe('construction', (done) => {
})
})

describe('requiring varint', (done) => {
var uTPAddr

it('create multiaddr', (done) => {
uTPAddr = multiaddr('/ip4/127.0.0.1/udp/1234/utp')
expect(uTPAddr instanceof multiaddr).to.equal(true)
done()
})

it('clone multiaddr', (done) => {
const uTPAddrClone = multiaddr(uTPAddr)
expect(uTPAddrClone !== uTPAddr).to.equal(true)
done()
})

it('reconstruct with buffer', (done) => {
expect(multiaddr(uTPAddr.buffer).buffer === uTPAddr.buffer).to.equal(false)
expect(multiaddr(uTPAddr.buffer).buffer).to.deep.equal(uTPAddr.buffer)
done()
})

it('reconstruct with string', (done) => {
expect(multiaddr(uTPAddr.toString()).buffer === uTPAddr.buffer).to.equal(false)
expect(multiaddr(uTPAddr.toString()).buffer).to.deep.equal(uTPAddr.buffer)
done()
})

it('reconstruct with object', (done) => {
expect(multiaddr(uTPAddr).buffer === uTPAddr.buffer).to.equal(false)
expect(multiaddr(uTPAddr).buffer).to.deep.equal(uTPAddr.buffer)
done()
})

it('empty construct still works', (done) => {
expect(multiaddr('').toString()).to.equal('/')
done()
})
})

describe('manipulation', () => {
it('basic', (done) => {
const udpAddrStr = '/ip4/127.0.0.1/udp/1234'
Expand All @@ -67,3 +106,123 @@ describe('manipulation', () => {
done()
})
})

describe('variants', () => {
it('ip4', (done) => {
const str = '/ip4/127.0.0.1'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip6', (done) => {
const str = '/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip4 + tcp', (done) => {
const str = '/ip4/127.0.0.1/tcp/5000'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip6 + tcp', (done) => {
const str = '/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/5000'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip4 + udp', (done) => {
const str = '/ip4/127.0.0.1/udp/5000'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip6 + udp', (done) => {
const str = '/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/udp/5000'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it.skip('ip4 + dccp', (done) => {})
it.skip('ip6 + dccp', (done) => {})

it.skip('ip4 + sctp', (done) => {})
it.skip('ip6 + sctp', (done) => {})

it('ip4 + udp + utp', (done) => {
const str = '/ip4/127.0.0.1/udp/5000/utp'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip6 + udp + utp', (done) => {
const str = '/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/udp/5000/utp'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip4 + tcp + http', (done) => {
const str = '/ip4/127.0.0.1/tcp/8000/http'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip6 + tcp + http', (done) => {
const str = '/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/8000/http'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip4 + tcp + https', (done) => {
const str = '/ip4/127.0.0.1/tcp/8000/https'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip6 + tcp + https', (done) => {
const str = '/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/8000/https'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip4 + tcp + websockets', (done) => {
const str = '/ip4/127.0.0.1/tcp/8000/websockets'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})

it('ip6 + tcp + websockets', (done) => {
const str = '/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/8000/websockets'
const addr = multiaddr(str)
expect(addr).to.have.property('buffer')
expect(addr.toString()).to.equal(str)
done()
})
})

0 comments on commit f376bed

Please sign in to comment.