Skip to content

BREAKING: change how the filter function works #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
feross merged 1 commit into from
Mar 2, 2017
Merged

BREAKING: change how the filter function works #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,14 @@ var server = new Server({
// This example only allows one torrent.

var allowed = (infoHash === 'aaa67059ed6bd08362da625b3ae77f6f4a075aaa')
cb(allowed)

// In addition to returning a boolean (`true` for allowed, `false` for disallowed),
// you can return an `Error` object to disallow and provide a custom reason.
if (allowed) {
// If the callback is passed `null`, the torrent will be allowed.
cb(null)
} else {
// If the callback is passed an `Error` object, the torrent will be disallowed
// and the error's `message` property will be given as the reason.
cb(new Error('disallowed torrent'))
}
}
})

Expand Down
9 changes: 4 additions & 5 deletions server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -661,11 +661,10 @@ Server.prototype._onAnnounce = function (params, cb) {

function createSwarm () {
if (self._filter) {
self._filter(params.info_hash, params, function (allowed) {
if (allowed instanceof Error) {
cb(allowed)
} else if (!allowed) {
cb(new Error('disallowed info_hash'))
self._filter(params.info_hash, params, function (err) {
// Precense of err means that this info_hash is disallowed
if (err) {
cb(err)
} else {
self.createSwarm(params.info_hash, function (err, swarm) {
if (err) return cb(err)
Expand Down
17 changes: 12 additions & 5 deletions test/filter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ function testFilterOption (t, serverType) {
var opts = { serverType: serverType } // this is test-suite-only option
opts.filter = function (infoHash, params, cb) {
process.nextTick(function () {
cb(infoHash !== fixtures.alice.parsedTorrent.infoHash)
if (infoHash === fixtures.alice.parsedTorrent.infoHash) {
cb(new Error('disallowed info_hash (Alice)'))
} else {
cb(null)
}
})
}

Expand All @@ -29,7 +33,7 @@ function testFilterOption (t, serverType) {
if (serverType === 'ws') common.mockWebsocketTracker(client1)

client1.once('warning', function (err) {
t.ok(/disallowed info_hash/.test(err.message), 'got client warning')
t.ok(err.message.includes('disallowed info_hash (Alice)'), 'got client warning')

client1.destroy(function () {
t.pass('client1 destroyed')
Expand Down Expand Up @@ -62,7 +66,7 @@ function testFilterOption (t, serverType) {

server.removeAllListeners('warning')
server.once('warning', function (err) {
t.ok(/disallowed info_hash/.test(err.message), 'got server warning')
t.ok(err.message.includes('disallowed info_hash (Alice)'), 'got server warning')
t.equal(Object.keys(server.torrents).length, 0)
})

Expand All @@ -88,8 +92,11 @@ function testFilterCustomError (t, serverType) {
var opts = { serverType: serverType } // this is test-suite-only option
opts.filter = function (infoHash, params, cb) {
process.nextTick(function () {
if (infoHash === fixtures.alice.parsedTorrent.infoHash) cb(new Error('alice blocked'))
else cb(true)
if (infoHash === fixtures.alice.parsedTorrent.infoHash) {
cb(new Error('alice blocked'))
} else {
cb(null)
}
})
}

Expand Down