web3-proxy/web3_proxy/src/user_queries.rs

359 lines
12 KiB
Rust
Raw Normal View History

2022-11-04 07:32:09 +03:00
use crate::frontend::errors::FrontendErrorResponse;
use crate::{app::Web3ProxyApp, user_token::UserBearerToken};
2022-10-20 07:44:33 +03:00
use anyhow::Context;
2022-10-20 09:17:20 +03:00
use axum::{
headers::{authorization::Bearer, Authorization},
TypedHeader,
};
use chrono::NaiveDateTime;
2022-11-01 21:54:39 +03:00
use entities::{rpc_accounting, rpc_key};
2022-10-20 02:02:34 +03:00
use hashbrown::HashMap;
2022-11-04 07:32:09 +03:00
use http::StatusCode;
use migration::{Condition, Expr, SimpleExpr};
2022-10-20 09:17:20 +03:00
use redis_rate_limiter::{redis::AsyncCommands, RedisConnection};
2022-10-20 00:34:05 +03:00
use sea_orm::{
2022-11-04 07:32:09 +03:00
ColumnTrait, EntityTrait, PaginatorTrait, QueryFilter, QueryOrder, QuerySelect, Select,
2022-10-20 00:34:05 +03:00
};
2022-11-04 01:16:27 +03:00
use tracing::{instrument, warn};
2022-10-20 09:17:20 +03:00
/// get the attached address from redis for the given auth_token.
/// 0 means all users
2022-10-29 01:52:47 +03:00
#[instrument(level = "trace", skip(redis_conn))]
2022-11-04 06:40:43 +03:00
pub async fn get_user_id_from_params(
2022-10-20 09:17:20 +03:00
mut redis_conn: RedisConnection,
// this is a long type. should we strip it down?
bearer: Option<TypedHeader<Authorization<Bearer>>>,
params: &HashMap<String, String>,
) -> anyhow::Result<u64> {
match (bearer, params.get("user_id")) {
2022-10-31 23:05:58 +03:00
(Some(TypedHeader(Authorization(bearer))), Some(user_id)) => {
2022-10-20 09:17:20 +03:00
// check for the bearer cache key
2022-10-31 23:05:58 +03:00
let bearer_cache_key = UserBearerToken::try_from(bearer)?.to_string();
2022-10-20 09:17:20 +03:00
// get the user id that is attached to this bearer token
2022-11-01 22:12:57 +03:00
let bearer_user_id = redis_conn
2022-10-20 09:17:20 +03:00
.get::<_, u64>(bearer_cache_key)
.await
// TODO: this should be a 403
2022-11-01 22:12:57 +03:00
.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)
}
2022-10-20 09:17:20 +03:00
}
(_, None) => {
// they have a bearer token. we don't care about it on public pages
// 0 means all
Ok(0)
}
2022-11-04 01:16:27 +03:00
(None, Some(x)) => {
2022-10-20 09:17:20 +03:00
// 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
2022-11-04 01:16:27 +03:00
// Err(anyhow::anyhow!("permission denied"))
// TODO: make this a flag
warn!("allowing without auth during development!");
Ok(x.parse()?)
2022-10-20 09:17:20 +03:00
}
}
}
2022-10-27 03:12:42 +03:00
/// only allow rpc_key to be set if user_id is also set.
2022-10-20 09:17:20 +03:00
/// this will keep people from reading someone else's keys.
/// 0 means none.
2022-10-29 01:52:47 +03:00
#[instrument(level = "trace")]
2022-10-27 03:12:42 +03:00
pub fn get_rpc_key_id_from_params(
2022-10-20 09:54:45 +03:00
user_id: u64,
params: &HashMap<String, String>,
) -> anyhow::Result<u64> {
2022-10-20 09:17:20 +03:00
if user_id > 0 {
2022-10-27 03:12:42 +03:00
params.get("rpc_key_id").map_or_else(
2022-10-20 09:17:20 +03:00
|| Ok(0),
|c| {
let c = c.parse()?;
Ok(c)
},
)
} else {
Ok(0)
}
}
2022-10-29 01:52:47 +03:00
#[instrument(level = "trace")]
2022-10-26 00:10:05 +03:00
pub fn get_chain_id_from_params(
2022-10-20 09:17:20 +03:00
app: &Web3ProxyApp,
params: &HashMap<String, String>,
) -> anyhow::Result<u64> {
params.get("chain_id").map_or_else(
|| Ok(app.config.chain_id),
|c| {
let c = c.parse()?;
Ok(c)
},
)
}
2022-10-29 01:52:47 +03:00
#[instrument(level = "trace")]
2022-10-26 00:10:05 +03:00
pub fn get_query_start_from_params(
2022-10-20 09:17:20 +03:00
params: &HashMap<String, String>,
) -> anyhow::Result<chrono::NaiveDateTime> {
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::<i64>().context("parsing timestamp query param")?;
// TODO: error code 401
let x =
NaiveDateTime::from_timestamp_opt(x, 0).context("parsing timestamp query param")?;
Ok(x)
},
)
}
2022-10-29 01:52:47 +03:00
#[instrument(level = "trace")]
2022-10-26 00:10:05 +03:00
pub fn get_page_from_params(params: &HashMap<String, String>) -> anyhow::Result<u64> {
2022-10-25 06:41:59 +03:00
params.get("page").map_or_else::<anyhow::Result<u64>, _, _>(
|| {
// 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")?;
2022-10-20 09:17:20 +03:00
2022-10-25 06:41:59 +03:00
Ok(x)
},
)
2022-10-20 09:17:20 +03:00
}
2022-10-29 01:52:47 +03:00
#[instrument(level = "trace")]
2022-10-26 00:10:05 +03:00
pub fn get_query_window_seconds_from_params(
params: &HashMap<String, String>,
2022-11-04 07:32:09 +03:00
) -> Result<u64, FrontendErrorResponse> {
2022-10-20 09:17:20 +03:00
params.get("query_window_seconds").map_or_else(
|| {
// no page in params. set default
Ok(0)
},
2022-11-04 07:32:09 +03:00
|query_window_seconds: &String| {
2022-10-20 09:17:20 +03:00
// parse the given timestamp
// TODO: error code 401
2022-11-04 07:32:09 +03:00
query_window_seconds.parse::<u64>().map_err(|e| {
FrontendErrorResponse::StatusCode(
StatusCode::BAD_REQUEST,
"Unable to parse rpc_key_id".to_string(),
e.into(),
)
})
2022-10-20 09:17:20 +03:00
},
)
}
2022-11-04 07:32:09 +03:00
pub fn filter_query_window_seconds(
params: &HashMap<String, String>,
response: &mut HashMap<&str, serde_json::Value>,
q: Select<rpc_accounting::Entity>,
) -> Result<Select<rpc_accounting::Entity>, FrontendErrorResponse> {
2022-10-20 09:54:45 +03:00
let query_window_seconds = get_query_window_seconds_from_params(&params)?;
2022-10-20 02:02:34 +03:00
2022-11-04 07:32:09 +03:00
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);
}
2022-10-20 07:44:33 +03:00
2022-11-04 07:32:09 +03:00
// 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],
);
2022-10-20 02:02:34 +03:00
2022-10-20 09:17:20 +03:00
response.insert(
2022-11-04 07:32:09 +03:00
"query_window_seconds",
serde_json::Value::Number(query_window_seconds.into()),
2022-10-20 09:17:20 +03:00
);
2022-10-20 02:02:34 +03:00
2022-11-04 07:32:09 +03:00
let q = q
2022-11-04 22:01:17 +03:00
.column_as(expr, "query_window_timestamp")
.group_by(Expr::cust("query_window_timestamp"))
2022-11-04 07:32:09 +03:00
// TODO: is there a simpler way to order_by?
2022-11-04 22:01:17 +03:00
.order_by_asc(SimpleExpr::Custom("query_window_timestamp".to_string()));
2022-11-04 07:32:09 +03:00
Ok(q)
}
pub enum StatResponse {
Aggregate,
Detailed,
}
pub async fn query_user_stats<'a>(
app: &'a Web3ProxyApp,
bearer: Option<TypedHeader<Authorization<Bearer>>>,
params: &'a HashMap<String, String>,
stat_response_type: StatResponse,
) -> Result<HashMap<&'a str, serde_json::Value>, 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();
2022-10-20 02:02:34 +03:00
let q = rpc_accounting::Entity::find()
.select_only()
.column_as(
rpc_accounting::Column::FrontendRequests.sum(),
2022-11-04 07:40:39 +03:00
"total_frontend_requests",
2022-10-20 02:02:34 +03:00
)
2022-11-03 02:14:16 +03:00
.column_as(
rpc_accounting::Column::BackendRequests.sum(),
2022-11-04 07:32:09 +03:00
"total_backend_retries",
2022-11-03 02:14:16 +03:00
)
2022-10-20 02:02:34 +03:00
.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",
2022-11-04 07:32:09 +03:00
);
2022-10-20 07:44:33 +03:00
2022-11-04 07:32:09 +03:00
let condition = Condition::all();
2022-10-20 07:44:33 +03:00
2022-11-04 07:32:09 +03:00
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));
2022-10-20 07:44:33 +03:00
2022-11-04 07:32:09 +03:00
// 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
2022-10-20 07:44:33 +03:00
(condition, q)
} else {
let condition = condition.add(rpc_accounting::Column::ChainId.eq(chain_id));
2022-11-04 07:32:09 +03:00
response.insert("chain_id", serde_json::Value::Number(chain_id.into()));
2022-10-20 07:44:33 +03:00
(condition, q)
};
2022-11-04 07:32:09 +03:00
// 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::<u64>().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);
2022-11-04 01:16:27 +03:00
2022-11-04 07:32:09 +03:00
let condition = condition.add(rpc_accounting::Column::RpcKeyId.eq(rpc_key_id));
2022-11-04 01:16:27 +03:00
2022-11-04 07:32:09 +03:00
response.insert("rpc_key_id", serde_json::Value::Number(rpc_key_id.into()));
2022-11-04 01:16:27 +03:00
2022-11-04 07:32:09 +03:00
(condition, q)
}
2022-11-04 01:16:27 +03:00
} else {
(condition, q)
};
2022-11-04 07:32:09 +03:00
// 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, &params).await?;
2022-10-20 09:54:45 +03:00
let (condition, q) = if user_id == 0 {
2022-11-04 07:32:09 +03:00
// 0 means everyone. don't filter on user
2022-10-20 07:44:33 +03:00
(condition, q)
} else {
2022-11-04 07:32:09 +03:00
let q = q.left_join(rpc_key::Entity);
2022-10-27 03:12:42 +03:00
2022-11-01 21:54:39 +03:00
let condition = condition.add(rpc_key::Column::UserId.eq(user_id));
2022-10-27 03:12:42 +03:00
2022-11-04 07:32:09 +03:00
response.insert("user_id", serde_json::Value::Number(user_id.into()));
2022-10-20 09:54:45 +03:00
2022-10-20 07:44:33 +03:00
(condition, q)
};
2022-11-04 07:32:09 +03:00
// now that all the conditions are set up. add them to the query
let q = q.filter(condition);
2022-10-20 22:01:07 +03:00
2022-11-04 07:32:09 +03:00
// TODO: trace log query here? i think sea orm has a useful log level for this
2022-10-20 22:01:07 +03:00
2022-11-04 07:32:09 +03:00
// set up pagination
let page = get_page_from_params(&params)?;
response.insert("page", serde_json::to_value(page).expect("can't fail"));
2022-10-20 23:26:14 +03:00
2022-11-04 07:32:09 +03:00
// 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"),
);
2022-10-20 07:44:33 +03:00
2022-11-04 07:32:09 +03:00
// query the database
let query_response = q
2022-10-20 07:44:33 +03:00
.into_json()
2022-10-20 09:17:20 +03:00
.paginate(&db_conn, page_size)
2022-10-20 07:44:33 +03:00
.fetch_page(page)
2022-11-04 07:32:09 +03:00
// TODO: timeouts here? or are they already set up on the connection
2022-10-20 07:44:33 +03:00
.await?;
2022-11-04 07:32:09 +03:00
// add the query_response to the json response
response.insert("result", serde_json::Value::Array(query_response));
2022-10-20 07:44:33 +03:00
Ok(response)
}