rpc-v2/tx/tests: Add transaction broadcast tests and check propagated tx status by lexnv · Pull Request #3193 · paritytech/polkadot-sdk

lexnv · 2024-02-02T18:11:44Z

This PR adds tests for the transaction_broadcast method.

The testing needs to coordinate the following components:

The TestApi marks transactions as invalid and implements ChainApi::validate_transaction
- this is what dictates if a transaction is valid or not and is called from within the BasicPool
The BasicPool which maintains the transactions and implements submit_and_watch needed by the tx broadcast to submit the transaction
- The status of the transaction pool is exposed by mocking the BasicPool
The ChainHeadMockClient which mocks the BlockchainEvents::import_notification_stream needed by the tx broadcast to know to which blocks the transaction is submitted

The following changes have been added to the substrate testing to accommodate this:

TestApi gets remove_invalid, counterpart to add_invalid to ensure an invalid transaction can become valid again; as well as a priority setter for extrinsics
BasicPool test constructor is extended with options for the PoolRotator
- this mechanism is needed because transactions are banned for 30mins (default) after they are declared invalid
- testing bypasses this by providing a Duration::ZERO

Testing Scenarios

Capture the status of the transaction as it is normally broadcasted
transaction_stop is valid while the transaction is in progress
A future transaction is handled when the dependencies are completed
Try to resubmit the transaction at a later block (currently invalid)
- An invalid transaction status is propagated; the transaction is marked as temporarily banned; then the ban expires and transaction is resubmitted

This builds on top of: #3079
Part of: #3084

cc @paritytech/subxt-team

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

skunert · 2024-02-15T10:18:51Z

substrate/client/rpc-spec-v2/src/transaction/tests/setup.rs

+/// Get the next event from the provided middleware in at most 60 seconds.
+macro_rules! get_next_event {
+	($middleware:expr) => {
+		tokio::time::timeout(std::time::Duration::from_secs(60), $middleware.recv())


Do we expect to ever get close to 60 seconds here? Can't we fail much faster?

We should get the response almost immediately. I'll bring this value down a bit :D

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

…tests Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

jsdw · 2024-02-26T16:07:33Z

substrate/client/rpc-spec-v2/src/transaction/tests/setup.rs

+macro_rules! get_next_event {
+	($middleware:expr) => {
+		tokio::time::timeout(std::time::Duration::from_secs(5), $middleware.recv())
+			.await
+			.unwrap()
+			.unwrap()
+	};
+}
+
+/// Collect the next number of transaction events from the provided middleware.
+macro_rules! get_next_tx_events {
+	($middleware:expr, $num:expr) => {{
+		let mut events = std::collections::HashMap::new();
+		for _ in 0..$num {
+			let event = get_next_event!($middleware);
+			match event {
+				crate::transaction::tests::middleware_pool::MiddlewarePoolEvent::TransactionStatus { transaction, status } => {
+                    events.entry(transaction).or_insert_with(|| vec![]).push(status);
+				},
+				other => panic!("Expected TransactionStatus, received {:?}", other),
+			};
+		}
+		events
+	}};
+}


Are these macros because $middleware might be something other than MiddlewarePoolRecv?

This gives a more useful line number on which the panic happened. The alternative of having a function would always result in a panic at line 100 for example, inside the function. We also use this for the pool middleware and executor middleware

substrate/client/rpc-spec-v2/src/transaction/tests/transaction_broadcast_tests.rs

substrate/test-utils/runtime/transaction-pool/src/lib.rs

jsdw

Just a couple of small nits!

I find a couple of the tests quite long and hard to follow (I wonder if it's possible to make them any smaller in general), but I don't know this code very well, and offhand they look useful!

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

…_broadcast_tests.rs Co-authored-by: James Wilson <james@jsdw.me>

Co-authored-by: James Wilson <james@jsdw.me>

…head-data * origin/master: Fix call enum's metadata regression (#3513) Enable elastic scaling node feature in local testnets genesis (#3509) update development setup in sdk-docs (#3506) Fix accidental no-shows on node restart (#3277) Remove `AssignmentProviderConfig` and use parameters from `HostConfiguration` instead (#3181) [Deprecation] Remove sp_weights::OldWeight (#3491) Fixup multi-collator parachain transition to async backing (#3510) Multi-Block-Migrations, `poll` hook and new System callbacks (#1781) Snowbridge - Extract Ethereum Chain ID (#3501) PVF: re-preparing artifact on failed runtime construction (#3187) Add documentation around FRAME Offchain workers (#3463) [prdoc] Optional SemVer bumps and Docs (#3441) rpc-v2/tx/tests: Add transaction broadcast tests and check propagated tx status (#3193)

…data * ao-collator-parent-head-data: Fix call enum's metadata regression (#3513) Enable elastic scaling node feature in local testnets genesis (#3509) update development setup in sdk-docs (#3506) Fix accidental no-shows on node restart (#3277) Remove `AssignmentProviderConfig` and use parameters from `HostConfiguration` instead (#3181) [Deprecation] Remove sp_weights::OldWeight (#3491) Fixup multi-collator parachain transition to async backing (#3510) Multi-Block-Migrations, `poll` hook and new System callbacks (#1781) Snowbridge - Extract Ethereum Chain ID (#3501) PVF: re-preparing artifact on failed runtime construction (#3187) Add documentation around FRAME Offchain workers (#3463) [prdoc] Optional SemVer bumps and Docs (#3441) rpc-v2/tx/tests: Add transaction broadcast tests and check propagated tx status (#3193)

… tx status (paritytech#3193) This PR adds tests for the `transaction_broadcast` method. The testing needs to coordinate the following components: - The `TestApi` marks transactions as invalid and implements `ChainApi::validate_transaction` - this is what dictates if a transaction is valid or not and is called from within the `BasicPool` - The `BasicPool` which maintains the transactions and implements `submit_and_watch` needed by the tx broadcast to submit the transaction - The status of the transaction pool is exposed by mocking the BasicPool - The `ChainHeadMockClient` which mocks the `BlockchainEvents::import_notification_stream` needed by the tx broadcast to know to which blocks the transaction is submitted The following changes have been added to the substrate testing to accommodate this: - `TestApi` gets ` remove_invalid`, counterpart to `add_invalid` to ensure an invalid transaction can become valid again; as well as a priority setter for extrinsics - `BasicPool` test constructor is extended with options for the `PoolRotator` - this mechanism is needed because transactions are banned for 30mins (default) after they are declared invalid - testing bypasses this by providing a `Duration::ZERO` ### Testing Scenarios - Capture the status of the transaction as it is normally broadcasted - `transaction_stop` is valid while the transaction is in progress - A future transaction is handled when the dependencies are completed - Try to resubmit the transaction at a later block (currently invalid) - An invalid transaction status is propagated; the transaction is marked as temporarily banned; then the ban expires and transaction is resubmitted This builds on top of: paritytech#3079 Part of: paritytech#3084 cc @paritytech/subxt-team --------- Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> Co-authored-by: James Wilson <james@jsdw.me>

lexnv added A1-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). R0-no-crate-publish-required The change does not require any crates to be re-published. T3-RPC_API This PR/Issue is related to RPC APIs. labels Feb 2, 2024

Base automatically changed from lexnv/broadcast-tx to master February 12, 2024 13:50

lexnv added 14 commits February 13, 2024 13:22

tx/tests: Move tests to dedicated module

886d3ab

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx/tests: Add mock transaction pool to gain access to tx status

52c3afb

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx/tests: Add task executor mock

58b3f5e

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx/tests: Add setup file to use middlewares

8fc2339

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx/tests: Use the testing infrastructure

9a54386

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx/tests: Ensure a future tx is propagated

d98f713

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx/tests: Check stop cannot be called after broadcast finishes

c93a386

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx/tests: Fix race between InBlock and Finalized events

274b47a

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx-pool: Extend basic pool with options

94bae37

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx/tests: Use options as default

233f789

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx/tests: Check that an invalid tx is resubmited in the future

f8177ab

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

chainHead/tests: Do not panic on dropped receivers from mocks

7004451

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

test-utils: Inject tx priority to the test pool api

5c76f29

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

tx/tests: Check immediately dropped tx are resubmitted

2d764ef

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

lexnv force-pushed the lexnv/broadcast-tx-tests branch from 1d1ce80 to 2d764ef Compare February 13, 2024 16:00

lexnv changed the title ~~rpc-v2/tx/tests: Add transaction middleware and check propagated tx status~~ rpc-v2/tx/tests: Add transaction broadcast tests and check propagated tx status Feb 13, 2024

lexnv requested a review from skunert February 14, 2024 16:20

skunert approved these changes Feb 15, 2024

View reviewed changes

lexnv added 2 commits February 15, 2024 14:18

tx/tests: Decrease timeout from 60 secs to 5 secs

373ae27

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

Merge remote-tracking branch 'origin/master' into lexnv/broadcast-tx-…

6466cf0

…tests Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

jsdw reviewed Feb 26, 2024

View reviewed changes

substrate/client/rpc-spec-v2/src/transaction/tests/transaction_broadcast_tests.rs Outdated Show resolved Hide resolved

jsdw reviewed Feb 26, 2024

View reviewed changes

substrate/client/rpc-spec-v2/src/transaction/tests/transaction_broadcast_tests.rs Outdated Show resolved Hide resolved

jsdw reviewed Feb 26, 2024

View reviewed changes

substrate/test-utils/runtime/transaction-pool/src/lib.rs Outdated Show resolved Hide resolved

jsdw approved these changes Feb 26, 2024

View reviewed changes

tx/tests: Check number of active spawned tasks

72dd3ae

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

lexnv and others added 2 commits February 27, 2024 15:21

Update substrate/client/rpc-spec-v2/src/transaction/tests/transaction…

661458a

…_broadcast_tests.rs Co-authored-by: James Wilson <james@jsdw.me>

Update substrate/test-utils/runtime/transaction-pool/src/lib.rs

c06012a

Co-authored-by: James Wilson <james@jsdw.me>

lexnv enabled auto-merge February 27, 2024 13:53

Merge branch 'master' into lexnv/broadcast-tx-tests

34933c3

lexnv added this pull request to the merge queue Feb 28, 2024

Merged via the queue into master with commit f1b2189 Feb 28, 2024

lexnv deleted the lexnv/broadcast-tx-tests branch February 28, 2024 10:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rpc-v2/tx/tests: Add transaction broadcast tests and check propagated tx status#3193

rpc-v2/tx/tests: Add transaction broadcast tests and check propagated tx status#3193
lexnv merged 20 commits intomasterfrom
lexnv/broadcast-tx-tests

lexnv commented Feb 2, 2024 •

edited

Loading

Uh oh!

skunert Feb 15, 2024

Uh oh!

lexnv Feb 15, 2024

Uh oh!

jsdw Feb 26, 2024

Uh oh!

lexnv Feb 26, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jsdw left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

lexnv commented Feb 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing Scenarios

Uh oh!

skunert Feb 15, 2024

Choose a reason for hiding this comment

Uh oh!

lexnv Feb 15, 2024

Choose a reason for hiding this comment

Uh oh!

jsdw Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

lexnv Feb 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jsdw left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lexnv commented Feb 2, 2024 •

edited

Loading

lexnv Feb 26, 2024 •

edited

Loading