jackhadrill/ut_metadata
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

modernize test files

Browse Source
This commit is contained in:
Jimmy Wärting 2018-08-28 19:34:08 +02:00
parent 6a0f5aecbe
commit 4539a41dad
3 changed files with 109 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
index.js
View File

@ -4,9 +4,9 @@ const BitField = require('bitfield')
const debug = require('debug')('ut_metadata') const debug = require('debug')('ut_metadata')
const sha1 = require('simple-sha1') const sha1 = require('simple-sha1')
const MAX_METADATA_SIZE = 10000000 // 10MB const MAX_METADATA_SIZE = 1E7 // 10 MB
const BITFIELD_GROW = 1000 const BITFIELD_GROW = 1E3
const PIECE_LENGTH = 16 * 1024 const PIECE_LENGTH = 1 << 14 // 16 KiB
module.exports = metadata => { module.exports = metadata => {
class utMetadata extends EventEmitter { class utMetadata extends EventEmitter {
@ -15,14 +15,15 @@ module.exports = metadata => {
this._wire = wire this._wire = wire
this._fetching = false
this._metadataComplete = false this._metadataComplete = false
this._metadataSize = null this._metadataSize = null
this._remainingRejects = null // how many reject messages to tolerate before quitting // how many reject messages to tolerate before quitting
this._fetching = false this._remainingRejects = null
// The largest .torrent file that I know of is ~1-2MB, which is ~100 pieces. // The largest torrent file that I know of is ~1-2MB, which is ~100
// Therefore, cap the bitfield to 10x that (1000 pieces) so a malicious peer can't // pieces. Therefore, cap the bitfield to 10x that (1000 pieces) so a
// make it grow to fill all memory. // malicious peer can't make it grow to fill all memory.
this._bitfield = new BitField(0, { grow: BITFIELD_GROW }) this._bitfield = new BitField(0, { grow: BITFIELD_GROW })
if (Buffer.isBuffer(metadata)) { if (Buffer.isBuffer(metadata)) {
@ -134,7 +135,9 @@ module.exports = metadata => {
this._metadataSize = this.metadata.length this._metadataSize = this.metadata.length
this._wire.extendedHandshake.metadata_size = this._metadataSize this._wire.extendedHandshake.metadata_size = this._metadataSize
this.emit('metadata', bencode.encode({ info: bencode.decode(this.metadata) })) this.emit('metadata', bencode.encode({
info: bencode.decode(this.metadata)
}))
return true return true
} }
@ -188,7 +191,8 @@ module.exports = metadata => {
_onReject (piece) { _onReject (piece) {
if (this._remainingRejects > 0 && this._fetching) { if (this._remainingRejects > 0 && this._fetching) {
// If we haven't been rejected too much, then try to request the piece again // If we haven't been rejected too much,
// then try to request the piece again
this._request(piece) this._request(piece)
this._remainingRejects -= 1 this._remainingRejects -= 1
} else { } else {

25
test/basic.js
View File

@ -1,11 +1,11 @@
var bencode = require('bencode') const { leavesMetadata } = require('webtorrent-fixtures')
var fixtures = require('webtorrent-fixtures') const bencode = require('bencode')
var Protocol = require('bittorrent-protocol') const Protocol = require('bittorrent-protocol')
var test = require('tape') const test = require('tape')
var utMetadata = require('../') const utMetadata = require('../')
test('wire.use(utMetadata())', function (t) { test('wire.use(utMetadata())', t => {
var wire = new Protocol() const wire = new Protocol()
wire.pipe(wire) wire.pipe(wire)
wire.use(utMetadata()) wire.use(utMetadata())
@ -17,15 +17,18 @@ test('wire.use(utMetadata())', function (t) {
t.end() t.end()
}) })
test('wire.use(utMetadata(metadata))', function (t) { test('wire.use(utMetadata(metadata))', t => {
var wire = new Protocol() const wire = new Protocol()
wire.pipe(wire) wire.pipe(wire)
wire.use(utMetadata(fixtures.leavesMetadata.torrent)) wire.use(utMetadata(leavesMetadata.torrent))
t.ok(wire.ut_metadata) t.ok(wire.ut_metadata)
t.ok(wire.ut_metadata.fetch) t.ok(wire.ut_metadata.fetch)
t.ok(wire.ut_metadata.cancel) t.ok(wire.ut_metadata.cancel)
t.equal(wire.ut_metadata.metadata.toString('hex'), bencode.encode(bencode.decode(fixtures.leavesMetadata.torrent).info).toString('hex')) t.equal(
wire.ut_metadata.metadata.toString('hex'),
bencode.encode(bencode.decode(leavesMetadata.torrent).info).toString('hex')
)
t.end() t.end()
}) })

143
test/fetch.js
View File

@ -1,34 +1,39 @@
var bencode = require('bencode') const { leavesMetadata, sintel } = require('webtorrent-fixtures')
var fixtures = require('webtorrent-fixtures') const bencode = require('bencode')
var Protocol = require('bittorrent-protocol') const Protocol = require('bittorrent-protocol')
var test = require('tape') const test = require('tape')
var utMetadata = require('../') const utMetadata = require('../')
var id1 = Buffer.from('01234567890123456789') const id1 = Buffer.from('01234567890123456789')
var id2 = Buffer.from('12345678901234567890') const id2 = Buffer.from('12345678901234567890')
test('fetch()', function (t) { test('fetch()', t => {
t.plan(3) t.plan(3)
var wire1 = new Protocol() const wire1 = new Protocol()
var wire2 = new Protocol() const wire2 = new Protocol()
wire1.pipe(wire2).pipe(wire1) wire1.pipe(wire2).pipe(wire1)
wire1.use(utMetadata(fixtures.leavesMetadata.torrent)) // wire1 already has metadata wire1.use(utMetadata(leavesMetadata.torrent)) // wire1 already has metadata
wire2.use(utMetadata()) // wire2 does not wire2.use(utMetadata()) // wire2 does not
wire2.ut_metadata.fetch() wire2.ut_metadata.fetch()
wire2.ut_metadata.on('metadata', function (_metadata) { wire2.ut_metadata.on('metadata', _metadata => {
// got metadata! // got metadata!
t.equal(_metadata.toString('hex'), bencode.encode({ info: bencode.decode(fixtures.leavesMetadata.torrent).info }).toString('hex')) t.equal(
_metadata.toString('hex'),
bencode.encode({
info: bencode.decode(leavesMetadata.torrent).info
}).toString('hex')
)
}) })
wire2.on('handshake', function (infoHash, peerId, extensions) { wire2.on('handshake', (infoHash, peerId, extensions) => {
wire2.handshake(fixtures.leavesMetadata.parsedTorrent.infoHash, id2) wire2.handshake(leavesMetadata.parsedTorrent.infoHash, id2)
}) })
wire2.on('extended', function (ext) { wire2.on('extended', ext => {
if (ext === 'handshake') { if (ext === 'handshake') {
t.pass('got extended handshake') t.pass('got extended handshake')
} else if (ext === 'ut_metadata') { } else if (ext === 'ut_metadata') {
@ -41,14 +46,14 @@ test('fetch()', function (t) {
} }
}) })
wire1.handshake(fixtures.leavesMetadata.parsedTorrent.infoHash, id1) wire1.handshake(leavesMetadata.parsedTorrent.infoHash, id1)
}) })
test('fetch() from peer without metadata', function (t) { test('fetch() from peer without metadata', t => {
t.plan(2) t.plan(2)
var wire1 = new Protocol() const wire1 = new Protocol()
var wire2 = new Protocol() const wire2 = new Protocol()
wire1.pipe(wire2).pipe(wire1) wire1.pipe(wire2).pipe(wire1)
wire1.use(utMetadata()) // neither wire has metadata wire1.use(utMetadata()) // neither wire has metadata
@ -56,25 +61,25 @@ test('fetch() from peer without metadata', function (t) {
wire2.ut_metadata.fetch() wire2.ut_metadata.fetch()
wire2.ut_metadata.on('metadata', function () { wire2.ut_metadata.on('metadata', () => {
t.fail('No "metadata" event should fire') t.fail('No "metadata" event should fire')
}) })
wire1.ut_metadata.onMessage = function () { wire1.ut_metadata.onMessage = () => {
t.fail('No messages should be sent to wire1') t.fail('No messages should be sent to wire1')
// No messages should be sent because wire1 never sent metadata_size in the // No messages should be sent because wire1 never sent metadata_size
// extended handshake, so he doesn't have metadata // in the extended handshake, so he doesn't have metadata
} }
wire2.ut_metadata.on('warning', function () { wire2.ut_metadata.on('warning', () => {
t.pass('got warning about peer missing metadata') t.pass('got warning about peer missing metadata')
}) })
wire2.on('handshake', function (infoHash, peerId, extensions) { wire2.on('handshake', (infoHash, peerId, extensions) => {
wire2.handshake(fixtures.leavesMetadata.parsedTorrent.infoHash, id2) wire2.handshake(leavesMetadata.parsedTorrent.infoHash, id2)
}) })
wire2.on('extended', function (ext) { wire2.on('extended', ext => {
if (ext === 'handshake') { if (ext === 'handshake') {
t.pass('got extended handshake') t.pass('got extended handshake')
} else if (ext === 'ut_metadata') { } else if (ext === 'ut_metadata') {
@ -84,36 +89,44 @@ test('fetch() from peer without metadata', function (t) {
} }
}) })
wire1.handshake(fixtures.leavesMetadata.parsedTorrent.infoHash, id1) wire1.handshake(leavesMetadata.parsedTorrent.infoHash, id1)
}) })
test('fetch when peer gets metadata later (setMetadata)', function (t) { test('fetch when peer gets metadata later (setMetadata)', t => {
t.plan(3) t.plan(3)
var wire1 = new Protocol() const wire1 = new Protocol()
var wire2 = new Protocol() const wire2 = new Protocol()
wire1.pipe(wire2).pipe(wire1) wire1.pipe(wire2).pipe(wire1)
wire1.use(utMetadata()) // wire1 starts without metadata wire1.use(utMetadata()) // wire1 starts without metadata
process.nextTick(function () { process.nextTick(() => {
wire1.ut_metadata.setMetadata(fixtures.leavesMetadata.torrent) // wire1 gets metadata later // wire1 gets metadata later
wire1.ut_metadata.setMetadata(leavesMetadata.torrent)
process.nextTick(function () { process.nextTick(() => {
// wire2 does not start with metadata, but connects to wire1 after it gets metadata // wire2 does not start with metadata,
// but connects to wire1 after it gets metadata
wire2.use(utMetadata()) wire2.use(utMetadata())
wire2.ut_metadata.fetch() wire2.ut_metadata.fetch()
wire2.ut_metadata.on('metadata', function (_metadata) { wire2.ut_metadata.on('metadata', _metadata => {
// got metadata! // got metadata!
t.equal(_metadata.toString('hex'), bencode.encode({ info: bencode.decode(fixtures.leavesMetadata.torrent).info }).toString('hex')) t.equal(
_metadata.toString('hex'),
bencode.encode({
info: bencode.decode(leavesMetadata.torrent).info
}).toString('hex')
)
}) })
wire2.on('handshake', function (infoHash, peerId, extensions) { wire2.on('handshake', (infoHash, peerId, extensions) => {
wire2.handshake(fixtures.leavesMetadata.parsedTorrent.infoHash, id2) wire2.handshake(leavesMetadata.parsedTorrent.infoHash, id2)
}) })
wire2.on('extended', function (ext) { wire2.on('extended', ext => {
if (ext === 'handshake') { if (ext === 'handshake') {
t.pass('got extended handshake') t.pass('got extended handshake')
} else if (ext === 'ut_metadata') { } else if (ext === 'ut_metadata') {
@ -126,37 +139,43 @@ test('fetch when peer gets metadata later (setMetadata)', function (t) {
} }
}) })
wire1.handshake(fixtures.leavesMetadata.parsedTorrent.infoHash, id1) wire1.handshake(leavesMetadata.parsedTorrent.infoHash, id1)
}) })
}) })
}) })
test('fetch() large torrent', function (t) { test('fetch() large torrent', t => {
t.plan(4) t.plan(4)
var wire1 = new Protocol() const wire1 = new Protocol()
var wire2 = new Protocol() const wire2 = new Protocol()
wire1.pipe(wire2).pipe(wire1) wire1.pipe(wire2).pipe(wire1)
wire1.use(utMetadata(fixtures.sintel.torrent)) // wire1 already has metadata wire1.use(utMetadata(sintel.torrent)) // wire1 already has metadata
wire2.use(utMetadata()) // wire2 does not wire2.use(utMetadata()) // wire2 does not
wire2.ut_metadata.fetch() wire2.ut_metadata.fetch()
wire2.ut_metadata.on('metadata', function (_metadata) { wire2.ut_metadata.on('metadata', _metadata => {
// got metadata! // got metadata!
t.equal(_metadata.toString('hex'), bencode.encode({ info: bencode.decode(fixtures.sintel.torrent).info }).toString('hex')) t.equal(
_metadata.toString('hex'),
bencode.encode({
info: bencode.decode(sintel.torrent).info
}).toString('hex')
)
}) })
wire2.on('handshake', function (infoHash, peerId, extensions) { wire2.on('handshake', (infoHash, peerId, extensions) => {
wire2.handshake(fixtures.sintel.parsedTorrent.infoHash, id2) wire2.handshake(sintel.parsedTorrent.infoHash, id2)
}) })
wire2.on('extended', function (ext) { wire2.on('extended', ext => {
if (ext === 'handshake') { if (ext === 'handshake') {
t.pass('got extended handshake') t.pass('got extended handshake')
} else if (ext === 'ut_metadata') { } else if (ext === 'ut_metadata') {
// note: this should get called twice, once for each block of the sintel metadata // note: this should get called twice,
// once for each block of the sintel metadata
t.pass('got extended ut_metadata message') t.pass('got extended ut_metadata message')
// this is emitted for consistency's sake, but it's ignored // this is emitted for consistency's sake, but it's ignored
@ -167,17 +186,17 @@ test('fetch() large torrent', function (t) {
} }
}) })
wire1.handshake(fixtures.sintel.parsedTorrent.infoHash, id1) wire1.handshake(sintel.parsedTorrent.infoHash, id1)
}) })
test('discard invalid metadata', function (t) { test('discard invalid metadata', t => {
t.plan(1) t.plan(1)
var wire1 = new Protocol() const wire1 = new Protocol()
var wire2 = new Protocol() const wire2 = new Protocol()
wire1.pipe(wire2).pipe(wire1) wire1.pipe(wire2).pipe(wire1)
var invalidMetadata = fixtures.leavesMetadata.torrent.slice(0) const invalidMetadata = leavesMetadata.torrent.slice(0)
invalidMetadata[55] = 65 // mess up a byte in the info block invalidMetadata[55] = 65 // mess up a byte in the info block
wire1.use(utMetadata(invalidMetadata)) wire1.use(utMetadata(invalidMetadata))
@ -185,17 +204,17 @@ test('discard invalid metadata', function (t) {
wire2.ut_metadata.fetch() wire2.ut_metadata.fetch()
wire2.ut_metadata.on('metadata', function () { wire2.ut_metadata.on('metadata', () => {
t.fail('No "metadata" event should fire') t.fail('No "metadata" event should fire')
}) })
wire2.ut_metadata.on('warning', function () { wire2.ut_metadata.on('warning', () => {
t.pass('got warning because peer sent reject too much') t.pass('got warning because peer sent reject too much')
}) })
wire2.on('handshake', function (infoHash, peerId, extensions) { wire2.on('handshake', (infoHash, peerId, extensions) => {
wire2.handshake(fixtures.leavesMetadata.parsedTorrent.infoHash, id2) wire2.handshake(leavesMetadata.parsedTorrent.infoHash, id2)
}) })
wire1.handshake(fixtures.leavesMetadata.parsedTorrent.infoHash, id1) wire1.handshake(leavesMetadata.parsedTorrent.infoHash, id1)
}) })