Make it possible to open http-streamed RRDs in follow mode via JS API. #6326
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
jleibs
added
enhancement
jleibs
force-pushed
the
jleibs/follow_streaming
branch
from
7e7e406
to
bc12f57
Compare
jprochazk
approved these changes
May 14, 2024
rerun_js/web-viewer/index.js
Outdated
| */ | ||
| open(rrd) { | ||
| open(rrd, follow_if_http = false) { |
There was a problem hiding this comment.
Putting a flag this specific onto a generic-sounding open call makes me uneasy, but it's fine if we plan to remove it at some point
There was a problem hiding this comment.
Hmm, yeah. These things tend to last longer than we'd like though.
Anything we could do to improve?
Would it be better as a different API like open_and_follow?
There was a problem hiding this comment.
I'm not sure 😅. Maybe this could be in an options object:
/** @param {{ follow_if_http?: boolean }} options */
open(rrd, options) {
// ...
this.#handle.add_receiver(url, options.follow_if_http);
}This way we can add more flags in a backwards compatible way
jleibs
added a commit
that referenced
this pull request
May 15, 2024
#6326) ### What - Resolves: #6243 In the context of the Gradio integration, although we are streaming over http, from the perspective of system operation it feels more like a websocket. In many situations we want new data to update immediately once computation is done, rather than playing over time abstract time domain. Eventually we would like to control all of this behavior through blueprint, but moving TimeControls to blueprint is a lot more work. We already use the SmartChannelSource to make the determination of follow mode, so with a little bit of additional plumbing, it's possible for us to indicate this from the js API. This is a pretty advanced edge-case and so I haven't exposed it to the other mechanism through which an http source might be added. I assume this will eventually be removed again once we have TimeControls available via blueprint. ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested the web demo (if applicable): * Using examples from latest `main` build: [rerun.io/viewer](https://rerun.io/viewer/pr/6326?manifest_url=https://app.rerun.io/version/main/examples_manifest.json) * Using full set of examples from `nightly` build: [rerun.io/viewer](https://rerun.io/viewer/pr/6326?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json) * [x] The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG * [x] If applicable, add a new check to the [release checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)! - [PR Build Summary](https://build.rerun.io/pr/6326) - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html) To run all checks from `main`, comment on the PR with `@rerun-bot full-check`.
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.
What
In the context of the Gradio integration, although we are streaming over http, from the perspective of system operation it feels more like a websocket. In many situations we want new data to update immediately once computation is done, rather than playing over time abstract time domain.
Eventually we would like to control all of this behavior through blueprint, but moving TimeControls to blueprint is a lot more work. We already use the SmartChannelSource to make the determination of follow mode, so with a little bit of additional plumbing, it's possible for us to indicate this from the js API.
This is a pretty advanced edge-case and so I haven't exposed it to the other mechanism through which an http source might be added. I assume this will eventually be removed again once we have TimeControls available via blueprint.
Checklist
mainbuild: rerun.io/viewernightlybuild: rerun.io/viewerTo run all checks from
main, comment on the PR with@rerun-bot full-check.