fix(x/epochs): avoid invalid epoch duration in simulation #20030

mmsqe · 2024-04-12T15:01:11Z

for more info, https://github.com/cosmos/cosmos-sdk/actions/runs/8663743427/job/23758527794?pr=20028

Description

Closes: #XXXX

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

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
- Improved the epoch duration settings in simulations to ensure durations are between 1 hour and 1 week, enhancing the reliability of time-based simulations.

for more info, https://github.com/cosmos/cosmos-sdk/actions/runs/8663743427/job/23758527794?pr=20028

coderabbitai · 2024-04-12T15:01:15Z

Walkthrough

The recent update introduces a refinement in the simulation module of the x/epochs component. This adjustment ensures that the epoch duration generated during the simulation now ranges between 1 hour and 1 week, enhancing the accuracy and reliability of the simulation results.

Changes

File	Change Summary
`.../simulation/genesis.go`	Modified `GenDuration` to generate random durations between 1 hour and 1 week.
`CHANGELOG.md`	Added a fix to prevent invalid epoch duration in the `x/epochs` simulation.

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.

coderabbitai

Actionable comments posted: 1

coderabbitai · 2024-04-12T15:07:36Z

x/epochs/simulation/genesis.go

@@ -14,7 +14,7 @@ import (

 // GenCommunityTax randomized CommunityTax
 func GenDuration(r *rand.Rand) time.Duration {
-	return time.Hour * time.Duration(r.Intn(168)) // limit 1 week
+	return time.Hour * time.Duration(r.Intn(167)+1) // between 1 hour to 1 week


Ensure the upper bound of the random duration is correctly set. The current implementation (r.Intn(167)+1) generates a number between 1 and 167, which corresponds to 1 hour to 167 hours (not a full week). Consider adjusting this to r.Intn(168)+1 to include the full range up to 168 hours (1 week).

- return time.Hour * time.Duration(r.Intn(167)+1) // between 1 hour to 1 week + return time.Hour * time.Duration(r.Intn(168)+1) // between 1 hour to 1 week

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

return time.Hour * time.Duration(r.Intn(167)+1) // between 1 hour to 1 week

return time.Hour * time.Duration(r.Intn(168)+1) // between 1 hour to 1 week

should we follow the original logic which is 167 hours

@mmsqe, the suggestion to adjust the upper bound to 168 hours was aimed at ensuring the duration could fully cover up to a complete week (168 hours). This adjustment was intended to enhance the accuracy of the simulation's time span.

However, if there's a specific reason or context within the simulation framework that makes 167 hours more appropriate, or if aligning exactly to a week introduces any issues, it would be helpful to understand that context. Could you please share if there's a particular reason for preferring the original logic of 167 hours? This will help in making the most informed decision.

julienrbrt

utACK

julienrbrt · 2024-04-12T15:15:26Z

CHANGELOG.md

@@ -114,6 +114,7 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i
 * [#19851](https://github.com/cosmos/cosmos-sdk/pull/19851) Fix some places in which we call Remove inside a Walk (x/staking and x/gov).
 * (baseapp) [#19970](https://github.com/cosmos/cosmos-sdk/pull/19970) Fix default config values to use no-op mempool as default.
 * (x/bank) [#20028](https://github.com/cosmos/cosmos-sdk/pull/20028) Align query with multi denoms for send-enabled.
+* (simulation) [#20030](https://github.com/cosmos/cosmos-sdk/pull/20030) Avoid invalid epoch duration in x/epochs simulation.


we don't need a changelog for this.

* main: (25 commits) fix: Implement gogoproto customtype to secp256r1 keys (cosmos#20027) fix(x/epochs): avoid invalid epoch duration in simulation (cosmos#20030) fix(x/bank): align query with multi denoms for send-enabled (cosmos#20028) refactor(x/slashing)!: remove Accounts String (cosmos#20026) refactor(x/evidence)!: remove Address.String() (cosmos#20016) chore: make telemetry consistent (cosmos#20025) chore: prepare x/tx changelog (cosmos#20015) build(deps): Bump actions/add-to-project from 1.0.0 to 1.0.1 (cosmos#20018) feat(x/bank): support depinject for send restrictions (cosmos#20014) feat: Conditionally emit metrics based on enablement (cosmos#19903) fix(store): fix the typo (cosmos#20011) docs(x/feegrant): fix allowance typo (cosmos#20000) chore(confix): update latest config value (cosmos#20012) refactor(x/auth): auth module can recognize x/accounts account (cosmos#20002) fix(mempool): use no-op mempool as default (cosmos#19970) fix(simapp): add epoch store to upgrade (cosmos#20007) test(kv): add unit tests for the helpers functions kv.AssertKeyAtLeas… (cosmos#19965) feat(x/tx): Rename custom Amino JSON encoder to "inline_json" (cosmos#19919) refactor(x/auth): use transaction service (cosmos#19967) fix(client/v2): add encoder for `cosmos.base.v1beta1.DecCoin` (cosmos#19976) ...

* main: fix: Implement gogoproto customtype to secp256r1 keys (#20027) fix(x/epochs): avoid invalid epoch duration in simulation (#20030) fix(x/bank): align query with multi denoms for send-enabled (#20028) refactor(x/slashing)!: remove Accounts String (#20026) refactor(x/evidence)!: remove Address.String() (#20016) chore: make telemetry consistent (#20025) chore: prepare x/tx changelog (#20015) build(deps): Bump actions/add-to-project from 1.0.0 to 1.0.1 (#20018) feat(x/bank): support depinject for send restrictions (#20014) feat: Conditionally emit metrics based on enablement (#19903) fix(store): fix the typo (#20011) docs(x/feegrant): fix allowance typo (#20000) chore(confix): update latest config value (#20012)

fix(x/epochs): avoid invalid epoch duration in simulation

526f500

for more info, https://github.com/cosmos/cosmos-sdk/actions/runs/8663743427/job/23758527794?pr=20028

github-actions bot added C:Simulations C:x/epochs labels Apr 12, 2024

update doc

c212974

mmsqe marked this pull request as ready for review April 12, 2024 15:01

mmsqe requested a review from a team as a code owner April 12, 2024 15:01

coderabbitai bot reviewed Apr 12, 2024

View reviewed changes

Apply suggestions from code review

cd39b88

julienrbrt approved these changes Apr 12, 2024

View reviewed changes

Apply suggestions from code review

a2cb4e5

tac0turtle approved these changes Apr 12, 2024

View reviewed changes

tac0turtle enabled auto-merge April 12, 2024 15:46

tac0turtle added this pull request to the merge queue Apr 12, 2024

Merged via the queue into cosmos:main with commit ce373b6 Apr 12, 2024
55 of 57 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(x/epochs): avoid invalid epoch duration in simulation #20030

fix(x/epochs): avoid invalid epoch duration in simulation #20030

mmsqe commented Apr 12, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 12, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Apr 12, 2024 •

edited

Loading

mmsqe Apr 12, 2024

coderabbitai bot Apr 12, 2024

julienrbrt left a comment

julienrbrt Apr 12, 2024

	return time.Hour * time.Duration(r.Intn(167)+1) // between 1 hour to 1 week
	return time.Hour * time.Duration(r.Intn(168)+1) // between 1 hour to 1 week

fix(x/epochs): avoid invalid epoch duration in simulation #20030

fix(x/epochs): avoid invalid epoch duration in simulation #20030

Conversation

mmsqe commented Apr 12, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Apr 12, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 12, 2024 • edited Loading

Choose a reason for hiding this comment

mmsqe Apr 12, 2024

Choose a reason for hiding this comment

coderabbitai bot Apr 12, 2024

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

julienrbrt Apr 12, 2024

Choose a reason for hiding this comment

mmsqe commented Apr 12, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 12, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

coderabbitai bot Apr 12, 2024 •

edited

Loading