Newer
Older
MessageQueue::sweep_queue(Here);
let book = BookStateFor::<Test>::get(Here);
assert!(book.ready_neighbours.is_none());
});
}
#[test]
fn sweep_queue_invalid_noops() {
use MessageOrigin::*;
build_and_execute::<Test>(|| {
assert_storage_noop!(MessageQueue::sweep_queue(Here));
});
}
#[test]
fn footprint_works() {
build_and_execute::<Test>(|| {
let origin = MessageOrigin::Here;
let (page, msgs) = full_page::<Test>();
let book = book_for::<Test>(&page);
BookStateFor::<Test>::insert(origin, book);
let info = MessageQueue::footprint(origin);
assert_eq!(info.count as usize, msgs);
assert_eq!(info.size, page.remaining_size as u64);
// Sweeping a queue never calls OnQueueChanged.
assert!(QueueChanges::take().is_empty());
})
}
/// The footprint of an invalid queue is the default footprint.
#[test]
fn footprint_invalid_works() {
build_and_execute::<Test>(|| {
let origin = MessageOrigin::Here;
assert_eq!(MessageQueue::footprint(origin), Default::default());
})
}
/// The footprint of a swept queue is still correct.
#[test]
fn footprint_on_swept_works() {
use MessageOrigin::*;
build_and_execute::<Test>(|| {
let mut book = empty_book::<Test>();
book.message_count = 3;
book.size = 10;
BookStateFor::<Test>::insert(Here, &book);
knit(&Here);
MessageQueue::sweep_queue(Here);
let fp = MessageQueue::footprint(Here);
assert_eq!(fp.count, 3);
assert_eq!(fp.size, 10);
})
}
#[test]
fn execute_overweight_works() {
build_and_execute::<Test>(|| {
set_weight("bump_service_head", 1.into_weight());
set_weight("service_queue_base", 1.into_weight());
set_weight("service_page_base_completion", 1.into_weight());
// Enqueue a message
let origin = MessageOrigin::Here;
MessageQueue::enqueue_message(msg("weight=6"), origin);
// Load the current book
let book = BookStateFor::<Test>::get(origin);
assert_eq!(book.message_count, 1);
assert!(Pages::<Test>::contains_key(origin, 0));
// Mark the message as permanently overweight.
assert_eq!(MessageQueue::service_queues(4.into_weight()), 4.into_weight());
assert_eq!(QueueChanges::take(), vec![(origin, 1, 8)]);
assert_last_event::<Test>(
Event::OverweightEnqueued {
id: blake2_256(b"weight=6"),
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
origin: MessageOrigin::Here,
message_index: 0,
page_index: 0,
}
.into(),
);
// Now try to execute it with too few weight.
let consumed =
<MessageQueue as ServiceQueues>::execute_overweight(5.into_weight(), (origin, 0, 0));
assert_eq!(consumed, Err(ExecuteOverweightError::InsufficientWeight));
// Execute it with enough weight.
assert_eq!(Pages::<Test>::iter().count(), 1);
assert!(QueueChanges::take().is_empty());
let consumed =
<MessageQueue as ServiceQueues>::execute_overweight(7.into_weight(), (origin, 0, 0))
.unwrap();
assert_eq!(consumed, 6.into_weight());
assert_eq!(QueueChanges::take(), vec![(origin, 0, 0)]);
// There is no message left in the book.
let book = BookStateFor::<Test>::get(origin);
assert_eq!(book.message_count, 0);
// And no more pages.
assert_eq!(Pages::<Test>::iter().count(), 0);
// Doing it again with enough weight will error.
let consumed =
<MessageQueue as ServiceQueues>::execute_overweight(70.into_weight(), (origin, 0, 0));
assert_eq!(consumed, Err(ExecuteOverweightError::NotFound));
assert!(QueueChanges::take().is_empty());
assert!(!Pages::<Test>::contains_key(origin, 0), "Page is gone");
// The book should have been unknit from the ready ring.
assert!(!ServiceHead::<Test>::exists(), "No ready book");
});
}
#[test]
fn permanently_overweight_book_unknits() {
use MessageOrigin::*;
build_and_execute::<Test>(|| {
set_weight("bump_service_head", 1.into_weight());
set_weight("service_queue_base", 1.into_weight());
set_weight("service_page_base_completion", 1.into_weight());
MessageQueue::enqueue_messages([msg("weight=9")].into_iter(), Here);
// It is the only ready book.
assert_ring(&[Here]);
// Mark the message as overweight.
assert_eq!(MessageQueue::service_queues(8.into_weight()), 4.into_weight());
assert_last_event::<Test>(
Event::OverweightEnqueued {
id: blake2_256(b"weight=9"),
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
origin: Here,
message_index: 0,
page_index: 0,
}
.into(),
);
// The book is not ready anymore.
assert_ring(&[]);
assert_eq!(MessagesProcessed::take().len(), 0);
assert_eq!(BookStateFor::<Test>::get(Here).message_count, 1);
// Now if we enqueue another message, it will become ready again.
MessageQueue::enqueue_messages([msg("weight=1")].into_iter(), Here);
assert_ring(&[Here]);
assert_eq!(MessageQueue::service_queues(8.into_weight()), 5.into_weight());
assert_eq!(MessagesProcessed::take().len(), 1);
assert_ring(&[]);
});
}
#[test]
fn permanently_overweight_book_unknits_multiple() {
use MessageOrigin::*;
build_and_execute::<Test>(|| {
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
set_weight("bump_service_head", 1.into_weight());
set_weight("service_queue_base", 1.into_weight());
set_weight("service_page_base_completion", 1.into_weight());
MessageQueue::enqueue_messages(
[msg("weight=1"), msg("weight=9"), msg("weight=9")].into_iter(),
Here,
);
assert_ring(&[Here]);
// Process the first message.
assert_eq!(MessageQueue::service_queues(4.into_weight()), 4.into_weight());
assert_eq!(num_overweight_enqueued_events(), 0);
assert_eq!(MessagesProcessed::take().len(), 1);
// Book is still ready since it was not marked as overweight yet.
assert_ring(&[Here]);
assert_eq!(MessageQueue::service_queues(8.into_weight()), 5.into_weight());
assert_eq!(num_overweight_enqueued_events(), 2);
assert_eq!(MessagesProcessed::take().len(), 0);
// Now it is overweight.
assert_ring(&[]);
// Enqueue another message.
MessageQueue::enqueue_messages([msg("weight=1")].into_iter(), Here);
assert_ring(&[Here]);
assert_eq!(MessageQueue::service_queues(4.into_weight()), 4.into_weight());
assert_eq!(MessagesProcessed::take().len(), 1);
assert_ring(&[]);
});
}
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
#[test]
fn permanently_overweight_limit_is_valid_basic() {
use MessageOrigin::*;
for w in 50..300 {
build_and_execute::<Test>(|| {
DefaultWeightForCall::set(Weight::MAX);
set_weight("bump_service_head", 10.into());
set_weight("service_queue_base", 10.into());
set_weight("service_page_base_no_completion", 10.into());
set_weight("service_page_base_completion", 0.into());
set_weight("service_page_item", 10.into());
set_weight("ready_ring_unknit", 10.into());
let m = "weight=200".to_string();
MessageQueue::enqueue_message(msg(&m), Here);
MessageQueue::service_queues(w.into());
let last_event =
frame_system::Pallet::<Test>::events().into_iter().last().expect("No event");
// The weight overhead for a single message is set to 50. The message itself needs 200.
// Every weight in range `[50, 249]` should result in a permanently overweight message:
if w < 250 {
assert_eq!(
last_event.event,
RuntimeEvent::MessageQueue(Event::OverweightEnqueued {
id: blake2_256(m.as_bytes()),
origin: Here,
message_index: 0,
page_index: 0,
})
);
} else {
// Otherwise it is processed as normal:
assert_eq!(
last_event.event,
RuntimeEvent::MessageQueue(Event::Processed {
origin: Here,
weight_used: 200.into(),
id: blake2_256(m.as_bytes()),
success: true,
})
);
}
});
}
}
#[test]
fn permanently_overweight_limit_is_valid_fuzzy() {
use MessageOrigin::*;
let mut rng = rand::rngs::StdRng::seed_from_u64(42);
for _ in 0..10 {
// Brainlet code, but works...
let (s1, s2) = (rng.gen_range(0..=10), rng.gen_range(0..=10));
let (s3, s4) = (rng.gen_range(0..=10), rng.gen_range(0..=10));
let s5 = rng.gen_range(0..=10);
let o = s1 + s2 + s3 + s4 + s5;
for w in o..=o + 300 {
build_and_execute::<Test>(|| {
DefaultWeightForCall::set(Weight::MAX);
set_weight("bump_service_head", s1.into());
set_weight("service_queue_base", s2.into());
// Only the larger one of these two is taken:
set_weight("service_page_base_no_completion", s3.into());
set_weight("service_page_base_completion", 0.into());
set_weight("service_page_item", s4.into());
set_weight("ready_ring_unknit", s5.into());
let m = "weight=200".to_string();
MessageQueue::enqueue_message(msg(&m), Here);
MessageQueue::service_queues(w.into());
let last_event =
frame_system::Pallet::<Test>::events().into_iter().last().expect("No event");
if w < o + 200 {
assert_eq!(
last_event.event,
RuntimeEvent::MessageQueue(Event::OverweightEnqueued {
id: blake2_256(m.as_bytes()),
origin: Here,
message_index: 0,
page_index: 0,
})
);
} else {
assert_eq!(
last_event.event,
RuntimeEvent::MessageQueue(Event::Processed {
origin: Here,
weight_used: 200.into(),
id: blake2_256(m.as_bytes()),
success: true,
})
);
}
});
}
}
}
/// We don't want empty books in the ready ring, but if they somehow make their way in there, it
/// should not panic.
#[test]
#[cfg(not(debug_assertions))] // Would trigger a defensive failure otherwise.
fn ready_but_empty_does_not_panic() {
use MessageOrigin::*;
build_and_execute::<Test>(|| {
BookStateFor::<Test>::insert(Here, empty_book::<Test>());
BookStateFor::<Test>::insert(There, empty_book::<Test>());
knit(&Here);
knit(&There);
assert_ring(&[Here, There]);
assert_eq!(MessageQueue::service_queues(Weight::MAX), 0.into_weight());
assert_ring(&[]);
});
}
/// We don't want permanently books in the ready ring, but if they somehow make their way in there,
/// it should not panic.
#[test]
#[cfg(not(debug_assertions))] // Would trigger a defensive failure otherwise.
fn ready_but_perm_overweight_does_not_panic() {
use MessageOrigin::*;
build_and_execute::<Test>(|| {
MessageQueue::enqueue_message(msg("weight=9"), Here);
assert_eq!(MessageQueue::service_queues(8.into_weight()), 0.into_weight());
assert_ring(&[]);
// Force it back into the ready ring.
knit(&Here);
assert_ring(&[Here]);
assert_eq!(MessageQueue::service_queues(Weight::MAX), 0.into_weight());
// Unready again.
assert_ring(&[]);
});
}
/// Checks that (un)knitting the ready ring works with just one queue.
///
/// This case is interesting since it wraps and a lot of `mutate` now operate on the same object.
#[test]
fn ready_ring_knit_basic_works() {
use MessageOrigin::*;
build_and_execute::<Test>(|| {
BookStateFor::<Test>::insert(Here, empty_book::<Test>());
for i in 0..10 {
if i % 2 == 0 {
knit(&Here);
assert_ring(&[Here]);
} else {
unknit(&Here);
assert_ring(&[]);
}
}
assert_ring(&[]);
});
}
#[test]
fn ready_ring_knit_and_unknit_works() {
use MessageOrigin::*;
build_and_execute::<Test>(|| {
// Place three queues into the storage.
BookStateFor::<Test>::insert(Here, empty_book::<Test>());
BookStateFor::<Test>::insert(There, empty_book::<Test>());
BookStateFor::<Test>::insert(Everywhere(0), empty_book::<Test>());
// Pausing should make no difference:
PausedQueues::set(vec![Here, There, Everywhere(0)]);
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
// Knit them into the ready ring.
assert_ring(&[]);
knit(&Here);
assert_ring(&[Here]);
knit(&There);
assert_ring(&[Here, There]);
knit(&Everywhere(0));
assert_ring(&[Here, There, Everywhere(0)]);
// Now unknit…
unknit(&Here);
assert_ring(&[There, Everywhere(0)]);
unknit(&There);
assert_ring(&[Everywhere(0)]);
unknit(&Everywhere(0));
assert_ring(&[]);
});
}
#[test]
fn enqueue_message_works() {
use MessageOrigin::*;
let max_msg_per_page = <Test as Config>::HeapSize::get() as u64 /
(ItemHeader::<<Test as Config>::Size>::max_encoded_len() as u64 + 1);
build_and_execute::<Test>(|| {
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
// Enqueue messages which should fill three pages.
let n = max_msg_per_page * 3;
for i in 1..=n {
MessageQueue::enqueue_message(msg("a"), Here);
assert_eq!(QueueChanges::take(), vec![(Here, i, i)], "OnQueueChanged not called");
}
assert_eq!(Pages::<Test>::iter().count(), 3);
// Enqueue one more onto page 4.
MessageQueue::enqueue_message(msg("abc"), Here);
assert_eq!(QueueChanges::take(), vec![(Here, n + 1, n + 3)]);
assert_eq!(Pages::<Test>::iter().count(), 4);
// Check the state.
assert_eq!(BookStateFor::<Test>::iter().count(), 1);
let book = BookStateFor::<Test>::get(Here);
assert_eq!(book.message_count, n + 1);
assert_eq!(book.size, n + 3);
assert_eq!((book.begin, book.end), (0, 4));
assert_eq!(book.count as usize, Pages::<Test>::iter().count());
});
}
#[test]
fn enqueue_messages_works() {
use MessageOrigin::*;
let max_msg_per_page = <Test as Config>::HeapSize::get() as u64 /
(ItemHeader::<<Test as Config>::Size>::max_encoded_len() as u64 + 1);
build_and_execute::<Test>(|| {
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
// Enqueue messages which should fill three pages.
let n = max_msg_per_page * 3;
let msgs = vec![msg("a"); n as usize];
// Now queue all messages at once.
MessageQueue::enqueue_messages(msgs.into_iter(), Here);
// The changed handler should only be called once.
assert_eq!(QueueChanges::take(), vec![(Here, n, n)], "OnQueueChanged not called");
assert_eq!(Pages::<Test>::iter().count(), 3);
// Enqueue one more onto page 4.
MessageQueue::enqueue_message(msg("abc"), Here);
assert_eq!(QueueChanges::take(), vec![(Here, n + 1, n + 3)]);
assert_eq!(Pages::<Test>::iter().count(), 4);
// Check the state.
assert_eq!(BookStateFor::<Test>::iter().count(), 1);
let book = BookStateFor::<Test>::get(Here);
assert_eq!(book.message_count, n + 1);
assert_eq!(book.size, n + 3);
assert_eq!((book.begin, book.end), (0, 4));
assert_eq!(book.count as usize, Pages::<Test>::iter().count());
});
}
#[test]
fn service_queues_suspend_works() {
use MessageOrigin::*;
build_and_execute::<Test>(|| {
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
MessageQueue::enqueue_messages(vec![msg("a"), msg("ab"), msg("abc")].into_iter(), Here);
MessageQueue::enqueue_messages(vec![msg("x"), msg("xy"), msg("xyz")].into_iter(), There);
assert_eq!(QueueChanges::take(), vec![(Here, 3, 6), (There, 3, 6)]);
// Pause `Here` - execution starts `There`.
PausedQueues::set(vec![Here]);
assert_eq!(
(true, false),
(
<Test as Config>::QueuePausedQuery::is_paused(&Here),
<Test as Config>::QueuePausedQuery::is_paused(&There)
)
);
assert_eq!(MessageQueue::service_queues(1.into_weight()), 1.into_weight());
assert_eq!(MessagesProcessed::take(), vec![(vmsg("x"), There)]);
assert_eq!(QueueChanges::take(), vec![(There, 2, 5)]);
// Unpause `Here` - execution continues `There`.
PausedQueues::take();
assert_eq!(
(false, false),
(
<Test as Config>::QueuePausedQuery::is_paused(&Here),
<Test as Config>::QueuePausedQuery::is_paused(&There)
)
);
assert_eq!(MessageQueue::service_queues(1.into_weight()), 1.into_weight());
assert_eq!(MessagesProcessed::take(), vec![(vmsg("xy"), There)]);
assert_eq!(QueueChanges::take(), vec![(There, 1, 3)]);
// Now it swaps to `Here`.
assert_eq!(MessageQueue::service_queues(1.into_weight()), 1.into_weight());
assert_eq!(MessagesProcessed::take(), vec![(vmsg("a"), Here)]);
assert_eq!(QueueChanges::take(), vec![(Here, 2, 5)]);
// Pause `There` - execution continues `Here`.
PausedQueues::set(vec![There]);
assert_eq!(
(false, true),
(
<Test as Config>::QueuePausedQuery::is_paused(&Here),
<Test as Config>::QueuePausedQuery::is_paused(&There)
)
);
assert_eq!(MessageQueue::service_queues(1.into_weight()), 1.into_weight());
assert_eq!(MessagesProcessed::take(), vec![(vmsg("ab"), Here)]);
assert_eq!(QueueChanges::take(), vec![(Here, 1, 3)]);
// Unpause `There` and service all remaining messages.
PausedQueues::take();
assert_eq!(
(false, false),
(
<Test as Config>::QueuePausedQuery::is_paused(&Here),
<Test as Config>::QueuePausedQuery::is_paused(&There)
)
);
assert_eq!(MessageQueue::service_queues(2.into_weight()), 2.into_weight());
assert_eq!(MessagesProcessed::take(), vec![(vmsg("abc"), Here), (vmsg("xyz"), There)]);
assert_eq!(QueueChanges::take(), vec![(Here, 0, 0), (There, 0, 0)]);
});
}
/// Tests that manual overweight execution on a suspended queue errors with `QueueSuspended`.
#[test]
fn execute_overweight_respects_suspension() {
build_and_execute::<Test>(|| {
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
let origin = MessageOrigin::Here;
MessageQueue::enqueue_message(msg("weight=5"), origin);
// Mark the message as permanently overweight.
MessageQueue::service_queues(4.into_weight());
assert_last_event::<Test>(
Event::OverweightEnqueued {
id: blake2_256(b"weight=5"),
origin,
message_index: 0,
page_index: 0,
}
.into(),
);
PausedQueues::set(vec![origin]);
assert!(<Test as Config>::QueuePausedQuery::is_paused(&origin));
// Execution should fail.
assert_eq!(
<MessageQueue as ServiceQueues>::execute_overweight(Weight::MAX, (origin, 0, 0)),
Err(ExecuteOverweightError::QueuePaused)
);
PausedQueues::take();
assert!(!<Test as Config>::QueuePausedQuery::is_paused(&origin));
// Execution should work again with same args.
assert_ok!(<MessageQueue as ServiceQueues>::execute_overweight(
Weight::MAX,
(origin, 0, 0)
));
assert_last_event::<Test>(
Event::Processed {
id: blake2_256(b"weight=5"),
origin,
weight_used: 5.into_weight(),
success: true,
}
.into(),
);
});
}
#[test]
fn service_queue_suspension_ready_ring_works() {
build_and_execute::<Test>(|| {
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
let origin = MessageOrigin::Here;
PausedQueues::set(vec![origin]);
MessageQueue::enqueue_message(msg("weight=5"), origin);
MessageQueue::service_queues(Weight::MAX);
// It did not execute but is in the ready ring.
assert!(System::events().is_empty(), "Paused");
assert_ring(&[origin]);
// Now when we un-pause, it will execute.
PausedQueues::take();
MessageQueue::service_queues(Weight::MAX);
assert_last_event::<Test>(
Event::Processed {
id: blake2_256(b"weight=5"),
origin,
weight_used: 5.into_weight(),
success: true,
}
.into(),
);
});
}
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
#[test]
fn integrity_test_checks_service_weight() {
build_and_execute::<Test>(|| {
assert_eq!(<Test as Config>::ServiceWeight::get(), Some(100.into()), "precond");
assert!(MessageQueue::do_integrity_test().is_ok(), "precond");
// Enough for all:
DefaultWeightForCall::set(20.into());
assert!(MessageQueue::do_integrity_test().is_ok());
// Not enough for anything:
DefaultWeightForCall::set(101.into());
assert_eq!(MessageQueue::single_msg_overhead(), 505.into());
assert!(MessageQueue::do_integrity_test().is_err());
// Not enough for a single function:
for f in [
"bump_service_head",
"service_queue_base",
"service_page_base_completion",
"service_page_base_no_completion",
"service_page_item",
"ready_ring_unknit",
] {
WeightForCall::take();
DefaultWeightForCall::set(Zero::zero());
assert!(MessageQueue::do_integrity_test().is_ok());
set_weight(f, 101.into());
assert!(MessageQueue::do_integrity_test().is_err());
}
});
}