Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Fix order of hook execution #10043

Merged
merged 16 commits into from
Dec 1, 2021
Merged
Show file tree
Hide file tree
Changes from 3 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
34 changes: 33 additions & 1 deletion frame/support/procedural/src/construct_runtime/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -204,14 +204,34 @@ fn decl_all_pallets<'a>(
types.extend(type_decl);
names.push(&pallet_declaration.name);
}
// Make nested tuple structure like (((Babe, Consensus), Grandpa), ...)

// Make nested tuple structure like:
// `((FirstPallet, (SecondPallet, ( ... , (LastPallet) ... ))))`
// But ignore the system pallet.
let all_pallets = names
.iter()
.filter(|n| **n != SYSTEM_PALLET_NAME)
.rev()
.fold(TokenStream2::default(), |combined, name| quote!((#name, #combined)));

// Make nested tuple structure like:
// `((FirstPallet, (SecondPallet, ( ... , (LastPallet) ... ))))`
let all_pallets_with_system = names
.iter()
.rev()
apopiak marked this conversation as resolved.
Show resolved Hide resolved
.fold(TokenStream2::default(), |combined, name| quote!((#name, #combined)));
KiChjang marked this conversation as resolved.
Show resolved Hide resolved

// Make nested tuple structure like:
// `((LastPallet, (SecondLastPallet, ( ... , (FirstPallet) ... ))))`
// But ignore the system pallet.
let all_pallets_reversed = names
.iter()
.filter(|n| **n != SYSTEM_PALLET_NAME)
.fold(TokenStream2::default(), |combined, name| quote!((#name, #combined)));

// Make nested tuple structure like:
// `((LastPallet, (SecondLastPallet, ( ... , (FirstPallet) ... ))))`
let all_pallets_with_system_reversed = names
.iter()
.fold(TokenStream2::default(), |combined, name| quote!((#name, #combined)));

Expand All @@ -220,9 +240,21 @@ fn decl_all_pallets<'a>(
/// All pallets included in the runtime as a nested tuple of types.
/// Excludes the System pallet.
pub type AllPallets = ( #all_pallets );

/// All pallets included in the runtime as a nested tuple of types.
pub type AllPalletsWithSystem = ( #all_pallets_with_system );

/// All pallets included in the runtime as a nested tuple of types in reversed order.
/// Excludes the System pallet.
#[deprecated(note = "use `AllPallets` instead")]
#[allow(dead_code)]
pub type AllPalletsReversed = ( #all_pallets_reversed );

/// All pallets included in the runtime as a nested tuple of types in reversed order.
#[deprecated(note = "use `AllPalletsWithSystem` instead")]
#[allow(dead_code)]
pub type AllPalletsWithSystemReversed = ( #all_pallets_with_system_reversed );

/// All modules included in the runtime as a nested tuple of types.
/// Excludes the System pallet.
#[deprecated(note = "use `AllPallets` instead")]
Expand Down
65 changes: 65 additions & 0 deletions frame/support/test/tests/pallet.rs
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,17 @@ pub mod pallet2 {
impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> where
T::AccountId: From<SomeType1> + SomeAssociation1
{
fn on_initialize(_: BlockNumberFor<T>) -> Weight {
Self::deposit_event(Event::Something(11));
0
}
fn on_finalize(_: BlockNumberFor<T>) {
Self::deposit_event(Event::Something(21));
}
fn on_runtime_upgrade() -> Weight {
Self::deposit_event(Event::Something(31));
0
}
}

#[pallet::call]
Expand All @@ -468,6 +479,7 @@ pub mod pallet2 {
CountedStorageMap<Hasher = Twox64Concat, Key = u8, Value = u32>;

#[pallet::event]
#[pallet::generate_deposit(fn deposit_event)]
pub enum Event {
/// Something
Something(u32),
Expand Down Expand Up @@ -950,15 +962,68 @@ fn pallet_hooks_expand() {
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[1].event,
Event::Example2(pallet2::Event::Something(11)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[2].event,
Event::Example(pallet::Event::Something(20)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[3].event,
Event::Example2(pallet2::Event::Something(21)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[4].event,
Event::Example(pallet::Event::Something(30)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[5].event,
Event::Example2(pallet2::Event::Something(31)),
);
})
}

#[test]
fn all_pallets_type_reversed_order_is_correct() {
TestExternalities::default().execute_with(|| {
frame_system::Pallet::<Runtime>::set_block_number(1);

#[allow(deprecated)]
{
assert_eq!(AllPalletsReversed::on_initialize(1), 10);
AllPalletsReversed::on_finalize(1);

assert_eq!(AllPalletsReversed::on_runtime_upgrade(), 30);
}

assert_eq!(
frame_system::Pallet::<Runtime>::events()[0].event,
Event::Example2(pallet2::Event::Something(11)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[1].event,
Event::Example(pallet::Event::Something(10)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[2].event,
Event::Example2(pallet2::Event::Something(21)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[3].event,
Event::Example(pallet::Event::Something(20)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[4].event,
Event::Example2(pallet2::Event::Something(31)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[5].event,
Event::Example(pallet::Event::Something(30)),
);
})
}


#[test]
fn pallet_on_genesis() {
TestExternalities::default().execute_with(|| {
Expand Down
13 changes: 6 additions & 7 deletions frame/support/test/tests/pallet_instance.rs
Original file line number Diff line number Diff line change
Expand Up @@ -515,30 +515,29 @@ fn pallet_hooks_expand() {

assert_eq!(AllPallets::on_runtime_upgrade(), 61);

// The order is indeed reversed due to https://github.com/paritytech/substrate/issues/6280
assert_eq!(
frame_system::Pallet::<Runtime>::events()[0].event,
Event::Instance1Example(pallet::Event::Something(11)),
Event::Example(pallet::Event::Something(10)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[1].event,
Event::Example(pallet::Event::Something(10)),
Event::Instance1Example(pallet::Event::Something(11)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[2].event,
Event::Instance1Example(pallet::Event::Something(21)),
Event::Example(pallet::Event::Something(20)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[3].event,
Event::Example(pallet::Event::Something(20)),
Event::Instance1Example(pallet::Event::Something(21)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[4].event,
Event::Instance1Example(pallet::Event::Something(31)),
Event::Example(pallet::Event::Something(30)),
);
assert_eq!(
frame_system::Pallet::<Runtime>::events()[5].event,
Event::Example(pallet::Event::Something(30)),
Event::Instance1Example(pallet::Event::Something(31)),
);
})
}
Expand Down