fix(runtime): fix option order

[julienrbrt]

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

  • Corrected halt height behavior to ensure blocks are committed only up to the specified halt height.
  • Fixed ordering of baseapp options to prevent overwriting of module-set options.

• New Features

  • Introduced the sims2 framework and factory methods to simplify message factory creation within modules.

These updates enhance the overall functionality and reliability of the system.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes include a bug fix for the base application's halt height behavior, ensuring blocks are committed only up to the specified halt height. Additionally, the runtime has been updated to prevent the overwriting of options set by modules. An API-breaking change was introduced with the addition of the sims2 framework and factory methods to streamline message factory creation within modules. These modifications aim to enhance the functionality and reliability of the system.

Changes

File	Change Summary
CHANGELOG.md	Updated to reflect bug fix for halt height behavior, runtime option ordering fix, and addition of sims2 framework and factory methods.
runtime/builder.go	Modified the initialization process of BaseApp to set message service and gRPC query routers before instantiation, improving routing configuration reliability.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AppBuilder
    participant BaseApp

    User->>AppBuilder: Initialize Application
    AppBuilder->>BaseApp: SetMsgServiceRouter
    AppBuilder->>BaseApp: SetGRPCQueryRouter
    AppBuilder->>BaseApp: Instantiate BaseApp
    BaseApp-->>AppBuilder: BaseApp Ready
    AppBuilder-->>User: Application Initialized

Loading

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3314cfb and a74cb0d.

Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• runtime/builder.go (1 hunks)

Additional context used

Path-based instructions (2)

runtime/builder.go (1)

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

CHANGELOG.md (1)

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

Additional comments not posted (6)

runtime/builder.go (1)

42-51: LGTM! This is a good change to ensure the reliability of the application's routing configuration.

Prepending the function to set the message service and gRPC query routers before the BaseApp is instantiated ensures that the intended routers are set first, preventing any potential modifications by other options. This enhances the reliability of the routing configuration and reduces the risk of unexpected behavior.

CHANGELOG.md (5)

Line range hint 1-56: Changelog segment looks good

The v0.46.0 release changelog is well-structured and documents the breaking changes clearly with links to relevant pull requests. The categorization into state machine breaking changes, API breaking changes, and client breaking changes makes it easy to understand the impact of the release.

---

Line range hint 58-87: Features segment is informative

The new features in the v0.46.0 release are clearly listed and grouped logically into relevant categories. The brief description of each feature along with the link to the pull request provides good context.

---

Line range hint 89-105: Bug fixes documented properly

The bug fixes in v0.46.0 are captured concisely with proper references to the fixed issues or pull requests. The changelog maintains a consistent structure here.

---

Line range hint 107-119: Improvements clearly documented

The improvements made in v0.46.0 are listed with clear descriptions and references to the corresponding pull requests. The changelog structure remains consistent.

---

Line range hint 121-130: Deprecated features properly documented

The features deprecated in v0.46.0 are clearly listed with descriptions and links to the relevant pull requests. The changelog format is followed consistently.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 generate interesting stats about this repository and render them as a table.
  -- @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.

[julienrbrt]

@Mergifyio backport release/v0.52.x

[julienrbrt]

@Mergifyio backport release/v0.50.x

[mergify]

backport release/v0.52.x

✅ Backports have been created

• #21770 fix(runtime): fix option order (backport #21769) has been created for branch release/v0.52.x but encountered conflicts

[mergify]

backport release/v0.50.x

✅ Backports have been created

• #21771 fix(runtime): fix option order (backport #21769) has been created for branch release/v0.50.x but encountered conflicts