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
use std::rc::Rc;
use actix_service::Service;
use actix_web::body::{EitherBody, MessageBody};
use actix_web::dev::{ServiceRequest, ServiceResponse};
use actix_web::http::header::HeaderMap;
use actix_web::http::uri::PathAndQuery;
use actix_web::http::{header, Method};
use actix_web::{Error, HttpResponse};
use futures_util::future::LocalBoxFuture;
use futures_util::TryFutureExt;
use log::trace;
use reqwest::Client;
use url::Url;
use crate::error::PrerenderError;
use crate::{IGNORED_EXTENSIONS, USER_AGENTS};
#[derive(Debug, Clone)]
pub struct Inner {
pub(crate) prerender_service_url: Url,
pub(crate) inner_client: Client,
pub(crate) prerender_token: Option<String>,
}
pub(crate) fn prerender_url() -> Url {
Url::parse("https://service.prerender.io").unwrap()
}
pub(crate) fn should_prerender(req: &ServiceRequest) -> bool {
let request_headers = req.headers();
let mut is_crawler = false;
if ![Method::GET, Method::HEAD].contains(req.method()) {
return false;
}
let req_ua_lowercase = if let Some(user_agent) = request_headers.get(header::USER_AGENT) {
let user_agent = user_agent.to_str().map(str::to_lowercase);
if let Ok(ua) = user_agent {
ua
} else {
return false;
}
} else {
return false;
};
if USER_AGENTS
.iter()
.any(|crawler_ua| req_ua_lowercase.contains(&*crawler_ua.to_lowercase()))
{
is_crawler = true;
}
let is_ignored_extension_url = req.uri().path_and_query().map_or_else(
|| false,
|path_query| IGNORED_EXTENSIONS.iter().any(|ext| path_query.as_str().contains(ext)),
);
if is_ignored_extension_url {
return false;
}
is_crawler
}
#[derive(Debug)]
pub struct PrerenderMiddleware<S> {
pub(crate) service: S,
pub(crate) inner: Rc<Inner>,
}
impl<S> PrerenderMiddleware<S> {
pub fn prepare_build_api_url(service_url: &Url, req: &ServiceRequest) -> String {
let req_uri = req.uri();
let req_headers = req.headers();
let host = req
.uri()
.host()
.or_else(|| req_headers.get("X-Forwarded-Host").and_then(|hdr| hdr.to_str().ok()))
.or_else(|| req_headers.get(header::HOST).and_then(|hdr| hdr.to_str().ok()))
.unwrap();
let scheme = req.uri().scheme_str().unwrap_or("http");
let url_path_query = req_uri.path_and_query().map(PathAndQuery::as_str).unwrap();
format!("{}render?url={}://{}{}", service_url, scheme, host, url_path_query)
}
pub async fn get_rendered_response(inner: &Inner, req: ServiceRequest) -> Result<ServiceResponse, PrerenderError> {
let mut prerender_request_headers = HeaderMap::new();
let forward_headers = true;
if forward_headers {
prerender_request_headers = req.headers().clone();
prerender_request_headers.remove(header::HOST);
}
prerender_request_headers.append(header::ACCEPT_ENCODING, "gzip".parse().unwrap());
if let Some(token) = &inner.prerender_token {
prerender_request_headers.append("X-Prerender-Token".parse().unwrap(), token.parse().unwrap());
}
let url_to_request = Self::prepare_build_api_url(&inner.prerender_service_url, &req);
trace!("sending request to: {}", &url_to_request);
let prerender_response = inner
.inner_client
.get(url_to_request)
.send()
.and_then(|resp| resp.bytes())
.await?;
let http_response = HttpResponse::Ok().content_type("text/html").body(prerender_response);
Ok(req.into_response(http_response))
}
}
impl<S, B> Service<ServiceRequest> for PrerenderMiddleware<S>
where
S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
S::Future: 'static,
B: MessageBody,
{
type Response = ServiceResponse<EitherBody<B>>;
type Error = Error;
type Future = LocalBoxFuture<'static, Result<ServiceResponse<EitherBody<B>>, Error>>;
actix_service::forward_ready!(service);
fn call(&self, req: ServiceRequest) -> Self::Future {
if !should_prerender(&req) {
let fut = self.service.call(req);
return Box::pin(async move { fut.await.map(ServiceResponse::map_into_left_body) });
}
let inner = Rc::clone(&self.inner);
Box::pin(async move {
Self::get_rendered_response(&inner, req)
.await
.map(ServiceResponse::map_into_right_body)
.map_err(Into::into)
})
}
}
#[cfg(test)]
mod tests {
use crate::builder::Prerender;
use actix_web::http::header;
use actix_web::middleware::Compat;
use actix_web::test::TestRequest;
use actix_web::App;
use url::Url;
use crate::middleware::{prerender_url, should_prerender, PrerenderMiddleware};
fn _init_logger() {
let _ = env_logger::builder().is_test(true).try_init();
}
#[actix_web::test]
async fn compat_compat() {
App::new().wrap(Compat::new(Prerender::build().use_prerender_io("".to_string())));
}
#[actix_web::test]
async fn test_human_valid_resource() {
let req = TestRequest::get()
.insert_header((
header::USER_AGENT,
"Mozilla/5.0 (X11; Linux x86_64; rv:62.0) Gecko/20100101 Firefox/62.0",
))
.uri("http://yourserver.com/clothes/tshirts?query=xl")
.to_srv_request();
assert!(!should_prerender(&req));
}
#[actix_web::test]
async fn test_crawler_valid_resource() {
let req = TestRequest::get()
.insert_header((
header::USER_AGENT,
"Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)",
))
.uri("http://yourserver.com/clothes/tshirts?query=xl")
.to_srv_request();
assert!(should_prerender(&req));
}
#[actix_web::test]
async fn test_crawler_ignored_resource() {
let req = TestRequest::get()
.insert_header((
header::USER_AGENT,
"LinkedInBot/1.0 (compatible; Mozilla/5.0; Jakarta Commons-HttpClient/3.1 +http://www.linkedin.com)",
))
.uri("http://yourserver.com/clothes/tshirts/blue.jpg")
.to_srv_request();
let render = should_prerender(&req);
assert!(!render);
}
#[actix_web::test]
async fn test_crawler_wrong_http_method() {
let req = TestRequest::post()
.insert_header((
header::USER_AGENT,
"LinkedInBot/1.0 (compatible; Mozilla/5.0; Jakarta Commons-HttpClient/3.1 +http://www.linkedin.com)",
))
.uri("http://yourserver.com/clothes/tshirts/red-dotted")
.to_srv_request();
let render = should_prerender(&req);
assert!(!render);
}
fn _create_middleware() -> Prerender {
Prerender::build().use_prerender_io("".to_string())
}
#[actix_web::test]
async fn test_redirect_url() {
let req_url = "http://yourserver.com/clothes/tshirts/red-dotted";
let req = TestRequest::post()
.insert_header((
header::USER_AGENT,
"LinkedInBot/1.0 (compatible; Mozilla/5.0; Jakarta Commons-HttpClient/3.1 +http://www.linkedin.com)",
))
.uri(req_url)
.to_srv_request();
assert_eq!(
PrerenderMiddleware::<()>::prepare_build_api_url(&prerender_url(), &req),
format!("{}render?url={}", prerender_url(), req_url)
);
assert_eq!(
PrerenderMiddleware::<()>::prepare_build_api_url(&Url::parse("http://localhost:5000").unwrap(), &req),
format!("http://localhost:5000/render?url={}", req_url)
);
}
}