Skip to content

Commit

Permalink
Improve try-runtime::on_runtime_upgrade and fix some storage versio…
Browse files Browse the repository at this point in the history
…n issues (paritytech#14083)

We now run all `try_on_runtime_upgrade` and collect the errors, instead of bailing on the first
error. This makes it easier to see directly all the things that are failing instead of fixing one,
recompiling and then checking the next one.

Then this pr also sets the correct storage version for `pallet-bounties` that was already correctly
set in the storage with the appropriate migration.
  • Loading branch information
bkchr authored and nathanwhit committed Jul 19, 2023
1 parent f44bcee commit 1559ffb
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 2 deletions.
3 changes: 3 additions & 0 deletions frame/bounties/src/lib.rs
Expand Up @@ -187,7 +187,10 @@ pub trait ChildBountyManager<Balance> {
pub mod pallet {
use super::*;

const STORAGE_VERSION: StorageVersion = StorageVersion::new(4);

#[pallet::pallet]
#[pallet::storage_version(STORAGE_VERSION)]
pub struct Pallet<T, I = ()>(_);

#[pallet::config]
Expand Down
2 changes: 1 addition & 1 deletion frame/support/procedural/src/pallet/expand/hooks.rs
Expand Up @@ -121,7 +121,7 @@ pub fn expand_hooks(def: &mut Def) -> proc_macro2::TokenStream {

#frame_support::log::error!(
target: #frame_support::LOG_TARGET,
"{}: On chain storage version {:?} is set to non zero,\
"{}: On chain storage version {:?} is set to non zero, \
while the pallet is missing the `#[pallet::storage_version(VERSION)]` attribute.",
pallet_name,
on_chain_version,
Expand Down
30 changes: 29 additions & 1 deletion frame/support/src/traits/hooks.rs
Expand Up @@ -203,7 +203,35 @@ impl OnRuntimeUpgrade for Tuple {
#[cfg(feature = "try-runtime")]
fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, &'static str> {
let mut weight = Weight::zero();
for_tuples!( #( weight = weight.saturating_add(Tuple::try_on_runtime_upgrade(checks)?); )* );

let mut errors = Vec::new();

for_tuples!(#(
match Tuple::try_on_runtime_upgrade(checks) {
Ok(weight) => { weight.saturating_add(weight); },
Err(err) => { errors.push(err); },
}
)*);

if errors.len() == 1 {
return Err(errors[0])
} else if !errors.is_empty() {
log::error!(
target: "try-runtime",
"Detected multiple errors while executing `try_on_runtime_upgrade`:",
);

errors.iter().for_each(|err| {
log::error!(
target: "try-runtime",
"{}",
err
);
});

return Err("Detected multiple errors while executing `try_on_runtime_upgrade`, check the logs!")
}

Ok(weight)
}
}
Expand Down

0 comments on commit 1559ffb

Please sign in to comment.