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: do not overwrite comet config when set in InterceptConfigsPreRunHandler #16395

Merged
merged 4 commits into from
Jun 1, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented May 31, 2023

Description

The SDK seems opinionated about some comet config parameters.
However, it renders the override of those parameters by an app useless and with no feedback.
This adds a check that keeps the SDK opinionated if the value is the default comet value.
Which allows app devs to overwrite those value if they want to.


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
  • added ! to 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
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • 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.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@julienrbrt julienrbrt added the backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release label May 31, 2023
@julienrbrt julienrbrt requested a review from a team as a code owner May 31, 2023 23:49
@github-actions

This comment has been minimized.

Comment on lines +251 to +253
if conf.Consensus.TimeoutCommit == defaultCometCfg.Consensus.TimeoutCommit {
conf.Consensus.TimeoutCommit = 5 * time.Second
}
Copy link
Member

Choose a reason for hiding this comment

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

I don't fully understand this. This is what it's doing:

if conf.Consensus.TimeoutCommit == 1s {
    conf.Consensus.TimeoutCommit = 5s
}

This other seems unnecessary because that's the default value for RecvRate, so it's ineffective:

if conf.P2P.RecvRate == defaultCometCfg.P2P.RecvRate {
			conf.P2P.RecvRate = 5120000
}

Is that expected?

Copy link
Member Author

@julienrbrt julienrbrt Jun 1, 2023

Choose a reason for hiding this comment

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

Well this is what it was always doing, so I kept the same behavior.

The issue is when you purposely change the timeout config in intercept pre handler, then it was getting overwritten here.
Making the override made by the app dev useless.
So this just checks if you didn't change the config before, so the SDK stays opinionated if the app dev hasn't changed that.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed the unnecessary override and added a comment.

@julienrbrt julienrbrt enabled auto-merge June 1, 2023 10:32
@julienrbrt julienrbrt added this pull request to the merge queue Jun 1, 2023
Merged via the queue into main with commit 0bded0d Jun 1, 2023
@julienrbrt julienrbrt deleted the julien/cometcfg branch June 1, 2023 11:24
mergify bot pushed a commit that referenced this pull request Jun 1, 2023
…nHandler` (#16395)

(cherry picked from commit 0bded0d)

# Conflicts:
#	CHANGELOG.md
#	server/util.go
julienrbrt added a commit that referenced this pull request Jun 1, 2023
…nHandler` (backport #16395) (#16399)

Co-authored-by: Julien Robert <julien@rbrt.fr>
roy-dydx pushed a commit to dydxprotocol/cosmos-sdk that referenced this pull request Jul 11, 2023
…nHandler` (backport cosmos#16395) (cosmos#16399)

Co-authored-by: Julien Robert <julien@rbrt.fr>
kakysha pushed a commit to InjectiveLabs/cosmos-sdk that referenced this pull request Aug 15, 2023
…nHandler` (backport cosmos#16395) (cosmos#16399)

Co-authored-by: Julien Robert <julien@rbrt.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants