use crate::frontend::errors::FrontendErrorResponse; use crate::{app::Web3ProxyApp, user_token::UserBearerToken}; use anyhow::Context; use axum::{ headers::{authorization::Bearer, Authorization}, TypedHeader, }; use chrono::NaiveDateTime; use entities::{rpc_accounting, rpc_key}; use hashbrown::HashMap; use http::StatusCode; use migration::{Condition, Expr, SimpleExpr}; use redis_rate_limiter::{redis::AsyncCommands, RedisConnection}; use sea_orm::{ ColumnTrait, EntityTrait, PaginatorTrait, QueryFilter, QueryOrder, QuerySelect, Select, }; use tracing::{instrument, warn}; /// get the attached address from redis for the given auth_token. /// 0 means all users #[instrument(level = "trace", skip(redis_conn))] pub async fn get_user_id_from_params( mut redis_conn: RedisConnection, // this is a long type. should we strip it down? bearer: Option>>, params: &HashMap, ) -> anyhow::Result { match (bearer, params.get("user_id")) { (Some(TypedHeader(Authorization(bearer))), Some(user_id)) => { // check for the bearer cache key let bearer_cache_key = UserBearerToken::try_from(bearer)?.to_string(); // get the user id that is attached to this bearer token let bearer_user_id = redis_conn .get::<_, u64>(bearer_cache_key) .await // TODO: this should be a 403 .context("fetching rpc_key_id from redis with bearer_cache_key")?; let user_id: u64 = user_id.parse().context("Parsing user_id param")?; if bearer_user_id != user_id { // TODO: proper HTTP Status code Err(anyhow::anyhow!("permission denied")) } else { Ok(bearer_user_id) } } (_, None) => { // they have a bearer token. we don't care about it on public pages // 0 means all Ok(0) } (None, Some(x)) => { // they do not have a bearer token, but requested a specific id. block // TODO: proper error code // TODO: maybe instead of this sharp edged warn, we have a config value? // TODO: check config for if we should deny or allow this // Err(anyhow::anyhow!("permission denied")) // TODO: make this a flag warn!("allowing without auth during development!"); Ok(x.parse()?) } } } /// only allow rpc_key to be set if user_id is also set. /// this will keep people from reading someone else's keys. /// 0 means none. #[instrument(level = "trace")] pub fn get_rpc_key_id_from_params( user_id: u64, params: &HashMap, ) -> anyhow::Result { if user_id > 0 { params.get("rpc_key_id").map_or_else( || Ok(0), |c| { let c = c.parse()?; Ok(c) }, ) } else { Ok(0) } } #[instrument(level = "trace")] pub fn get_chain_id_from_params( app: &Web3ProxyApp, params: &HashMap, ) -> anyhow::Result { params.get("chain_id").map_or_else( || Ok(app.config.chain_id), |c| { let c = c.parse()?; Ok(c) }, ) } #[instrument(level = "trace")] pub fn get_query_start_from_params( params: &HashMap, ) -> anyhow::Result { params.get("query_start").map_or_else( || { // no timestamp in params. set default let x = chrono::Utc::now() - chrono::Duration::days(30); Ok(x.naive_utc()) }, |x: &String| { // parse the given timestamp let x = x.parse::().context("parsing timestamp query param")?; // TODO: error code 401 let x = NaiveDateTime::from_timestamp_opt(x, 0).context("parsing timestamp query param")?; Ok(x) }, ) } #[instrument(level = "trace")] pub fn get_page_from_params(params: &HashMap) -> anyhow::Result { params.get("page").map_or_else::, _, _>( || { // no page in params. set default Ok(0) }, |x: &String| { // parse the given timestamp // TODO: error code 401 let x = x.parse().context("parsing page query from params")?; Ok(x) }, ) } #[instrument(level = "trace")] pub fn get_query_window_seconds_from_params( params: &HashMap, ) -> Result { params.get("query_window_seconds").map_or_else( || { // no page in params. set default Ok(0) }, |query_window_seconds: &String| { // parse the given timestamp // TODO: error code 401 query_window_seconds.parse::().map_err(|e| { FrontendErrorResponse::StatusCode( StatusCode::BAD_REQUEST, "Unable to parse rpc_key_id".to_string(), e.into(), ) }) }, ) } pub fn filter_query_window_seconds( params: &HashMap, response: &mut HashMap<&str, serde_json::Value>, q: Select, ) -> Result, FrontendErrorResponse> { let query_window_seconds = get_query_window_seconds_from_params(¶ms)?; if query_window_seconds == 0 { // TODO: order by more than this? // query_window_seconds is not set so we aggregate all records // TODO: i am pretty sure we need to filter by something return Ok(q); } // TODO: is there a better way to do this? how can we get "period_datetime" into this with types? // TODO: how can we get the first window to start at query_start_timestamp let expr = Expr::cust_with_values( "FLOOR(UNIX_TIMESTAMP(rpc_accounting.period_datetime) / ?) * ?", [query_window_seconds, query_window_seconds], ); response.insert( "query_window_seconds", serde_json::Value::Number(query_window_seconds.into()), ); let q = q .column_as(expr, "query_window_timestamp") .group_by(Expr::cust("query_window_timestamp")) // TODO: is there a simpler way to order_by? .order_by_asc(SimpleExpr::Custom("query_window_timestamp".to_string())); Ok(q) } pub enum StatResponse { Aggregate, Detailed, } pub async fn query_user_stats<'a>( app: &'a Web3ProxyApp, bearer: Option>>, params: &'a HashMap, stat_response_type: StatResponse, ) -> Result, FrontendErrorResponse> { let db_conn = app.db_conn().context("connecting to db")?; let redis_conn = app.redis_conn().await.context("connecting to redis")?; let mut response = HashMap::new(); let q = rpc_accounting::Entity::find() .select_only() .column_as( rpc_accounting::Column::FrontendRequests.sum(), "total_frontend_requests", ) .column_as( rpc_accounting::Column::BackendRequests.sum(), "total_backend_retries", ) .column_as( rpc_accounting::Column::CacheMisses.sum(), "total_cache_misses", ) .column_as(rpc_accounting::Column::CacheHits.sum(), "total_cache_hits") .column_as( rpc_accounting::Column::SumResponseBytes.sum(), "total_response_bytes", ) .column_as( // TODO: can we sum bools like this? rpc_accounting::Column::ErrorResponse.sum(), "total_error_responses", ) .column_as( rpc_accounting::Column::SumResponseMillis.sum(), "total_response_millis", ); let condition = Condition::all(); let q = if let StatResponse::Detailed = stat_response_type { // group by the columns that we use as keys in other places of the code q.column(rpc_accounting::Column::ErrorResponse) .group_by(rpc_accounting::Column::ErrorResponse) .column(rpc_accounting::Column::Method) .group_by(rpc_accounting::Column::Method) .column(rpc_accounting::Column::ArchiveRequest) .group_by(rpc_accounting::Column::ArchiveRequest) } else { q }; let q = filter_query_window_seconds(params, &mut response, q)?; // aggregate stats after query_start // TODO: minimum query_start of 90 days? let query_start = get_query_start_from_params(params)?; // TODO: if no query_start, don't add to response or condition response.insert( "query_start", serde_json::Value::Number(query_start.timestamp().into()), ); let condition = condition.add(rpc_accounting::Column::PeriodDatetime.gte(query_start)); // filter on chain_id let chain_id = get_chain_id_from_params(app, params)?; let (condition, q) = if chain_id == 0 { // fetch all the chains. don't filter or aggregate (condition, q) } else { let condition = condition.add(rpc_accounting::Column::ChainId.eq(chain_id)); response.insert("chain_id", serde_json::Value::Number(chain_id.into())); (condition, q) }; // filter on rpc_key_id // TODO: move getting the param and checking the bearer token into a helper function let (condition, q) = if let Some(rpc_key_id) = params.get("rpc_key_id") { let rpc_key_id = rpc_key_id.parse::().map_err(|e| { FrontendErrorResponse::StatusCode( StatusCode::BAD_REQUEST, "Unable to parse rpc_key_id".to_string(), e.into(), ) })?; if rpc_key_id == 0 { (condition, q) } else { // TODO: make sure that the bearer token is allowed to view this rpc_key_id let q = q.group_by(rpc_accounting::Column::RpcKeyId); let condition = condition.add(rpc_accounting::Column::RpcKeyId.eq(rpc_key_id)); response.insert("rpc_key_id", serde_json::Value::Number(rpc_key_id.into())); (condition, q) } } else { (condition, q) }; // get_user_id_from_params checks that the bearer is connected to this user_id let user_id = get_user_id_from_params(redis_conn, bearer, ¶ms).await?; let (condition, q) = if user_id == 0 { // 0 means everyone. don't filter on user (condition, q) } else { let q = q.left_join(rpc_key::Entity); let condition = condition.add(rpc_key::Column::UserId.eq(user_id)); response.insert("user_id", serde_json::Value::Number(user_id.into())); (condition, q) }; // now that all the conditions are set up. add them to the query let q = q.filter(condition); // TODO: trace log query here? i think sea orm has a useful log level for this // set up pagination let page = get_page_from_params(¶ms)?; response.insert("page", serde_json::to_value(page).expect("can't fail")); // TODO: page size from param with a max from the config let page_size = 200; response.insert( "page_size", serde_json::to_value(page_size).expect("can't fail"), ); // query the database let query_response = q .into_json() .paginate(&db_conn, page_size) .fetch_page(page) // TODO: timeouts here? or are they already set up on the connection .await?; // add the query_response to the json response response.insert("result", serde_json::Value::Array(query_response)); Ok(response) }