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(tools/cosmovisor): do not download all binaires with autodownload #23653

Merged
merged 4 commits into from
Feb 12, 2025

Conversation

gartnera
Copy link
Contributor

@gartnera gartnera commented Feb 10, 2025

Description

As described in #19871, cosmovisor will currently try to download binaries for all platforms and architectures. This is bad for several reasons:

  1. wastes time, space, and bandwidth
  2. increases chance of failure since it has to do more
  3. fails if any of checksums are incorrect for any architecture

This logic was responsible for some issues during the @zeta-chain v27 upgrade since we had messed up one of the checksums in the upgrade proposal.

The only place that this validation should take place is during the proposal submission process.

Author Checklist

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

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced the auto-download process by eliminating duplicate binary downloads.
  • Refactor

    • Simplified the binary upgrade workflow by removing an extra validation check.
    • Maintained essential safeguards such as download error handling and ensuring the correct setup of the binary.

@gartnera gartnera requested a review from a team as a code owner February 10, 2025 17:31
Copy link
Contributor

coderabbitai bot commented Feb 10, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the UpgradeBinary function in the cosmovisor tool by removing the call to validate the upgrade information against the configuration name. With the deletion of upgradeInfo.ValidateFull(cfg.Name), the binary integrity check against the current configuration is skipped before proceeding with the download. Other error handling and process flows remain unchanged, ensuring the binary is downloaded (if missing) when auto-download is allowed, and the upgrade directory and download errors are still managed appropriately.

Changes

File Change Summary
tools/cosmovisor/upgrade.go Removed the validation step (upgradeInfo.ValidateFull(cfg.Name)) in the UpgradeBinary function.
tools/cosmovisor/CHANGELOG.md Updated changelog for v1.7.1 to include a bug fix entry addressing the removal of duplicate binary downloads during auto-download, referencing issue #23653.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant UB as UpgradeBinary
    participant DL as Downloader

    Caller->>UB: Call UpgradeBinary()
    UB->>UB: Check if binary exists
    alt Binary exists
        UB->>Caller: Return existing binary
    else
        UB->>UB: (Validation step removed)
        UB->>DL: Initiate binary download
        DL-->>UB: Return downloaded binary
        UB->>Caller: Set and return binary
    end
Loading

Suggested reviewers

  • aljo242
  • julienrbrt

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 90a230a and 176d329.

📒 Files selected for processing (1)
  • tools/cosmovisor/CHANGELOG.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.md`: "Assess the documentation for misspellings, gramm...

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

  • tools/cosmovisor/CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Summary
🔇 Additional comments (1)
tools/cosmovisor/CHANGELOG.md (1)

44-44: LGTM! The changelog entry is well-formatted and clear.

The entry follows the Keep a Changelog format, is placed in the correct section, and effectively communicates the bug fix addressing duplicate binary downloads.


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.

@github-actions github-actions bot added the C:Cosmovisor Issues and PR related to Cosmovisor label Feb 10, 2025
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

The only place that this validation should take place is during the proposal submission process.

I am not sure I totally agree with this, you can always submit an invalid proposal.
F.e those that are using the CLI but pass --no-validate or those that just craft their proposal from somewhere else. I think it is good to have node operator (and so effectively cosmovisor, to do that verification, and won't switch to an invalid binary).
However, I do see the use case for not validating the upgrade info as well.
Maybe an option to add in the Cosmovisor config and just skip it here if true?

@gartnera
Copy link
Contributor Author

and so effectively cosmovisor, to do that verification, and won't switch to an invalid binary

I don't understand what scenario downloading and checking everything twice actually prevents? The checksum will still be required to be verified in the plan.DownloadUpgrade() call and the current symlink won't be updated until cfg.SetCurrentUpgrade(p) is called right?

Once the upgrade height has hit, it's not like the old binary is useable anyway right?

Maybe an option to add in the Cosmovisor config and just skip it here if true?

Yeah I can do it that way if it will allow us to get this done faster.

@gartnera gartnera requested a review from julienrbrt February 10, 2025 20:45
@julienrbrt
Copy link
Member

julienrbrt commented Feb 10, 2025

You are right! I missed that we would be using go-getter earlier. This is fine as is indeed. Could you add a changelog entry (tools/cosmovisor/changelog.md)

@gartnera
Copy link
Contributor Author

You are right! I missed that we would be using go-getter earlier. This is fine as is indeed. Could you add a changelog entry (tools/cosmovisor/changelog.md)

Yes I will once #23652 is merged. Otherwise we will hit a merge conflict?

@aljo242
Copy link
Collaborator

aljo242 commented Feb 11, 2025

@gartnera merged and up to date!

@gartnera gartnera requested a review from julienrbrt February 11, 2025 19:23
@aljo242 aljo242 merged commit f072eca into cosmos:main Feb 12, 2025
66 of 68 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Cosmovisor Issues and PR related to Cosmovisor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants