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

migrations: take()should consume read and write operation weight #4302

Merged
merged 5 commits into from
May 12, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions prdoc/pr_4302.prdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json

title: "migrations: take()should consume read and write operation weight"
dastansam marked this conversation as resolved.
Show resolved Hide resolved

doc:
- audience: Runtime Dev
description: |
`take()` consumes only 1 read worth of weight in `single-block-migrations` example, while `take()` is `get() + kill()`,
i.e should be 1 read + 1 write. Since this could mislead developers writing migrations following the example,
this PR fixes the weight calculation.

crates:
- name: pallet-example-single-block-migrations
bump: minor
2 changes: 1 addition & 1 deletion substrate/frame/balances/src/migration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for ResetInactive<T, I> {
StorageVersion::new(0).put::<Pallet<T, I>>();

log::info!(target: LOG_TARGET, "Storage to version 0");
T::DbWeight::get().reads_writes(1, 2)
T::DbWeight::get().reads_writes(1, 3)
} else {
log::info!(
target: LOG_TARGET,
Expand Down
4 changes: 2 additions & 2 deletions substrate/frame/democracy/src/migrations/v1.rs
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ pub mod v1 {
.collect::<Vec<_>>();
let bounded = BoundedVec::<_, T::MaxProposals>::truncate_from(props.clone());
PublicProps::<T>::put(bounded);
weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));
weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 2));

if props.len() as u32 > T::MaxProposals::get() {
log::error!(
Expand All @@ -126,7 +126,7 @@ pub mod v1 {

StorageVersion::new(1).put::<Pallet<T>>();

weight.saturating_add(T::DbWeight::get().reads_writes(1, 2))
weight.saturating_add(T::DbWeight::get().reads_writes(1, 3))
}

#[cfg(feature = "try-runtime")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ impl<T: crate::Config> UncheckedOnRuntimeUpgrade for InnerMigrateV0ToV1<T> {
// Write the new value to storage
let new = crate::CurrentAndPreviousValue { current: old_value, previous: None };
crate::Value::<T>::put(new);
// One read for the old value, one write for the new value
T::DbWeight::get().reads_writes(1, 1)
// One read + write for taking the old value, and one write for setting the new value
T::DbWeight::get().reads_writes(1, 2)
} else {
// One read for trying to access the old value
// No writes since there was no old value, just one read for checking
T::DbWeight::get().reads(1)
}
}
Expand Down
2 changes: 1 addition & 1 deletion substrate/frame/staking/src/migrations.rs
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ pub mod v10 {
StorageVersion::<T>::put(ObsoleteReleases::V10_0_0);

log!(info, "MigrateToV10 executed successfully");
T::DbWeight::get().reads_writes(1, 1)
T::DbWeight::get().reads_writes(1, 2)
} else {
log!(warn, "MigrateToV10 should be removed.");
T::DbWeight::get().reads(1)
Expand Down
Loading