-
Notifications
You must be signed in to change notification settings - Fork 288
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Global drop queue for Root #700
Merged
Merged
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
d80f5d1
to
194945e
Compare
dherman
requested changes
Mar 19, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a great improvement. The code is just subtle enough that my main comments are about comments and docs.
dherman
approved these changes
Mar 20, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
This was referenced Jun 6, 2021
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.
Why
Currently, dropping a
Root
will cause apanic
instead of leaking the data. This can be problematic for users since there are many ways to accidentally leak aRoot
. Consider the following example:Root
is created and captured by a closureIn this case, even though the user knows the
Root
won't be used, there's no easy way to get it back out to safely drop it.What
This feature is flagged with
napi-6
. The existingpanic
behavior continues for older versions.InstanceData
A private
InstanceData
type is added that usesnapi_get_instance_data
andnapi_set_instance_data
. This provides a place to stash module specific context for Neon.Global drop queue
A global drop queue is added as a
ThreadsafeFunction
.ThreadsafeFunction
is used instead ofEventQueue
since we only need a static callback. Closures would require unnecessary overhead.ThreadsafeFunction
is maintained in anArc
to ensure it can outlive an unloaded moduleAdditional
Added
impl Object for JsBox
that was missing.Testing
It was really fun finding a creative way to test this behavior!
struct Wrapper
for holding a callback and an event queueJsBox
which is then rooted and immediately leaked (dropped)Finalize
implementation,Wrapper
has aDrop
implementation that calls the callback. If this is called, we know that theRoot
reference count was dropped, allowing our struct to be dropped.