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

chore: finish prep beta.2 #23411

Merged
merged 2 commits into from
Jan 16, 2025
Merged

chore: finish prep beta.2 #23411

merged 2 commits into from
Jan 16, 2025

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jan 16, 2025

Description

I have just tagged now that sims are integrated:

This adds the changelog and bumps it in the relevant packages.
Noticed we haven't had a changelog in runtime/v2 so adding one.

A nice follow-up would be to tag core/testing/v0.0.2 once #23355 is merged.


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

  • New Features

    • Introduced TransactionFuzzer interface for processing and generating state transitions
    • Added DeliverSims interface for handling state transitions by simulations
  • Dependency Updates

    • Updated multiple module dependencies to newer beta versions
    • Upgraded cosmossdk.io/x/tx to stable version v1.0.0
  • Changelog Improvements

    • Established structured changelog format with semantic versioning guidelines
    • Added detailed version entries for v2.0.0-beta.2 and v1.0.0-beta.2
  • Bug Fixes

    • Fixed gRPC reflection
    • Modified command name retrieval in IsAppRequired() function

@julienrbrt julienrbrt requested a review from a team as a code owner January 16, 2025 08:25
Copy link
Contributor

coderabbitai bot commented Jan 16, 2025

📝 Walkthrough

Walkthrough

This pull request introduces structured changelog management across multiple modules in the Cosmos SDK repository. The changes primarily focus on updating changelog files for runtime/v2, server/v2, server/v2/appmanager, and server/v2/stf modules. Additionally, several go.mod files have been updated with new dependency versions, specifically incrementing versions for cosmossdk.io/server/v2/appmanager and cosmossdk.io/server/v2/stf from v1.0.0-beta.1 to v1.0.0-beta.2.

Changes

File Change Summary
runtime/v2/CHANGELOG.md Added guiding principles for changelog management, new sections for [Unreleased] and v2.0.0-beta.1
runtime/v2/go.mod Updated dependency versions for cosmossdk.io/server/v2/appmanager, cosmossdk.io/server/v2/stf, and cosmossdk.io/x/tx
server/v2/CHANGELOG.md Added new version entry for v2.0.0-beta.2, retained v2.0.0-beta.1
server/v2/appmanager/CHANGELOG.md Added new version entry v1.0.0-beta.2 with TransactionFuzzer interface
server/v2/commands.go Modified IsAppRequired function to use cmd.Name() instead of cmd.Use
server/v2/stf/CHANGELOG.md Added new version entry v1.0.0-beta.2 with DeliverSims interface
Multiple go.mod files Updated dependency versions for cosmossdk.io/server/v2/appmanager and cosmossdk.io/server/v2/stf

Possibly related PRs

Suggested Labels

C:x/staking, C:CLI, C:x/gov, C:x/slashing, C:x/distribution, C:x/mint, C:Simulations, C:Store, C:x/bank, C:x/evidence, C:x/upgrade, C:x/feegrant, C:x/authz, C:x/group, C:x/nft, C:x/consensus, C:x/circuit, C:x/accounts, C:x/protocolpool, C:x/epochs, C:x/accounts/lockup, C:x/accounts/multisig, C:x/accounts/base, T:Docs, Type: ADR

Suggested Reviewers

  • sontrinh16
  • kocubinski
  • aljo242

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

🧹 Nitpick comments (1)
server/v2/appmanager/CHANGELOG.md (1)

27-27: Fix typo in changelog entry

There's a typo in the changelog message: "generated" should be "generating".

-* [#23013](https://github.com/cosmos/cosmos-sdk/pull/23013) Introduce `TransactionFuzzer`, an interface for processing and generated state transitions.
+* [#23013](https://github.com/cosmos/cosmos-sdk/pull/23013) Introduce `TransactionFuzzer`, an interface for processing and generating state transitions.
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a03c90b and db12dfb.

⛔ Files ignored due to path filters (2)
  • runtime/v2/go.sum is excluded by !**/*.sum
  • server/v2/go.sum is excluded by !**/*.sum
📒 Files selected for processing (10)
  • runtime/v2/CHANGELOG.md (1 hunks)
  • runtime/v2/go.mod (1 hunks)
  • server/v2/CHANGELOG.md (1 hunks)
  • server/v2/appmanager/CHANGELOG.md (1 hunks)
  • server/v2/cometbft/go.mod (1 hunks)
  • server/v2/commands.go (1 hunks)
  • server/v2/go.mod (1 hunks)
  • server/v2/stf/CHANGELOG.md (1 hunks)
  • simapp/v2/go.mod (3 hunks)
  • tests/go.mod (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • runtime/v2/CHANGELOG.md
🧰 Additional context used
📓 Path-based instructions (5)
server/v2/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

server/v2/appmanager/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

tests/go.mod (1)

Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"

server/v2/commands.go (1)

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

server/v2/stf/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: test-system-v2
  • GitHub Check: Summary
  • GitHub Check: Summary
  • GitHub Check: Analyze
🔇 Additional comments (10)
server/v2/commands.go (1)

208-208: Improvement in command name retrieval logic

The change from cmd.Use to cmd.Name() is a good improvement as it provides a more precise way to get the command name without any additional usage information or formatting that might be present in the Use field.

server/v2/stf/CHANGELOG.md (1)

25-28: LGTM! Changelog entry follows guidelines

The changelog entry is well-formatted with:

  • Proper version linking
  • Clear reference to the GitHub issue
  • Concise description of the new feature
server/v2/CHANGELOG.md (1)

25-28: LGTM! Well-structured changelog entries

The changelog entries are properly formatted with:

  • Clear version linking
  • GitHub issue references
  • Concise descriptions of changes
runtime/v2/go.mod (2)

18-19: Version updates look consistent.

The updates to appmanager and stf dependencies align with changes in other modules, maintaining version consistency across the codebase.

Also applies to: 21-21


21-21: Notable upgrade: tx module reaches stable version.

The cosmossdk.io/x/tx dependency has been upgraded from v1.0.0-alpha.3 to v1.0.0, marking a significant milestone as it moves from alpha to a stable release.

Let's verify the compatibility of this major version change:

✅ Verification successful

Verified: The tx module upgrade to v1.0.0 is safe to proceed.

The upgrade from v1.0.0-alpha.3 to v1.0.0 marks the stabilization of the tx module's API. The module is extensively used across core components for transaction handling, signing, and verification. The graduation from alpha to stable release indicates API maturity and stability, making this a safe upgrade.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any breaking changes in tx module usage
# Search for any imports or usage of the tx module that might be affected
rg -l "cosmossdk.io/x/tx"

Length of output: 4455


Script:

#!/bin/bash
# Search for actual imports and usage of tx module in non-test files
# Exclude go.mod, go.sum, and test files
rg "cosmossdk.io/x/tx" \
  --type go \
  --glob '!*_test.go' \
  -B 2 -A 2 \
  --no-ignore

Length of output: 12795

server/v2/go.mod (1)

16-16: Version update is consistent.

The update of appmanager dependency to v1.0.0-beta.2 maintains consistency with other modules.

server/v2/cometbft/go.mod (1)

25-26: Version updates are consistent.

The updates to both appmanager and stf dependencies to v1.0.0-beta.2 maintain consistency with other modules.

tests/go.mod (1)

29-29: Version updates are consistent.

The updates to both appmanager and stf dependencies to v1.0.0-beta.2 maintain consistency with other modules.

Also applies to: 74-74

simapp/v2/go.mod (2)

15-15: Version updates are consistent.

The updates to both appmanager and stf dependencies to v1.0.0-beta.2 maintain consistency with other modules.

Also applies to: 68-68


19-19: New dependencies added.

The following new dependencies have been added:

  • cosmossdk.io/tools/confix
  • cosmossdk.io/x/accounts/defaults/lockup

Please ensure these new dependencies are necessary and their pseudo-versions (0.0.0-00010101000000-000000000000) are replaced with proper versions in the replace directives.

Let's verify the usage of these new dependencies:

Also applies to: 22-22

✅ Verification successful

Dependencies are properly managed and necessary

Both new dependencies are internal modules with proper replace directives:

  • cosmossdk.io/tools/confix => ../../tools/confix
  • cosmossdk.io/x/accounts/defaults/lockup => ../../x/accounts/defaults/lockup

The pseudo-versions are correctly handled by local replace directives, and both modules show legitimate usage in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for actual usage of the new dependencies
# Search for imports of the new modules
rg -l "cosmossdk.io/tools/confix"
rg -l "cosmossdk.io/x/accounts/defaults/lockup"

Length of output: 1622


Script:

#!/bin/bash
# Check replace directives in go.mod
cat simapp/v2/go.mod | grep -A 1 "replace"

Length of output: 670


Script:

#!/bin/bash
# View complete go.mod file
cat simapp/v2/go.mod

Length of output: 15041

@julienrbrt julienrbrt added this pull request to the merge queue Jan 16, 2025
Merged via the queue into main with commit 6ffebdf Jan 16, 2025
78 of 81 checks passed
@julienrbrt julienrbrt deleted the julien/prep-beta-2 branch January 16, 2025 09:01
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

🧹 Nitpick comments (1)
server/v2/appmanager/CHANGELOG.md (1)

27-27: Enhance the changelog entry description.

While the entry follows the correct format, it could be more descriptive about the purpose and impact of introducing the TransactionFuzzer interface. Consider adding details about:

  • Why this interface was introduced
  • What problems it solves
  • How it benefits users or developers
-* [#23013](https://github.com/cosmos/cosmos-sdk/pull/23013) Introduce `TransactionFuzzer`, an interface for processing and generated state transitions.
+* [#23013](https://github.com/cosmos/cosmos-sdk/pull/23013) Introduce `TransactionFuzzer`, an interface for processing and generating state transitions. This interface enhances testing capabilities by allowing systematic exploration of state transitions and transaction validation scenarios.
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a03c90b and db12dfb.

⛔ Files ignored due to path filters (2)
  • runtime/v2/go.sum is excluded by !**/*.sum
  • server/v2/go.sum is excluded by !**/*.sum
📒 Files selected for processing (10)
  • runtime/v2/CHANGELOG.md (1 hunks)
  • runtime/v2/go.mod (1 hunks)
  • server/v2/CHANGELOG.md (1 hunks)
  • server/v2/appmanager/CHANGELOG.md (1 hunks)
  • server/v2/cometbft/go.mod (1 hunks)
  • server/v2/commands.go (1 hunks)
  • server/v2/go.mod (1 hunks)
  • server/v2/stf/CHANGELOG.md (1 hunks)
  • simapp/v2/go.mod (3 hunks)
  • tests/go.mod (2 hunks)
✅ Files skipped from review due to trivial changes (2)
  • tests/go.mod
  • runtime/v2/CHANGELOG.md
🧰 Additional context used
📓 Path-based instructions (4)
server/v2/commands.go (1)

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

server/v2/stf/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

server/v2/appmanager/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

server/v2/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Summary
  • GitHub Check: Summary
  • GitHub Check: Analyze
🔇 Additional comments (8)
server/v2/commands.go (1)

208-208: LGTM! Using cmd.Name() improves command path matching precision.

The change from cmd.Use to cmd.Name() ensures more accurate command path matching by using only the command name without usage information.

Let's verify that all command paths are correctly matched with this change:

✅ Verification successful

Verified: cmd.Name() is the correct choice for command path matching

The change is verified to be correct as the IsAppRequired function compares against pre-defined command paths that contain only command names. Using cmd.Name() instead of cmd.Use ensures exact matching without interference from usage information.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find all cobra command definitions and their usage patterns
rg -U "cobra\.Command\s*=\s*&cobra\.Command\s*{[^}]*Use:\s*\"([^\"]+)\"" -g "*.go"

Length of output: 265


Script:

#!/bin/bash
# Find cobra command definitions with their Use and Name fields
ast-grep --pattern 'cobra.Command{
  $$$
  Use: $_,
  $$$
}'

# Find command path related code
rg -A 3 "cmdPath.*append" -g "*.go"

Length of output: 296


Script:

#!/bin/bash
# Get more context around the command path usage
rg -B 10 -A 10 "cmdPath.*append" server/v2/commands.go

# Find command name definitions
ast-grep --pattern 'cobra.Command{
  $$$
  Name: $_,
  $$$
}'

Length of output: 676

server/v2/stf/CHANGELOG.md (1)

25-28: LGTM! Well-formatted changelog entry.

The changelog entry follows the guidelines, properly references PR #23013, and clearly describes the introduction of the DeliverSims interface.

server/v2/CHANGELOG.md (1)

25-28: LGTM! Comprehensive changelog entries for beta.2.

The changelog entries are well-structured, properly reference PRs, and clearly describe the changes made in this release.

runtime/v2/go.mod (1)

18-21: Verify compatibility with the stable x/tx v1.0.0 release.

The dependency updates align with the beta.2 release. However, the significant version jump for cosmossdk.io/x/tx from v1.0.0-alpha.3 to v1.0.0 warrants verification of compatibility.

Let's check for any breaking changes in x/tx v1.0.0:

✅ Verification successful

The update to x/tx v1.0.0 is compatible with the codebase

The version upgrade from v1.0.0-alpha.3 to v1.0.0 represents a stabilization release with no breaking changes. Recent alpha releases focused on bug fixes and improvements, maintaining backward compatibility.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find all imports and usages of x/tx package
rg -l "cosmossdk.io/x/tx" --type go

# Find all method calls from x/tx package
ast-grep --pattern 'tx.$_($_)'

Length of output: 2976


Script:

#!/bin/bash
# Check for changelog
fd CHANGELOG.md
cat x/tx/CHANGELOG.md || true

# Look for recent release commits
git log --oneline --grep="x/tx" -n 10

Length of output: 10141

server/v2/go.mod (1)

16-16: LGTM: Version update aligns with beta.2 preparation.

The update of cosmossdk.io/server/v2/appmanager to v1.0.0-beta.2 is consistent with the PR objectives.

server/v2/cometbft/go.mod (1)

25-26: LGTM: Consistent version updates for beta.2.

Both dependency updates to v1.0.0-beta.2 are consistent:

  • cosmossdk.io/server/v2/appmanager
  • cosmossdk.io/server/v2/stf
simapp/v2/go.mod (2)

15-15: LGTM: Version updates consistent with beta.2 preparation.

The updates to v1.0.0-beta.2 for both appmanager and stf packages align with the PR objectives and are consistent with other module updates.

Also applies to: 68-68


19-23: Verify local module replacements.

The placeholder versions (0.0.0-00010101000000-000000000000) for local modules are correctly managed through replace directives at the bottom of the file.

✅ Verification successful

All placeholder versions are properly managed through replace directives

All modules using the placeholder version (0.0.0-00010101000000-000000000000) have corresponding replace directives pointing to local paths, which is the correct setup for local development.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify that all placeholder versions have corresponding replace directives
echo "Checking for placeholder versions and their replace directives..."
rg "v0\.0\.0-00010101000000-000000000000" | while read -r line; do
  module=$(echo "$line" | awk '{print $1}')
  echo "Checking replace directive for $module"
  rg "replace.*$module.*=>" 
done

Length of output: 504


Script:

#!/bin/bash
# Display the content of simapp/v2/go.mod
echo "Content of simapp/v2/go.mod:"
cat simapp/v2/go.mod

Length of output: 15108

@@ -22,6 +22,10 @@ Each entry must include the Github issue reference in the following format:

## [Unreleased]

## [v1.0.0-beta.2](https://github.com/cosmos/cosmos-sdk/releases/tag/server/v2/stf%2Fv1.0.0-beta.2)
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix incorrect release tag URL.

The release tag URL points to server/v2/stf instead of server/v2/appmanager. This appears to be a copy-paste error.

-## [v1.0.0-beta.2](https://github.com/cosmos/cosmos-sdk/releases/tag/server/v2/stf%2Fv1.0.0-beta.2)
+## [v1.0.0-beta.2](https://github.com/cosmos/cosmos-sdk/releases/tag/server/v2/appmanager%2Fv1.0.0-beta.2)
📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## [v1.0.0-beta.2](https://github.com/cosmos/cosmos-sdk/releases/tag/server/v2/stf%2Fv1.0.0-beta.2)
## [v1.0.0-beta.2](https://github.com/cosmos/cosmos-sdk/releases/tag/server/v2/appmanager%2Fv1.0.0-beta.2)

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.

5 participants