searchengines-web/MeiliSearch
searchengines-web/MeiliSearch
1
0
Fork 0
mirror of https://github.com/meilisearch/MeiliSearch synced 2025-06-15 20:42:24 +02:00
Code Issues Releases Wiki Activity

chore: Fix English grammar in SearchQueue's comments

Browse Source 
No functional changes!

Signed-off-by: Martin Tzvetanov Grigorov <mgrigorov@apache.org>
This commit is contained in:
Martin Tzvetanov Grigorov 2025-06-06 13:49:29 +03:00 committed by Tamo
parent 1d02efeab9
commit 2ec9664878
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
crates/meilisearch/src/search_queue.rs
View File

@ -1,5 +1,5 @@
//! This file implements a queue of searches to process and the ability to control how many searches can be run in parallel. //! This file implements a queue of searches to process and the ability to control how many searches can be run in parallel.
//! We need this because we don't want to process more search requests than we have cores. //! We need this because we don't want to process more search requests than the available CPU cores.
//! That slows down everything and consumes RAM for no reason. //! That slows down everything and consumes RAM for no reason.
//! The steps to do a search are to get the `SearchQueue` data structure and try to get a search permit. //! The steps to do a search are to get the `SearchQueue` data structure and try to get a search permit.
//! This can fail if the queue is full, and we need to drop your search request to register a new one. //! This can fail if the queue is full, and we need to drop your search request to register a new one.
@ -8,7 +8,7 @@
//! //!
//! In order to do a search request you should try to get a search permit. //! In order to do a search request you should try to get a search permit.
//! Retrieve the `SearchQueue` structure from actix-web (`search_queue: Data<SearchQueue>`) //! Retrieve the `SearchQueue` structure from actix-web (`search_queue: Data<SearchQueue>`)
//! and right before processing the search, calls the `SearchQueue::try_get_search_permit` method: `search_queue.try_get_search_permit().await?;` //! and right before processing the search, call the `SearchQueue::try_get_search_permit` method: `search_queue.try_get_search_permit().await?;`
//! //!
//! What is going to happen at this point is that you're going to send a oneshot::Sender over an async mpsc channel. //! What is going to happen at this point is that you're going to send a oneshot::Sender over an async mpsc channel.
//! Then, the queue/scheduler is going to either: //! Then, the queue/scheduler is going to either:
@ -121,12 +121,12 @@ impl SearchQueue {
let mut queue: Vec<oneshot::Sender<Permit>> = Default::default(); let mut queue: Vec<oneshot::Sender<Permit>> = Default::default();
let mut rng: StdRng = StdRng::from_entropy(); let mut rng: StdRng = StdRng::from_entropy();
let mut searches_running: usize = 0; let mut searches_running: usize = 0;
// By having a capacity of parallelism we ensures that every time a search finish it can release its RAM asap // By having a capacity of parallelism we ensure that every time a search finish it can release its RAM asap
let (sender, mut search_finished) = mpsc::channel(parallelism.into()); let (sender, mut search_finished) = mpsc::channel(parallelism.into());
loop { loop {
tokio::select! { tokio::select! {
// biased select because we wants to free up space before trying to register new tasks // biased select because we want to free up space before trying to register new tasks
biased; biased;
_ = search_finished.recv() => { _ = search_finished.recv() => {
searches_running = searches_running.saturating_sub(1); searches_running = searches_running.saturating_sub(1);
@ -148,11 +148,11 @@ impl SearchQueue {
if searches_running < usize::from(parallelism) && queue.is_empty() { if searches_running < usize::from(parallelism) && queue.is_empty() {
searches_running += 1; searches_running += 1;
// if the search requests die it's not a hard error on our side // if the search requests die, it's not a hard error on our side
let _ = search_request.send(Permit { sender: sender.clone() }); let _ = search_request.send(Permit { sender: sender.clone() });
continue; continue;
} else if capacity == 0 { } else if capacity == 0 {
// in the very specific case where we have a capacity of zero // in the very specific case where we have a capacity of zero,
// we must refuse the request straight away without going through // we must refuse the request straight away without going through
// the queue stuff. // the queue stuff.
drop(search_request); drop(search_request);
@ -183,7 +183,7 @@ impl SearchQueue {
.map_err(|_| MeilisearchHttpError::TooManySearchRequests(self.capacity))?; .map_err(|_| MeilisearchHttpError::TooManySearchRequests(self.capacity))?;
// If we've been for more than one minute to get a search permit, it's better to simply // If we've been for more than one minute to get a search permit, it's better to simply
// abort the search request than spending time processing something were the client // abort the search request than spending time processing something where the client
// most certainly exited or got a timeout a long time ago. // most certainly exited or got a timeout a long time ago.
// We may find a better solution in https://github.com/actix/actix-web/issues/3462. // We may find a better solution in https://github.com/actix/actix-web/issues/3462.
if now.elapsed() > self.time_to_abort { if now.elapsed() > self.time_to_abort {