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

fix: trim peer str #1115

Merged
merged 4 commits into from
Jun 25, 2024
Merged

fix: trim peer str #1115

merged 4 commits into from
Jun 25, 2024

Conversation

mindfocus
Copy link
Contributor

@mindfocus mindfocus commented Jun 25, 2024

Motivation:

trim peerstr,使其更健壮?

Modification:

trim peerstr,使其更健壮?

Result:

Fixes #.

If there is no issue then describe the changes introduced by this PR.

Summary by CodeRabbit

  • Bug Fixes

    • Improved configuration parsing by trimming spaces in configuration strings.
  • Tests

    • Added a new test to verify configuration parsing with spaces.

Copy link

sofastack-cla bot commented Jun 25, 2024

Hi @mindfocus, welcome to SOFAStack community, Please sign Contributor License Agreement!

After you signed CLA, we will automatically sync the status of this pull request in 3 minutes.

Copy link
Contributor

coderabbitai bot commented Jun 25, 2024

Walkthrough

The overall change enhances the Configuration class's parse method to trim input strings, ensuring better handling of whitespace. Additionally, a new test method testToStringParseWithSpace is added to the ConfigurationTest to verify the functionality of parsing configuration strings with spaces.

Changes

File Path Change Summary
.../jraft/conf/Configuration.java Modified the parse method to trim peerStr before parsing.
.../jraft/conf/ConfigurationTest.java Added a new test method testToStringParseWithSpace to test parsing a configuration string with spaces.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Configuration
    participant StringUtils
    
    Client->>Configuration: Call parse(conf)
    Configuration->>StringUtils: StringUtils.trim(peerStr)
    StringUtils-->>Configuration: Returns trimmed peerStr
    Configuration->>Peer: peer.parse(trimmed peerStr)
    Peer-->>Configuration: Returns parse result
    Configuration-->>Client: Returns from parse method
Loading

Poem

In the land where code does hum,
Strings are trimmed, all are welcome,
Parsing cleanly with a grace,
New tests added, just in case.
A rabbit cheers with joyful cheer,
For code made clear, we’re engineers here!
🌟✨


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.

@mindfocus mindfocus changed the title 去除空格 fix: trim peer str Jun 25, 2024
@sofastack-cla sofastack-cla bot added the bug Something isn't working label Jun 25, 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6be4448 and 2f67463.

Files selected for processing (1)
  • jraft-core/src/main/java/com/alipay/sofa/jraft/conf/Configuration.java (1 hunks)

@sofastack-cla sofastack-cla bot added cla:yes and removed cla:no labels Jun 25, 2024
@sofastack-cla sofastack-cla bot added size/S and removed size/XS labels Jun 25, 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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2f67463 and 4ca53f5.

Files selected for processing (1)
  • jraft-core/src/test/java/com/alipay/sofa/jraft/conf/ConfigurationTest.java (1 hunks)
Additional comments not posted (1)
jraft-core/src/test/java/com/alipay/sofa/jraft/conf/ConfigurationTest.java (1)

44-63: Comprehensive test for space tolerance in configuration parsing

The added test method testToStringParseWithSpace effectively validates the robustness of the Configuration class's parsing logic against leading and trailing spaces in peer strings. This is crucial for ensuring that configuration strings are parsed correctly regardless of formatting discrepancies that might occur in real-world scenarios.

  • Lines 46-48, 55: The test confirms that the original and newly parsed configurations have the same size, which is a good practice for ensuring data consistency after parsing.
  • Lines 49-51, 57-59: The loop and assertions verify that each PeerId starts with the expected string and that specific peers are correctly identified in the configuration. This is essential for validating the integrity of each peer entry.
  • Lines 52, 60: The assertFalse and assertEquals assertions ensure that the configuration is not marked as empty and that the string representation remains consistent before and after parsing, which are good checks for data integrity.

Overall, the test is well-structured and aligns with the objective of enhancing the parsing robustness by handling spaces effectively. This addition complements the existing suite of tests by covering a scenario that was previously untested, thereby improving the overall quality assurance of the Configuration class.

Copy link
Contributor

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@fengjiachun fengjiachun enabled auto-merge (squash) June 25, 2024 03:26
Copy link
Contributor

@caicancai caicancai left a comment

Choose a reason for hiding this comment

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

LGTM

@fengjiachun
Copy link
Contributor

CI failed @mindfocus

auto-merge was automatically disabled June 25, 2024 06:18

Head branch was pushed to by a user without write access

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 4ca53f5 and 7ceaca9.

Files selected for processing (1)
  • jraft-core/src/test/java/com/alipay/sofa/jraft/conf/ConfigurationTest.java (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • jraft-core/src/test/java/com/alipay/sofa/jraft/conf/ConfigurationTest.java

@mindfocus
Copy link
Contributor Author

@fengjiachun fixed.

@killme2008 killme2008 merged commit a71fae7 into sofastack:master Jun 25, 2024
9 checks passed
@mindfocus mindfocus deleted the patch-1 branch June 26, 2024 06:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants