Refactor re_sdk::Session
#1528
Merged
Refactor re_sdk::Session
#1528
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
The Python API have different needs from the Rust API
less re-compiling
emilk
commented
Mar 7, 2023
| @@ -0,0 +1,243 @@ | |||
| use std::net::SocketAddr; | |||
There was a problem hiding this comment.
The following file is the old session.rs, with a few small refactorings
jleibs
reviewed
Mar 9, 2023
jleibs
reviewed
Mar 9, 2023
jleibs
approved these changes
Mar 9, 2023
| @@ -25,7 +24,7 @@ py_folders := "examples rerun_py scripts" | |||
| py-dev-env: | |||
| #!/usr/bin/env bash | |||
| echo "Setting up Python virtual environment in venv" | |||
| # set -euxo pipefail | |||
| set -euxo pipefail | |||
There was a problem hiding this comment.
A bit curious why this was commented out before?
There was a problem hiding this comment.
I'm suspecting it was a mistake
| @@ -41,9 +41,6 @@ def lint_line(line: str) -> Optional[str]: | |||
| if "todo!()" in line: | |||
| return 'todo!() should be written as todo!("$details")' | |||
|
|
|||
| if "dbg!(" in line and not line.startswith("//"): | |||
There was a problem hiding this comment.
Any particular reason we're removing this?
There was a problem hiding this comment.
It is (better) checked by clippy in clippy.toml
Co-authored-by: Jeremy Leibs <jeremy@rerun.io>
Co-authored-by: Jeremy Leibs <jeremy@rerun.io>
1 task
2 tasks
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.
Backstory
Sessionwas originally designed for internal use by the Python API. It was then reused as the main interface for the Rust API. However, the needs of the Python API and the Rust API are quite different:Sessions, while in Python we currently have one global sessionSesssiononce, while in Python we have methods to change the recording id etc as the session is aliveSessionneeds to be ergonomic and user-facing for our Rust API, while in Python is an implementation detailWhat this PR does
This PR does two major things:
PythonSessionfor internal use inrerun_py. It is a slightly simplified version of the oldSession.Sessionis now vastly simpler, with only a few methods. It can be constructed with aSessionBuilder.This separation allow us to more easily evolve the Python and Rust APIs independently.
The Rust
Sessionis now associated with oneLogSinkfor the duration of its lifetime. To connect to something else you create a newSession.Sessionis alsoClone,SendandSyncso it can easily be used from multiple threads.Why tho?
I want to be able to easily hook up the
tracinglog stream to send its log events to Rerun, and for that I need to get anArc<dyn LogSink>, which lead me down this rabbit hole. EachSessionneeds to start by sending off aBeginRecordingMsg, and its only after that is sent that one should be able to share aSession, hence this refactor to a builder-pattern.Checklist