mas_handlers/admin/v1/user_sessions/
get.rs

1// Copyright 2025 New Vector Ltd.
2//
3// SPDX-License-Identifier: AGPL-3.0-only
4// Please see LICENSE in the repository root for full details.
5
6use aide::{OperationIo, transform::TransformOperation};
7use axum::{Json, response::IntoResponse};
8use hyper::StatusCode;
9use mas_axum_utils::record_error;
10use ulid::Ulid;
11
12use crate::{
13    admin::{
14        call_context::CallContext,
15        model::UserSession,
16        params::UlidPathParam,
17        response::{ErrorResponse, SingleResponse},
18    },
19    impl_from_error_for_route,
20};
21
22#[derive(Debug, thiserror::Error, OperationIo)]
23#[aide(output_with = "Json<ErrorResponse>")]
24pub enum RouteError {
25    #[error(transparent)]
26    Internal(Box<dyn std::error::Error + Send + Sync + 'static>),
27
28    #[error("User session ID {0} not found")]
29    NotFound(Ulid),
30}
31
32impl_from_error_for_route!(mas_storage::RepositoryError);
33
34impl IntoResponse for RouteError {
35    fn into_response(self) -> axum::response::Response {
36        let error = ErrorResponse::from_error(&self);
37        let sentry_event_id = record_error!(self, Self::Internal(_));
38        let status = match self {
39            Self::Internal(_) => StatusCode::INTERNAL_SERVER_ERROR,
40            Self::NotFound(_) => StatusCode::NOT_FOUND,
41        };
42        (status, sentry_event_id, Json(error)).into_response()
43    }
44}
45
46pub fn doc(operation: TransformOperation) -> TransformOperation {
47    operation
48        .id("getUserSession")
49        .summary("Get a user session")
50        .tag("user-session")
51        .response_with::<200, Json<SingleResponse<UserSession>>, _>(|t| {
52            let [sample, ..] = UserSession::samples();
53            let response = SingleResponse::new_canonical(sample);
54            t.description("User session was found").example(response)
55        })
56        .response_with::<404, RouteError, _>(|t| {
57            let response = ErrorResponse::from_error(&RouteError::NotFound(Ulid::nil()));
58            t.description("User session was not found")
59                .example(response)
60        })
61}
62
63#[tracing::instrument(name = "handler.admin.v1.user_sessions.get", skip_all)]
64pub async fn handler(
65    CallContext { mut repo, .. }: CallContext,
66    id: UlidPathParam,
67) -> Result<Json<SingleResponse<UserSession>>, RouteError> {
68    let session = repo
69        .browser_session()
70        .lookup(*id)
71        .await?
72        .ok_or(RouteError::NotFound(*id))?;
73
74    Ok(Json(SingleResponse::new_canonical(UserSession::from(
75        session,
76    ))))
77}
78
79#[cfg(test)]
80mod tests {
81    use hyper::{Request, StatusCode};
82    use insta::assert_json_snapshot;
83    use sqlx::PgPool;
84
85    use crate::test_utils::{RequestBuilderExt, ResponseExt, TestState, setup};
86
87    #[sqlx::test(migrator = "mas_storage_pg::MIGRATOR")]
88    async fn test_get(pool: PgPool) {
89        setup();
90        let mut state = TestState::from_pool(pool).await.unwrap();
91        let token = state.token_with_scope("urn:mas:admin").await;
92        let mut rng = state.rng();
93
94        // Provision a user and a user session
95        let mut repo = state.repository().await.unwrap();
96        let user = repo
97            .user()
98            .add(&mut rng, &state.clock, "alice".to_owned())
99            .await
100            .unwrap();
101        let session = repo
102            .browser_session()
103            .add(&mut rng, &state.clock, &user, None)
104            .await
105            .unwrap();
106        repo.save().await.unwrap();
107
108        let session_id = session.id;
109        let request = Request::get(format!("/api/admin/v1/user-sessions/{session_id}"))
110            .bearer(&token)
111            .empty();
112        let response = state.request(request).await;
113        response.assert_status(StatusCode::OK);
114        let body: serde_json::Value = response.json();
115        assert_json_snapshot!(body, @r###"
116        {
117          "data": {
118            "type": "user-session",
119            "id": "01FSHN9AG0AJ6AC5HQ9X6H4RP4",
120            "attributes": {
121              "created_at": "2022-01-16T14:40:00Z",
122              "finished_at": null,
123              "user_id": "01FSHN9AG0MZAA6S4AF7CTV32E",
124              "user_agent": null,
125              "last_active_at": null,
126              "last_active_ip": null
127            },
128            "links": {
129              "self": "/api/admin/v1/user-sessions/01FSHN9AG0AJ6AC5HQ9X6H4RP4"
130            }
131          },
132          "links": {
133            "self": "/api/admin/v1/user-sessions/01FSHN9AG0AJ6AC5HQ9X6H4RP4"
134          }
135        }
136        "###);
137    }
138}
mas_handlers/admin/v1/user_sessions/get.rs

mas_handlers/admin/v1/user_sessions/
get.rs
