feat(relayer): ListOperations api endpoint (#4089)
### Description Adds a `list_operations` API endpoint to the relayer, which returns all operations in its prepare queue. Example output from `GET http://0.0.0.0:9092/list_operations?destination_domain=13371` ``` [ { "app_context": null, "message": { "body": [ 18, 52 ], "destination": 13371, "nonce": 1, "origin": 13373, "recipient": "0x000000000000000000000000927b167526babb9be047421db732c663a0b77b11", "sender": "0x000000000000000000000000927b167526babb9be047421db732c663a0b77b11", "version": 3 }, "num_retries": 13, "status": { "Retry": "CouldNotFetchMetadata" }, "submitted": false, "type": "PendingMessage" }, { "app_context": null, "message": { "body": [ 18, 52 ], "destination": 13371, "nonce": 2, "origin": 13372, "recipient": "0x000000000000000000000000927b167526babb9be047421db732c663a0b77b11", "sender": "0x000000000000000000000000927b167526babb9be047421db732c663a0b77b11", "version": 3 }, "num_retries": 13, "status": { "Retry": "CouldNotFetchMetadata" }, "submitted": false, "type": "PendingMessage" } ] ``` ### Drive-by changes Makes `PendingOperation` serializable, which means switching from JSON format to e.g. CSV (for easily filtering / aggregating in excel) should be very easy. ### Related issues <!-- - Fixes #[issue number here] --> ### Backward compatibility Yes ### Testing Manual and Unit Testspull/4098/head
Daniel Savu
5 months ago
committed by
GitHub
parent
1022e3858e
commit
8c8f39abfe
@ -0,0 +1,135 @@ |
||||
use axum::{ |
||||
extract::{Query, State}, |
||||
routing, Router, |
||||
}; |
||||
use derive_new::new; |
||||
use hyperlane_core::QueueOperation; |
||||
use serde::Deserialize; |
||||
use serde_json::Value; |
||||
use std::collections::HashMap; |
||||
|
||||
use crate::msg::op_queue::OperationPriorityQueue; |
||||
|
||||
const LIST_OPERATIONS_API_BASE: &str = "/list_operations"; |
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Deserialize)] |
||||
pub struct ListOperationsRequest { |
||||
destination_domain: u32, |
||||
} |
||||
|
||||
impl PartialEq<QueueOperation> for &ListOperationsRequest { |
||||
fn eq(&self, other: &QueueOperation) -> bool { |
||||
self.destination_domain == other.destination_domain().id() |
||||
} |
||||
} |
||||
|
||||
#[derive(new, Clone)] |
||||
pub struct ListOperationsApi { |
||||
op_queues: HashMap<u32, OperationPriorityQueue>, |
||||
} |
||||
|
||||
async fn list_operations( |
||||
State(queues): State<HashMap<u32, OperationPriorityQueue>>, |
||||
Query(request): Query<ListOperationsRequest>, |
||||
) -> String { |
||||
let domain = request.destination_domain; |
||||
let Some(op_queue) = queues.get(&domain) else { |
||||
return format!("No queue found for domain {}", domain); |
||||
}; |
||||
format_queue(op_queue.clone()).await |
||||
} |
||||
|
||||
pub async fn format_queue(queue: OperationPriorityQueue) -> String { |
||||
let res: Result<Vec<Value>, _> = queue |
||||
.lock() |
||||
.await |
||||
.iter() |
||||
.map(|reverse| serde_json::to_value(&reverse.0)) |
||||
.collect(); |
||||
match res.and_then(|v| serde_json::to_string_pretty(&v)) { |
||||
Ok(s) => s, |
||||
Err(e) => format!("Error formatting queue: {}", e), |
||||
} |
||||
} |
||||
|
||||
impl ListOperationsApi { |
||||
pub fn router(&self) -> Router { |
||||
Router::new() |
||||
.route("/", routing::get(list_operations)) |
||||
.with_state(self.op_queues.clone()) |
||||
} |
||||
|
||||
pub fn get_route(&self) -> (&'static str, Router) { |
||||
(LIST_OPERATIONS_API_BASE, self.router()) |
||||
} |
||||
} |
||||
|
||||
// TODO: there's some duplication between the setup for these tests and the one in `message_retry.rs`,
|
||||
// which should be refactored into a common test setup.
|
||||
#[cfg(test)] |
||||
mod tests { |
||||
use crate::msg::op_queue::{ |
||||
test::{dummy_metrics_and_label, MockPendingOperation}, |
||||
OpQueue, |
||||
}; |
||||
|
||||
use super::*; |
||||
use axum::http::StatusCode; |
||||
use hyperlane_core::KnownHyperlaneDomain; |
||||
use std::{cmp::Reverse, net::SocketAddr, sync::Arc}; |
||||
use tokio::sync::{self, Mutex}; |
||||
|
||||
const DUMMY_DOMAIN: KnownHyperlaneDomain = KnownHyperlaneDomain::Arbitrum; |
||||
|
||||
fn setup_test_server() -> (SocketAddr, OperationPriorityQueue) { |
||||
let (metrics, queue_metrics_label) = dummy_metrics_and_label(); |
||||
let broadcaster = sync::broadcast::Sender::new(100); |
||||
let op_queue = OpQueue::new( |
||||
metrics.clone(), |
||||
queue_metrics_label.clone(), |
||||
Arc::new(Mutex::new(broadcaster.subscribe())), |
||||
); |
||||
let mut op_queues_map = HashMap::new(); |
||||
op_queues_map.insert(DUMMY_DOMAIN as u32, op_queue.queue.clone()); |
||||
|
||||
let list_operations_api = ListOperationsApi::new(op_queues_map); |
||||
let (path, router) = list_operations_api.get_route(); |
||||
let app = Router::new().nest(path, router); |
||||
|
||||
// Running the app in the background using a test server
|
||||
let server = |
||||
axum::Server::bind(&"127.0.0.1:0".parse().unwrap()).serve(app.into_make_service()); |
||||
let addr = server.local_addr(); |
||||
tokio::spawn(server); |
||||
|
||||
(addr, op_queue.queue.clone()) |
||||
} |
||||
|
||||
#[tokio::test] |
||||
async fn test_message_id_retry() { |
||||
let (addr, op_queue) = setup_test_server(); |
||||
let dummy_operation_1 = |
||||
Box::new(MockPendingOperation::new(1, DUMMY_DOMAIN.into())) as QueueOperation; |
||||
let dummy_operation_2 = |
||||
Box::new(MockPendingOperation::new(2, DUMMY_DOMAIN.into())) as QueueOperation; |
||||
let v = vec![ |
||||
serde_json::to_value(&dummy_operation_1).unwrap(), |
||||
serde_json::to_value(&dummy_operation_2).unwrap(), |
||||
]; |
||||
let expected_response = serde_json::to_string_pretty(&v).unwrap(); |
||||
op_queue.lock().await.push(Reverse(dummy_operation_1)); |
||||
op_queue.lock().await.push(Reverse(dummy_operation_2)); |
||||
|
||||
// Send a GET request to the server
|
||||
let response = reqwest::get(format!( |
||||
"http://{}{}?destination_domain={}", |
||||
addr, LIST_OPERATIONS_API_BASE, DUMMY_DOMAIN as u32 |
||||
)) |
||||
.await |
||||
.unwrap(); |
||||
|
||||
// Check that the response status code is OK
|
||||
assert_eq!(response.status(), StatusCode::OK); |
||||
assert_eq!(response.text().await.unwrap(), expected_response); |
||||
} |
||||
} |
||||
@ -0,0 +1,48 @@ |
||||
use axum::Router; |
||||
use derive_new::new; |
||||
use std::collections::HashMap; |
||||
use tokio::sync::broadcast::Sender; |
||||
|
||||
use crate::msg::op_queue::OperationPriorityQueue; |
||||
|
||||
pub const ENDPOINT_MESSAGES_QUEUE_SIZE: usize = 1_000; |
||||
|
||||
pub use list_messages::*; |
||||
pub use message_retry::*; |
||||
|
||||
mod list_messages; |
||||
mod message_retry; |
||||
|
||||
#[derive(new)] |
||||
pub struct Server { |
||||
#[new(default)] |
||||
retry_transmitter: Option<Sender<MessageRetryRequest>>, |
||||
#[new(default)] |
||||
op_queues: Option<HashMap<u32, OperationPriorityQueue>>, |
||||
} |
||||
|
||||
impl Server { |
||||
pub fn with_op_retry(mut self, transmitter: Sender<MessageRetryRequest>) -> Self { |
||||
self.retry_transmitter = Some(transmitter); |
||||
self |
||||
} |
||||
|
||||
pub fn with_message_queue(mut self, op_queues: HashMap<u32, OperationPriorityQueue>) -> Self { |
||||
self.op_queues = Some(op_queues); |
||||
self |
||||
} |
||||
|
||||
/// Returns a vector of agent-specific endpoint routes to be served.
|
||||
/// Can be extended with additional routes and feature flags to enable/disable individually.
|
||||
pub fn routes(self) -> Vec<(&'static str, Router)> { |
||||
let mut routes = vec![]; |
||||
if let Some(retry_transmitter) = self.retry_transmitter { |
||||
routes.push(MessageRetryApi::new(retry_transmitter).get_route()); |
||||
} |
||||
if let Some(op_queues) = self.op_queues { |
||||
routes.push(ListOperationsApi::new(op_queues).get_route()); |
||||
} |
||||
|
||||
routes |
||||
} |
||||
} |
||||
Loading…
Reference in new issue