Skip to content

Commit 0ef5f7f

Browse files
achingbrainachingbrain
authored
fix: revert "refactor: rename event emitter class" (#2172)
This reverts commit b5a808a.
1 parent de4f4c3 commit 0ef5f7f

File tree

81 files changed

+195
-212
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+195
-212
lines changed

‎packages/interface-compliance-tests/src/mocks/connection-manager.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { isMultiaddr, type Multiaddr } from '@multiformats/multiaddr'
66
import { connectionPair } from './connection.js'
77
import type { Libp2pEvents, PendingDial } from '@libp2p/interface'
88
import type { Connection } from '@libp2p/interface/connection'
9-
import type { TypedEventTarget } from '@libp2p/interface/events'
9+
import type { EventEmitter } from '@libp2p/interface/events'
1010
import type { PubSub } from '@libp2p/interface/pubsub'
1111
import type { Startable } from '@libp2p/interface/startable'
1212
import type { ConnectionManager } from '@libp2p/interface-internal/connection-manager'
@@ -16,7 +16,7 @@ export interface MockNetworkComponents {
1616
peerId: PeerId
1717
registrar: Registrar
1818
connectionManager: ConnectionManager
19-
events: TypedEventTarget<Libp2pEvents>
19+
events: EventEmitter<Libp2pEvents>
2020
pubsub?: PubSub
2121
}
2222

@@ -51,7 +51,7 @@ export const mockNetwork = new MockNetwork()
5151
export interface MockConnectionManagerComponents {
5252
peerId: PeerId
5353
registrar: Registrar
54-
events: TypedEventTarget<Libp2pEvents>
54+
events: EventEmitter<Libp2pEvents>
5555
}
5656

5757
class MockConnectionManager implements ConnectionManager, Startable {

‎packages/interface-compliance-tests/src/mocks/peer-discovery.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { TypedEventEmitter } from '@libp2p/interface/events'
1+
import { EventEmitter } from '@libp2p/interface/events'
22
import { peerDiscovery } from '@libp2p/interface/peer-discovery'
33
import * as PeerIdFactory from '@libp2p/peer-id-factory'
44
import { multiaddr } from '@multiformats/multiaddr'
@@ -12,7 +12,7 @@ interface MockDiscoveryInit {
1212
/**
1313
* Emits 'peer' events on discovery.
1414
*/
15-
export class MockDiscovery extends TypedEventEmitter<PeerDiscoveryEvents> implements PeerDiscovery {
15+
export class MockDiscovery extends EventEmitter<PeerDiscoveryEvents> implements PeerDiscovery {
1616
public readonly options: MockDiscoveryInit
1717
private _isRunning: boolean
1818
private _timer: any

‎packages/interface-compliance-tests/src/mocks/upgrader.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
import { mockConnection } from './connection.js'
22
import type { Libp2pEvents } from '@libp2p/interface'
33
import type { Connection, MultiaddrConnection } from '@libp2p/interface/connection'
4-
import type { TypedEventTarget } from '@libp2p/interface/events'
4+
import type { EventEmitter } from '@libp2p/interface/events'
55
import type { Upgrader, UpgraderOptions } from '@libp2p/interface/transport'
66
import type { Registrar } from '@libp2p/interface-internal/registrar'
77

88
export interface MockUpgraderInit {
99
registrar?: Registrar
10-
events?: TypedEventTarget<Libp2pEvents>
10+
events?: EventEmitter<Libp2pEvents>
1111
}
1212

1313
class MockUpgrader implements Upgrader {
1414
private readonly registrar?: Registrar
15-
private readonly events?: TypedEventTarget<Libp2pEvents>
15+
private readonly events?: EventEmitter<Libp2pEvents>
1616

1717
constructor (init: MockUpgraderInit) {
1818
this.registrar = init.registrar

‎packages/interface-compliance-tests/src/pubsub/utils.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { TypedEventEmitter } from '@libp2p/interface/events'
1+
import { EventEmitter } from '@libp2p/interface/events'
22
import { createEd25519PeerId } from '@libp2p/peer-id-factory'
33
import { pEvent } from 'p-event'
44
import pWaitFor from 'p-wait-for'
@@ -19,7 +19,7 @@ export async function createComponents (): Promise<MockNetworkComponents> {
1919
const components: any = {
2020
peerId: await createEd25519PeerId(),
2121
registrar: mockRegistrar(),
22-
events: new TypedEventEmitter()
22+
events: new EventEmitter()
2323
}
2424
components.connectionManager = mockConnectionManager(components)
2525

‎packages/interface-compliance-tests/src/transport/dial-test.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { AbortError } from '@libp2p/interface/errors'
2-
import { TypedEventEmitter } from '@libp2p/interface/events'
2+
import { EventEmitter } from '@libp2p/interface/events'
33
import { expect } from 'aegir/chai'
44
import all from 'it-all'
55
import drain from 'it-drain'
@@ -27,7 +27,7 @@ export default (common: TestSetup<TransportTestFixtures>): void => {
2727
registrar = mockRegistrar()
2828
upgrader = mockUpgrader({
2929
registrar,
30-
events: new TypedEventEmitter()
30+
events: new EventEmitter()
3131
});
3232

3333
({ addrs, transport, connector } = await common.setup())

‎packages/interface-compliance-tests/src/transport/listen-test.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* eslint max-nested-callbacks: ["error", 8] */
2-
import { CustomEvent, TypedEventEmitter } from '@libp2p/interface/events'
2+
import { CustomEvent, EventEmitter } from '@libp2p/interface/events'
33
import { expect } from 'aegir/chai'
44
import drain from 'it-drain'
55
import { pipe } from 'it-pipe'
@@ -27,7 +27,7 @@ export default (common: TestSetup<TransportTestFixtures>): void => {
2727
registrar = mockRegistrar()
2828
upgrader = mockUpgrader({
2929
registrar,
30-
events: new TypedEventEmitter()
30+
events: new EventEmitter()
3131
});
3232

3333
({ transport, addrs } = await common.setup())

‎packages/interface/src/events.ts

+1-20
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,7 @@ interface Listener {
1515
* https://github.com/microsoft/TypeScript/issues/299
1616
* etc
1717
*/
18-
export interface TypedEventTarget <EventMap extends Record<string, any>> extends EventTarget {
19-
addEventListener<K extends keyof EventMap>(type: K, listener: EventHandler<EventMap[K]> | null, options?: boolean | AddEventListenerOptions): void
20-
21-
listenerCount (type: string): number
22-
23-
removeEventListener<K extends keyof EventMap>(type: K, listener?: EventHandler<EventMap[K]> | null, options?: boolean | EventListenerOptions): void
24-
25-
removeEventListener (type: string, listener?: EventHandler<Event>, options?: boolean | EventListenerOptions): void
26-
27-
safeDispatchEvent<Detail>(type: keyof EventMap, detail: CustomEventInit<Detail>): boolean
28-
}
29-
30-
/**
31-
* An implementation of a typed event target
32-
* etc
33-
*/
34-
export class TypedEventEmitter<EventMap extends Record<string, any>> extends EventTarget implements TypedEventTarget<EventMap> {
18+
export class EventEmitter<EventMap extends Record<string, any>> extends EventTarget {
3519
#listeners = new Map<any, Listener[]>()
3620

3721
listenerCount (type: string): number {
@@ -114,6 +98,3 @@ class CustomEventPolyfill<T = any> extends Event {
11498
}
11599

116100
export const CustomEvent = globalThis.CustomEvent ?? CustomEventPolyfill
117-
118-
// TODO: remove this in v1
119-
export { TypedEventEmitter as EventEmitter }

‎packages/interface/src/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
import type { Connection, NewStreamOptions, Stream } from './connection/index.js'
1818
import type { ContentRouting } from './content-routing/index.js'
19-
import type { TypedEventTarget } from './events.js'
19+
import type { EventEmitter } from './events.js'
2020
import type { KeyChain } from './keychain/index.js'
2121
import type { Metrics } from './metrics/index.js'
2222
import type { PeerId } from './peer-id/index.js'
@@ -303,7 +303,7 @@ export interface PendingDial {
303303
/**
304304
* Libp2p nodes implement this interface.
305305
*/
306-
export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, TypedEventTarget<Libp2pEvents<T>> {
306+
export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, EventEmitter<Libp2pEvents<T>> {
307307
/**
308308
* The PeerId is a unique identifier for a node on the network.
309309
*

‎packages/interface/src/peer-discovery/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type { TypedEventTarget } from '../events.js'
1+
import type { EventEmitter } from '../events.js'
22
import type { PeerInfo } from '../peer-info/index.js'
33

44
/**
@@ -26,4 +26,4 @@ export interface PeerDiscoveryEvents {
2626
'peer': CustomEvent<PeerInfo>
2727
}
2828

29-
export interface PeerDiscovery extends TypedEventTarget<PeerDiscoveryEvents> {}
29+
export interface PeerDiscovery extends EventEmitter<PeerDiscoveryEvents> {}

‎packages/interface/src/pubsub/index.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type { Stream } from '../connection/index.js'
2-
import type { TypedEventTarget } from '../events.js'
2+
import type { EventEmitter } from '../events.js'
33
import type { PeerId } from '../peer-id/index.js'
44
import type { Pushable } from 'it-pushable'
55
import type { Uint8ArrayList } from 'uint8arraylist'
@@ -65,7 +65,7 @@ export interface PubSubRPC {
6565
messages: PubSubRPCMessage[]
6666
}
6767

68-
export interface PeerStreams extends TypedEventTarget<PeerStreamEvents> {
68+
export interface PeerStreams extends EventEmitter<PeerStreamEvents> {
6969
id: PeerId
7070
protocol: string
7171
outboundStream?: Pushable<Uint8ArrayList>
@@ -152,7 +152,7 @@ export interface TopicValidatorFn {
152152
(peer: PeerId, message: Message): TopicValidatorResult | Promise<TopicValidatorResult>
153153
}
154154

155-
export interface PubSub<Events extends Record<string, any> = PubSubEvents> extends TypedEventTarget<Events> {
155+
export interface PubSub<Events extends Record<string, any> = PubSubEvents> extends EventEmitter<Events> {
156156
/**
157157
* The global signature policy controls whether or not we sill send and receive
158158
* signed or unsigned messages.

‎packages/interface/src/transport/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type { Connection, MultiaddrConnection } from '../connection/index.js'
2-
import type { TypedEventTarget } from '../events.js'
2+
import type { EventEmitter } from '../events.js'
33
import type { AbortOptions } from '../index.js'
44
import type { StreamMuxerFactory } from '../stream-muxer/index.js'
55
import type { Multiaddr } from '@multiformats/multiaddr'
@@ -11,7 +11,7 @@ export interface ListenerEvents {
1111
'close': CustomEvent
1212
}
1313

14-
export interface Listener extends TypedEventTarget<ListenerEvents> {
14+
export interface Listener extends EventEmitter<ListenerEvents> {
1515
/**
1616
* Start a listener
1717
*/

‎packages/kad-dht/src/dual-kad-dht.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { type ContentRouting, contentRouting } from '@libp2p/interface/content-routing'
22
import { CodeError } from '@libp2p/interface/errors'
3-
import { TypedEventEmitter, CustomEvent } from '@libp2p/interface/events'
3+
import { EventEmitter, CustomEvent } from '@libp2p/interface/events'
44
import { type PeerDiscovery, peerDiscovery, type PeerDiscoveryEvents } from '@libp2p/interface/peer-discovery'
55
import { type PeerRouting, peerRouting } from '@libp2p/interface/peer-routing'
66
import { logger } from '@libp2p/logger'
@@ -121,7 +121,7 @@ function multiaddrIsPublic (multiaddr: Multiaddr): boolean {
121121
* A DHT implementation modelled after Kademlia with S/Kademlia modifications.
122122
* Original implementation in go: https://github.com/libp2p/go-libp2p-kad-dht.
123123
*/
124-
export class DefaultDualKadDHT extends TypedEventEmitter<PeerDiscoveryEvents> implements DualKadDHT, PeerDiscovery {
124+
export class DefaultDualKadDHT extends EventEmitter<PeerDiscoveryEvents> implements DualKadDHT, PeerDiscovery {
125125
public readonly wan: DefaultKadDHT
126126
public readonly lan: DefaultKadDHT
127127
public readonly components: KadDHTComponents

‎packages/kad-dht/src/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { DefaultDualKadDHT } from './dual-kad-dht.js'
22
import type { ProvidersInit } from './providers.js'
33
import type { Libp2pEvents, AbortOptions } from '@libp2p/interface'
4-
import type { TypedEventTarget } from '@libp2p/interface/events'
4+
import type { EventEmitter } from '@libp2p/interface/events'
55
import type { Metrics } from '@libp2p/interface/metrics'
66
import type { PeerId } from '@libp2p/interface/peer-id'
77
import type { PeerInfo } from '@libp2p/interface/peer-info'
@@ -314,7 +314,7 @@ export interface KadDHTComponents {
314314
metrics?: Metrics
315315
connectionManager: ConnectionManager
316316
datastore: Datastore
317-
events: TypedEventTarget<Libp2pEvents>
317+
events: EventEmitter<Libp2pEvents>
318318
}
319319

320320
export function kadDHT (init?: KadDHTInit): (components: KadDHTComponents) => DualKadDHT {

‎packages/kad-dht/src/kad-dht.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { CustomEvent, TypedEventEmitter } from '@libp2p/interface/events'
1+
import { CustomEvent, EventEmitter } from '@libp2p/interface/events'
22
import { type Logger, logger } from '@libp2p/logger'
33
import pDefer from 'p-defer'
44
import { PROTOCOL_DHT, PROTOCOL_PREFIX, LAN_PREFIX } from './constants.js'
@@ -39,7 +39,7 @@ export interface SingleKadDHTInit extends KadDHTInit {
3939
* A DHT implementation modelled after Kademlia with S/Kademlia modifications.
4040
* Original implementation in go: https://github.com/libp2p/go-libp2p-kad-dht.
4141
*/
42-
export class DefaultKadDHT extends TypedEventEmitter<PeerDiscoveryEvents> implements KadDHT {
42+
export class DefaultKadDHT extends EventEmitter<PeerDiscoveryEvents> implements KadDHT {
4343
public protocol: string
4444
public routingTable: RoutingTable
4545
public providers: Providers

‎packages/kad-dht/src/network.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { CodeError } from '@libp2p/interface/errors'
2-
import { TypedEventEmitter, CustomEvent } from '@libp2p/interface/events'
2+
import { EventEmitter, CustomEvent } from '@libp2p/interface/events'
33
import { logger } from '@libp2p/logger'
44
import { abortableDuplex } from 'abortable-iterator'
55
import drain from 'it-drain'
@@ -35,7 +35,7 @@ interface NetworkEvents {
3535
/**
3636
* Handle network operations for the dht
3737
*/
38-
export class Network extends TypedEventEmitter<NetworkEvents> implements Startable {
38+
export class Network extends EventEmitter<NetworkEvents> implements Startable {
3939
private readonly log: Logger
4040
private readonly protocol: string
4141
private running: boolean

‎packages/kad-dht/src/query/manager.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { setMaxListeners } from 'events'
22
import { AbortError } from '@libp2p/interface/errors'
3-
import { TypedEventEmitter, CustomEvent } from '@libp2p/interface/events'
3+
import { EventEmitter, CustomEvent } from '@libp2p/interface/events'
44
import { logger } from '@libp2p/logger'
55
import { PeerSet } from '@libp2p/peer-collections'
66
import { anySignal } from 'any-signal'
@@ -143,7 +143,7 @@ export class QueryManager implements Startable {
143143

144144
// query a subset of peers up to `kBucketSize / 2` in length
145145
const startTime = Date.now()
146-
const cleanUp = new TypedEventEmitter<CleanUpEvents>()
146+
const cleanUp = new EventEmitter<CleanUpEvents>()
147147

148148
try {
149149
if (options.isSelfQuery !== true && this.initialQuerySelfHasRun != null) {

‎packages/kad-dht/src/query/query-path.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { queryErrorEvent } from './events.js'
99
import type { CleanUpEvents } from './manager.js'
1010
import type { QueryEvent, QueryOptions } from '../index.js'
1111
import type { QueryFunc } from '../query/types.js'
12-
import type { TypedEventTarget } from '@libp2p/interface/events'
12+
import type { EventEmitter } from '@libp2p/interface/events'
1313
import type { PeerId } from '@libp2p/interface/peer-id'
1414
import type { Logger } from '@libp2p/logger'
1515
import type { PeerSet } from '@libp2p/peer-collections'
@@ -60,7 +60,7 @@ export interface QueryPathOptions extends QueryOptions {
6060
/**
6161
* will emit a 'cleanup' event if the caller exits the for..await of early
6262
*/
63-
cleanUp: TypedEventTarget<CleanUpEvents>
63+
cleanUp: EventEmitter<CleanUpEvents>
6464

6565
/**
6666
* A timeout for queryFunc in ms
@@ -185,7 +185,7 @@ export async function * queryPath (options: QueryPathOptions): AsyncGenerator<Qu
185185
yield * toGenerator(queue, signal, cleanUp, log)
186186
}
187187

188-
async function * toGenerator (queue: Queue, signal: AbortSignal, cleanUp: TypedEventTarget<CleanUpEvents>, log: Logger): AsyncGenerator<QueryEvent, void, undefined> {
188+
async function * toGenerator (queue: Queue, signal: AbortSignal, cleanUp: EventEmitter<CleanUpEvents>, log: Logger): AsyncGenerator<QueryEvent, void, undefined> {
189189
let deferred = defer()
190190
let running = true
191191
const results: QueryEvent[] = []

‎packages/kad-dht/src/routing-table/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { TypedEventEmitter } from '@libp2p/interface/events'
1+
import { EventEmitter } from '@libp2p/interface/events'
22
import { logger } from '@libp2p/logger'
33
import { PeerSet } from '@libp2p/peer-collections'
44
import Queue from 'p-queue'
@@ -43,7 +43,7 @@ export interface RoutingTableEvents {
4343
* A wrapper around `k-bucket`, to provide easy store and
4444
* retrieval for peers.
4545
*/
46-
export class RoutingTable extends TypedEventEmitter<RoutingTableEvents> implements Startable {
46+
export class RoutingTable extends EventEmitter<RoutingTableEvents> implements Startable {
4747
public kBucketSize: number
4848
public kb?: KBucket
4949
public pingQueue: Queue

‎packages/kad-dht/src/routing-table/k-bucket.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
2727
OTHER DEALINGS IN THE SOFTWARE.
2828
*/
2929

30-
import { TypedEventEmitter } from '@libp2p/interface/events'
30+
import { EventEmitter } from '@libp2p/interface/events'
3131
import type { PeerId } from '@libp2p/interface/peer-id'
3232

3333
function arrayEquals (array1: Uint8Array, array2: Uint8Array): boolean {
@@ -122,8 +122,10 @@ export interface Bucket {
122122
/**
123123
* Implementation of a Kademlia DHT k-bucket used for storing
124124
* contact (peer node) information.
125+
*
126+
* @extends EventEmitter
125127
*/
126-
export class KBucket extends TypedEventEmitter<KBucketEvents> {
128+
export class KBucket extends EventEmitter<KBucketEvents> {
127129
public localNodeId: Uint8Array
128130
public root: Bucket
129131
private readonly numberOfNodesPerKBucket: number

‎packages/kad-dht/src/topology-listener.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { CustomEvent, TypedEventEmitter } from '@libp2p/interface/events'
1+
import { CustomEvent, EventEmitter } from '@libp2p/interface/events'
22
import { logger } from '@libp2p/logger'
33
import type { KadDHTComponents } from '.'
44
import type { PeerId } from '@libp2p/interface/peer-id'
@@ -17,7 +17,7 @@ export interface TopologyListenerEvents {
1717
/**
1818
* Receives notifications of new peers joining the network that support the DHT protocol
1919
*/
20-
export class TopologyListener extends TypedEventEmitter<TopologyListenerEvents> implements Startable {
20+
export class TopologyListener extends EventEmitter<TopologyListenerEvents> implements Startable {
2121
private readonly log: Logger
2222
private readonly components: KadDHTComponents
2323
private readonly protocol: string

‎packages/kad-dht/test/routing-table.spec.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/* eslint-env mocha */
22

3-
import { TypedEventEmitter, CustomEvent } from '@libp2p/interface/events'
3+
import { EventEmitter, CustomEvent } from '@libp2p/interface/events'
44
import { mockConnectionManager } from '@libp2p/interface-compliance-tests/mocks'
55
import { PeerSet } from '@libp2p/peer-collections'
66
import { peerIdFromString } from '@libp2p/peer-id'
@@ -33,7 +33,7 @@ describe('Routing Table', () => {
3333
beforeEach(async function () {
3434
this.timeout(20 * 1000)
3535

36-
const events = new TypedEventEmitter<Libp2pEvents>()
36+
const events = new EventEmitter<Libp2pEvents>()
3737

3838
components = {
3939
peerId: await createPeerId(),

0 commit comments

Comments
 (0)