Skip to content

Split API search route validation #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yvette-carlisle merged 1 commit into from
Jun 29, 2026
Merged

Split API search route validation #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 21 additions & 118 deletions apps/elf-api/src/routes/search.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
mod validation;

use crate::routes::{
self, ApiError, AppState, ErrorBody, HeaderMap, Json, JsonRejection, MAX_CANDIDATE_K,
MAX_NOTE_IDS_PER_DETAILS, MAX_QUERY_CHARS, MAX_TOP_K, Path, Query, QueryRejection,
RequestContext, SearchCreateRequest, SearchCreateResponseV2, SearchDetailsBody,
self, ApiError, AppState, ErrorBody, HeaderMap, Json, JsonRejection, Path, Query,
QueryRejection, RequestContext, SearchCreateRequest, SearchCreateResponseV2, SearchDetailsBody,
SearchDetailsRequest, SearchDetailsResponseV2, SearchIndexResponseV2, SearchMode,
SearchRequest, SearchResponse, SearchSessionGetQuery, SearchSessionGetRequest,
SearchTimelineQuery, SearchTimelineRequest, SearchTimelineResponseV2, State, StatusCode, Uuid,
SearchTimelineQuery, SearchTimelineRequest, SearchTimelineResponseV2, State, Uuid,
};

#[utoipa::path(
Expand All @@ -28,49 +29,13 @@ pub(super) async fn searches_create(
) -> Result<Json<SearchCreateResponseV2>, ApiError> {
let ctx = RequestContext::from_headers(&headers)?;
let read_profile = routes::required_read_profile(&headers)?;
let Json(payload) = payload.map_err(|err| {
tracing::warn!(error = %err, "Invalid request payload.");

routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Invalid request payload.",
None,
)
})?;
let Json(payload) = payload.map_err(validation::invalid_json_payload)?;

if payload.query.chars().count() > MAX_QUERY_CHARS {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Query is too long.",
Some(vec!["$.query".to_string()]),
));
}
if payload.top_k.unwrap_or(state.service.cfg.memory.top_k) > MAX_TOP_K {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"top_k is too large.",
Some(vec!["$.top_k".to_string()]),
));
}
if payload.candidate_k.unwrap_or(state.service.cfg.memory.candidate_k) > MAX_CANDIDATE_K {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"candidate_k is too large.",
Some(vec!["$.candidate_k".to_string()]),
));
}
if payload.ranking.is_some() {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Ranking overrides are only supported on admin endpoints.".to_string(),
None,
));
}
validation::validate_search_create_payload(
&payload,
state.service.cfg.memory.top_k,
state.service.cfg.memory.candidate_k,
)?;

let mode = payload.mode;
let token_id =
Expand Down Expand Up @@ -147,16 +112,7 @@ pub(super) async fn searches_get(
query: Result<Query<SearchSessionGetQuery>, QueryRejection>,
) -> Result<Json<SearchIndexResponseV2>, ApiError> {
let ctx = RequestContext::from_headers(&headers)?;
let Query(query) = query.map_err(|err| {
tracing::warn!(error = %err, "Invalid query parameters.");

routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Invalid query parameters.".to_string(),
None,
)
})?;
let Query(query) = query.map_err(validation::invalid_query_parameters)?;
let response = state
.service
.search_session_get(SearchSessionGetRequest {
Expand Down Expand Up @@ -211,16 +167,7 @@ pub(super) async fn searches_timeline(
query: Result<Query<SearchTimelineQuery>, QueryRejection>,
) -> Result<Json<SearchTimelineResponseV2>, ApiError> {
let ctx = RequestContext::from_headers(&headers)?;
let Query(query) = query.map_err(|err| {
tracing::warn!(error = %err, "Invalid query parameters.");

routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Invalid query parameters.".to_string(),
None,
)
})?;
let Query(query) = query.map_err(validation::invalid_query_parameters)?;
let response = state
.service
.search_timeline(SearchTimelineRequest {
Expand Down Expand Up @@ -262,25 +209,9 @@ pub(super) async fn searches_notes(
payload: Result<Json<SearchDetailsBody>, JsonRejection>,
) -> Result<Json<SearchDetailsResponseV2>, ApiError> {
let ctx = RequestContext::from_headers(&headers)?;
let Json(payload) = payload.map_err(|err| {
tracing::warn!(error = %err, "Invalid request payload.");

routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Invalid request payload.",
None,
)
})?;
let Json(payload) = payload.map_err(validation::invalid_json_payload)?;

if payload.note_ids.len() > MAX_NOTE_IDS_PER_DETAILS {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"note_ids list is too large.",
Some(vec!["$.note_ids".to_string()]),
));
}
validation::validate_search_details_payload(&payload)?;

let response = state
.service
Expand Down Expand Up @@ -323,41 +254,13 @@ pub(super) async fn searches_raw(
) -> Result<Json<SearchResponse>, ApiError> {
let ctx = RequestContext::from_headers(&headers)?;
let read_profile = routes::required_read_profile(&headers)?;
let Json(payload) = payload.map_err(|err| {
tracing::warn!(error = %err, "Invalid request payload.");

routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Invalid request payload.",
None,
)
})?;
let Json(payload) = payload.map_err(validation::invalid_json_payload)?;

if payload.query.chars().count() > MAX_QUERY_CHARS {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Query is too long.",
Some(vec!["$.query".to_string()]),
));
}
if payload.top_k.unwrap_or(state.service.cfg.memory.top_k) > MAX_TOP_K {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"top_k is too large.",
Some(vec!["$.top_k".to_string()]),
));
}
if payload.candidate_k.unwrap_or(state.service.cfg.memory.candidate_k) > MAX_CANDIDATE_K {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"candidate_k is too large.",
Some(vec!["$.candidate_k".to_string()]),
));
}
validation::validate_search_raw_payload(
&payload,
state.service.cfg.memory.top_k,
state.service.cfg.memory.candidate_k,
)?;

let request = SearchRequest {
tenant_id: ctx.tenant_id,
Expand Down
108 changes: 108 additions & 0 deletions apps/elf-api/src/routes/search/validation.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
use crate::routes::{
self, ApiError, JsonRejection, MAX_CANDIDATE_K, MAX_NOTE_IDS_PER_DETAILS, MAX_QUERY_CHARS,
MAX_TOP_K, QueryRejection, SearchCreateRequest, SearchDetailsBody, StatusCode,
};

pub(super) fn invalid_json_payload(err: JsonRejection) -> ApiError {
tracing::warn!(error = %err, "Invalid request payload.");

routes::json_error(StatusCode::BAD_REQUEST, "INVALID_REQUEST", "Invalid request payload.", None)
}

pub(super) fn invalid_query_parameters(err: QueryRejection) -> ApiError {
tracing::warn!(error = %err, "Invalid query parameters.");

routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Invalid query parameters.",
None,
)
}

pub(super) fn validate_search_create_payload(
payload: &SearchCreateRequest,
default_top_k: u32,
default_candidate_k: u32,
) -> Result<(), ApiError> {
validate_search_limits(
payload.query.as_str(),
payload.top_k,
payload.candidate_k,
default_top_k,
default_candidate_k,
)?;

if payload.ranking.is_some() {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Ranking overrides are only supported on admin endpoints.",
None,
));
}

Ok(())
}

pub(super) fn validate_search_raw_payload(
payload: &SearchCreateRequest,
default_top_k: u32,
default_candidate_k: u32,
) -> Result<(), ApiError> {
validate_search_limits(
payload.query.as_str(),
payload.top_k,
payload.candidate_k,
default_top_k,
default_candidate_k,
)
}

pub(super) fn validate_search_details_payload(payload: &SearchDetailsBody) -> Result<(), ApiError> {
if payload.note_ids.len() > MAX_NOTE_IDS_PER_DETAILS {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"note_ids list is too large.",
Some(vec!["$.note_ids".to_string()]),
));
}

Ok(())
}

fn validate_search_limits(
query: &str,
top_k: Option<u32>,
candidate_k: Option<u32>,
default_top_k: u32,
default_candidate_k: u32,
) -> Result<(), ApiError> {
if query.chars().count() > MAX_QUERY_CHARS {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"Query is too long.",
Some(vec!["$.query".to_string()]),
));
}
if top_k.unwrap_or(default_top_k) > MAX_TOP_K {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"top_k is too large.",
Some(vec!["$.top_k".to_string()]),
));
}
if candidate_k.unwrap_or(default_candidate_k) > MAX_CANDIDATE_K {
return Err(routes::json_error(
StatusCode::BAD_REQUEST,
"INVALID_REQUEST",
"candidate_k is too large.",
Some(vec!["$.candidate_k".to_string()]),
));
}

Ok(())
}