Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(rpc): Check for panics in the transaction queue #4046

Merged
merged 3 commits into from
Apr 6, 2022
Merged

fix(rpc): Check for panics in the transaction queue #4046

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
36200c4
Check for panics in the RPC transaction queue
teor2345 Apr 6, 2022
f24d495
Add missing pin! and abort in the start task
teor2345 Apr 6, 2022
7c2ea75
Check for transaction queue panics in tests
teor2345 Apr 6, 2022
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
Prev Previous commit
Check for transaction queue panics in tests
  • Loading branch information
@teor2345
teor2345 committed Apr 6, 2022
commit 7c2ea75afeee084682cf589d291188c3f1c3db40
77 changes: 65 additions & 12 deletions zebra-rpc/src/methods/tests/prop.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

use std::collections::HashSet;

use futures::FutureExt;
use hex::ToHex;
use jsonrpc_core::{Error, ErrorCode};
use proptest::prelude::*;
Expand Down Expand Up @@ -34,7 +35,7 @@ proptest! {
runtime.block_on(async move {
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();
let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand Down Expand Up @@ -67,6 +68,10 @@ proptest! {

prop_assert_eq!(result, Ok(hash));

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

Ok::<_, TestCaseError>(())
})?;
}
Expand All @@ -82,7 +87,7 @@ proptest! {
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();

let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand Down Expand Up @@ -122,6 +127,10 @@ proptest! {
"Result is not a server error: {result:?}"
);

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

Ok::<_, TestCaseError>(())
})?;
}
Expand All @@ -135,7 +144,7 @@ proptest! {
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();

let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand Down Expand Up @@ -176,6 +185,10 @@ proptest! {
"Result is not a server error: {result:?}"
);

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

Ok::<_, TestCaseError>(())
})?;
}
Expand All @@ -196,7 +209,7 @@ proptest! {
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();

let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand Down Expand Up @@ -224,6 +237,10 @@ proptest! {
"Result is not an invalid parameters error: {result:?}"
);

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

Ok::<_, TestCaseError>(())
})?;
}
Expand All @@ -246,7 +263,7 @@ proptest! {
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();

let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand Down Expand Up @@ -274,6 +291,10 @@ proptest! {
"Result is not an invalid parameters error: {result:?}"
);

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

Ok::<_, TestCaseError>(())
})?;
}
Expand All @@ -295,7 +316,7 @@ proptest! {
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();

let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand Down Expand Up @@ -323,6 +344,10 @@ proptest! {

prop_assert_eq!(result, Ok(expected_response));

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

Ok::<_, TestCaseError>(())
})?;
}
Expand All @@ -343,7 +368,7 @@ proptest! {
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();

let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand Down Expand Up @@ -371,6 +396,10 @@ proptest! {
"Result is not an invalid parameters error: {result:?}"
);

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

Ok::<_, TestCaseError>(())
})?;
}
Expand All @@ -393,7 +422,7 @@ proptest! {
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();

let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand All @@ -420,6 +449,11 @@ proptest! {
),
"Result is not an invalid parameters error: {result:?}"
);

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

Ok::<_, TestCaseError>(())
})?;
}
Expand All @@ -431,16 +465,23 @@ proptest! {
let _guard = runtime.enter();
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();

// look for an error with a `NoChainTip`
let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
NoChainTip,
network,
);

let response = rpc.get_blockchain_info();
prop_assert_eq!(&response.err().unwrap().message, "No Chain tip available yet");

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

runtime.block_on(async move {
mempool.expect_no_requests().await?;
state.expect_no_requests().await?;
Expand Down Expand Up @@ -471,7 +512,7 @@ proptest! {
mock_chain_tip_sender.send_best_tip_block_time(block_time);

// Start RPC with the mocked `ChainTip`
let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand Down Expand Up @@ -504,6 +545,10 @@ proptest! {
},
};

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

// check no requests were made during this test
runtime.block_on(async move {
mempool.expect_no_requests().await?;
Expand All @@ -528,7 +573,7 @@ proptest! {
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();

let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand Down Expand Up @@ -594,6 +639,10 @@ proptest! {
mempool.expect_no_requests().await?;
state.expect_no_requests().await?;

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

Ok::<_, TestCaseError>(())
})?;
}
Expand All @@ -611,7 +660,7 @@ proptest! {
let mut mempool = MockService::build().for_prop_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_prop_tests();

let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand Down Expand Up @@ -686,6 +735,10 @@ proptest! {
mempool.expect_no_requests().await?;
state.expect_no_requests().await?;

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
prop_assert!(matches!(rpc_tx_queue_task_result, None));

Ok::<_, TestCaseError>(())
})?;
}
Expand Down
30 changes: 25 additions & 5 deletions zebra-rpc/src/methods/tests/vectors.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ async fn rpc_getinfo() {
let mut mempool: MockService<_, _, _, BoxError> = MockService::build().for_unit_tests();
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_unit_tests();

let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand All @@ -45,6 +45,10 @@ async fn rpc_getinfo() {

mempool.expect_no_requests().await;
state.expect_no_requests().await;

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
assert!(matches!(rpc_tx_queue_task_result, None));
}

#[tokio::test]
Expand All @@ -63,7 +67,7 @@ async fn rpc_getblock() {
zebra_state::populated_state(blocks.clone(), Mainnet).await;

// Init RPC
let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
read_state,
Expand All @@ -82,6 +86,10 @@ async fn rpc_getblock() {
}

mempool.expect_no_requests().await;

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
assert!(matches!(rpc_tx_queue_task_result, None));
}

#[tokio::test]
Expand All @@ -92,7 +100,7 @@ async fn rpc_getblock_error() {
let mut state: MockService<_, _, _, BoxError> = MockService::build().for_unit_tests();

// Init RPC
let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
Buffer::new(state.clone(), 1),
Expand All @@ -108,6 +116,10 @@ async fn rpc_getblock_error() {

mempool.expect_no_requests().await;
state.expect_no_requests().await;

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
assert!(matches!(rpc_tx_queue_task_result, None));
}

#[tokio::test]
Expand All @@ -132,7 +144,7 @@ async fn rpc_getbestblockhash() {
zebra_state::populated_state(blocks.clone(), Mainnet).await;

// Init RPC
let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
read_state,
Expand All @@ -150,6 +162,10 @@ async fn rpc_getbestblockhash() {
assert_eq!(response_hash, tip_block_hash);

mempool.expect_no_requests().await;

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
assert!(matches!(rpc_tx_queue_task_result, None));
}

#[tokio::test]
Expand All @@ -168,7 +184,7 @@ async fn rpc_getrawtransaction() {
zebra_state::populated_state(blocks.clone(), Mainnet).await;

// Init RPC
let (rpc, _rpc_tx_queue_task_handle) = RpcImpl::new(
let (rpc, rpc_tx_queue_task_handle) = RpcImpl::new(
"RPC test",
Buffer::new(mempool.clone(), 1),
read_state,
Expand Down Expand Up @@ -231,4 +247,8 @@ async fn rpc_getrawtransaction() {
}
}
}

// The queue task should continue without errors or panics
let rpc_tx_queue_task_result = rpc_tx_queue_task_handle.now_or_never();
assert!(matches!(rpc_tx_queue_task_result, None));
}