refactor: rename event emitter class #2159
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
achingbrain
changed the title
We add types to a EventEmitter class which extends the plain js EventTarget. The name is chosen to give familiarity to node developers but it's not generally a good idea. This refactor: 1. Exports a new TypedEventTarget interface which adds types to EventTarget 2. Renames EventEmitter to TypedEventEmitter to draw a distinction between them In the future all consuming code should rely on the TypedEventTarget interface while implemmenting code uses TypedEventEmitter as an implementation of a TypedEventEmitter. By depending on the interface and not the implementation consuming code is isolated from problems that arise when two versions of `@libp2p/interface` is in the dependency tree and the event subsystems would otherwise be compatible due to type overlap. This maifests as an error message about incompatible implementations of the private `#listeners` field in EventEmitter.
achingbrain
force-pushed
the
refactor/rename-event-emitter
branch
from
c89744a to
7be6dfd
Compare
achingbrain
force-pushed
the
refactor/rename-event-emitter
branch
from
56b2e26 to
62d515f
Compare
achingbrain
added a commit
that referenced
this pull request
Oct 25, 2023
This reverts commit b5a808a.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We add types to a
EventEmitterclass which extends the plain jsEventTarget.The name is chosen to give familiarity to node developers but it's not generally a good idea.
This refactor:
TypedEventTargetinterface which adds types toEventTargetEventEmittertoTypedEventEmitterto draw a distinction between themTypedEventEmitterasEventEmitterto preserve backwards compatibilityIn the future all consuming code should rely on the
TypedEventTargetinterface while implementing code usesTypedEventEmitteras an implementation of aTypedEventEmitter.By depending on the interface and not the implementation consuming code is isolated from problems that arise when two versions of
@libp2p/interfaceis in the dependency tree and the event subsystems would otherwise be compatible due to type overlap.This manifests as an error message about incompatible implementations of the private
#listenersfield in EventEmitter.Backwards compatibility is achieved by exporting the
TypedEventEmitterclass as the olderEventEmittername. This should be removed in a future PR to the v1.0 branch once external modules (e.g. Gossipsub) have been updated to use the newTypedEventEmittersymbol.Change checklist