Close track FFI handles automatically when a FfiRoom is closed. #539
Conversation
This file contains 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
|
it seems like you haven't added any nanpa changeset files to this PR. if this pull request includes changes to code, make sure to add a changeset, by writing a file to refer to the manpage for more information. |
typester
commented
Jan 3, 2025
livekit-ffi/src/server/room.rs
Outdated
Comment on lines
273
to
274
| // Store an empty handle for the FFI client that assumes a handle exists for this id. | ||
| server.store_handle(handle, vec![].into_boxed_slice()); |
There was a problem hiding this comment.
The Python-side code assumes this handle ID exists, and if the ID does not exist when Python attempts to dispose of it, an assertion failure occurs. To avoid this, an empty entry is stored here.
There was a problem hiding this comment.
Can we implement FfiHandle for ()?
impl FfiHandle for () {
There was a problem hiding this comment.
@theomonnom Fixed in d867bee
bcherry
approved these changes
Jan 3, 2025
theomonnom
approved these changes
Jan 6, 2025
typester
deleted the
typester/free-associated-stream-handles-when-room-is-closed
branch
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.
As shown in this test script, it seems that if the FFI client forgets to close Audio/Video Stream on their side, a memory leak occurs.
Looking at the Python-side code, the
__del__method is supposed to dispose of FFI handles when objects like VideoStream are released. However, for some reason, in this test script, that part is not invoked, leaving the handles unclosed.In this pull request, the
FfiRoomis modified to automatically dispose of associated track handles when it is closed.With the script mentioned above, after running it, the memory consumption of the test process decreased from around 110MB to about 80MB, indicating the change is effective.
(The test was conducted in a local environment using a livekit-server with one video and one audio stream are running in a joined room)