Skip to content

gs1.1 peer score #83

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
wemeetagain merged 15 commits into from
Jun 17, 2020
Merged

gs1.1 peer score #83

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
cddee52
chore: add peer score machinery
wemeetagain Jun 3, 2020
55c3d0b
chore: increase test timeouts
wemeetagain Jun 4, 2020
37d7020
chore: tweak test timeouts
wemeetagain Jun 4, 2020
2293dc4
chore: split score params/thresholds files
wemeetagain Jun 7, 2020
98beab9
chore: default constructors score params/thresholds
wemeetagain Jun 7, 2020
88480ec
chore: fix peerScore test
wemeetagain Jun 7, 2020
a7d08a9
Apply suggestions from code review
wemeetagain Jun 8, 2020
3ccbfa8
chore: default params/thresholds as objects
wemeetagain Jun 8, 2020
53e7a0a
chore: add fn comments
wemeetagain Jun 8, 2020
2663dcb
chore: fix PeerScore#deliverMessage
wemeetagain Jun 8, 2020
eea879f
chore: tweak PeerScore start/stop
wemeetagain Jun 8, 2020
31224a6
chore: peerScore: use string instead of peer id
wemeetagain Jun 9, 2020
f17b2c6
chore: AddressBook => ConnectionManager
wemeetagain Jun 9, 2020
a6c4de4
chore: add err-code
wemeetagain Jun 16, 2020
7206a9d
chore: sync IP update, clear data on stop
wemeetagain Jun 16, 2020
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
Prev Previous commit
Next Next commit
chore: default constructors score params/thresholds
  • Loading branch information
@wemeetagain
wemeetagain committed Jun 7, 2020
commit 98beab9ce826bda78fd527d87c20eea309f6e29a
118 changes: 28 additions & 90 deletions test/peerScore.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ const { PeerScore, createPeerScoreParams, createTopicScoreParams } = require('..
const addrBook = new Map()
addrBook.getMultiaddrsForPeer = () => ([])

const makeTestMessage = (i) => {
const makeTestMessage = (i, topicIDs = []) => {
return {
seqno: Buffer.alloc(8, i),
data: Buffer.from([i]),
from: "test",
topicIDs: []
topicIDs
}
}

Expand All @@ -20,16 +20,13 @@ describe('PeerScore', () => {
// Create parameters with reasonable default values
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
topicScoreCap: 1000
})
const tparams = params.topics[mytopic] = createTopicScoreParams({
topicWeight: 0.5,
timeInMeshWeight: 1,
timeInMeshQuantum: 1,
timeInMeshCap: 3600,
invalidMessageDeliveriesDecay: 0.1,
})
const peerA = await PeerId.create({keyType: 'secp256k1'})
// Peer score should start at 0
Expand All @@ -54,9 +51,6 @@ describe('PeerScore', () => {
// Create parameters with reasonable default values
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
})
const tparams = params.topics[mytopic] = createTopicScoreParams({
topicWeight: 0.5,
Expand Down Expand Up @@ -91,34 +85,25 @@ describe('PeerScore', () => {
// Create parameters with reasonable default values
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
topicScoreCap: 1000
})
const tparams = params.topics[mytopic] = createTopicScoreParams({
topicWeight: 1,
firstMessageDeliveriesWeight: 1,
firstMessageDeliveriesDecay: 0.9,
invalidMessageDeliveriesDecay: 0.9,
firstMessageDeliveriesCap: 50000,
timeInMeshQuantum: 1000
timeInMeshWeight: 0
})
const peerA = await PeerId.create({keyType: 'secp256k1'})
// Peer score should start at 0
const ps = new PeerScore(params, addrBook, (msg) => utils.msgId(msg.from, msg.seqno))
ps.addPeer(peerA)

let aScore = ps.score(peerA)
expect(aScore, 'expected score to start at zero').to.equal(0)

// The time in mesh depends on how long the peer has been grafted
ps.graft(peerA, mytopic)

// deliver a bunch of messages from peer A
const nMessages = 100
for (let i = 0; i < nMessages; i++) {
const msg = makeTestMessage(i)
msg.topicIDs = [mytopic]
const msg = makeTestMessage(i, [mytopic])
ps.validateMessage(peerA, msg)
ps.deliverMessage(peerA, msg)
}
Expand All @@ -133,17 +118,15 @@ describe('PeerScore', () => {
// Create parameters with reasonable default values
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
topicScoreCap: 1000
})
const tparams = params.topics[mytopic] = createTopicScoreParams({
topicWeight: 1,
firstMessageDeliveriesWeight: 1,
firstMessageDeliveriesDecay: 0.9,
invalidMessageDeliveriesDecay: 0.9,
firstMessageDeliveriesCap: 50,
timeInMeshQuantum: 1000
timeInMeshWeight: 0
})
const peerA = await PeerId.create({keyType: 'secp256k1'})
// Peer score should start at 0
Expand All @@ -159,8 +142,7 @@ describe('PeerScore', () => {
// deliver a bunch of messages from peer A
const nMessages = 100
for (let i = 0; i < nMessages; i++) {
const msg = makeTestMessage(i)
msg.topicIDs = [mytopic]
const msg = makeTestMessage(i, [mytopic])
ps.validateMessage(peerA, msg)
ps.deliverMessage(peerA, msg)
}
Expand All @@ -175,17 +157,15 @@ describe('PeerScore', () => {
// Create parameters with reasonable default values
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
topicScoreCap: 1000
})
const tparams = params.topics[mytopic] = createTopicScoreParams({
topicWeight: 1,
firstMessageDeliveriesWeight: 1,
firstMessageDeliveriesDecay: 0.9, // decay 10% per decay interval
invalidMessageDeliveriesDecay: 0.9,
firstMessageDeliveriesCap: 50,
timeInMeshQuantum: 1000
timeInMeshWeight: 0
})
const peerA = await PeerId.create({keyType: 'secp256k1'})
// Peer score should start at 0
Expand All @@ -201,8 +181,7 @@ describe('PeerScore', () => {
// deliver a bunch of messages from peer A
const nMessages = 100
for (let i = 0; i < nMessages; i++) {
const msg = makeTestMessage(i)
msg.topicIDs = [mytopic]
const msg = makeTestMessage(i, [mytopic])
ps.validateMessage(peerA, msg)
ps.deliverMessage(peerA, msg)
}
Expand All @@ -226,9 +205,6 @@ describe('PeerScore', () => {
// Create parameters with reasonable default values
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
})
const tparams = params.topics[mytopic] = createTopicScoreParams({
topicWeight: 1,
Expand All @@ -240,7 +216,7 @@ describe('PeerScore', () => {
meshMessageDeliveriesDecay: 0.9,
invalidMessageDeliveriesDecay: 0.9,
firstMessageDeliveriesWeight: 0,
timeInMeshQuantum: 1000
timeInMeshWeight: 0
})
// peer A always delivers the message first
// peer B delivers next (within the delivery window)
Expand Down Expand Up @@ -273,8 +249,7 @@ describe('PeerScore', () => {
// deliver a bunch of messages from peers
const nMessages = 100
for (let i = 0; i < nMessages; i++) {
const msg = makeTestMessage(i)
msg.topicIDs = [mytopic]
const msg = makeTestMessage(i, [mytopic])

ps.validateMessage(peerA, msg)
ps.deliverMessage(peerA, msg)
Expand Down Expand Up @@ -303,9 +278,6 @@ describe('PeerScore', () => {
// Create parameters with reasonable default values
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
})
const tparams = params.topics[mytopic] = createTopicScoreParams({
topicWeight: 1,
Expand All @@ -317,7 +289,7 @@ describe('PeerScore', () => {
meshMessageDeliveriesDecay: 0.9,
invalidMessageDeliveriesDecay: 0.9,
firstMessageDeliveriesWeight: 0,
timeInMeshQuantum: 1000
timeInMeshWeight: 0
})
const peerA = await PeerId.create({keyType: 'secp256k1'})
// Peer score should start at 0
Expand All @@ -331,9 +303,7 @@ describe('PeerScore', () => {
// deliver a bunch of messages from peer A
const nMessages = 40
for (let i = 0; i < nMessages; i++) {
const msg = makeTestMessage(i)
msg.topicIDs = [mytopic]

const msg = makeTestMessage(i, [mytopic])
ps.validateMessage(peerA, msg)
ps.deliverMessage(peerA, msg)
}
Expand All @@ -359,9 +329,6 @@ describe('PeerScore', () => {
// Create parameters with reasonable default values
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
})
// the mesh failure penalty is applied when a peer is pruned while their
// mesh deliveries are under the threshold.
Expand All @@ -380,15 +347,14 @@ describe('PeerScore', () => {
meshMessageDeliveriesCap: 100,
meshMessageDeliveriesDecay: 0.9,

invalidMessageDeliveriesDecay: 0.9,
firstMessageDeliveriesWeight: 0,
timeInMeshQuantum: 1000
timeInMeshWeight: 0
})
const peerA = await PeerId.create({keyType: 'secp256k1'})
const peerB = await PeerId.create({keyType: 'secp256k1'})
const peers = [peerA, peerB]
// Peer score should start at 0
const ps = new PeerScore(params, addrBook, (msg) => utils.msgId(msg.from, msg.seqno))

peers.forEach(p => {
ps.addPeer(p)
ps.graft(p, mytopic)
Expand All @@ -400,9 +366,7 @@ describe('PeerScore', () => {
// deliver a bunch of messages from peer A. peer B does nothing
const nMessages = 100
for (let i = 0; i < nMessages; i++) {
const msg = makeTestMessage(i)
msg.topicIDs = [mytopic]

const msg = makeTestMessage(i, [mytopic])
ps.validateMessage(peerA, msg)
ps.deliverMessage(peerA, msg)
}
Expand Down Expand Up @@ -430,15 +394,12 @@ describe('PeerScore', () => {
// Create parameters with reasonable default values
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
})
const tparams = params.topics[mytopic] = createTopicScoreParams({
topicWeight: 1,
invalidMessageDeliveriesWeight: -1,
invalidMessageDeliveriesDecay: 0.9,
timeInMeshQuantum: 1000
timeInMeshWeight: 0
})
const peerA = await PeerId.create({keyType: 'secp256k1'})
const ps = new PeerScore(params, addrBook, (msg) => utils.msgId(msg.from, msg.seqno))
Expand All @@ -448,9 +409,7 @@ describe('PeerScore', () => {
// deliver a bunch of messages from peer A
const nMessages = 100
for (let i = 0; i < nMessages; i++) {
const msg = makeTestMessage(i)
msg.topicIDs = [mytopic]

const msg = makeTestMessage(i, [mytopic])
ps.rejectMessage(peerA, msg)
}
ps._refreshScores()
Expand All @@ -463,15 +422,12 @@ describe('PeerScore', () => {
// Create parameters with reasonable default values
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
})
const tparams = params.topics[mytopic] = createTopicScoreParams({
topicWeight: 1,
invalidMessageDeliveriesWeight: -1,
invalidMessageDeliveriesDecay: 0.9,
timeInMeshQuantum: 1000
timeInMeshWeight: 0
})
const peerA = await PeerId.create({keyType: 'secp256k1'})
const ps = new PeerScore(params, addrBook, (msg) => utils.msgId(msg.from, msg.seqno))
Expand All @@ -481,9 +437,7 @@ describe('PeerScore', () => {
// deliver a bunch of messages from peer A
const nMessages = 100
for (let i = 0; i < nMessages; i++) {
const msg = makeTestMessage(i)
msg.topicIDs = [mytopic]

const msg = makeTestMessage(i, [mytopic])
ps.rejectMessage(peerA, msg)
}
ps._refreshScores()
Expand All @@ -504,9 +458,6 @@ describe('PeerScore', () => {
// this test adds coverage for the dark corners of message rejection
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
})
const tparams = params.topics[mytopic] = createTopicScoreParams({
topicWeight: 1,
Expand All @@ -520,8 +471,7 @@ describe('PeerScore', () => {
ps.addPeer(peerA)
ps.addPeer(peerB)

const msg = makeTestMessage(0)
msg.topicIDs = [mytopic]
const msg = makeTestMessage(0, [mytopic])

// insert a record
ps.validateMessage(peerA, msg)
Expand Down Expand Up @@ -576,11 +526,8 @@ describe('PeerScore', () => {
const mytopic = 'mytopic'
let appScoreValue = 0
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
appSpecificScore: () => appScoreValue,
appSpecificWeight: 0.5,
decayToZero: 0.1
appSpecificWeight: 0.5
})
const peerA = await PeerId.create({keyType: 'secp256k1'})
const ps = new PeerScore(params, addrBook, (msg) => utils.msgId(msg.from, msg.seqno))
Expand All @@ -598,11 +545,8 @@ describe('PeerScore', () => {
it('should score w/ IP colocation', async function () {
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
invalidMessageDeliveriesDecay: 0.1,
IPColocationFactorThreshold: 1,
IPColocationFactorWeight: -1,
decayToZero: 0.1
IPColocationFactorWeight: -1
})
const peerA = await PeerId.create({keyType: 'secp256k1'})
const peerB = await PeerId.create({keyType: 'secp256k1'})
Expand Down Expand Up @@ -645,11 +589,8 @@ describe('PeerScore', () => {
})
it('should score w/ behavior penalty', async function () {
const params = createPeerScoreParams({
decayInterval: 1000,
behaviourPenaltyWeight: -1,
behaviourPenaltyDecay: 0.99,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1
behaviourPenaltyDecay: 0.99
})
const peerA = await PeerId.create({keyType: 'secp256k1'})

Expand Down Expand Up @@ -682,12 +623,9 @@ describe('PeerScore', () => {
it('should handle score retention', async function () {
const mytopic = 'mytopic'
const params = createPeerScoreParams({
decayInterval: 1000,
appSpecificScore: () => -1000,
appSpecificWeight: 1,
invalidMessageDeliveriesDecay: 0.1,
decayToZero: 0.1,
retainScore: 800,
retainScore: 800
})
const peerA = await PeerId.create({keyType: 'secp256k1'})

Expand Down
Loading