Skip to content

Commit f86328c

Browse files
maschadmaschad
authored
chore: upgrade aegir to 38.1.2 (#182)
1 parent ff42363 commit f86328c

10 files changed

+71
-67
lines changed

‎package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -143,14 +143,14 @@
143143
"@libp2p/peer-id": "^2.0.0",
144144
"@multiformats/multiaddr": "^11.0.0",
145145
"@types/multicast-dns": "^7.2.1",
146-
"multicast-dns": "^7.2.0",
147-
"multiformats": "^11.0.0"
146+
"dns-packet": "^5.4.0",
147+
"multicast-dns": "^7.2.0"
148148
},
149149
"devDependencies": {
150150
"@libp2p/interface-address-manager": "^2.0.0",
151151
"@libp2p/interface-peer-discovery-compliance-tests": "^2.0.0",
152152
"@libp2p/peer-id-factory": "^2.0.0",
153-
"aegir": "^37.9.1",
153+
"aegir": "^38.1.2",
154154
"delay": "^5.0.0",
155155
"p-defer": "^4.0.0",
156156
"p-wait-for": "^5.0.0",

‎src/compat/index.ts

+6-8
Original file line numberDiff line numberDiff line change
@@ -37,28 +37,26 @@ export class GoMulticastDNS extends EventEmitter<PeerDiscoveryEvents> implements
3737
return true
3838
}
3939

40-
get [Symbol.toStringTag] () {
40+
get [Symbol.toStringTag] (): '@libp2p/go-mdns' {
4141
return '@libp2p/go-mdns'
4242
}
4343

44-
isStarted () {
44+
isStarted (): boolean {
4545
return this._started
4646
}
4747

48-
async start () {
48+
async start (): Promise<void> {
4949
if (this.isStarted()) {
5050
return
5151
}
5252

5353
this._started = true
5454

55-
await Promise.all([
56-
this._responder.start(),
57-
this._querier.start()
58-
])
55+
await this._responder.start()
56+
await this._querier.start()
5957
}
6058

61-
async stop () {
59+
async stop (): Promise<void> {
6260
if (!this.isStarted()) {
6361
return
6462
}

‎src/compat/querier.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ export class Querier extends EventEmitter<PeerDiscoveryEvents> implements PeerDi
5353
return true
5454
}
5555

56-
get [Symbol.toStringTag] () {
56+
get [Symbol.toStringTag] (): '@libp2p/go-mdns-querier' {
5757
return '@libp2p/go-mdns-querier'
5858
}
5959

60-
isStarted () {
60+
isStarted (): boolean {
6161
return Boolean(this._handle)
6262
}
6363

64-
start () {
64+
async start (): Promise<void> {
6565
this._handle = periodically(() => {
6666
// Create a querier that queries multicast but gets responses unicast
6767
const mdns = MDNS({ multicast: false, interface: '0.0.0.0', port: 0 })
@@ -84,7 +84,7 @@ export class Querier extends EventEmitter<PeerDiscoveryEvents> implements PeerDi
8484
return {
8585
stop: async () => {
8686
mdns.removeListener('response', this._onResponse)
87-
return await new Promise(resolve => mdns.destroy(resolve))
87+
await new Promise(resolve => { mdns.destroy(resolve as () => void) })
8888
}
8989
}
9090
}, {
@@ -93,7 +93,7 @@ export class Querier extends EventEmitter<PeerDiscoveryEvents> implements PeerDi
9393
})
9494
}
9595

96-
_onResponse (event: ResponsePacket, info: RemoteInfo) {
96+
_onResponse (event: ResponsePacket, info: RemoteInfo): void {
9797
log.trace('received mDNS query response')
9898
const answers = event.answers ?? []
9999

@@ -116,7 +116,7 @@ export class Querier extends EventEmitter<PeerDiscoveryEvents> implements PeerDi
116116
}))
117117
}
118118

119-
async stop () {
119+
async stop (): Promise<void> {
120120
if (this._handle != null) {
121121
await this._handle.stop()
122122
}
@@ -128,12 +128,12 @@ export class Querier extends EventEmitter<PeerDiscoveryEvents> implements PeerDi
128128
* running it again. `fn` must return an object with a stop function, which is
129129
* called when the period expires.
130130
*/
131-
function periodically (fn: () => Handle, options: { period: number, interval: number }) {
131+
function periodically (fn: () => Handle, options: { period: number, interval: number }): { stop: () => Promise<void> } {
132132
let handle: Handle | null
133133
let timeoutId: NodeJS.Timer
134134
let stopped = false
135135

136-
const reRun = () => {
136+
const reRun = (): void => {
137137
handle = fn()
138138
timeoutId = setTimeout(() => {
139139
if (handle != null) {

‎src/compat/responder.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ export class Responder {
1818
this._onQuery = this._onQuery.bind(this)
1919
}
2020

21-
start () {
21+
async start (): Promise<void> {
2222
this._mdns = MDNS()
2323
this._mdns.on('query', this._onQuery)
2424
}
2525

26-
_onQuery (event: QueryPacket, info: RemoteInfo) {
26+
_onQuery (event: QueryPacket, info: RemoteInfo): void {
2727
const addresses = this.components.addressManager.getAddresses().reduce<MultiaddrObject[]>((acc, addr) => {
2828
addr = addr.decapsulateCode(protocols('p2p').code)
2929

@@ -101,10 +101,10 @@ export class Responder {
101101
}
102102
}
103103

104-
stop () {
104+
async stop (): Promise<void> {
105105
if (this._mdns != null) {
106106
this._mdns.removeListener('query', this._onQuery)
107-
return new Promise<void>(resolve => {
107+
await new Promise<void>(resolve => {
108108
if (this._mdns != null) {
109109
this._mdns.destroy(resolve)
110110
} else {

‎src/index.ts

+7-7
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@ class MulticastDNS extends EventEmitter<PeerDiscoveryEvents> implements PeerDisc
6666
return true
6767
}
6868

69-
get [Symbol.toStringTag] () {
69+
get [Symbol.toStringTag] (): '@libp2p/mdns' {
7070
return '@libp2p/mdns'
7171
}
7272

73-
isStarted () {
73+
isStarted (): boolean {
7474
return Boolean(this.mdns)
7575
}
7676

@@ -79,7 +79,7 @@ class MulticastDNS extends EventEmitter<PeerDiscoveryEvents> implements PeerDisc
7979
*
8080
* @returns {void}
8181
*/
82-
async start () {
82+
async start (): Promise<void> {
8383
if (this.mdns != null) {
8484
return
8585
}
@@ -95,7 +95,7 @@ class MulticastDNS extends EventEmitter<PeerDiscoveryEvents> implements PeerDisc
9595
}
9696
}
9797

98-
_onMdnsQuery (event: multicastDNS.QueryPacket) {
98+
_onMdnsQuery (event: multicastDNS.QueryPacket): void {
9999
if (this.mdns == null) {
100100
return
101101
}
@@ -104,7 +104,7 @@ class MulticastDNS extends EventEmitter<PeerDiscoveryEvents> implements PeerDisc
104104
query.gotQuery(event, this.mdns, this.components.peerId, this.components.addressManager.getAddresses(), this.serviceTag, this.broadcast)
105105
}
106106

107-
_onMdnsResponse (event: multicastDNS.ResponsePacket) {
107+
_onMdnsResponse (event: multicastDNS.ResponsePacket): void {
108108
log.trace('received mDNS query response')
109109

110110
try {
@@ -122,7 +122,7 @@ class MulticastDNS extends EventEmitter<PeerDiscoveryEvents> implements PeerDisc
122122
}
123123
}
124124

125-
_onPeer (evt: CustomEvent<PeerInfo>) {
125+
_onPeer (evt: CustomEvent<PeerInfo>): void {
126126
if (this.mdns == null) {
127127
return
128128
}
@@ -137,7 +137,7 @@ class MulticastDNS extends EventEmitter<PeerDiscoveryEvents> implements PeerDisc
137137
*
138138
* @returns {Promise}
139139
*/
140-
async stop () {
140+
async stop (): Promise<void> {
141141
if (this.mdns == null) {
142142
return
143143
}

‎src/query.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import type { SrvAnswer, StringAnswer, TxtAnswer, Answer } from 'dns-packet'
1010

1111
const log = logger('libp2p:mdns:query')
1212

13-
export function queryLAN (mdns: MulticastDNS, serviceTag: string, interval: number) {
14-
const query = () => {
13+
export function queryLAN (mdns: MulticastDNS, serviceTag: string, interval: number): NodeJS.Timer {
14+
const query = (): void => {
1515
log('query', serviceTag)
1616

1717
mdns.query({
@@ -98,7 +98,7 @@ export function gotResponse (rsp: ResponsePacket, localPeerId: PeerId, serviceTa
9898
}
9999
}
100100

101-
export function gotQuery (qry: QueryPacket, mdns: MulticastDNS, peerId: PeerId, multiaddrs: Multiaddr[], serviceTag: string, broadcast: boolean) {
101+
export function gotQuery (qry: QueryPacket, mdns: MulticastDNS, peerId: PeerId, multiaddrs: Multiaddr[], serviceTag: string, broadcast: boolean): void {
102102
if (!broadcast) {
103103
log('not responding to mDNS query as broadcast mode is false')
104104
return
@@ -139,7 +139,7 @@ export function gotQuery (qry: QueryPacket, mdns: MulticastDNS, peerId: PeerId,
139139
data: {
140140
priority: 10,
141141
weight: 1,
142-
port: port,
142+
port,
143143
target: os.hostname()
144144
}
145145
})

‎test/compat/go-multicast-dns.spec.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import type { PeerInfo } from '@libp2p/interface-peer-info'
1010

1111
let port = 20000
1212

13-
async function createGoMulticastDNS () {
13+
async function createGoMulticastDNS (): Promise<{ mdns: GoMulticastDNS, components: any }> {
1414
const peerId = await createEd25519PeerId()
1515
const addressManager = stubInterface<AddressManager>()
1616
addressManager.getAddresses.returns([
@@ -36,7 +36,7 @@ describe('GoMulticastDNS', () => {
3636
const { mdns } = await createGoMulticastDNS()
3737

3838
await mdns.start()
39-
return await mdns.stop()
39+
await mdns.stop()
4040
})
4141

4242
it('should ignore multiple start calls', async () => {
@@ -45,7 +45,7 @@ describe('GoMulticastDNS', () => {
4545
await mdns.start()
4646
await mdns.start()
4747

48-
return await mdns.stop()
48+
await mdns.stop()
4949
})
5050

5151
it('should ignore unnecessary stop calls', async () => {
@@ -62,7 +62,7 @@ describe('GoMulticastDNS', () => {
6262
mdnsA.addEventListener('peer', (evt) => {
6363
const { id } = evt.detail
6464

65-
if (!componentsB.peerId.equals(id)) {
65+
if (componentsB.peerId.equals(id) !== true) {
6666
return
6767
}
6868

‎test/compat/querier.spec.ts

+12-13
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ describe('Querier', () => {
2727
})
2828

2929
afterEach(async () => {
30+
mdns?.destroy()
3031
return await Promise.all([
31-
querier?.stop(),
32-
mdns?.destroy()
32+
querier?.stop()
3333
])
3434
})
3535

@@ -60,7 +60,7 @@ describe('Querier', () => {
6060
})
6161

6262
it('should not emit peer for responses with non matching service tags', async () => {
63-
return await ensureNoPeer(event => {
63+
await ensureNoPeer(event => {
6464
const peerServiceTagLocal = `${peerIds[1].toString()}.${SERVICE_TAG_LOCAL}`
6565
const bogusServiceTagLocal = '_ifps-discovery._udp'
6666

@@ -75,7 +75,7 @@ describe('Querier', () => {
7575
})
7676

7777
it('should not emit peer for responses with missing TXT record', async () => {
78-
return await ensureNoPeer(event => {
78+
await ensureNoPeer(event => {
7979
const peerServiceTagLocal = `${peerIds[1].toString()}.${SERVICE_TAG_LOCAL}`
8080

8181
return [{
@@ -89,7 +89,7 @@ describe('Querier', () => {
8989
})
9090

9191
it('should not emit peer for responses with missing peer ID in TXT record', async () => {
92-
return await ensureNoPeer(event => {
92+
await ensureNoPeer(event => {
9393
const peerServiceTagLocal = `${peerIds[1].toString()}.${SERVICE_TAG_LOCAL}`
9494

9595
return [{
@@ -109,7 +109,7 @@ describe('Querier', () => {
109109
})
110110

111111
it('should not emit peer for responses to self', async () => {
112-
return await ensureNoPeer(event => {
112+
await ensureNoPeer(event => {
113113
const peerServiceTagLocal = `${peerIds[1].toString()}.${SERVICE_TAG_LOCAL}`
114114

115115
return [{
@@ -128,9 +128,8 @@ describe('Querier', () => {
128128
})
129129
})
130130

131-
// TODO: unskip when https://github.com/libp2p/js-peer-id/issues/83 is resolved
132131
it('should not emit peer for responses with invalid peer ID in TXT record', async () => {
133-
return await ensureNoPeer(event => {
132+
await ensureNoPeer(event => {
134133
const peerServiceTagLocal = `${peerIds[1].toString()}.${SERVICE_TAG_LOCAL}`
135134

136135
return [{
@@ -150,7 +149,7 @@ describe('Querier', () => {
150149
})
151150

152151
it('should not emit peer for responses with missing SRV record', async () => {
153-
return await ensureNoPeer(event => {
152+
await ensureNoPeer(event => {
154153
const peerServiceTagLocal = `${peerIds[1].toString()}.${SERVICE_TAG_LOCAL}`
155154

156155
return [{
@@ -170,7 +169,7 @@ describe('Querier', () => {
170169
})
171170

172171
it('should emit peer for responses even if no multiaddrs', async () => {
173-
return await ensurePeer(event => {
172+
await ensurePeer(event => {
174173
const peerServiceTagLocal = `${peerIds[1].toString()}.${SERVICE_TAG_LOCAL}`
175174

176175
return [{
@@ -201,7 +200,7 @@ describe('Querier', () => {
201200
})
202201

203202
it('should emit peer for responses with valid multiaddrs', async () => {
204-
return await ensurePeer(event => {
203+
await ensurePeer(event => {
205204
const peerServiceTagLocal = `${peerIds[1].toString()}.${SERVICE_TAG_LOCAL}`
206205

207206
return [{
@@ -242,7 +241,7 @@ describe('Querier', () => {
242241
*
243242
* @param {Function} getResponse - Given a query, construct a response to test the querier
244243
*/
245-
async function ensurePeer (getResponse: (event: QueryPacket, info: RemoteInfo) => Answer[]) {
244+
async function ensurePeer (getResponse: (event: QueryPacket, info: RemoteInfo) => Answer[]): Promise<void> {
246245
const querier = new Querier({ peerId: peerIds[0] })
247246
mdns = MDNS()
248247

@@ -278,7 +277,7 @@ describe('Querier', () => {
278277
*
279278
* @param {Function} getResponse - Given a query, construct a response to test the querier
280279
*/
281-
async function ensureNoPeer (getResponse: (event: QueryPacket, info: RemoteInfo) => Answer[]) {
280+
async function ensureNoPeer (getResponse: (event: QueryPacket, info: RemoteInfo) => Answer[]): Promise<void> {
282281
const querier = new Querier({ peerId: peerIds[0] })
283282
mdns = MDNS()
284283

0 commit comments

Comments
 (0)