feat!: Allow Service trait to return custom errors (#921)

Add `Error` associated type to the `Service` trait to allow consumers to
return a custom error from their `Service` implementations.

Relates to #922

Author: spencewenski

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "roadster"
-version = "0.8.1"
+version = "0.9.0-alpha"
 edition = "2024"
 publish = true
 description = "A \"Batteries Included\" web framework for rust designed to get you moving fast."

Cargo.toml

@@ -9,7 +9,7 @@ publish = false
 [features]
 
 [dependencies]
-roadster = { version = "0.8.1", path = "../..", default-features = false, features = ["worker-pg", "worker-sidekiq"] }
+roadster = { version = "0.9.0-alpha", path = "../..", default-features = false, features = ["worker-pg", "worker-sidekiq"] }
 tokio = { workspace = true }
 tokio-util = { workspace = true }
 tracing = { workspace = true }
@@ -22,7 +22,7 @@ itertools = { workspace = true }
 sqlx = { workspace = true }
 
 [dev-dependencies]
-roadster = { version = "0.8.1", path = "../..", default-features = false, features = ["testing", "bench"] }
+roadster = { version = "0.9.0-alpha", path = "../..", default-features = false, features = ["testing", "bench"] }
 criterion = { version = "0.6.0", features = ["html_reports"] }
 fake = { workspace = true }
 

benches/worker/Cargo.toml

@@ -88,11 +88,15 @@ fn worker_benchmark<W: 'static + Worker<AppContext, ExampleWorkerArgs>>(
                         let state = app.state.clone();
 
                         runtime.block_on(async {
-                            let srv = app
-                                .service_registry
-                                .get::<PgWorkerService<AppContext>>()
+                            app.service_registry
+                                .invoke({
+                                    let state = state.clone();
+                                    async move |srvc: &PgWorkerService<AppContext>| {
+                                        srvc.before_run(&state).await.unwrap();
+                                    }
+                                })
+                                .await
                                 .unwrap();
-                            srv.before_run(&state).await.unwrap();
                             sqlx::query(&format!(
                                 "truncate pgmq.q_{}",
                                 worker_bench::worker::example::QUEUE

benches/worker/src/bench.rs

@@ -23,11 +23,11 @@ async fn open_api() -> RoadsterResult<()> {
     // Prepare the app
     let prepared = prepare(app, PrepareOptions::builder().build()).await?;
 
-    // Get the `HttpService`
-    let http_service = prepared.service_registry.get::<HttpService>()?;
-
-    // Get the OpenAPI schema
-    let schema = http_service.open_api_schema(&OpenApiArgs::builder().build())?;
+    // Get the OpenAPI schema from the `HttpService`
+    let schema = prepared
+        .service_registry
+        .invoke(async |srvc: &HttpService| srvc.open_api_schema(&OpenApiArgs::builder().build()))
+        .await??;
 
     println!("{schema}");
 

book/examples/service/src/http/open_api.rs

@@ -12,7 +12,7 @@ cli = ["roadster/cli", "clap"]
 db-sea-orm = ["roadster/db-sea-orm", "app-builder-migration", "sea-orm"]
 
 [dependencies]
-roadster = { version = "0.8.1", path = "../..", default-features = false, features = ["open-api", "worker-sidekiq", "otel-grpc"] }
+roadster = { version = "0.9.0-alpha", path = "../..", default-features = false, features = ["open-api", "worker-sidekiq", "otel-grpc"] }
 tokio = { workspace = true }
 tokio-util = { workspace = true }
 anyhow = { workspace = true }
@@ -41,7 +41,7 @@ cron = { workspace = true }
 config = { workspace = true, features = ["async"] }
 
 [dev-dependencies]
-roadster = { version = "0.8.1", path = "../..", default-features = false, features = ["testing"] }
+roadster = { version = "0.9.0-alpha", path = "../..", default-features = false, features = ["testing"] }
 tower-util = { workspace = true }
 
 [build-dependencies]

examples/app-builder/Cargo.toml

@@ -8,15 +8,20 @@ use tower_util::ServiceExt;
 #[tokio::test]
 async fn ping() {
     run_test(build_app(), PrepareOptions::test(), async |app| {
-        let http_service = app.service_registry.get::<HttpService>().unwrap();
-        let router = http_service.router().clone();
+        let response = app
+            .service_registry
+            .invoke(async |srvc: &HttpService| {
+                let router = srvc.router().clone();
 
-        let request: Request<Body> = Request::builder()
-            .uri("/api/_ping")
-            .body(().into())
-            .unwrap();
+                let request: Request<Body> = Request::builder()
+                    .uri("/api/_ping")
+                    .body(().into())
+                    .unwrap();
 
-        let response = router.oneshot(request).await.unwrap();
+                router.oneshot(request).await.unwrap()
+            })
+            .await
+            .unwrap();
 
         assert_eq!(response.status(), StatusCode::OK);
     })

examples/app-builder/tests/ping.rs

@@ -7,7 +7,7 @@ publish = false
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-roadster = { version = "0.8.1", path = "../..", features = ["db-diesel-postgres-pool-async"] }
+roadster = { version = "0.9.0-alpha", path = "../..", features = ["db-diesel-postgres-pool-async"] }
 tokio = { workspace = true }
 tokio-util = { workspace = true }
 anyhow = { workspace = true }
@@ -42,7 +42,7 @@ chrono = { workspace = true, features = ["serde"] }
 fake = { workspace = true }
 
 [dev-dependencies]
-roadster = { version = "0.8.1", path = "../..", default-features = false, features = ["testing"] }
+roadster = { version = "0.9.0-alpha", path = "../..", default-features = false, features = ["testing"] }
 tokio = { workspace = true, features = ["test-util"] }
 tower-util = { workspace = true }
 

examples/diesel/Cargo.toml

@@ -1,5 +1,5 @@
 use axum::body::Body;
-use axum::http::{Request, Response, StatusCode};
+use axum::http::{Request, StatusCode};
 use roadster::app::{PrepareOptions, run_test};
 use roadster::service::http::service::HttpService;
 use roadster_diesel_example::build_app;
@@ -8,16 +8,19 @@ use tower_util::ServiceExt;
 #[tokio::test]
 async fn health() {
     run_test(build_app(), PrepareOptions::test(), async |app| {
-        let http_service = app.service_registry.get::<HttpService>().unwrap();
-        let router = http_service.router().clone();
-
-        let request: Request<Body> = Request::builder()
-            .uri("/api/_health")
-            .body(().into())
+        let response = app
+            .service_registry
+            .invoke(async |srvc: &HttpService| {
+                let router = srvc.router().clone();
+                let request: Request<Body> = Request::builder()
+                    .uri("/api/_health")
+                    .body(().into())
+                    .unwrap();
+                router.oneshot(request).await.unwrap()
+            })
+            .await
             .unwrap();
 
-        let response: Response<Body> = router.oneshot(request).await.unwrap();
-
         assert_eq!(response.status(), StatusCode::OK);
     })
     .await

examples/diesel/tests/health.rs

@@ -11,7 +11,7 @@ default = ["grpc"]
 grpc = ["roadster/grpc", "dep:tonic", "dep:tonic-reflection", "dep:tonic-prost-build", "dep:prost"]
 
 [dependencies]
-roadster = { version = "0.8.1", path = "../..", features = ["worker-sidekiq", "db-sea-orm", "email-smtp", "email-sendgrid", "config-yml", "otel-grpc"] }
+roadster = { version = "0.9.0-alpha", path = "../..", features = ["worker-sidekiq", "db-sea-orm", "email-smtp", "email-sendgrid", "config-yml", "otel-grpc"] }
 tokio = { workspace = true }
 tokio-util = { workspace = true }
 anyhow = { workspace = true }
@@ -47,7 +47,7 @@ uuid = { workspace = true, features = ["v7"] }
 chrono = { workspace = true, features = ["serde"] }
 
 [dev-dependencies]
-roadster = { version = "0.8.1", path = "../..", features = ["testing-mocks"] }
+roadster = { version = "0.9.0-alpha", path = "../..", features = ["testing-mocks"] }
 tokio = { workspace = true, features = ["test-util"] }
 tower-util = { workspace = true }