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

WIP: Initial V0 storage node API grpc spec #7634

Closed
wants to merge 11 commits into from
Closed

Conversation

zehiko
Copy link
Contributor

@zehiko zehiko commented Oct 8, 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(),
            storage_url: "dna.rrd".to_string(),
            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.

@zehiko zehiko added the exclude from changelog PRs with this won't show up in CHANGELOG.md label Oct 8, 2024
@zehiko zehiko self-assigned this Oct 8, 2024
Copy link

github-actions bot commented Oct 8, 2024

Deployed docs

Commit Link
eac1888 https://landing-k16d3bte5-rerun.vercel.app/docs

@zehiko zehiko requested review from jleibs and teh-cmc October 8, 2024 12:50
@teh-cmc
Copy link
Member

teh-cmc commented Oct 9, 2024

Im inferring from the big "WIP" in the title that this is a draft 😶 -- marking as such to unclog the review queue.

@teh-cmc teh-cmc marked this pull request as draft October 9, 2024 07:05
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.

LGTM! I like where this is going.

  • I don't like the names re_storage_types and re_storage_types_builder, in fact I just don't like "storage" in general. Whatever, I don't think that matters in the slightest right now.
  • Very happy about the codegen setup (unsurprisingly).
  • Very happy about the duplicated types (unsurprisingly).
  • Naming of all things will need some love in general, but we can do that later.

crates/build/re_storage_types_builder/src/lib.rs Outdated Show resolved Hide resolved
crates/store/re_storage_types/proto/rerun/v0/storage.proto Outdated Show resolved Hide resolved
crates/store/re_storage_types/proto/rerun/v0/storage.proto Outdated Show resolved Hide resolved
crates/store/re_storage_types/src/lib.rs Outdated Show resolved Hide resolved
@zehiko zehiko closed this Oct 10, 2024
@zehiko zehiko deleted the zehiko/storage-grpc-spec branch October 10, 2024 10:18
@zehiko
Copy link
Contributor Author

zehiko commented Oct 10, 2024

(acidentally) closed in favour of #7674

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants