Skip to content

Use tokio sleep instead of blocking thread when using reqwest client #689

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.

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
merged 2 commits into from
Jul 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ futures-util = { version = "0.3.31", default-features = false, features = ["io"]

[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
jsonwebtoken = { version = "9.3.1", default-features = false }
tokio = { version = "1.38", optional = true, features = ["time"] }

[target.'cfg(target_arch = "wasm32")'.dependencies]
uuid = { version = "1.17.0", default-features = false, features = ["v4", "js"] }
Expand All @@ -42,7 +43,7 @@ wasm-bindgen-futures = "0.4"

[features]
default = ["reqwest"]
reqwest = ["dep:reqwest", "pin-project-lite", "bytes"]
reqwest = ["dep:reqwest", "dep:tokio", "pin-project-lite", "bytes"]
futures-unsend = []

[dev-dependencies]
Expand Down
8 changes: 6 additions & 2 deletions src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use crate::{
search::*,
task_info::TaskInfo,
tasks::{Task, TasksCancelQuery, TasksDeleteQuery, TasksResults, TasksSearchQuery},
utils::async_sleep,
utils::SleepBackend,
DefaultHttpClient,
};

Expand Down Expand Up @@ -933,7 +933,7 @@ impl<Http: HttpClient> Client<Http> {
}
Task::Enqueued { .. } | Task::Processing { .. } => {
elapsed_time += interval;
async_sleep(interval).await;
self.sleep_backend().sleep(interval).await;
}
},
Err(error) => return Err(error),
Expand Down Expand Up @@ -1144,6 +1144,10 @@ impl<Http: HttpClient> Client<Http> {

crate::tenant_tokens::generate_tenant_token(api_key_uid, search_rules, api_key, expires_at)
}

fn sleep_backend(&self) -> SleepBackend {
SleepBackend::infer(self.http_client.is_tokio())
}
}

#[derive(Debug, Clone, Deserialize)]
Expand Down
4 changes: 4 additions & 0 deletions src/request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ pub trait HttpClient: Clone + Send + Sync {
content_type: &str,
expected_status_code: u16,
) -> Result<Output, Error>;

fn is_tokio(&self) -> bool {
false
}
}

pub fn parse_response<Output: DeserializeOwned>(
Expand Down
4 changes: 4 additions & 0 deletions src/reqwest.rs
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ impl HttpClient for ReqwestClient {

parse_response(status, expected_status_code, &body, url.to_string())
}

fn is_tokio(&self) -> bool {
true
}
}

fn verb<Q, B>(method: &Method<Q, B>) -> reqwest::Method {
Expand Down
109 changes: 83 additions & 26 deletions src/utils.rs
Original file line number Diff line number Diff line change
@@ -1,44 +1,101 @@
use std::time::Duration;

#[cfg(not(target_arch = "wasm32"))]
pub(crate) async fn async_sleep(interval: Duration) {
let (sender, receiver) = futures_channel::oneshot::channel::<()>();
std::thread::spawn(move || {
std::thread::sleep(interval);
let _ = sender.send(());
});
let _ = receiver.await;
#[derive(Debug, Copy, Clone)]
pub(crate) enum SleepBackend {
#[cfg(all(not(target_arch = "wasm32"), feature = "reqwest"))]
Tokio,
#[cfg(not(target_arch = "wasm32"))]
Thread,
#[cfg(target_arch = "wasm32")]
Javascript,
}

#[cfg(target_arch = "wasm32")]
pub(crate) async fn async_sleep(interval: Duration) {
use std::convert::TryInto;
use wasm_bindgen_futures::JsFuture;

JsFuture::from(web_sys::js_sys::Promise::new(&mut |yes, _| {
web_sys::window()
.unwrap()
.set_timeout_with_callback_and_timeout_and_arguments_0(
&yes,
interval.as_millis().try_into().unwrap(),
)
.unwrap();
}))
.await
.unwrap();
impl SleepBackend {
pub(crate) fn infer(is_tokio: bool) -> Self {
#[cfg(all(not(target_arch = "wasm32"), feature = "reqwest"))]
if is_tokio {
return Self::Tokio;
}
#[cfg(any(target_arch = "wasm32", not(feature = "reqwest")))]
let _ = is_tokio;

#[cfg(not(target_arch = "wasm32"))]
return Self::Thread;

#[cfg(target_arch = "wasm32")]
return Self::Javascript;
}

pub(crate) async fn sleep(self, interval: Duration) {
match self {
#[cfg(all(not(target_arch = "wasm32"), feature = "reqwest"))]
Self::Tokio => {
tokio::time::sleep(interval).await;
}
#[cfg(not(target_arch = "wasm32"))]
Self::Thread => {
let (sender, receiver) = futures_channel::oneshot::channel::<()>();
std::thread::spawn(move || {
std::thread::sleep(interval);
let _ = sender.send(());
});
let _ = receiver.await;
}
#[cfg(target_arch = "wasm32")]
Self::Javascript => {
use std::convert::TryInto;
use wasm_bindgen_futures::JsFuture;

JsFuture::from(web_sys::js_sys::Promise::new(&mut |yes, _| {
web_sys::window()
.unwrap()
.set_timeout_with_callback_and_timeout_and_arguments_0(
&yes,
interval.as_millis().try_into().unwrap(),
)
.unwrap();
}))
.await
.unwrap();
}
}
}
}

#[cfg(test)]
mod test {
use super::*;
use meilisearch_test_macro::meilisearch_test;

#[cfg(all(not(target_arch = "wasm32"), feature = "reqwest"))]
#[meilisearch_test]
async fn sleep_tokio() {
let sleep_duration = Duration::from_millis(10);
let now = std::time::Instant::now();

SleepBackend::Tokio.sleep(sleep_duration).await;

assert!(now.elapsed() >= sleep_duration);
}

#[cfg(not(target_arch = "wasm32"))]
#[meilisearch_test]
async fn sleep_thread() {
let sleep_duration = Duration::from_millis(10);
let now = std::time::Instant::now();

SleepBackend::Thread.sleep(sleep_duration).await;

assert!(now.elapsed() >= sleep_duration);
}

#[cfg(target_arch = "wasm32")]
#[meilisearch_test]
async fn test_async_sleep() {
async fn sleep_javascript() {
let sleep_duration = Duration::from_millis(10);
let now = std::time::Instant::now();

async_sleep(sleep_duration).await;
SleepBackend::Javascript.sleep(sleep_duration).await;

assert!(now.elapsed() >= sleep_duration);
}
Expand Down