feat(ci): feature checks (#25)

* feat(ci): feature checks

Adds feature checks to CI.

Closes ENG-835

* chore: rename action

* beep boop

* fix: feature gate `Router::into_axum_with_handle` (#24)

* fix: clippy

---------

Co-authored-by: onbjerg <[email protected]>
Co-authored-by: James <[email protected]>

Author: 3 people

.github/workflows/rust-ci.yml

@@ -1,11 +1,12 @@
 name: Rust CI
-
 on:
+  workflow_dispatch:
   push:
     branches: [main]
   pull_request:
+env:
+  CARGO_TERM_COLOR: always
 
-# simplest example of using the rust-base action
 jobs:
-  rust-base:
-    uses: init4tech/actions/.github/workflows/rust-base.yml@main
+  rust-library-base:
+    uses: init4tech/actions/.github/workflows/rust-library-base.yml@main

Cargo.toml

@@ -20,35 +20,34 @@ serde = { version = "1.0.217", features = ["derive"] }
 serde_json = { version = "1.0.135", features = ["raw_value"] }
 thiserror = "2.0.9"
 tokio = { version = "1.43.0", features = ["sync", "rt", "macros"] }
+tokio-util = { version = "0.7.13", features = ["io", "rt"] }
 tower = { version = "0.5.2", features = ["util"] }
 tracing = "0.1.41"
 
 # axum
 axum = { version = "0.8.1", optional = true }
+mime = { version = "0.3.17", optional = true}
 
 # pubsub
 tokio-stream = { version = "0.1.17", optional = true }
 
 # ipc
 interprocess = { version = "2.2.2", features = ["async", "tokio"], optional = true }
-tokio-util = { version = "0.7.13", optional = true, features = ["io", "rt"] }
 
 # ws
 tokio-tungstenite = { version = "0.26.1", features = ["rustls-tls-webpki-roots"], optional = true }
 futures-util = { version = "0.3.31", optional = true }
-mime = "0.3.17"
 
 [dev-dependencies]
 tempfile = "3.15.0"
 tracing-subscriber = "0.3.19"
 
 [features]
 default = ["axum", "ws", "ipc"]
-axum = ["dep:axum"]
+axum = ["dep:axum", "dep:mime"]
 pubsub = ["dep:tokio-stream"]
-ipc = ["pubsub", "dep:tokio-util", "dep:interprocess"]
+ipc = ["pubsub", "dep:interprocess"]
 ws = ["pubsub", "dep:tokio-tungstenite", "dep:futures-util"]
-tokio-util = ["dep:tokio-util"]
 
 [profile.release]
 opt-level = 3

src/router.rs

@@ -346,10 +346,10 @@ where
     ///
     /// This method allows users to specify a runtime handle for the router to
     /// use. This runtime is accessible to all handlers invoked by the router.
-    /// Handlers.
     ///
     /// Tasks spawned by the router will be spawned on the provided runtime,
     /// and automatically cancelled when the returned `axum::Router` is dropped.
+    #[cfg(feature = "axum")]
     pub fn into_axum_with_handle(
         self,
         path: &str,

src/routes/ctx.rs

@@ -1,7 +1,6 @@
-use std::future::Future;
-
 use crate::{types::Request, RpcSend, TaskSet};
 use serde_json::value::RawValue;
+use std::future::Future;
 use tokio::{runtime::Handle, sync::mpsc, task::JoinHandle};
 use tokio_util::sync::WaitForCancellationFutureOwned;
 use tracing::error;
@@ -54,6 +53,7 @@ impl From<Handle> for HandlerCtx {
 
 impl HandlerCtx {
     /// Create a new handler context.
+    #[allow(dead_code)] // used in pubsub and axum features
     pub(crate) const fn new(
         notifications: Option<mpsc::Sender<Box<RawValue>>>,
         tasks: TaskSet,

src/routes/handler.rs

@@ -120,8 +120,8 @@ pub struct PhantomParams<T>(PhantomData<T>);
 ///
 /// 1. The handler takes EITHER `params` or `state`.
 /// 2. The `S` type of the router would also be a valid `Params` type (i.e. it
-///   impls [`DeserializeOwned`] and satisfies the other
-///   requirements of [`RpcRecv`]).
+///    impls [`DeserializeOwned`] and satisfies the other
+///    requirements of [`RpcRecv`]).
 /// 3. The argument to the handler matches the `S` type of the router.
 ///
 /// ```compile_fail

src/tasks.rs

@@ -24,6 +24,7 @@ impl From<Handle> for TaskSet {
     }
 }
 
+#[allow(dead_code)] // used in pubsub and axum features
 impl TaskSet {
     /// Create a new [`TaskSet`] with a handle.
     pub(crate) fn with_handle(handle: Handle) -> Self {

tests/common/mod.rs

@@ -1,7 +1,6 @@
-use std::time::Duration;
-
 use ajj::{HandlerCtx, Router};
 use serde_json::{json, Value};
+use std::time::Duration;
 use tokio::time::{self, timeout};
 
 /// Instantiate a router for testing.

tests/ipc.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "ipc")]
+
 mod common;
 use common::{test_router, TestClient};
 

tests/ws.rs

@@ -1,3 +1,5 @@
+#![cfg(feature = "ws")]
+
 mod common;
 use common::{test_router, TestClient};