Skip to content
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

Add remote store protobuf/gRPC definitions #7674

Merged
merged 42 commits into from
Oct 19, 2024
Merged

Conversation

zehiko
Copy link
Contributor

@zehiko zehiko commented Oct 10, 2024

What

In this PR we aim to define initial version of the V0 storage node APIs in the form of grpc protobuf definition. We also want to:

  • settle on code generation
  • type conversions (between rerun internal types and grpc types

(currently) Example usage:

use re_storage_types::v0::{
    storage_node_client::StorageNodeClient, RegisterRecordingsRequest
};

...

  let mut client = StorageNodeClient::connect("http://127.0.0.1:51234")
        .await
        .unwrap();

    let resp = client
        .register_recordings(RegisterRecordingsRequest {
            description: "test".to_string(),
            obj_storage:  ObjectStore {
              url: "dna.rd",
              bucket_name: "my_s3_bucket",
            },
            typ: re_storage_types::v0::RecordingType::Rrd.into(),
        })
        .await
        .unwrap()
        .into_inner();

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!
  • If have noted any breaking changes to the log API in CHANGELOG.md and the migration guide

To run all checks from main, comment on the PR with @rerun-bot full-check.

…ilding rust types from the proto definition

We introduce re_remote_store_types with proto definition files for V0 remote store gRPC API. We also introduce re_remote_store_tpyes_builder
that heaveily relies on tonic_build to build the actual rust code from protobuf files.
Copy link

github-actions bot commented Oct 10, 2024

Deployed docs

Commit Link
417f0ce https://landing-h27xvj3fn-rerun.vercel.app/docs

@zehiko zehiko self-assigned this Oct 10, 2024
@zehiko zehiko added exclude from changelog PRs with this won't show up in CHANGELOG.md ⛃ re_datastore affects the datastore itself labels Oct 10, 2024
@teh-cmc teh-cmc self-requested a review October 11, 2024 07:53
Copy link
Member

@teh-cmc teh-cmc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! A few last things but we're very close.

@@ -16,6 +16,7 @@ pub fn viewer_to_server(
// We set a very high limit, because we should be able to trust the server.
// See https://github.com/rerun-io/rerun/issues/5268 for more
max_incoming_frame_size: 2 * gigs,
delay_blocking: Duration::from_millis(10),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A comment explaining what this is and why 10ms would be helpful?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, right, these are new fields (2 more incoming in the next rebase) from ewebsock version 0.7. Will add comments.

crates/build/README.md Outdated Show resolved Hide resolved
crates/store/re_remote_store_types/src/lib.rs Outdated Show resolved Hide resolved
crates/store/re_remote_store_types/src/lib.rs Outdated Show resolved Hide resolved
crates/store/re_remote_store_types/src/lib.rs Show resolved Hide resolved
crates/store/re_remote_store_types/src/lib.rs Outdated Show resolved Hide resolved
@teh-cmc teh-cmc changed the title Add definitions for remote store gRPC API as well as the logic for bu… Add remote store protobuf/gRPC definitions Oct 19, 2024
@teh-cmc
Copy link
Member

teh-cmc commented Oct 19, 2024

@teh-cmc teh-cmc merged commit 454b7ca into main Oct 19, 2024
39 of 40 checks passed
@teh-cmc teh-cmc deleted the zehiko/remote-store-spec branch October 19, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exclude from changelog PRs with this won't show up in CHANGELOG.md ⛃ re_datastore affects the datastore itself
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants