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

feat: store peer info in TableFlowValue #4280

Merged
merged 2 commits into from
Jul 4, 2024

Conversation

WenyXu
Copy link
Member

@WenyXu WenyXu commented Jul 4, 2024

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Storing peer info in FlowTableValue which reduce one query when mirror insertion.

The original steps:

  1. Querying TableId -> FlowIds
  2. Querying FlowId -> Peers

Checklist

  • I have written the necessary rustdoc comments.
  • I have added the necessary unit tests and integration tests.
  • This PR requires documentation updates.

Summary by CodeRabbit

  • New Features

    • Enhanced flow management to include peer information alongside flownode data.
  • Bug Fixes

    • Corrected key format in FlowRouteManager to ensure accurate flow partition handling.
  • Performance Improvements

    • Switched from HashSet to Arc<HashMap> for flownode storage, which improves data handling efficiency.
  • Developer Experience

    • Simplified the creation of flow transactions with updated data structures and serialization support.
    • Improved test suite to align with the new data handling mechanisms.

@WenyXu WenyXu requested review from MichaelScofield and a team as code owners July 4, 2024 07:35
@WenyXu WenyXu requested review from fengjiachun and discord9 July 4, 2024 07:35
Copy link
Contributor

coderabbitai bot commented Jul 4, 2024

Walkthrough

The recent changes involve modifying the handling of Flownode data throughout the codebase. The primary adjustment is transitioning from HashSet to using Arc<HashMap>, which accommodates more sophisticated data structures by including Peer information. This alteration necessitated updates in several modules, including table_flownode, create_flow, instruction, and others. Function signatures and logic were revised to work with the new data structure. Corresponding test cases were also updated.

Changes

Files Change Summary
src/common/meta/src/cache/flow/table_flownode.rs Switched from HashSet to Arc<HashMap> for FlownodeSet, updated functions for new structure, and adjusted test cases.
src/common/meta/src/ddl/create_flow.rs Replaced mapping of flownode_ids with flownode_peers and updated function implementations accordingly.
src/common/meta/src/instruction.rs Changed from flownode_ids to flownodes vectors and included import for Peer.
src/common/meta/src/key.rs Added TableFlowValue to the list of entities in the impl_table_meta_value! macro.
src/common/meta/src/key/flow.rs Added import for TableFlowValue, modified build_create_txn methods, updated test data, adjusted assertions.
src/common/meta/src/key/flow/flow_route.rs Updated key format in FlowRouteManager implementation.
src/common/meta/src/key/flow/table_flow.rs Introduced serde serialization, added TableFlowValue struct, adjusted decoder, flows, and build_create_txn functions.
src/operator/src/insert.rs Changed logic for retrieving and cloning values in Inserter implementation.

Poem

🐰 In lines of code, a shift we see,
From sets to maps, we set them free.
Peers now join the nodes we flow,
A structure changed for them to show.
In tests and functions did we dive,
The code anew, now more alive!
With keys and tables, paths now new,
Together we, the bugs eschew. 🐰


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.
    • @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 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 docs-not-required This change does not impact docs. label Jul 4, 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: 4

Outside diff range and nitpick comments (8)
src/common/meta/src/key/flow/flow_route.rs (1)

190-190: Add missing parameter documentation.

The partition_id parameter is added to the build_create_txn function but is not documented. Ensure all function parameters are documented for clarity.

src/common/meta/src/key/flow/table_flow.rs (3)

20-20: Organize imports.

Group related imports together for better readability. Consider grouping serde imports together and crate imports together.

Also applies to: 26-26, 29-29


171-174: Add documentation for TableFlowValue.

The TableFlowValue struct is missing Rustdoc comments. Add documentation to explain the purpose and usage of this struct.


199-202: Add missing documentation for flows function parameters.

The flows function is missing documentation for its parameters. Ensure all parameters are documented for clarity.

src/common/meta/src/instruction.rs (2)

28-28: Organize imports.

Group related imports together for better readability. Consider grouping serde imports together and crate imports together.


173-173: Add documentation for flownode_peers field.

The flownode_peers field in the CreateFlow struct is missing documentation. Add documentation to explain the purpose and usage of this field.

src/common/meta/src/cache/flow/table_flownode.rs (2)

15-15: Organize imports.

Group related imports together for better readability. Consider grouping std imports together and crate imports together.

Also applies to: 29-29


32-32: Update type alias documentation.

The FlownodeSet type alias should have updated documentation to reflect the change from HashSet to Arc<HashMap>.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 03c933c and baa23aa.

Files selected for processing (8)
  • src/common/meta/src/cache/flow/table_flownode.rs (11 hunks)
  • src/common/meta/src/ddl/create_flow.rs (1 hunks)
  • src/common/meta/src/instruction.rs (2 hunks)
  • src/common/meta/src/key.rs (2 hunks)
  • src/common/meta/src/key/flow.rs (4 hunks)
  • src/common/meta/src/key/flow/flow_route.rs (1 hunks)
  • src/common/meta/src/key/flow/table_flow.rs (4 hunks)
  • src/operator/src/insert.rs (1 hunks)
Additional comments not posted (6)
src/common/meta/src/cache/flow/table_flownode.rs (1)

108-115: Improve error handling in handle_drop_flow.

Add context to the error handling in the handle_drop_flow function for better debugging.

-                async |entry: Option<moka::Entry<u32, Arc<HashMap<u64, _>>>>| match entry {
-                    Some(entry) => {
-                        let mut set = entry.into_value().as_ref().clone();
-                        for flownode_id in flownode_ids {
-                            set.remove(flownode_id);
-                        }

-                        Op::Put(Arc::new(set))
-                    }
-                    None => {
-                        // Do nothing
-                        Op::Nop
-                    }
-                },
+                async |entry: Option<moka::Entry<u32, Arc<HashMap<u64, _>>>>| {
+                    if let Some(entry) = entry {
+                        let mut set = entry.into_value().as_ref().clone();
+                        for flownode_id in flownode_ids {
+                            set.remove(flownode_id);
+                        }
+                        Op::Put(Arc::new(set))
+                    } else {
+                        // Do nothing
+                        Op::Nop
+                    }
+                },

Likely invalid or redundant comment.

src/common/meta/src/ddl/create_flow.rs (1)

197-197: LGTM! But verify the usage of flownode_peers.

The code changes are approved.

However, ensure that all instances of flownode_ids have been correctly replaced with flownode_peers.

src/common/meta/src/key/flow.rs (1)

171-176: LGTM! But verify the transformation logic.

The code changes are approved.

However, ensure that the transformation logic for flow_routes to TableFlowValue is consistent throughout the codebase.

Verification successful

Let's create a new shell script to accurately search for the transformation logic related to TableFlowValue { peer: route.peer } by escaping the curly braces.


To ensure consistency in the transformation logic throughout the codebase, let's search for all instances where TableFlowValue is used.


To verify the consistency of the transformation logic, let's extract the specific lines where TableFlowValue is instantiated in flow.rs and table_flow.rs.


To ensure consistency in the transformation logic, let's extract and review the lines around the instances of TableFlowValue in flow.rs and table_flow.rs.


Transformation Logic Verified

The transformation logic for flow_routes to TableFlowValue { peer: route.peer } is consistent throughout the codebase. The instances in flow.rs and the definition in table_flow.rs align correctly.

  • flow.rs:

    • Line 173: Transformation logic
    • Lines 438-444: Consistent usage of TableFlowValue { peer: Peer::empty(x) }
  • table_flow.rs:

    • Line 172: Definition of TableFlowValue
    • Line 179: Usage in table_flow_decoder
    • Lines 202, 221: Usage in methods
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the transformation logic for `flow_routes` to `TableFlowValue`.

# Test: Search for the transformation logic. Expect: Consistent usage of `TableFlowValue { peer: route.peer }`.
rg --type rust $'TableFlowValue { peer: route.peer }'

Length of output: 189


Script:

#!/bin/bash
# Description: Verify the transformation logic for `flow_routes` to `TableFlowValue`.

# Test: Search for the transformation logic. Expect: Consistent usage of `TableFlowValue { peer: route.peer }`.
rg --type rust 'TableFlowValue \{ peer: route.peer \}'

Length of output: 186


Script:

#!/bin/bash
# Description: Verify the usage of `TableFlowValue` throughout the codebase.

# Test: Search for all instances of `TableFlowValue`. Expect: Consistent transformation logic.
rg --type rust 'TableFlowValue'

Length of output: 1010


Script:

#!/bin/bash
# Description: Extract lines where `TableFlowValue` is instantiated for verification.

# Extract lines from `flow.rs`
rg --type rust 'TableFlowValue' src/common/meta/src/key/flow.rs -n

# Extract lines from `table_flow.rs`
rg --type rust 'TableFlowValue' src/common/meta/src/key/flow/table_flow.rs -n

Length of output: 704


Script:

#!/bin/bash
# Description: Extract surrounding lines where `TableFlowValue` is instantiated for detailed verification.

# Extract surrounding lines from `flow.rs`
rg --type rust 'TableFlowValue' src/common/meta/src/key/flow.rs -A 3 -B 3

# Extract surrounding lines from `table_flow.rs`
rg --type rust 'TableFlowValue' src/common/meta/src/key/flow/table_flow.rs -A 3 -B 3

Length of output: 2122

src/operator/src/insert.rs (1)

344-345: LGTM! But verify the usage of flownode_peers.

The code changes are approved.

However, ensure that all instances of flownode_ids have been correctly replaced with flownode_peers.

src/common/meta/src/key.rs (2)

115-115: Addition of TableFlowValue to impl_table_meta_value! macro is correct.

The addition follows the existing pattern and ensures that TableFlowValue implements the TableMetaValue trait.


1198-1198: Addition of TableFlowValue to impl_table_meta_value! macro is correct.

The addition follows the existing pattern and ensures that TableFlowValue implements the TableMetaValue trait.

src/common/meta/src/key/flow/table_flow.rs Show resolved Hide resolved
src/common/meta/src/key/flow/table_flow.rs Show resolved Hide resolved
src/common/meta/src/cache/flow/table_flownode.rs Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jul 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.69%. Comparing base (ee9a5d7) to head (ef19cc8).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4280      +/-   ##
==========================================
- Coverage   84.94%   84.69%   -0.25%     
==========================================
  Files        1057     1058       +1     
  Lines      187517   188109     +592     
==========================================
+ Hits       159279   159327      +48     
- Misses      28238    28782     +544     

src/common/meta/src/instruction.rs Outdated Show resolved Hide resolved
@fengjiachun fengjiachun enabled auto-merge July 4, 2024 08:39
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between baa23aa and ef19cc8.

Files selected for processing (3)
  • src/common/meta/src/cache/flow/table_flownode.rs (11 hunks)
  • src/common/meta/src/ddl/create_flow.rs (1 hunks)
  • src/common/meta/src/instruction.rs (2 hunks)
Files skipped from review as they are similar to previous changes (3)
  • src/common/meta/src/cache/flow/table_flownode.rs
  • src/common/meta/src/ddl/create_flow.rs
  • src/common/meta/src/instruction.rs

@fengjiachun fengjiachun added this pull request to the merge queue Jul 4, 2024
Merged via the queue into GreptimeTeam:main with commit 4ec247f Jul 4, 2024
49 of 53 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-not-required This change does not impact docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants