ref: Update actix integration to actix-web 4 (#437)

Co-authored-by: Oscar Rainford <[email protected]>

Author: Swatinem

.github/workflows/ci.yml

@@ -99,7 +99,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        rust: [1.53.0]
+        rust: [1.54.0]
 
     name: Check / Test MSRV ${{ matrix.rust }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## Unreleased
+
+**Breaking Changes**:
+
+- The minium supported Rust version was bumped to **1.54.0** due to requirements from dependencies.
+- Updated the `sentry-actix` integration to `actix-web@4`. ([#437](https://github.com/getsentry/sentry-rust/pull/437))
+
+**Features**:
+
+- Calling `Scope::set_transaction` will override the Transaction name of any currently running performance monitoring transaction. ([#433](https://github.com/getsentry/sentry-rust/pull/433))
+
+**Fixes**:
+
+- Make sure Spans/Transactions have a meaningful/non-empty name. ([#434](https://github.com/getsentry/sentry-rust/pull/434))
+
+**Thank you**:
+
+Features, fixes and improvements in this release have been contributed by:
+
+- [@jessfraz](https://github.com/jessfraz)
+- [@fourbytes](https://github.com/fourbytes)
+
 ## 0.24.3
 
 **Features**:

README.md

@@ -94,7 +94,7 @@ best API and adding new features.
 We currently only verify this crate against a recent version of Sentry hosted on [sentry.io](https://sentry.io/) but it
 should work with on-prem Sentry versions 20.6 and later.
 
-The **Minimum Supported Rust Version** is currently at _1.53.0_.
+The **Minimum Supported Rust Version** is currently at _1.54.0_.
 The Sentry crates will support a _6 month_ old Rust version at time of release,
 and the MSRV will be increased in accordance with its dependencies.
 

clippy.toml

@@ -1 +1 @@
-msrv = "1.53"
+msrv = "1.54"

sentry-actix/Cargo.toml

@@ -12,11 +12,12 @@ Sentry client extension for actix-web 3.
 edition = "2018"
 
 [dependencies]
-sentry-core = { version = "0.24.3", path = "../sentry-core", default-features = false, features = ["client"] }
-actix-web = { version = "3", default-features = false }
+actix-web = { version = "4", default-features = false }
 futures-util = { version = "0.3.5", default-features = false }
+sentry-core = { version = "0.24.3", path = "../sentry-core", default-features = false, features = ["client"] }
 
 [dev-dependencies]
-sentry = { path = "../sentry", features = ["test"] }
-actix-rt = "2.1.0"
+actix-web = { version = "4" }
 futures = "0.3"
+sentry = { path = "../sentry", features = ["test"] }
+tokio = { version = "1.0", features = ["full"] }

sentry-actix/examples/basic.rs

@@ -21,30 +21,35 @@ async fn captures_message(_req: HttpRequest) -> Result<String, Error> {
 }
 
 // cargo run -p sentry-actix --example basic
-#[actix_web::main]
-async fn main() -> io::Result<()> {
+fn main() -> io::Result<()> {
     let _guard = sentry::init(sentry::ClientOptions {
+        release: sentry::release_name!(),
         auto_session_tracking: true,
         traces_sample_rate: 1.0,
         session_mode: sentry::SessionMode::Request,
+        debug: true,
         ..Default::default()
     });
     env::set_var("RUST_BACKTRACE", "1");
 
-    let addr = "127.0.0.1:3001";
-
-    println!("Starting server on http://{}", addr);
-
-    HttpServer::new(|| {
-        App::new()
-            .wrap(sentry_actix::Sentry::with_transaction())
-            .service(healthy)
-            .service(errors)
-            .service(captures_message)
+    let runtime = tokio::runtime::Builder::new_multi_thread()
+        .enable_all()
+        .build()?;
+
+    runtime.block_on(async move {
+        let addr = "127.0.0.1:3001";
+
+        println!("Starting server on http://{}", addr);
+
+        HttpServer::new(|| {
+            App::new()
+                .wrap(sentry_actix::Sentry::with_transaction())
+                .service(healthy)
+                .service(errors)
+                .service(captures_message)
+        })
+        .bind(addr)?
+        .run()
+        .await
     })
-    .bind(addr)?
-    .run()
-    .await?;
-
-    Ok(())
 }

sentry-actix/src/lib.rs

@@ -18,21 +18,26 @@
 //!     Err(io::Error::new(io::ErrorKind::Other, "An error happens here").into())
 //! }
 //!
-//! #[actix_web::main]
-//! async fn main() -> io::Result<()> {
-//!     let _guard = sentry::init(());
+//! fn main() -> io::Result<()> {
+//!     let _guard = sentry::init(sentry::ClientOptions {
+//!         release: sentry::release_name!(),
+//!         ..Default::default()
+//!     });
 //!     std::env::set_var("RUST_BACKTRACE", "1");
 //!
-//!     HttpServer::new(|| {
-//!         App::new()
-//!             .wrap(sentry_actix::Sentry::new())
-//!             .service(failing)
+//!     let runtime = tokio::runtime::Builder::new_multi_thread()
+//!         .enable_all()
+//!         .build()?;
+//!     runtime.block_on(async move {
+//!         HttpServer::new(|| {
+//!             App::new()
+//!                 .wrap(sentry_actix::Sentry::new())
+//!                 .service(failing)
+//!         })
+//!         .bind("127.0.0.1:3001")?
+//!         .run()
+//!         .await
 //!     })
-//!     .bind("127.0.0.1:3001")?
-//!     .run()
-//!     .await?;
-//!
-//!     Ok(())
 //! }
 //! ```
 //!
@@ -44,6 +49,7 @@
 //!
 //! ```
 //! let _sentry = sentry::init(sentry::ClientOptions {
+//!     release: sentry::release_name!(),
 //!     session_mode: sentry::SessionMode::Request,
 //!     auto_session_tracking: true,
 //!     ..Default::default()
@@ -172,12 +178,11 @@ impl Default for Sentry {
     }
 }
 
-impl<S, B> Transform<S> for Sentry
+impl<S, B> Transform<S, ServiceRequest> for Sentry
 where
-    S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
+    S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
     S::Future: 'static,
 {
-    type Request = ServiceRequest;
     type Response = ServiceResponse<B>;
     type Error = Error;
     type Transform = SentryMiddleware<S>;
@@ -198,24 +203,23 @@ pub struct SentryMiddleware<S> {
     inner: Sentry,
 }
 
-impl<S, B> Service for SentryMiddleware<S>
+impl<S, B> Service<ServiceRequest> for SentryMiddleware<S>
 where
-    S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
+    S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
     S::Future: 'static,
 {
-    type Request = ServiceRequest;
     type Response = ServiceResponse<B>;
     type Error = Error;
     type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>>>>;
 
     fn poll_ready(
-        &mut self,
+        &self,
         cx: &mut std::task::Context<'_>,
     ) -> std::task::Poll<Result<(), Self::Error>> {
         self.service.poll_ready(cx)
     }
 
-    fn call(&mut self, req: ServiceRequest) -> Self::Future {
+    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),
@@ -412,7 +416,7 @@ mod tests {
     }
 
     /// Test explicit events sent to the current Hub inside an Actix service.
-    #[actix_rt::test]
+    #[actix_web::test]
     async fn test_explicit_events() {
         let events = sentry::test::with_captured_events(|| {
             block_on(async {
@@ -428,7 +432,7 @@ mod tests {
                     HttpResponse::Ok()
                 };
 
-                let mut app = init_service(
+                let app = init_service(
                     App::new()
                         .wrap(Sentry::builder().with_hub(Hub::current()).finish())
                         .service(web::resource("/test").to(service)),
@@ -438,7 +442,7 @@ mod tests {
                 // Call the service twice (sequentially) to ensure the middleware isn't sticky
                 for _ in 0..2 {
                     let req = TestRequest::get().uri("/test").to_request();
-                    let res = call_service(&mut app, req).await;
+                    let res = call_service(&app, req).await;
                     assert!(res.status().is_success());
                 }
             })
@@ -455,7 +459,7 @@ mod tests {
     }
 
     /// Ensures errors returned in the Actix service trigger an event.
-    #[actix_rt::test]
+    #[actix_web::test]
     async fn test_response_errors() {
         let events = sentry::test::with_captured_events(|| {
             block_on(async {
@@ -467,7 +471,7 @@ mod tests {
                     Err(io::Error::new(io::ErrorKind::Other, "Test Error").into())
                 }
 
-                let mut app = init_service(
+                let app = init_service(
                     App::new()
                         .wrap(Sentry::builder().with_hub(Hub::current()).finish())
                         .service(failing),
@@ -477,7 +481,7 @@ mod tests {
                 // Call the service twice (sequentially) to ensure the middleware isn't sticky
                 for _ in 0..2 {
                     let req = TestRequest::get().uri("/test").to_request();
-                    let res = call_service(&mut app, req).await;
+                    let res = call_service(&app, req).await;
                     assert!(res.status().is_server_error());
                 }
             })
@@ -496,21 +500,21 @@ mod tests {
     }
 
     /// Ensures client errors (4xx) are not captured.
-    #[actix_rt::test]
+    #[actix_web::test]
     async fn test_client_errors_discarded() {
         let events = sentry::test::with_captured_events(|| {
             block_on(async {
                 let service = HttpResponse::NotFound;
 
-                let mut app = init_service(
+                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(&mut app, req).await;
+                let res = call_service(&app, req).await;
                 assert!(res.status().is_client_error());
             })
         });
@@ -519,7 +523,7 @@ mod tests {
     }
 
     /// Ensures transaction name can be overridden in handler scope.
-    #[actix_rt::test]
+    #[actix_web::test]
     async fn test_override_transaction_name() {
         let events = sentry::test::with_captured_events(|| {
             block_on(async {
@@ -530,15 +534,15 @@ mod tests {
                     Err(io::Error::new(io::ErrorKind::Other, "Test Error").into())
                 }
 
-                let mut app = init_service(
+                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(&mut app, req).await;
+                let res = call_service(&app, req).await;
                 assert!(res.status().is_server_error());
             })
         });
@@ -554,7 +558,7 @@ mod tests {
         assert_eq!(request.method, Some("GET".into()));
     }
 
-    #[actix_rt::test]
+    #[actix_web::test]
     async fn test_track_session() {
         let envelopes = sentry::test::with_captured_envelopes_options(
             || {
@@ -566,11 +570,11 @@ mod tests {
 
                     let middleware = Sentry::builder().with_hub(Hub::current()).finish();
 
-                    let mut app = init_service(App::new().wrap(middleware).service(hello)).await;
+                    let app = init_service(App::new().wrap(middleware).service(hello)).await;
 
                     for _ in 0..5 {
                         let req = TestRequest::get().uri("/").to_request();
-                        call_service(&mut app, req).await;
+                        call_service(&app, req).await;
                     }
                 })
             },

sentry-core/src/session.rs

@@ -43,8 +43,8 @@ impl Session {
             .and_then(|user| {
                 user.id
                     .as_ref()
-                    .or_else(|| user.email.as_ref())
-                    .or_else(|| user.username.as_ref())
+                    .or(user.email.as_ref())
+                    .or(user.username.as_ref())
             })
             .cloned();
         Some(Self {

sentry-tower/src/lib.rs

@@ -70,20 +70,25 @@
 //! # mod hello_world {
 //! #     include!("helloworld.rs");
 //! # }
+//! use hello_world::{greeter_server::*, *};
 //! use sentry_tower::NewSentryLayer;
-//! use hello_world::{*, greeter_server::*};
 //!
 //! struct GreeterService;
 //!
 //! #[tonic::async_trait]
 //! impl Greeter for GreeterService {
-//!     async fn say_hello(&self, req: Request<HelloRequest>) -> Result<Response<HelloReply>, Status> {
+//!     async fn say_hello(
+//!         &self,
+//!         req: Request<HelloRequest>,
+//!     ) -> Result<Response<HelloReply>, Status> {
 //!         let HelloRequest { name } = req.into_inner();
 //!         if name == "world" {
 //!             capture_anyhow(&anyhow!("Trying to greet a planet"));
 //!             return Err(Status::invalid_argument("Cannot greet a planet"));
 //!         }
-//!         Ok(Response::new(HelloReply { message: format!("Hello {}", name) }))
+//!         Ok(Response::new(HelloReply {
+//!             message: format!("Hello {}", name),
+//!         }))
 //!     }
 //! }
 //!