-
Notifications
You must be signed in to change notification settings - Fork 443
/
tracked-list.ts
92 lines (76 loc) · 1.85 KB
/
tracked-list.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
import { PeerList } from './list.js'
import type { Metric, Metrics, PeerId } from '@libp2p/interface'
export interface TrackedPeerListInit {
name: string
metrics: Metrics
}
class TrackedPeerList extends PeerList {
private readonly metric: Metric
constructor (init: TrackedPeerListInit) {
super()
const { name, metrics } = init
this.metric = metrics.registerMetric(name)
this.updateComponentMetric()
}
pop (): PeerId | undefined {
const peerId = super.pop()
this.updateComponentMetric()
return peerId
}
push (...peerIds: PeerId[]): void {
super.push(...peerIds)
this.updateComponentMetric()
}
shift (): PeerId | undefined {
const peerId = super.shift()
this.updateComponentMetric()
return peerId
}
unshift (...peerIds: PeerId[]): number {
const result = super.unshift(...peerIds)
this.updateComponentMetric()
return result
}
clear (): void {
super.clear()
this.updateComponentMetric()
}
private updateComponentMetric (): void {
this.metric.update(this.length)
}
}
export interface CreateTrackedPeerListInit {
/**
* The metric name to use
*/
name: string
/**
* A metrics implementation
*/
metrics?: Metrics
}
/**
* Creates a PeerList that reports it's size to the libp2p Metrics service
*
* @example
*
* * ```Typescript
* import { trackedPeerList } from '@libp2p/peer-collections'
* import { createLibp2p } from 'libp2p'
*
* const libp2p = await createLibp2p()
*
* const list = trackedPeerList({ name: 'my_metric_name', metrics: libp2p.metrics })
* list.push(peerId)
* ```
*/
export function trackedPeerList (config: CreateTrackedPeerListInit): PeerList {
const { name, metrics } = config
let map: PeerList
if (metrics != null) {
map = new TrackedPeerList({ name, metrics })
} else {
map = new PeerList()
}
return map
}