feat!: modify constraint for signal versions

[rootulp]

Closes #3550

[coderabbitai]

Walkthrough

The changes involve updating the SignalVersion function within the keeper.go file to allow for signaling of any version that is greater than or equal to the current version, removing the previous constraint that limited signaling to only the current or next version. Additionally, the error messaging and related test cases have been updated to reflect and validate this new logic.

Changes

File	Change Summary
x/signal/keeper.go	Updated SignalVersion function to allow signaling for any version greater than the current one. Improved error handling.
x/signal/keeper_test.go	Adjusted test functions to align with new validation logic. Added a new test (TestCanSkipVersion) to verify signaling for higher versions.
x/signal/types/errors.go	Updated ErrInvalidVersion error message to reflect the new validation logic.

Sequence Diagram(s)

sequenceDiagram
    participant Validator
    participant SignalKeeper

    Validator->>SignalKeeper: Request SignalVersion(current, signaled)
    alt signaled >= current
        SignalKeeper-->Validator: Success
    else signaled < current
        SignalKeeper-->Validator: Error: "signalled version cannot be less than the current version"
    end

Loading

Assessment against linked issues

Objective (#3550)	Addressed	Explanation
Remove constraint enforcing signals for current or next app version	✅
Update error handling to provide specific error messages for invalid versions	✅
Add comprehensive tests to validate scenarios including signaling for versions greater than next version	✅

Possibly related issues

• Signal for a specific version #3543: This PR addresses the issue by removing the constraint on signaling versions, allowing for signaling of any greater version, which aligns with one of the proposed solutions in the issue.

---

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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.
  • @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 as 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.

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.

[staheri14]

LGTM!

[staheri14]

[nit] Would be helpful to add a one liner for each testcase explaining why an error is required or not required.

[cmwaters]

👍