migrations: prevent accidentally using unversioned migrations instead of VersionedMigration
#3835
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dastansam
changed the title
VersionedMigration
|
|
xlc
reviewed
Mar 26, 2024
xlc
approved these changes
Mar 28, 2024
liamaharon
added
the
T1-FRAME
liamaharon
reviewed
Mar 29, 2024
acatangiu
approved these changes
Mar 29, 2024
…dastansam/polkadot-sdk into feat/unchecked-on-runtime-upgrade
liamaharon
approved these changes
Apr 2, 2024
|
/tip medium |
|
@liamaharon A referendum for a medium (80 DOT) tip was successfully submitted for @dastansam (16FqwPZ8GRC5U5D4Fu7W33nA55ZXzXGWHwmbnE1eT6pxuqcT on polkadot). Referendum number: 638. |
|
The referendum has appeared on Polkassembly. |
liamaharon
suggested changes
Apr 2, 2024
…dastansam/polkadot-sdk into feat/unchecked-on-runtime-upgrade
auto-merge was automatically disabled
April 2, 2024 11:47
Head branch was pushed to by a user without write access
|
The CI pipeline was cancelled due to failure one of the required jobs. |
ggwpez
approved these changes
Apr 2, 2024
|
I think the normal |
liamaharon
approved these changes
Apr 2, 2024
Merged
via the queue into
paritytech:master
with commit Apr 2, 2024
e542796
129 of 134 checks passed
Ank4n
pushed a commit
that referenced
this pull request
Apr 9, 2024
… of `VersionedMigration` (#3835) closes #1324 #### Problem Currently, it is possible to accidentally use inner unversioned migration instead of `VersionedMigration` since both implement `OnRuntimeUpgrade`. #### Solution With this change, we make it clear that value of `Inner` is not intended to be used directly. It is achieved by bounding `Inner` to new trait `UncheckedOnRuntimeUpgrade`, which has the same interface (except `unchecked_` prefix) as `OnRuntimeUpgrade`. #### `try-runtime` functions Since developers can implement `try-runtime` for `Inner` value in `VersionedMigration` and have custom logic for it, I added the same `try-runtime` functions to `UncheckedOnRuntimeUpgrade`. I looked for a ways to not duplicate functions, but couldn't find anything that doesn't significantly change the codebase. So I would appreciate If you have any suggestions to improve this cc @liamaharon @xlc polkadot address: 16FqwPZ8GRC5U5D4Fu7W33nA55ZXzXGWHwmbnE1eT6pxuqcT --------- Co-authored-by: Liam Aharon <[email protected]>
dharjeezy
pushed a commit
to dharjeezy/polkadot-sdk
that referenced
this pull request
Apr 9, 2024
… of `VersionedMigration` (paritytech#3835) closes paritytech#1324 #### Problem Currently, it is possible to accidentally use inner unversioned migration instead of `VersionedMigration` since both implement `OnRuntimeUpgrade`. #### Solution With this change, we make it clear that value of `Inner` is not intended to be used directly. It is achieved by bounding `Inner` to new trait `UncheckedOnRuntimeUpgrade`, which has the same interface (except `unchecked_` prefix) as `OnRuntimeUpgrade`. #### `try-runtime` functions Since developers can implement `try-runtime` for `Inner` value in `VersionedMigration` and have custom logic for it, I added the same `try-runtime` functions to `UncheckedOnRuntimeUpgrade`. I looked for a ways to not duplicate functions, but couldn't find anything that doesn't significantly change the codebase. So I would appreciate If you have any suggestions to improve this cc @liamaharon @xlc polkadot address: 16FqwPZ8GRC5U5D4Fu7W33nA55ZXzXGWHwmbnE1eT6pxuqcT --------- Co-authored-by: Liam Aharon <[email protected]>
This was referenced Jun 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #1324
Problem
Currently, it is possible to accidentally use inner unversioned migration instead of
VersionedMigrationsince both implementOnRuntimeUpgrade.Solution
With this change, we make it clear that value of
Inneris not intended to be used directly. It is achieved by boundingInnerto new traitUncheckedOnRuntimeUpgrade, which has the same interface (exceptunchecked_prefix) asOnRuntimeUpgrade.try-runtimefunctionsSince developers can implement
try-runtimeforInnervalue inVersionedMigrationand have custom logic for it, I added the sametry-runtimefunctions toUncheckedOnRuntimeUpgrade. I looked for a ways to not duplicate functions, but couldn't find anything that doesn't significantly change the codebase. So I would appreciate If you have any suggestions to improve thiscc @liamaharon @xlc
polkadot address: 16FqwPZ8GRC5U5D4Fu7W33nA55ZXzXGWHwmbnE1eT6pxuqcT