`pallet-message-queue`: add queue pausing #14318

ggwpez · 2023-06-07T13:15:40Z

Introduces a QueuePausedQuery hook into the MQ pallet that is polled once before starting to service a queue. This hook decided whether the queue should start service or not.

It can be used to dynamically pause queues and is better than using Yield since no PoV is wasted for loading the first message and ProcessMessage does not need to be implemented just for pausing.
Context: Greatly reduces the complexity of paritytech/cumulus#2157

I also implemented explicit suspension (via set_suspended) by adding a bool flag to the BookState here. This is generally a nice thing to have for the future IMHO, but not well usable for 2157. This approach works better when knowing in advance which queues need to stay paused without any more complicated predicates involved.
2157 instead has custom predicate logic here which can change at any time.

Changes:

🚨 Add QueuePausedQuery to the MQ pallet Config. () indicates that nothing is paused.
Add trait frame_support::traits::QueuePausedQuery
Extend pallet_message_queue::Error and ExecuteOverweightError

Polkadot companion: paritytech/polkadot#7433

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

gavofyork

Seem harmless enough, but what about migrations?

ggwpez · 2023-06-07T14:33:40Z

Seem harmless enough, but what about migrations?

Its not changing any storage - just adding a QueuePausedQuery hook.

kianenigma · 2023-06-08T07:59:46Z

frame/support/src/traits/messages.rs

@@ -220,3 +230,15 @@ where
 		E::footprint(O::get())
 	}
 }
+
+/// Provides information on paused queues.
+pub trait QueuePausedQuery<Origin> {


As a design nit, I sometimes wonder if we should avoid creating a new trait like this when it can be easily expressed by Convert<Origin, bool> (cc @gpestana this is similar to my comment in #13983 (comment) 🙈).

No strong opinion myself, but I might personally lean into reusing Convert more and more.

Interesting idea. Yes I also dont like having tons of trivial traits.

The only problem i see with Convert is on the implementor side. When seeing impl<T: Config> Convert… for Pallet<T>, it is not clear what it means. Maybe we can use type alias for that, or something similar.

Maybe we could use the frame_support::Get trait instead? The type name is explicitly enough to use the getter trait and it things readable.

Suppose we have impl Get<bool> for Pallet<T>.
Now from the implementor side what does this mean? Anyone seeing this code will have no idea what it means.

kianenigma

LGTM. I would suggest double checking that all code-paths leading into servicing queues is blocked, as I could not be sure that the places that are already checked are not missing anything.

Otherwise it would not start servicing queues that started paused and became unpaused afterwards. Signed-off-by: Oliver Tale-Yazdi <[email protected]>

frame/message-queue/src/lib.rs

gpestana

Added a question and a suggestion wrt to the QueuePausedQuery trait, but lgtm!

gpestana · 2023-06-22T14:44:07Z

frame/support/src/traits/messages.rs

@@ -220,3 +230,15 @@ where
 		E::footprint(O::get())
 	}
 }
+
+/// Provides information on paused queues.
+pub trait QueuePausedQuery<Origin> {


Maybe we could use the frame_support::Get trait instead? The type name is explicitly enough to use the getter trait and it things readable.

frame/support/src/traits/messages.rs

ggwpez · 2023-06-28T08:58:20Z

bot merge

* pallet-message-queue: add queue pausing Signed-off-by: Oliver Tale-Yazdi <[email protected]> * Fix build Signed-off-by: Oliver Tale-Yazdi <[email protected]> * Remove check Otherwise it would not start servicing queues that started paused and became unpaused afterwards. Signed-off-by: Oliver Tale-Yazdi <[email protected]> --------- Signed-off-by: Oliver Tale-Yazdi <[email protected]>

pallet-message-queue: add queue pausing

a3d9e58

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

Fix build

76fb2b5

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

ggwpez added the E6-needs_polkadot_pr This is an issue that needs to be implemented upstream in Polkadot. label Jun 7, 2023

gavofyork approved these changes Jun 7, 2023

View reviewed changes

ggwpez marked this pull request as ready for review June 7, 2023 14:33

ggwpez requested review from a team June 7, 2023 14:33

ggwpez added A0-please_review Pull request needs code review. and removed A3-in_progress Pull request is in progress. No review needed at this stage. labels Jun 7, 2023

kianenigma self-requested a review June 8, 2023 06:59

kianenigma reviewed Jun 8, 2023

View reviewed changes

kianenigma approved these changes Jun 8, 2023

View reviewed changes

Remove check

add9382

Otherwise it would not start servicing queues that started paused and became unpaused afterwards. Signed-off-by: Oliver Tale-Yazdi <[email protected]>

ggwpez mentioned this pull request Jun 8, 2023

Use Message Queue as DMP and XCMP dispatch queue paritytech/cumulus#2157

Open

10 tasks

gupnik reviewed Jun 9, 2023

View reviewed changes

frame/message-queue/src/lib.rs Show resolved Hide resolved

gpestana approved these changes Jun 22, 2023

View reviewed changes

sam0x17 approved these changes Jun 23, 2023

View reviewed changes

louismerlin added D1-audited 👍 PR contains changes to fund-managing logic that has been properly reviewed and externally audited and removed D9-needsaudit 👮 PR contains changes to fund-managing logic that should be properly reviewed and externally audited labels Jun 27, 2023

ggwpez mentioned this pull request Jun 27, 2023

Co #14318: pallet-message-queue: add queue pausing paritytech/polkadot#7433

Merged

paritytech-processbot bot merged commit a84f0af into master Jun 28, 2023

paritytech-processbot bot deleted the oty-mq-pause-check branch June 28, 2023 08:58

svyatonik mentioned this pull request Jul 12, 2023

A way to dynamically (programmatically) suspend and resume inbound XCM channels at bridge hub paritytech/parity-bridges-common#2406

Closed

crystalin mentioned this pull request Oct 20, 2023

Update substrate/polkadot/cumulus from v0.9.43 to v1.1.0 moonbeam-foundation/moonbeam#2535

Closed

JesseAbram mentioned this pull request Oct 26, 2023

Update substrate and subxt entropyxyz/entropy-core#435

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`pallet-message-queue`: add queue pausing #14318

`pallet-message-queue`: add queue pausing #14318

ggwpez commented Jun 7, 2023 •

edited

Loading

gavofyork left a comment

ggwpez commented Jun 7, 2023

kianenigma Jun 8, 2023

ggwpez Jun 8, 2023 •

edited

Loading

gpestana Jun 22, 2023

ggwpez Jun 27, 2023

kianenigma left a comment

gpestana left a comment

gpestana Jun 22, 2023

ggwpez commented Jun 28, 2023

pallet-message-queue: add queue pausing #14318

pallet-message-queue: add queue pausing #14318

Conversation

ggwpez commented Jun 7, 2023 • edited Loading

gavofyork left a comment

Choose a reason for hiding this comment

ggwpez commented Jun 7, 2023

kianenigma Jun 8, 2023

Choose a reason for hiding this comment

ggwpez Jun 8, 2023 • edited Loading

Choose a reason for hiding this comment

gpestana Jun 22, 2023

Choose a reason for hiding this comment

ggwpez Jun 27, 2023

Choose a reason for hiding this comment

kianenigma left a comment

Choose a reason for hiding this comment

gpestana left a comment

Choose a reason for hiding this comment

gpestana Jun 22, 2023

Choose a reason for hiding this comment

ggwpez commented Jun 28, 2023

`pallet-message-queue`: add queue pausing #14318

`pallet-message-queue`: add queue pausing #14318

ggwpez commented Jun 7, 2023 •

edited

Loading

ggwpez Jun 8, 2023 •

edited

Loading