feat: support in-place migration ordering #10614

robert-zaremba · 2021-11-25T19:19:02Z

Description

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

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)

docs/core/upgrade.md

robert-zaremba · 2021-11-25T19:22:12Z

@aaronc , @AmauryM , @alexanderbez let me know what do you think about this idea.
Should I update ADR in the same PR or other?

amaury1093

This is not my preferred solution, but I won't block this work if others agree with it.

types/module/module.go

robert-zaremba · 2022-01-04T22:55:27Z

types/module/module.go

 	}
 }

 // MigrationHandler is the migration function that each module registers.
 type MigrationHandler func(sdk.Context) error

-// VersionMap is a map of moduleName -> version, where version denotes the
-// version from which we should perform the migration for each module.
+// VersionMap is a map of moduleName -> version


the second part was not relevant to this type. VersionMap is just a map - it's also use as a return type in RunMigrations

codecov · 2022-01-05T00:47:46Z

Codecov Report

Merging #10614 (c2773cb) into master (074c95b) will decrease coverage by 0.15%.
The diff coverage is 67.74%.

@@            Coverage Diff             @@
##           master   #10614      +/-   ##
==========================================
- Coverage   64.91%   64.76%   -0.16%     
==========================================
  Files         632      614      -18     
  Lines       59901    59025     -876     
==========================================
- Hits        38885    38227     -658     
+ Misses      18816    18649     -167     
+ Partials     2200     2149      -51

Impacted Files	Coverage Δ
x/feegrant/filtered_fee.go	`57.74% <53.84%> (+57.74%)`	⬆️
types/module/module.go	`70.58% <69.56%> (+3.13%)`	⬆️
simapp/app.go	`82.54% <100.00%> (+0.15%)`	⬆️
orm/encoding/ormfield/int32.go
orm/encoding/ormfield/string.go
orm/encoding/ormfield/duration.go
orm/encoding/ormkv/primary_key.go
orm/encoding/ormkv/key_codec.go
orm/encoding/ormfield/enum.go
orm/encoding/ormkv/seq.go
... and 14 more

amaury1093

LGTM, nice that it's backwards-compatible. Just small nits, mostly around comments

types/module/module.go

types/module/module_int_test.go

simapp/app.go

types/module/module.go

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

ValarDragon

LGTM, I like this setup!

## Description Closes: #10604 --- ### 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... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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) (cherry picked from commit da92921) # Conflicts: # CHANGELOG.md # docs/core/upgrade.md # types/errors/errors.go # types/module/module.go

* feat: support in-place migration ordering (#10614) ## Description Closes: #10604 --- ### 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... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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) (cherry picked from commit da92921) # Conflicts: # CHANGELOG.md # docs/core/upgrade.md # types/errors/errors.go # types/module/module.go * conflict fix * Add Features section * fix conflicts Co-authored-by: Robert Zaremba <robert@zaremba.ch>

…smos#10890) * feat: support in-place migration ordering (cosmos#10614) ## Description Closes: cosmos#10604 --- ### 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... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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) (cherry picked from commit da92921) # Conflicts: # CHANGELOG.md # docs/core/upgrade.md # types/errors/errors.go # types/module/module.go * conflict fix * Add Features section * fix conflicts Co-authored-by: Robert Zaremba <robert@zaremba.ch>

…smos#10890) * feat: support in-place migration ordering (cosmos#10614) Closes: cosmos#10604 --- *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... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed *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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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) (cherry picked from commit da92921) * conflict fix * Add Features section * fix conflicts Co-authored-by: Robert Zaremba <robert@zaremba.ch>

## Description Closes: cosmos#10604 --- ### 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... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)

…smos#10890) * feat: support in-place migration ordering (cosmos#10614) ## Description Closes: cosmos#10604 --- ### 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... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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) (cherry picked from commit da92921) # Conflicts: # CHANGELOG.md # docs/core/upgrade.md # types/errors/errors.go # types/module/module.go * conflict fix * Add Features section * fix conflicts Co-authored-by: Robert Zaremba <robert@zaremba.ch>

robert-zaremba added 4 commits November 25, 2021 11:50

update migration docs

2d70e68

remove todo

d067a8f

wip

d442004

proof of concept

d7d2752

robert-zaremba requested review from ValarDragon, amaury1093, aaronc, clevinson and alexanderbez November 25, 2021 19:19

robert-zaremba commented Nov 25, 2021

View reviewed changes

docs/core/upgrade.md Outdated Show resolved Hide resolved

cleanup

cfe9af7

amaury1093 reviewed Dec 8, 2021

View reviewed changes

types/module/module.go Outdated Show resolved Hide resolved

types/module/module.go Outdated Show resolved Hide resolved

amaury1093 requested a review from technicallyty December 8, 2021 14:35

aaronc changed the title ~~feat!: support in-palace migration ordering~~ feat!: support in-place migration ordering Dec 8, 2021

amaury1093 mentioned this pull request Dec 13, 2021

chore: v0.45.0 Release Notes #10760

Merged

20 tasks

robert-zaremba added 4 commits December 14, 2021 17:00

Use SetOrderMigrations for ordering migrations

20864e6

fix

767a00d

Merge remote-tracking branch 'origin/master' into robert/migration-order

daa283d

update module/assertNoForgottenModules

a55cc22

robert-zaremba commented Jan 4, 2022

View reviewed changes

robert-zaremba added 3 commits January 4, 2022 23:56

add tests

eb6e147

documentation update

628ff1f

adding changelog entry

2d2752f

robert-zaremba marked this pull request as ready for review January 4, 2022 23:18

robert-zaremba requested a review from amaury1093 January 4, 2022 23:18

robert-zaremba added 2 commits January 5, 2022 00:36

Merge branch 'master' into robert/migration-order

b5efc9f

remove SetOrderMigrations from app.go

607522a

amaury1093 approved these changes Jan 5, 2022

View reviewed changes

types/module/module.go Outdated Show resolved Hide resolved

types/module/module.go Outdated Show resolved Hide resolved

types/module/module_int_test.go Show resolved Hide resolved

simapp/app.go Outdated Show resolved Hide resolved

types/module/module.go Outdated Show resolved Hide resolved

amaury1093 changed the title ~~feat!: support in-place migration ordering~~ feat: support in-place migration ordering Jan 5, 2022

amaury1093 added the backport/0.45.x label Jan 5, 2022

robert-zaremba added A:automerge Automatically merge PR once all prerequisites pass. and removed A:automerge Automatically merge PR once all prerequisites pass. labels Jan 5, 2022

robert-zaremba and others added 3 commits January 5, 2022 12:41

Apply suggestions from code review

6b21690

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

update test

ac658c4

Merge remote-tracking branch 'origin/master' into robert/migration-order

1eb1f3b

robert-zaremba added the A:automerge Automatically merge PR once all prerequisites pass. label Jan 5, 2022

Merge branch 'master' into robert/migration-order

c2773cb

ValarDragon approved these changes Jan 5, 2022

View reviewed changes

mergify bot merged commit da92921 into master Jan 5, 2022

mergify bot deleted the robert/migration-order branch January 5, 2022 22:32

mergify bot mentioned this pull request Jan 5, 2022

feat: support in-place migration ordering (backport #10614) #10890

Merged

faddat mentioned this pull request Feb 28, 2022

v0.45.x akash-network/cosmos-sdk#176

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support in-place migration ordering #10614

feat: support in-place migration ordering #10614

robert-zaremba commented Nov 25, 2021

robert-zaremba commented Nov 25, 2021

amaury1093 left a comment

robert-zaremba Jan 4, 2022

codecov bot commented Jan 5, 2022 •

edited

Loading

amaury1093 left a comment

ValarDragon left a comment

feat: support in-place migration ordering #10614

feat: support in-place migration ordering #10614

Conversation

robert-zaremba commented Nov 25, 2021

Description

Author Checklist

Reviewers Checklist

robert-zaremba commented Nov 25, 2021

amaury1093 left a comment

Choose a reason for hiding this comment

robert-zaremba Jan 4, 2022

Choose a reason for hiding this comment

codecov bot commented Jan 5, 2022 • edited Loading

Codecov Report

amaury1093 left a comment

Choose a reason for hiding this comment

ValarDragon left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 5, 2022 •

edited

Loading