Merge pull request #3876 from ProvableHQ/ci/bench-get-recent-block

[CI] Measure speed of retrieving the most recent block

Author: kaimast

.ci/bench_rest_api.sh

@@ -57,5 +57,6 @@ wait_for_nodes 0 1
 
 python ./.ci/rest_api_helper.py "get-block" $CORES_PER_NODE 60
 python ./.ci/rest_api_helper.py "block-height" $CORES_PER_NODE 10000
+python ./.ci/rest_api_helper.py "get-latest-block" $CORES_PER_NODE 100
 
 exit 0

.ci/rest_api_helper.py

@@ -42,9 +42,14 @@ async def make_request(session, worker_id, mode):
     """Make a single async request to the block endpoint"""
 
     if mode == "get-block":
+        # Checks that any block can be retrieved in a reasonable time.
         block_id = random.randint(MIN_BLOCK, MAX_BLOCK)
         url = f"{GET_BLOCK_BASE_URL}/{block_id}"
+    elif mode == "get-latest-block":
+        # Tests that the most recent block(s) are cached and can be retrieved even quicker.
+        url = f"{GET_BLOCK_BASE_URL}/{MAX_BLOCK}"
     elif mode == "block-height":
+        # Fetches the current block height as a basline for the REST API speed.
         url = BLOCK_HEIGHT_URL
     else:
         raise RuntimeError(f'Unknown REST mode "{mode}"')
@@ -96,15 +101,15 @@ async def worker(session, worker_id, mode, reqs_per_worker):
 async def main(mode, num_workers, reqs_per_worker):
     """Main async function to coordinate the workers"""
 
-    if mode == "get-block":
+    if mode in ["get-block", "get-latest-block"]:
         base_url = GET_BLOCK_BASE_URL
     elif mode == "block-height":
         base_url = BLOCK_HEIGHT_URL
     else:
         raise RuntimeError(f'Unknown REST mode "{mode}"')
 
-    print(f'Starting {num_workers} async workers, each making '
-          f'{reqs_per_worker} requests...')
+    print(f'Starting {num_workers} async workers for "{mode}", '
+          f' each making {reqs_per_worker} requests...')
     print(f"Target endpoint: {base_url}")
     print("")
 

Cargo.lock

@@ -23,7 +23,11 @@ use snarkos_node_cdn::CdnBlockSync;
 use snarkos_node_network::NodeType;
 use snarkos_node_rest::Rest;
 use snarkos_node_router::{
-    Heartbeat, Inbound, Outbound, Router, Routing,
+    Heartbeat,
+    Inbound,
+    Outbound,
+    Router,
+    Routing,
     messages::{Message, UnconfirmedSolution, UnconfirmedTransaction},
 };
 use snarkos_node_sync::{BLOCK_REQUEST_BATCH_DELAY, BlockSync, Ping, PrepareSyncRequest, locators::BlockLocators};
@@ -58,7 +62,8 @@ use std::{
     sync::{
         Arc,
         atomic::{
-            AtomicBool, AtomicUsize,
+            AtomicBool,
+            AtomicUsize,
             Ordering::{Acquire, Relaxed},
         },
     },

node/src/client/mod.rs

@@ -24,7 +24,11 @@ use snarkos_node_consensus::Consensus;
 use snarkos_node_network::{NodeType, PeerPoolHandling};
 use snarkos_node_rest::Rest;
 use snarkos_node_router::{
-    Heartbeat, Inbound, Outbound, Router, Routing,
+    Heartbeat,
+    Inbound,
+    Outbound,
+    Router,
+    Routing,
     messages::{PuzzleResponse, UnconfirmedSolution, UnconfirmedTransaction},
 };
 use snarkos_node_sync::{BlockSync, Ping};
@@ -33,7 +37,8 @@ use snarkos_node_tcp::{
     protocols::{Disconnect, Handshake, OnConnect, Reading},
 };
 use snarkvm::prelude::{
-    Ledger, Network,
+    Ledger,
+    Network,
     block::{Block, Header},
     puzzle::Solution,
     store::ConsensusStorage,
@@ -483,7 +488,8 @@ impl<N: Network, C: ConsensusStorage<N>> NodeInterface<N> for Validator<N, C> {
 mod tests {
     use super::*;
     use snarkvm::prelude::{
-        MainnetV0, VM,
+        MainnetV0,
+        VM,
         store::{ConsensusStore, helpers::memory::ConsensusMemory},
     };