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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
#![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
#![warn(missing_docs)]
#![allow(deprecated)]
#![allow(clippy::type_complexity)]
use std::borrow::Cow;
use std::pin::Pin;
use std::sync::Arc;
use actix_web::dev::{Service, ServiceRequest, ServiceResponse, Transform};
use actix_web::http::StatusCode;
use actix_web::Error;
use futures_util::future::{ok, Future, Ready};
use futures_util::FutureExt;
use sentry_core::protocol::{self, ClientSdkPackage, Event, Request};
use sentry_core::{Hub, SentryFutureExt};
pub struct SentryBuilder {
middleware: Sentry,
}
impl SentryBuilder {
pub fn finish(self) -> Sentry {
self.middleware
}
#[must_use]
pub fn start_transaction(mut self, start_transaction: bool) -> Self {
self.middleware.start_transaction = start_transaction;
self
}
#[must_use]
pub fn with_hub(mut self, hub: Arc<Hub>) -> Self {
self.middleware.hub = Some(hub);
self
}
#[must_use]
pub fn with_default_hub(mut self) -> Self {
self.middleware.hub = None;
self
}
#[must_use]
pub fn emit_header(mut self, val: bool) -> Self {
self.middleware.emit_header = val;
self
}
#[must_use]
pub fn capture_server_errors(mut self, val: bool) -> Self {
self.middleware.capture_server_errors = val;
self
}
}
#[derive(Clone)]
pub struct Sentry {
hub: Option<Arc<Hub>>,
emit_header: bool,
capture_server_errors: bool,
start_transaction: bool,
}
impl Sentry {
pub fn new() -> Self {
Sentry {
hub: None,
emit_header: false,
capture_server_errors: true,
start_transaction: false,
}
}
pub fn with_transaction() -> Sentry {
Sentry {
start_transaction: true,
..Sentry::default()
}
}
pub fn builder() -> SentryBuilder {
Sentry::new().into_builder()
}
pub fn into_builder(self) -> SentryBuilder {
SentryBuilder { middleware: self }
}
}
impl Default for Sentry {
fn default() -> Self {
Sentry::new()
}
}
impl<S, B> Transform<S, ServiceRequest> for Sentry
where
S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
S::Future: 'static,
{
type Response = ServiceResponse<B>;
type Error = Error;
type Transform = SentryMiddleware<S>;
type InitError = ();
type Future = Ready<Result<Self::Transform, Self::InitError>>;
fn new_transform(&self, service: S) -> Self::Future {
ok(SentryMiddleware {
service,
inner: self.clone(),
})
}
}
pub struct SentryMiddleware<S> {
service: S,
inner: Sentry,
}
impl<S, B> Service<ServiceRequest> for SentryMiddleware<S>
where
S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
S::Future: 'static,
{
type Response = ServiceResponse<B>;
type Error = Error;
type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>>>>;
fn poll_ready(
&self,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Result<(), Self::Error>> {
self.service.poll_ready(cx)
}
fn call(&self, req: ServiceRequest) -> Self::Future {
let inner = self.inner.clone();
let hub = Arc::new(Hub::new_from_top(
inner.hub.clone().unwrap_or_else(Hub::main),
));
let client = hub.client();
let track_sessions = client.as_ref().map_or(false, |client| {
let options = client.options();
options.auto_session_tracking
&& options.session_mode == sentry_core::SessionMode::Request
});
if track_sessions {
hub.start_session();
}
let with_pii = client
.as_ref()
.map_or(false, |client| client.options().send_default_pii);
let (mut tx, sentry_req) = sentry_request_from_http(&req, with_pii);
let transaction = if inner.start_transaction {
let name = std::mem::take(&mut tx)
.unwrap_or_else(|| format!("{} {}", req.method(), req.uri()));
let headers = req.headers().iter().flat_map(|(header, value)| {
value.to_str().ok().map(|value| (header.as_str(), value))
});
let ctx = sentry_core::TransactionContext::continue_from_headers(
&name,
"http.server",
headers,
);
Some(hub.start_transaction(ctx))
} else {
None
};
let parent_span = hub.configure_scope(|scope| {
let parent_span = scope.get_span();
if let Some(transaction) = transaction.as_ref() {
scope.set_span(Some(transaction.clone().into()));
} else {
scope.set_transaction(tx.as_deref());
}
scope.add_event_processor(move |event| Some(process_event(event, &sentry_req)));
parent_span
});
let fut = self.service.call(req).bind_hub(hub.clone());
async move {
let mut res: Self::Response = match fut.await {
Ok(res) => res,
Err(e) => {
if inner.capture_server_errors {
hub.capture_error(&e);
}
if let Some(transaction) = transaction {
if transaction.get_status().is_none() {
let status = protocol::SpanStatus::UnknownError;
transaction.set_status(status);
}
transaction.finish();
hub.configure_scope(|scope| scope.set_span(parent_span));
}
return Err(e);
}
};
if inner.capture_server_errors && res.response().status().is_server_error() {
if let Some(e) = res.response().error() {
let event_id = hub.capture_error(e);
if inner.emit_header {
res.response_mut().headers_mut().insert(
"x-sentry-event".parse().unwrap(),
event_id.simple().to_string().parse().unwrap(),
);
}
}
}
if let Some(transaction) = transaction {
if transaction.get_status().is_none() {
let status = map_status(res.status());
transaction.set_status(status);
}
transaction.finish();
hub.configure_scope(|scope| scope.set_span(parent_span));
}
Ok(res)
}
.boxed_local()
}
}
fn map_status(status: StatusCode) -> protocol::SpanStatus {
match status {
StatusCode::UNAUTHORIZED => protocol::SpanStatus::Unauthenticated,
StatusCode::FORBIDDEN => protocol::SpanStatus::PermissionDenied,
StatusCode::NOT_FOUND => protocol::SpanStatus::NotFound,
StatusCode::TOO_MANY_REQUESTS => protocol::SpanStatus::ResourceExhausted,
status if status.is_client_error() => protocol::SpanStatus::InvalidArgument,
StatusCode::NOT_IMPLEMENTED => protocol::SpanStatus::Unimplemented,
StatusCode::SERVICE_UNAVAILABLE => protocol::SpanStatus::Unavailable,
status if status.is_server_error() => protocol::SpanStatus::InternalError,
StatusCode::CONFLICT => protocol::SpanStatus::AlreadyExists,
status if status.is_success() => protocol::SpanStatus::Ok,
_ => protocol::SpanStatus::UnknownError,
}
}
fn sentry_request_from_http(request: &ServiceRequest, with_pii: bool) -> (Option<String>, Request) {
let transaction = if let Some(name) = request.match_name() {
Some(String::from(name))
} else {
request.match_pattern()
};
let mut sentry_req = Request {
url: format!(
"{}://{}{}",
request.connection_info().scheme(),
request.connection_info().host(),
request.uri()
)
.parse()
.ok(),
method: Some(request.method().to_string()),
headers: request
.headers()
.iter()
.map(|(k, v)| (k.to_string(), v.to_str().unwrap_or_default().to_string()))
.collect(),
..Default::default()
};
if with_pii {
if let Some(remote) = request.connection_info().remote_addr() {
sentry_req.env.insert("REMOTE_ADDR".into(), remote.into());
}
};
(transaction, sentry_req)
}
fn process_event(mut event: Event<'static>, request: &Request) -> Event<'static> {
if event.request.is_none() {
event.request = Some(request.clone());
}
if let Some(sdk) = event.sdk.take() {
let mut sdk = sdk.into_owned();
sdk.packages.push(ClientSdkPackage {
name: "sentry-actix".into(),
version: env!("CARGO_PKG_VERSION").into(),
});
event.sdk = Some(Cow::Owned(sdk));
}
event
}
#[cfg(test)]
mod tests {
use std::io;
use actix_web::test::{call_service, init_service, TestRequest};
use actix_web::{get, web, App, HttpRequest, HttpResponse};
use futures::executor::block_on;
use sentry::Level;
use super::*;
fn _assert_hub_no_events() {
if Hub::current().last_event_id().is_some() {
panic!("Current hub should not have had any events.");
}
}
fn _assert_hub_has_events() {
Hub::current()
.last_event_id()
.expect("Current hub should have had events.");
}
#[actix_web::test]
async fn test_explicit_events() {
let events = sentry::test::with_captured_events(|| {
block_on(async {
let service = || {
_assert_hub_no_events();
sentry::capture_message("Message", Level::Warning);
_assert_hub_has_events();
HttpResponse::Ok()
};
let app = init_service(
App::new()
.wrap(Sentry::builder().with_hub(Hub::current()).finish())
.service(web::resource("/test").to(service)),
)
.await;
for _ in 0..2 {
let req = TestRequest::get().uri("/test").to_request();
let res = call_service(&app, req).await;
assert!(res.status().is_success());
}
})
});
assert_eq!(events.len(), 2);
for event in events {
let request = event.request.expect("Request should be set.");
assert_eq!(event.transaction, Some("/test".into()));
assert_eq!(event.message, Some("Message".into()));
assert_eq!(event.level, Level::Warning);
assert_eq!(request.method, Some("GET".into()));
}
}
#[actix_web::test]
async fn test_response_errors() {
let events = sentry::test::with_captured_events(|| {
block_on(async {
#[get("/test")]
async fn failing(_req: HttpRequest) -> Result<String, Error> {
_assert_hub_no_events();
Err(io::Error::new(io::ErrorKind::Other, "Test Error").into())
}
let app = init_service(
App::new()
.wrap(Sentry::builder().with_hub(Hub::current()).finish())
.service(failing),
)
.await;
for _ in 0..2 {
let req = TestRequest::get().uri("/test").to_request();
let res = call_service(&app, req).await;
assert!(res.status().is_server_error());
}
})
});
assert_eq!(events.len(), 2);
for event in events {
let request = event.request.expect("Request should be set.");
assert_eq!(event.transaction, Some("failing".into())); assert_eq!(event.message, None);
assert_eq!(event.exception.values[0].ty, String::from("Custom"));
assert_eq!(event.exception.values[0].value, Some("Test Error".into()));
assert_eq!(event.level, Level::Error);
assert_eq!(request.method, Some("GET".into()));
}
}
#[actix_web::test]
async fn test_client_errors_discarded() {
let events = sentry::test::with_captured_events(|| {
block_on(async {
let service = HttpResponse::NotFound;
let app = init_service(
App::new()
.wrap(Sentry::builder().with_hub(Hub::current()).finish())
.service(web::resource("/test").to(service)),
)
.await;
let req = TestRequest::get().uri("/test").to_request();
let res = call_service(&app, req).await;
assert!(res.status().is_client_error());
})
});
assert!(events.is_empty());
}
#[actix_web::test]
async fn test_override_transaction_name() {
let events = sentry::test::with_captured_events(|| {
block_on(async {
#[get("/test")]
async fn original_transaction(_req: HttpRequest) -> Result<String, Error> {
sentry::configure_scope(|scope| scope.set_transaction(Some("new_transaction")));
Err(io::Error::new(io::ErrorKind::Other, "Test Error").into())
}
let app = init_service(
App::new()
.wrap(Sentry::builder().with_hub(Hub::current()).finish())
.service(original_transaction),
)
.await;
let req = TestRequest::get().uri("/test").to_request();
let res = call_service(&app, req).await;
assert!(res.status().is_server_error());
})
});
assert_eq!(events.len(), 1);
let event = events[0].clone();
let request = event.request.expect("Request should be set.");
assert_eq!(event.transaction, Some("new_transaction".into())); assert_eq!(event.message, None);
assert_eq!(event.exception.values[0].ty, String::from("Custom"));
assert_eq!(event.exception.values[0].value, Some("Test Error".into()));
assert_eq!(event.level, Level::Error);
assert_eq!(request.method, Some("GET".into()));
}
#[actix_web::test]
async fn test_track_session() {
let envelopes = sentry::test::with_captured_envelopes_options(
|| {
block_on(async {
#[get("/")]
async fn hello() -> impl actix_web::Responder {
String::from("Hello there!")
}
let middleware = Sentry::builder().with_hub(Hub::current()).finish();
let app = init_service(App::new().wrap(middleware).service(hello)).await;
for _ in 0..5 {
let req = TestRequest::get().uri("/").to_request();
call_service(&app, req).await;
}
})
},
sentry::ClientOptions {
release: Some("some-release".into()),
session_mode: sentry::SessionMode::Request,
auto_session_tracking: true,
..Default::default()
},
);
assert_eq!(envelopes.len(), 1);
let mut items = envelopes[0].items();
if let Some(sentry::protocol::EnvelopeItem::SessionAggregates(aggregate)) = items.next() {
let aggregates = &aggregate.aggregates;
assert_eq!(aggregates[0].distinct_id, None);
assert_eq!(aggregates[0].exited, 5);
} else {
panic!("expected session");
}
assert_eq!(items.next(), None);
}
}