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

refactor(grpc): remove build script for grpc convert benchmark #1721

Merged
merged 1 commit into from
Apr 12, 2024

Conversation

meskill
Copy link
Contributor

@meskill meskill commented Apr 12, 2024

Summary:

Build script was causing redundant project rebuilds. Although, it could be fixed by fixing the build script itself I suggested to refactor benchmark code to looks similar the way tailcall works with grpc and remove additional dependencies

Build & Testing:

  • I ran cargo test successfully.
  • I have run ./lint.sh --mode=fix to fix all linting issues raised by ./lint.sh --mode=check.

Checklist:

  • I have added relevant unit & integration tests.
  • I have updated the documentation accordingly.
  • I have performed a self-review of my code.
  • PR follows the naming convention of <type>(<optional scope>): <title>

Summary by CodeRabbit

  • Chores
    • Updated build dependencies to streamline project configuration.
  • Refactor
    • Improved the efficiency and reliability of dummy data generation for benchmarks related to protobuf conversions.

Copy link
Contributor

coderabbitai bot commented Apr 12, 2024

Walkthrough

Walkthrough

The recent update focuses on optimizing the build process by eliminating tonic-build and protoc-bin-vendored from Cargo.toml's build dependencies. It also enhances the handling of dummy data for benchmark tests using serde_json and rand, improving data manipulation efficiency and overall project maintainability.

Changes

File(s) Change Summary
Cargo.toml Removed tonic-build and protoc-bin-vendored from build dependencies.
benches/.../protobuf_convert_output.rs Refactored dummy value creation with serde_json and rand; updated JSON conversion logic; adjusted protobuf-related paths and constants.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f1bff57 and 43d43de.
Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
Files selected for processing (2)
  • Cargo.toml (1 hunks)
  • benches/protobuf_convert_output.rs (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • Cargo.toml
Additional Context Used
Path-based Instructions (1)
benches/protobuf_convert_output.rs (1)

Pattern **/*.rs: Programming Style Guidelines

  • When calling functions that do not need to modify values, pass references of those values.
  • When calling functions that need to modify values, pass ownership of the values, and ensure they are returned from the function.

IMPORTANT: This programming style may not be suitable for performance-sensitive components or hot code paths. In such cases, prioritize efficiency and optimization strategies to enhance performance.

Testing

  1. Write Tests: For every new feature or bugfix, ensure that you write appropriate tests.
    Structure your tests in the following way:

    use pretty_assertions::assert_eq;
    fn test_something_important() {
       let value = setup_something_using_a_function();
    
       let actual = perform_some_operation_on_the_value(value);
       let expected = ExpectedValue {foo: 1, bar: 2};
    
       assert_eq!(actual, expected);
    }
    • Setup the value using helper methods in tests.
    • Create an actual and an expected value.
    • Assert the two values in a new line.
    • Ensure there are only one assertions per test.
Additional comments not posted (1)
benches/protobuf_convert_output.rs (1)

16-42: The implementation of create_dummy_value using rand and serde_json for generating dummy data is well done. The use of try_fill for error handling is appropriate and aligns with Rust's safety and error handling principles.


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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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.

@github-actions github-actions bot added the type: chore Routine tasks like conversions, reorganization, and maintenance work. label Apr 12, 2024
@meskill meskill added ci: benchmark Runs benchmarks ci: lint Automatically fix the linters issues and make a commit and removed type: chore Routine tasks like conversions, reorganization, and maintenance work. labels Apr 12, 2024
@github-actions github-actions bot added the type: chore Routine tasks like conversions, reorganization, and maintenance work. label Apr 12, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

@meskill meskill removed ci: lint Automatically fix the linters issues and make a commit ci: benchmark Runs benchmarks labels Apr 12, 2024
@meskill meskill enabled auto-merge (squash) April 12, 2024 21:27
build script was causing redundant project rebuilds
@meskill meskill force-pushed the chore/protobuf-convert branch from 0d59efd to 43d43de Compare April 12, 2024 21:31
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

benches/protobuf_convert_output.rs Show resolved Hide resolved
@meskill meskill merged commit 5129e80 into main Apr 12, 2024
31 checks passed
@meskill meskill deleted the chore/protobuf-convert branch April 12, 2024 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: chore Routine tasks like conversions, reorganization, and maintenance work.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants