1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
use std::fmt::Debug;
#[cfg(feature = "multi")]
use std::thread::sleep;
#[cfg(feature = "multi")]
use std::time::Duration;
use curl::easy::{Easy2, Handler};
#[cfg(feature = "multi")]
use curl::multi::Multi;
use tokio::sync::mpsc::{self, Sender};
use tokio::sync::oneshot;
use crate::error::Error;
/// CurlActor is responsible for performing
/// the contructed Easy2 object by passing
/// it into send_request
/// ```
/// use curl::easy::Easy2;
/// use async_curl::response_handler::ResponseHandler;
/// use async_curl::actor::CurlActor;
///
/// # #[tokio::main(flavor = "current_thread")]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>>{
/// let curl = CurlActor::new();
/// let mut easy2 = Easy2::new(ResponseHandler::new());
///
/// easy2.url("https://www.rust-lang.org").unwrap();
/// easy2.get(true).unwrap();
///
/// let response = curl.send_request(easy2).await.unwrap();
/// eprintln!("{:?}", response.get_ref());
///
/// Ok(())
/// # }
/// ```
///
/// Example for multiple request executed
/// at the same time.
///
/// ```
/// use async_curl::{actor::CurlActor, response_handler::ResponseHandler};
/// use curl::easy::Easy2;
///
/// # #[tokio::main(flavor = "current_thread")]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let curl = CurlActor::new();
/// let mut easy2 = Easy2::new(ResponseHandler::new());
/// easy2.url("https://www.rust-lang.org").unwrap();
/// easy2.get(true).unwrap();
///
/// let spawn1 = tokio::spawn(async move {
/// let response = curl.send_request(easy2).await;
/// let mut response = response.unwrap();
///
/// // Response body
/// eprintln!(
/// "Task 1 : {}",
/// String::from_utf8_lossy(&response.get_ref().to_owned().get_data())
/// );
/// // Response status code
/// let status_code = response.response_code().unwrap();
/// eprintln!("Task 1 : {}", status_code);
/// });
///
/// let curl = CurlActor::new();
/// let mut easy2 = Easy2::new(ResponseHandler::new());
/// easy2.url("https://www.rust-lang.org").unwrap();
/// easy2.get(true).unwrap();
///
/// let spawn2 = tokio::spawn(async move {
/// let response = curl.send_request(easy2).await;
/// let mut response = response.unwrap();
///
/// // Response body
/// eprintln!(
/// "Task 2 : {}",
/// String::from_utf8_lossy(&response.get_ref().to_owned().get_data())
/// );
/// // Response status code
/// let status_code = response.response_code().unwrap();
/// eprintln!("Task 2 : {}", status_code);
/// });
/// let (_, _) = tokio::join!(spawn1, spawn2);
///
/// Ok(())
/// # }
/// ```
///
#[derive(Clone)]
pub struct CurlActor<H>
where
H: Handler + Debug + Send + 'static,
{
request_sender: Sender<Request<H>>,
}
impl<H> Default for CurlActor<H>
where
H: Handler + Debug + Send + 'static,
{
fn default() -> Self {
Self::new()
}
}
impl<H> CurlActor<H>
where
H: Handler + Debug + Send + 'static,
{
/// This creates the new instance of CurlActor.
/// This spawns a new asynchronous task using tokio
/// so that it won't block. The perform_curl
/// function is executed when send_request is called
pub fn new() -> Self {
let (request_sender, mut request_receiver) = mpsc::channel::<Request<H>>(1);
tokio::spawn(async move {
while let Some(Request(easy2, oneshot_sender)) = request_receiver.recv().await {
if let Err(err) = tokio::task::spawn_blocking(move || {
let response = perform_curl(easy2);
if let Err(res) = oneshot_sender.send(response) {
eprintln!("Warning! The receiver has been dropped. {:?}", res);
}
})
.await
{
eprintln!("Error! Join Error. {:?}", err);
}
}
});
Self { request_sender }
}
/// This will trigger the request_reciever channel
/// at the spawned asynchronous task to call
/// perform_curl_multi to start communicating with
/// the target server.
pub async fn send_request(&self, easy2: Easy2<H>) -> Result<Easy2<H>, Error<H>>
where
H: Handler + Debug + Send + 'static,
{
let (oneshot_sender, oneshot_receiver) = oneshot::channel::<Result<Easy2<H>, Error<H>>>();
self.request_sender
.send(Request(easy2, oneshot_sender))
.await?;
oneshot_receiver.await?
}
}
#[derive(Debug)]
pub struct Request<H: Handler + Debug + Send + 'static>(
Easy2<H>,
oneshot::Sender<Result<Easy2<H>, Error<H>>>,
);
/// This will perform the sending of the built Easy2
/// request to the target server.
#[cfg(feature = "multi")]
fn perform_curl<H: Handler + Debug + Send + 'static>(
easy2: Easy2<H>,
) -> Result<Easy2<H>, Error<H>> {
let multi = Multi::new();
let handle = multi.add2(easy2)?;
while multi.perform()? != 0 {
let timeout_result = multi
.get_timeout()
.map(|d| d.unwrap_or_else(|| Duration::from_secs(2)));
let timeout = match timeout_result {
Ok(duration) => duration,
Err(multi_error) => {
if !multi_error.is_call_perform() {
return Err(Error::from(multi_error));
}
Duration::ZERO
}
};
if !timeout.is_zero() {
sleep(Duration::from_millis(200));
}
}
multi.remove2(handle).map_err(Error::from)
}
/// This will perform the sending of the built Easy2
/// request to the target server.
#[cfg(not(feature = "multi"))]
fn perform_curl<H: Handler + Debug + Send + 'static>(
easy2: Easy2<H>,
) -> Result<Easy2<H>, Error<H>> {
easy2.perform().map_err(Error::from)?;
Ok(easy2)
}
#[cfg(test)]
mod test {
use http::StatusCode;
use wiremock::matchers::method;
use wiremock::matchers::path;
use wiremock::Mock;
use wiremock::MockServer;
use wiremock::ResponseTemplate;
use crate::actor::CurlActor;
use crate::actor::Easy2;
use crate::response_handler::ResponseHandler;
use std::convert::TryFrom;
async fn start_mock_server(
node: &str,
mock_body: String,
mock_status_code: StatusCode,
) -> MockServer {
let server = MockServer::start().await;
Mock::given(method("GET"))
.and(path(node))
.respond_with(ResponseTemplate::new(mock_status_code).set_body_string(mock_body))
.mount(&server)
.await;
server
}
#[tokio::test]
#[cfg(not(feature = "multi"))]
async fn test_async_requests() {
const MOCK_BODY_RESPONSE: &str = r#"{"token":"12345"}"#;
const MOCK_STATUS_CODE: StatusCode = StatusCode::OK;
let server = start_mock_server(
"/async-test",
MOCK_BODY_RESPONSE.to_string(),
StatusCode::OK,
)
.await;
let url = format!("{}{}", server.uri(), "/async-test");
let curl = CurlActor::new();
let mut easy2 = Easy2::new(ResponseHandler::new());
easy2.url(url.as_str()).unwrap();
easy2.get(true).unwrap();
let spawn1 = tokio::spawn(async move {
let result = curl.send_request(easy2).await;
let mut result = result.unwrap();
// Test response body
assert_eq!(
String::from_utf8_lossy(&result.get_ref().to_owned().get_data()),
MOCK_BODY_RESPONSE.to_string()
);
// Test response status code
let status_code = result.response_code().unwrap();
assert_eq!(
StatusCode::from_u16(u16::try_from(status_code).unwrap()).unwrap(),
MOCK_STATUS_CODE
);
});
let curl = CurlActor::new();
let mut easy2 = Easy2::new(ResponseHandler::new());
easy2.url(url.as_str()).unwrap();
easy2.get(true).unwrap();
let spawn2 = tokio::spawn(async move {
let result = curl.send_request(easy2).await;
let mut result = result.unwrap();
// Test response body
assert_eq!(
String::from_utf8_lossy(&result.get_ref().to_owned().get_data()),
MOCK_BODY_RESPONSE.to_string()
);
// Test response status code
let status_code = result.response_code().unwrap();
assert_eq!(
StatusCode::from_u16(u16::try_from(status_code).unwrap()).unwrap(),
MOCK_STATUS_CODE
);
});
let (_, _) = tokio::join!(spawn1, spawn2);
}
#[tokio::test]
#[cfg(feature = "multi")]
async fn test_async_requests_multi() {
const MOCK_BODY_RESPONSE: &str = r#"{"token":"12345"}"#;
const MOCK_STATUS_CODE: StatusCode = StatusCode::OK;
let server = start_mock_server(
"/async-test",
MOCK_BODY_RESPONSE.to_string(),
StatusCode::OK,
)
.await;
let url = format!("{}{}", server.uri(), "/async-test");
let curl = CurlActor::new();
let mut easy2 = Easy2::new(ResponseHandler::new());
easy2.url(url.as_str()).unwrap();
easy2.get(true).unwrap();
let spawn1 = tokio::spawn(async move {
let result = curl.send_request(easy2).await;
let mut result = result.unwrap();
// Test response body
assert_eq!(
String::from_utf8_lossy(&result.get_ref().to_owned().get_data()),
MOCK_BODY_RESPONSE.to_string()
);
// Test response status code
let status_code = result.response_code().unwrap();
assert_eq!(
StatusCode::from_u16(u16::try_from(status_code).unwrap()).unwrap(),
MOCK_STATUS_CODE
);
});
let curl = CurlActor::new();
let mut easy2 = Easy2::new(ResponseHandler::new());
easy2.url(url.as_str()).unwrap();
easy2.get(true).unwrap();
let spawn2 = tokio::spawn(async move {
let result = curl.send_request(easy2).await;
let mut result = result.unwrap();
// Test response body
assert_eq!(
String::from_utf8_lossy(&result.get_ref().to_owned().get_data()),
MOCK_BODY_RESPONSE.to_string()
);
// Test response status code
let status_code = result.response_code().unwrap();
assert_eq!(
StatusCode::from_u16(u16::try_from(status_code).unwrap()).unwrap(),
MOCK_STATUS_CODE
);
});
let (_, _) = tokio::join!(spawn1, spawn2);
}
}