Skip to main content

ironflow_api/routes/users/
list.rs

1//! `GET /api/v1/users` -- List all users (admin only).
2
3use axum::extract::{Query, State};
4use axum::response::IntoResponse;
5use serde::Deserialize;
6
7use ironflow_auth::extractor::Authenticated;
8
9use crate::entities::UserResponse;
10use crate::error::ApiError;
11use crate::response::ok_paged;
12use crate::state::AppState;
13
14/// Query parameters for listing users.
15#[cfg_attr(feature = "openapi", derive(utoipa::IntoParams, utoipa::ToSchema))]
16#[derive(Debug, Deserialize)]
17pub struct ListUsersQuery {
18    /// Page number (1-based, defaults to 1).
19    pub page: Option<u32>,
20    /// Items per page (defaults to 20, max 100).
21    pub per_page: Option<u32>,
22}
23
24/// List all users with pagination. Admin only.
25///
26/// # Errors
27///
28/// - 403 if the caller is not an admin
29#[cfg_attr(
30    feature = "openapi",
31    utoipa::path(
32        get,
33        path = "/api/v1/users",
34        tags = ["users"],
35        params(ListUsersQuery),
36        responses(
37            (status = 200, description = "Paginated list of users", body = Vec<UserResponse>),
38            (status = 401, description = "Unauthorized"),
39            (status = 403, description = "Forbidden (not an admin)")
40        ),
41        security(("Bearer" = []))
42    )
43)]
44pub async fn list_users(
45    auth: Authenticated,
46    State(state): State<AppState>,
47    Query(query): Query<ListUsersQuery>,
48) -> Result<impl IntoResponse, ApiError> {
49    if !auth.is_admin() {
50        return Err(ApiError::Forbidden);
51    }
52
53    let page = query.page.unwrap_or(1).max(1);
54    let per_page = query.per_page.unwrap_or(20).clamp(1, 100);
55
56    let result = state.store.list_users(page, per_page).await?;
57
58    let items: Vec<UserResponse> = result.items.into_iter().map(UserResponse::from).collect();
59
60    Ok(ok_paged(items, page, per_page, result.total))
61}
62
63#[cfg(test)]
64mod tests {
65    use axum::Router;
66    use axum::body::Body;
67    use axum::http::{Request, StatusCode};
68    use axum::routing::get;
69    use http_body_util::BodyExt;
70    use ironflow_auth::jwt::{AccessToken, JwtConfig};
71    use ironflow_core::providers::claude::ClaudeCodeProvider;
72    use ironflow_engine::context::WorkflowContext;
73    use ironflow_engine::engine::Engine;
74    use ironflow_engine::handler::{HandlerFuture, WorkflowHandler};
75    use ironflow_engine::notify::Event;
76    use ironflow_store::entities::NewUser;
77    use ironflow_store::memory::InMemoryStore;
78    use ironflow_store::store::Store;
79    use serde_json::Value as JsonValue;
80    use std::sync::Arc;
81    use tokio::sync::broadcast;
82    use tower::ServiceExt;
83    use uuid::Uuid;
84
85    use super::*;
86
87    struct TestWorkflow;
88
89    impl WorkflowHandler for TestWorkflow {
90        fn name(&self) -> &str {
91            "test-workflow"
92        }
93
94        fn execute<'a>(&'a self, _ctx: &'a mut WorkflowContext) -> HandlerFuture<'a> {
95            Box::pin(async move { Ok(()) })
96        }
97    }
98
99    fn test_jwt_config() -> Arc<JwtConfig> {
100        Arc::new(JwtConfig {
101            secret: "test-secret-for-user-tests".to_string(),
102            access_token_ttl_secs: 900,
103            refresh_token_ttl_secs: 604800,
104            cookie_domain: None,
105            cookie_secure: false,
106        })
107    }
108
109    fn test_state() -> AppState {
110        let store: Arc<dyn Store> = Arc::new(InMemoryStore::new());
111        let provider = Arc::new(ClaudeCodeProvider::new());
112        let mut engine = Engine::new(store.clone(), provider);
113        engine
114            .register(TestWorkflow)
115            .expect("failed to register test workflow");
116        let (event_sender, _) = broadcast::channel::<Event>(1);
117        AppState::new(
118            store,
119            Arc::new(engine),
120            test_jwt_config(),
121            "test-worker-token".to_string(),
122            event_sender,
123        )
124    }
125
126    fn make_auth_header(user_id: Uuid, is_admin: bool, state: &AppState) -> String {
127        let token =
128            AccessToken::for_user(user_id, "testuser", is_admin, &state.jwt_config).unwrap();
129        format!("Bearer {}", token.0)
130    }
131
132    #[tokio::test]
133    async fn list_users_as_admin() {
134        let state = test_state();
135        let admin = state
136            .store
137            .create_user(NewUser {
138                email: "admin@example.com".to_string(),
139                username: "admin".to_string(),
140                password_hash: "hash".to_string(),
141                is_admin: None,
142            })
143            .await
144            .unwrap();
145
146        let auth_header = make_auth_header(admin.id, true, &state);
147        let app = Router::new().route("/", get(list_users)).with_state(state);
148
149        let req = Request::builder()
150            .uri("/?page=1&per_page=20")
151            .header("authorization", auth_header)
152            .body(Body::empty())
153            .unwrap();
154
155        let resp = app.oneshot(req).await.unwrap();
156        assert_eq!(resp.status(), StatusCode::OK);
157
158        let body = resp.into_body().collect().await.unwrap().to_bytes();
159        let json: JsonValue = serde_json::from_slice(&body).unwrap();
160        assert_eq!(json["data"].as_array().unwrap().len(), 1);
161        assert_eq!(json["meta"]["total"], 1);
162    }
163
164    #[tokio::test]
165    async fn list_users_as_member_forbidden() {
166        let state = test_state();
167        let member = state
168            .store
169            .create_user(NewUser {
170                email: "member@example.com".to_string(),
171                username: "member".to_string(),
172                password_hash: "hash".to_string(),
173                is_admin: Some(false),
174            })
175            .await
176            .unwrap();
177
178        let auth_header = make_auth_header(member.id, false, &state);
179        let app = Router::new().route("/", get(list_users)).with_state(state);
180
181        let req = Request::builder()
182            .uri("/?page=1&per_page=20")
183            .header("authorization", auth_header)
184            .body(Body::empty())
185            .unwrap();
186
187        let resp = app.oneshot(req).await.unwrap();
188        assert_eq!(resp.status(), StatusCode::FORBIDDEN);
189    }
190}