Fix JS client leaking exported references, clarify dh.Widget API #4939
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
niloc132
added
documentation
niloc132
force-pushed
the
4903-js-widgets
branch
from
bfa7828
to
f4fe85b
Compare
mofojed
requested changes
Dec 12, 2023
web/client-api/src/main/java/io/deephaven/web/client/api/widget/JsWidget.java
Outdated
Show resolved
Hide resolved
web/client-api/src/main/java/io/deephaven/web/client/api/widget/JsWidgetExportedObject.java
Show resolved
Hide resolved
| req.setSourceId(ticket.getTicket()); | ||
| req.setResultId(reexportedTicket); | ||
| connection.sessionServiceClient().exportFromTicket(req, connection.metadata(), c::apply); | ||
| }).then(success -> { |
There was a problem hiding this comment.
The downside of this is the extra round trip (not a TicketAndPromise), but it is a lot cleaner this way.
There was a problem hiding this comment.
Oh right - I can make it less clean and less round trippy....
There was a problem hiding this comment.
Hmm. I can, but then there will be zero round trips, and we would be ignoring failure (if any) from the exportFromTIcket call, and would only find out after trying to use the resulting object.
In that case, we could stop returning promise entirely.
There was a problem hiding this comment.
I'm indifferent. Could file a ticket to optimize this in the future?
web/client-api/src/main/java/io/deephaven/web/client/api/widget/JsWidgetExportedObject.java
Show resolved
Hide resolved
mofojed
approved these changes
Dec 12, 2023
pete-petey
modified the milestones:
November 2023,
2023 tickets that need to be 'milestone-ed' and assigned
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR is an update to #4909.
JsPartitionedTable, JsFigure, PandasTable were previously being leaked even with correct usage, ensure that those are released when client code calls close(). Additionally, partitioned tables would be re-exported unnecessarily, but only the re-export was released, leaking the original reference.
Widget and WidgetExportedObject had documentation indicating how to consume exported objects, but these rules were not enforced. The rules have changed to be more consistent and are enforced, which should avoid later confusion, and new documentation added to propose potential patterns to follow when authoring plugins.
Fixes #4903