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(upgrades): perform no-op if from and to migration version are equal #12174

Merged
merged 5 commits into from
Jun 8, 2022

Conversation

fedekunze
Copy link
Collaborator

@fedekunze fedekunze commented Jun 7, 2022

Description

When the migration version is the same (from = to), no logic is required so we can perform a no-op for the module.


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
  • added ! to 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
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • 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 ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@fedekunze fedekunze changed the title fix(upgrades): perform no-op if 'from' and 'to' migration version are equal fix(upgrades): perform no-op if from and to migration version are equal Jun 7, 2022
@fedekunze fedekunze marked this pull request as ready for review June 7, 2022 11:58
@fedekunze fedekunze requested a review from a team as a code owner June 7, 2022 11:58
@aaronc
Copy link
Member

aaronc commented Jun 7, 2022

Is this affecting 0.45/0.46? Is there some failure case you can document @fedekunze ?

@codecov
Copy link

codecov bot commented Jun 7, 2022

Codecov Report

Merging #12174 (05fb17e) into main (2094c13) will not change coverage.
The diff coverage is 0.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #12174   +/-   ##
=======================================
  Coverage   66.01%   66.01%           
=======================================
  Files         672      672           
  Lines       71060    71060           
=======================================
  Hits        46913    46913           
  Misses      21483    21483           
  Partials     2664     2664           
Impacted Files Coverage Δ
types/module/configurator.go 15.55% <0.00%> (ø)

Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

ACK

@alexanderbez alexanderbez added backport/0.45.x backport/0.46.x PR scheduled for inclusion in the v0.46's next stable release labels Jun 7, 2022
@alexanderbez
Copy link
Contributor

@fedekunze can you add a quick changelog entry please 🙏

@ValarDragon
Copy link
Contributor

ValarDragon commented Jun 7, 2022

I don't understand, this doesn't change anything?

Its handled in the for loop on line 103

@alexanderbez
Copy link
Contributor

@ValarDragon is correct -- closing.

@fedekunze fedekunze reopened this Jun 8, 2022
@fedekunze
Copy link
Collaborator Author

fedekunze commented Jun 8, 2022

@alexanderbez @ValarDragon @aaronc if the migration for an old version gets deleted for any reason, that means that the upgrade will fail because the migration with return an error on L99. This happened to us during a testnet upgrade: evmos/evmos#588

The fact that you cannot remove legacy migration logic is NOT documented anywhere and is an unexpected behavior

@alexanderbez
Copy link
Contributor

Yes, that's fine, I don't see this change as contentious anyway, so we can merge 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/0.46.x PR scheduled for inclusion in the v0.46's next stable release C:Types
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants