pubky-homeserver 0.5.1

Pubky core's homeserver.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

use super::super::app_state::AppState;
use crate::persistence::lmdb::tables::signup_tokens::SignupToken;
use crate::shared::HttpResult;
use axum::{extract::State, http::StatusCode, Json};
use serde::Serialize;

#[derive(Serialize)]
pub(crate) struct InfoResponse {
    num_users: u64,
    num_disabled_users: u64,
    total_disk_used_mb: f64,
    num_signup_codes: u64,
    num_unused_signup_codes: u64,
}

/// Return summary statistics about the homeserver.
pub async fn info(State(state): State<AppState>) -> HttpResult<(StatusCode, Json<InfoResponse>)> {
    // Read-only transaction
    let rtxn = state.db.env.read_txn()?;

    // Count users, disabled flag, and accumulate usage
    let mut num_users = 0;
    let mut num_disabled_users = 0;
    let mut total_bytes = 0u64;
    let mut users_iter = state.db.tables.users.iter(&rtxn)?;
    while let Some(Ok((_pk, user))) = users_iter.next() {
        num_users += 1;
        if user.disabled {
            num_disabled_users += 1;
        }
        total_bytes = total_bytes.saturating_add(user.used_bytes);
    }

    // Count signup tokens and unused ones
    let mut num_signup_codes = 0;
    let mut num_unused_signup_codes = 0;
    let mut tokens_iter = state.db.tables.signup_tokens.iter(&rtxn)?;
    while let Some(Ok((_token_str, bytes))) = tokens_iter.next() {
        num_signup_codes += 1;
        let token: SignupToken = SignupToken::deserialize(bytes);
        if !token.is_used() {
            num_unused_signup_codes += 1;
        }
    }

    // Build response
    let body = InfoResponse {
        num_users,
        num_disabled_users,
        total_disk_used_mb: (total_bytes as f64) / (1024.0 * 1024.0),
        num_signup_codes,
        num_unused_signup_codes,
    };

    Ok((StatusCode::OK, Json(body)))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::admin::app_state::AppState;
    use crate::persistence::files::FileService;
    use crate::persistence::lmdb::LmDB;
    use axum::extract::State;
    use axum::http::StatusCode;
    use pkarr::Keypair;

    #[tokio::test]
    async fn test_info_counts() {
        // Setup test DB
        let mut db = LmDB::test();
        let key1 = Keypair::random().public_key();
        let key2 = Keypair::random().public_key();

        // 1) Create both users
        {
            db.create_user(&key1).unwrap();
            db.create_user(&key2).unwrap();
        }

        // 2) Modify usage and disabled flags
        {
            let mut wtxn = db.env.write_txn().unwrap();
            // User1: enabled, 1 MB
            let mut user1 = db
                .get_user(&key1, &db.env.read_txn().unwrap())
                .unwrap()
                .unwrap();
            user1.used_bytes = 1024 * 1024;
            db.tables.users.put(&mut wtxn, &key1, &user1).unwrap();

            // User2: disabled, 0.5 MB
            let mut user2 = db
                .get_user(&key2, &db.env.read_txn().unwrap())
                .unwrap()
                .unwrap();
            user2.disabled = true;
            user2.used_bytes = 512 * 1024;
            db.tables.users.put(&mut wtxn, &key2, &user2).unwrap();

            wtxn.commit().unwrap();
        }

        // 3) Create two signup tokens and consume one
        let code1 = db.generate_signup_token().unwrap();
        let _code2 = db.generate_signup_token().unwrap();
        db.validate_and_consume_signup_token(&code1, &key1).unwrap();

        // 4) Invoke handler
        let state = AppState::new(db.clone(), FileService::test(db));
        let (status, Json(info)) = info(State(state)).await.unwrap();
        assert_eq!(status, StatusCode::OK);
        assert_eq!(info.num_users, 2);
        assert_eq!(info.num_disabled_users, 1);
        // 1 MB + 0.5 MB = 1.5 MB
        assert!((info.total_disk_used_mb - 1.5).abs() < 1e-6);
        assert_eq!(info.num_signup_codes, 2);
        assert_eq!(info.num_unused_signup_codes, 1);
    }
}