pezkuwi-sdk/pezkuwi/runtime/teyrchains/src/dmp/tests.rs

// Copyright (C) Parity Technologies (UK) Ltd.
// This file is part of Pezkuwi.

// Pezkuwi is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Pezkuwi is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Pezkuwi.  If not, see <http://www.gnu.org/licenses/>.

use super::*;
use crate::{
	configuration::ActiveConfig,
	mock::{new_test_ext, Dmp, MockGenesisConfig, Paras, System, Test},
};
use codec::Encode;
use pezframe_support::assert_ok;
use hex_literal::hex;
use pezkuwi_primitives::BlockNumber;
use pezsp_arithmetic::traits::Saturating;

pub(crate) fn run_to_block(to: BlockNumber, new_session: Option<Vec<BlockNumber>>) {
	while System::block_number() < to {
		let b = System::block_number();
		Paras::initializer_finalize(b);
		Dmp::initializer_finalize();
		if new_session.as_ref().map_or(false, |v| v.contains(&(b + 1))) {
			Dmp::initializer_on_new_session(&Default::default(), &Vec::new());
		}
		System::on_finalize(b);

		System::on_initialize(b + 1);
		System::set_block_number(b + 1);

		Paras::initializer_finalize(b + 1);
		Dmp::initializer_initialize(b + 1);
	}
}

fn default_genesis_config() -> MockGenesisConfig {
	MockGenesisConfig {
		configuration: crate::configuration::GenesisConfig {
			config: crate::configuration::HostConfiguration {
				max_downward_message_size: 1024,
				..Default::default()
			},
		},
		..Default::default()
	}
}

fn queue_downward_message(
	para_id: ParaId,
	msg: DownwardMessage,
) -> Result<(), QueueDownwardMessageError> {
	Dmp::queue_downward_message(&configuration::ActiveConfig::<Test>::get(), para_id, msg)
}

fn register_paras(paras: &[ParaId]) {
	paras.iter().for_each(|p| {
		Dmp::make_teyrchain_reachable(*p);
	});
}

#[test]
fn clean_dmp_works() {
	let a = ParaId::from(1312);
	let b = ParaId::from(228);
	let c = ParaId::from(123);

	new_test_ext(default_genesis_config()).execute_with(|| {
		register_paras(&[a, b, c]);

		// enqueue downward messages to A, B and C.
		queue_downward_message(a, vec![1, 2, 3]).unwrap();
		queue_downward_message(b, vec![4, 5, 6]).unwrap();
		queue_downward_message(c, vec![7, 8, 9]).unwrap();

		let notification = crate::initializer::SessionChangeNotification::default();
		let outgoing_paras = vec![a, b];
		Dmp::initializer_on_new_session(&notification, &outgoing_paras);

		assert!(DownwardMessageQueues::<Test>::get(&a).is_empty());
		assert!(DownwardMessageQueues::<Test>::get(&b).is_empty());
		assert!(!DownwardMessageQueues::<Test>::get(&c).is_empty());
	});
}

#[test]
fn dmq_length_and_head_updated_properly() {
	let a = ParaId::from(1312);
	let b = ParaId::from(228);

	new_test_ext(default_genesis_config()).execute_with(|| {
		register_paras(&[a, b]);

		assert_eq!(Dmp::dmq_length(a), 0);
		assert_eq!(Dmp::dmq_length(b), 0);

		queue_downward_message(a, vec![1, 2, 3]).unwrap();

		assert_eq!(Dmp::dmq_length(a), 1);
		assert_eq!(Dmp::dmq_length(b), 0);
		assert!(!Dmp::dmq_mqc_head(a).is_zero());
		assert!(Dmp::dmq_mqc_head(b).is_zero());
	});
}

#[test]
fn dmq_fail_if_para_does_not_exist() {
	let a = ParaId::from(1312);

	new_test_ext(default_genesis_config()).execute_with(|| {
		assert_eq!(Dmp::dmq_length(a), 0);

		assert!(matches!(
			queue_downward_message(a, vec![1, 2, 3]),
			Err(QueueDownwardMessageError::Unroutable)
		));

		assert_eq!(Dmp::dmq_length(a), 0);
		assert!(Dmp::dmq_mqc_head(a).is_zero());
	});
}

#[test]
fn dmp_mqc_head_fixture() {
	let a = ParaId::from(2000);

	new_test_ext(default_genesis_config()).execute_with(|| {
		register_paras(&[a]);

		run_to_block(2, None);
		assert!(Dmp::dmq_mqc_head(a).is_zero());
		queue_downward_message(a, vec![1, 2, 3]).unwrap();

		run_to_block(3, None);
		queue_downward_message(a, vec![4, 5, 6]).unwrap();

		assert_eq!(
			Dmp::dmq_mqc_head(a),
			hex!["88dc00db8cc9d22aa62b87807705831f164387dfa49f80a8600ed1cbe1704b6b"].into(),
		);
	});
}

#[test]
fn check_processed_downward_messages() {
	let a = ParaId::from(1312);

	new_test_ext(default_genesis_config()).execute_with(|| {
		register_paras(&[a]);

		let block_number = System::block_number();

		// processed_downward_messages=0 is allowed when the DMQ is empty.
		assert!(Dmp::check_processed_downward_messages(a, block_number, 0).is_ok());

		queue_downward_message(a, vec![1, 2, 3]).unwrap();
		queue_downward_message(a, vec![4, 5, 6]).unwrap();
		queue_downward_message(a, vec![7, 8, 9]).unwrap();

		// 0 doesn't pass if the DMQ has msgs.
		assert!(Dmp::check_processed_downward_messages(a, block_number, 0).is_err());
		// a candidate can consume up to 3 messages
		assert!(Dmp::check_processed_downward_messages(a, block_number, 1).is_ok());
		assert!(Dmp::check_processed_downward_messages(a, block_number, 2).is_ok());
		assert!(Dmp::check_processed_downward_messages(a, block_number, 3).is_ok());
		// there is no 4 messages in the queue
		assert!(Dmp::check_processed_downward_messages(a, block_number, 4).is_err());
	});
}

#[test]
fn check_processed_downward_messages_advancement_rule() {
	let a = ParaId::from(1312);

	new_test_ext(default_genesis_config()).execute_with(|| {
		register_paras(&[a]);

		let block_number = System::block_number();

		run_to_block(block_number + 1, None);
		let advanced_block_number = System::block_number();

		queue_downward_message(a, vec![1, 2, 3]).unwrap();
		queue_downward_message(a, vec![4, 5, 6]).unwrap();

		// The queue was empty at genesis, 0 is OK despite it being non-empty in the further block.
		assert!(Dmp::check_processed_downward_messages(a, block_number, 0).is_ok());
		// For the advanced block number, however, the rule is broken in case of 0.
		assert!(Dmp::check_processed_downward_messages(a, advanced_block_number, 0).is_err());
	});
}

#[test]
fn dmq_pruning() {
	let a = ParaId::from(1312);

	new_test_ext(default_genesis_config()).execute_with(|| {
		register_paras(&[a]);

		assert_eq!(Dmp::dmq_length(a), 0);

		queue_downward_message(a, vec![1, 2, 3]).unwrap();
		queue_downward_message(a, vec![4, 5, 6]).unwrap();
		queue_downward_message(a, vec![7, 8, 9]).unwrap();
		assert_eq!(Dmp::dmq_length(a), 3);

		// pruning 0 elements shouldn't change anything.
		Dmp::prune_dmq(a, 0);
		assert_eq!(Dmp::dmq_length(a), 3);

		Dmp::prune_dmq(a, 2);
		assert_eq!(Dmp::dmq_length(a), 1);
	});
}

#[test]
fn queue_downward_message_critical() {
	let a = ParaId::from(1312);

	let mut genesis = default_genesis_config();
	genesis.configuration.config.max_downward_message_size = 7;

	new_test_ext(genesis).execute_with(|| {
		register_paras(&[a]);

		let smol = [0; 3].to_vec();
		let big = [0; 8].to_vec();

		// still within limits
		assert_eq!(smol.encode().len(), 4);
		assert!(queue_downward_message(a, smol).is_ok());

		// that's too big
		assert_eq!(big.encode().len(), 9);
		assert!(queue_downward_message(a, big).is_err());
	});
}

#[test]
fn verify_dmq_mqc_head_is_externally_accessible() {
	use hex_literal::hex;
	use pezkuwi_primitives::well_known_keys;

	let a = ParaId::from(2020);

	new_test_ext(default_genesis_config()).execute_with(|| {
		register_paras(&[a]);

		let head = pezsp_io::storage::get(&well_known_keys::dmq_mqc_head(a));
		assert_eq!(head, None);

		queue_downward_message(a, vec![1, 2, 3]).unwrap();

		let head = pezsp_io::storage::get(&well_known_keys::dmq_mqc_head(a));
		assert_eq!(
			head,
			Some(
				hex!["434f8579a2297dfea851bf6be33093c83a78b655a53ae141a7894494c0010589"]
					.to_vec()
					.into()
			)
		);
	});
}

#[test]
fn verify_fee_increase_and_decrease() {
	let a = ParaId::from(123);

	let mut genesis = default_genesis_config();
	genesis.configuration.config.max_downward_message_size = 16777216;
	new_test_ext(genesis).execute_with(|| {
		register_paras(&[a]);

		let initial = Pallet::<Test>::MIN_FEE_FACTOR;
		assert_eq!(DeliveryFeeFactor::<Test>::get(a), initial);

		// Under fee limit
		queue_downward_message(a, vec![1]).unwrap();
		assert_eq!(DeliveryFeeFactor::<Test>::get(a), initial);

		// Limit reached so fee is increased
		queue_downward_message(a, vec![1]).unwrap();
		let result = Pallet::<Test>::MIN_FEE_FACTOR.saturating_mul(Dmp::EXPONENTIAL_FEE_BASE);
		assert_eq!(DeliveryFeeFactor::<Test>::get(a), result);

		Dmp::prune_dmq(a, 1);
		assert_eq!(DeliveryFeeFactor::<Test>::get(a), initial);

		// 10 Kb message adds additional 0.001 per KB fee factor
		let big_message = [0; 10240].to_vec();
		let msg_len_in_kb = big_message.len().saturating_div(1024) as u32;
		let result = initial.saturating_mul(
			Dmp::EXPONENTIAL_FEE_BASE +
				Dmp::MESSAGE_SIZE_FEE_BASE.saturating_mul(FixedU128::from_u32(msg_len_in_kb)),
		);
		queue_downward_message(a, big_message).unwrap();
		assert_eq!(DeliveryFeeFactor::<Test>::get(a), result);

		queue_downward_message(a, vec![1]).unwrap();
		let result = result.saturating_mul(Dmp::EXPONENTIAL_FEE_BASE);
		assert_eq!(DeliveryFeeFactor::<Test>::get(a), result);

		Dmp::prune_dmq(a, 3);
		let result = result / Dmp::EXPONENTIAL_FEE_BASE;
		assert_eq!(DeliveryFeeFactor::<Test>::get(a), result);
		assert_eq!(Dmp::dmq_length(a), 0);

		// Messages under limit will keep decreasing fee factor until base fee factor is reached
		queue_downward_message(a, vec![1]).unwrap();
		Dmp::prune_dmq(a, 1);
		queue_downward_message(a, vec![1]).unwrap();
		Dmp::prune_dmq(a, 1);
		assert_eq!(DeliveryFeeFactor::<Test>::get(a), initial);
	});
}

#[test]
fn verify_fee_factor_reaches_high_value() {
	let a = ParaId::from(123);
	let mut genesis = default_genesis_config();
	genesis.configuration.config.max_downward_message_size = 51200;
	new_test_ext(genesis).execute_with(|| {
		register_paras(&[a]);

		let max_messages =
			Dmp::dmq_max_length(ActiveConfig::<Test>::get().max_downward_message_size);
		let mut total_fee_factor = FixedU128::from_float(1.0);
		for _ in 1..max_messages {
			assert_ok!(queue_downward_message(a, vec![]));
			total_fee_factor = total_fee_factor + (DeliveryFeeFactor::<Test>::get(a));
		}
		assert!(total_fee_factor > FixedU128::from_u32(100_000_000));
	});
}