Fixing memory leak when removing tracks / streams#6
Merged
Conversation
The _senderMap keeps references to no more used MediaStream / MediaTracks. In an application where many tracks will be added/removed from a remote peer, the "dead" tracks keep accumulating in _senderMap. To avoid this, we turn _senderMap and its inner map into WeakMap. This way, if the track is never used anymore, it will be freed from memory.
moufmouf
force-pushed
the
weak-sendermap
branch
from
b954138 to
ae42338
Compare
There was a problem hiding this comment.
Pull request overview
This PR addresses a memory leak in the simple-peer library by converting the _senderMap data structure from regular Map objects to WeakMap objects. In applications where many tracks are frequently added and removed from remote peers, the previous implementation would retain references to unused MediaStream and MediaStreamTrack objects, preventing garbage collection.
Key Changes
- Changed
_senderMapfromMaptoWeakMapfor both the outer map (track → submap) and inner maps (stream → sender) - This allows tracks and streams to be garbage collected when no longer referenced by the application, while maintaining functional correctness
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The _senderMap keeps references to no more used MediaStream / MediaTracks.
In an application where many tracks will be added/removed from a remote peer,
the "dead" tracks keep accumulating in _senderMap.
To avoid this, we turn _senderMap and its inner map into WeakMap.
This way, if the track is never used anymore, it will be freed from memory.