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(confix): correctly distinguish server/v2 config #22780

Merged
merged 2 commits into from
Dec 5, 2024

Conversation

kocubinski
Copy link
Member

@kocubinski kocubinski commented Dec 5, 2024

Description

Since the removal of SS from store/v2, and call to config set app will fail in server/v2 with

updated config is invalid: server config invalid: set min gas price in app.toml or flag or env variable: error in app.toml [cosmossdk.io/errors@v1.0.1/errors.go:151]

This fixes it.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Bug Fixes
    • Updated configuration string handling to improve validation processes related to "serverv2."
    • Enhanced error messages for better clarity during configuration transformations and validations.

Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the Upgrade function in the tools/confix/upgrade.go file. The primary update is the alteration of the string used to identify "serverv2" configurations, changing from "store.options.ss-pruning-option" to "store.options.sc-pruning-option." This affects the validation logic without altering error handling or control flow. The function continues to return formatted error messages and calls the CheckValid function when necessary.

Changes

File Change Summary
tools/confix/upgrade.go Updated string check in Upgrade function from "store.options.ss-pruning-option" to "store.options.sc-pruning-option" for configuration validation. Error handling remains unchanged.

Possibly related PRs

Suggested labels

C:server/v2

Suggested reviewers

  • tac0turtle
  • sontrinh16
  • akhilkumarpilli
  • hieuvubk

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between abc5fd0 and 5b27e91.

📒 Files selected for processing (1)
  • tools/confix/upgrade.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
tools/confix/upgrade.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🔇 Additional comments (2)
tools/confix/upgrade.go (2)

Line range hint 46-53: LGTM: Error handling and validation logic are sound

The validation skip logic is well-implemented:

  1. Correctly identifies serverv2 configs using the store options path
  2. Respects the skipValidate parameter
  3. Properly handles validation errors with descriptive messages

47-47: Verify the new configuration path for store options

The change from ss-pruning-option to sc-pruning-option aligns with the removal of SS from store/v2 configuration. However, let's verify that this is the correct new path.

✅ Verification successful

The configuration path change is correct and consistent

The verification confirms that:

  • The new path store.options.sc-pruning-option is used consistently across the codebase
  • It's properly defined in store/v2/root/factory.go as a configuration field
  • The migration paths in tools/confix/migrations.go also use this new path for both keep-recent and interval settings
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any other occurrences of pruning options in the codebase
# to ensure consistency and verify the new path

echo "Searching for pruning option references:"
rg -A 2 "pruning-option" --type go

echo "Searching for store options configuration:"
rg -A 5 "store\.options" --type go

Length of output: 2333


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 C:Confix Issues and PR related to Confix label Dec 5, 2024
Copy link
Contributor

github-actions bot commented Dec 5, 2024

@kocubinski your pull request is missing a changelog!

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

ACK

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Dec 5, 2024
@kocubinski kocubinski enabled auto-merge December 5, 2024 20:47
@kocubinski kocubinski added this pull request to the merge queue Dec 5, 2024
Merged via the queue into main with commit 10c5400 Dec 5, 2024
77 of 78 checks passed
@kocubinski kocubinski deleted the kocu/server-v2-config branch December 5, 2024 22:56
mergify bot pushed a commit that referenced this pull request Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:Confix Issues and PR related to Confix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants