Inside Bitcoin

1#!/usr/bin/env python3
2# Copyright (c) The Bitcoin Core developers
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or https://opensource.org/license/mit/.
5"""Ensure RPCs with a (possibly large) payload will either be rejected or handled, but will never time out."""
6
7from concurrent.futures import ThreadPoolExecutor
8from test_framework.test_framework import BitcoinTestFramework
9from test_framework.util import assert_equal, JSONRPCException
10import random
11
12
13class RpcEchoPayloadTest(BitcoinTestFramework):
14    def set_test_params(self):
15        self.num_nodes = 1
16        self.setup_clean_chain = True
17        self.extra_args = [["-rpcworkqueue=2", "-rpcthreads=2"]]
18        # enough to possibly fill the running threads as well as the queue:
19        self.num_threads = 6
20
21    def run_test(self):
22        node = self.nodes[0]
23        # Use json-serializable, but non-hex data
24        data = "z" + random.randbytes(1_999_000).hex()
25
26        def check_results(rpc):
27            self.log.info("Starting thread ...")
28            for i in range(200):
29                payload = data[: random.randrange(0, len(data))]
30                try:
31                    if random.getrandbits(1):
32                        assert_equal(payload, rpc.echo(payload)[0])
33                    else:
34                        rpc.sendrawtransaction(payload)
35                except JSONRPCException as e:
36                    msg = e.error["message"]
37                    if msg not in [
38                        "TX decode failed. Make sure the tx has at least one input.",
39                        "non-JSON HTTP response with '503 Service Unavailable' from server: Work queue depth exceeded",
40                    ]:
41                        raise AssertionError(f"Unexpected msg: {msg}")
42
43        rpcs = [node.create_new_rpc_connection() for _ in range(self.num_threads)]
44        self.log.info("Starting threadpool ...")
45        with ThreadPoolExecutor(max_workers=len(rpcs)) as threads:
46            list(threads.map(check_results, rpcs))
47
48
49if __name__ == "__main__":
50    RpcEchoPayloadTest(__file__).main()
51