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

Camel case rename when deserializing protos #273

Closed
wants to merge 1 commit into from

Conversation

cbrit
Copy link
Member

@cbrit cbrit commented Aug 28, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced serialization behavior to use camel case naming conventions for generated Rust structures, improving interoperability with systems expecting camel case JSON formats.
  • Bug Fixes

    • No bug fixes were introduced in this release.
  • Documentation

    • No changes to documentation were made in this release.

@cbrit cbrit requested a review from zmanian August 28, 2024 16:47
Copy link

coderabbitai bot commented Aug 28, 2024

Walkthrough

The change introduces a new configuration option in the build.rs file, specifically within the generate_rust_protos function. This addition specifies that all fields in the generated Rust structures should be serialized using camel case naming conventions. The existing functionality for compiling protocol buffers remains unchanged.

Changes

Files Change Summary
build.rs Added a configuration line to generate_rust_protos to serialize fields in camel case.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Build System
    participant Rust Protos

    User->>Build System: Initiate build
    Build System->>Rust Protos: Compile protocol buffers
    Rust Protos->>Build System: Generate Rust code with camel case
    Build System->>User: Complete build
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b0decf4 and c4273e9.

Files ignored due to path filters (2)
  • Cargo.lock is excluded by !**/*.lock, !**/*.lock
  • crates/steward-proto/src/gen/steward.v4.rs is excluded by !**/gen/**
Files selected for processing (1)
  • build.rs (1 hunks)
Additional comments not posted (1)
build.rs (1)

194-194: LGTM!

The configuration line for camel case serialization is correctly added and beneficial for interoperability.

The code changes are approved.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@cbrit
Copy link
Member Author

cbrit commented Aug 28, 2024

Nixing this, creates some issues with proposal deserialization

@cbrit cbrit closed this Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants