allowthem-core 0.0.6

Core types, database, and auth logic for allowthem
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
use crate::db::Db;
use crate::error::AuthError;
use crate::event_sink::AuthEvent;
use crate::handle::AllowThem;
use crate::types::{Role, RoleId, RoleName, UserId};

/// Map a SQLite UNIQUE constraint violation on `allowthem_roles.name` to
/// `AuthError::Conflict`. Other errors pass through as `AuthError::Database`.
fn map_unique_violation(err: sqlx::Error) -> AuthError {
    if let sqlx::Error::Database(ref db_err) = err {
        let msg = db_err.message();
        if msg.contains("UNIQUE constraint failed") && msg.contains("name") {
            return AuthError::Conflict("role name already exists".into());
        }
    }
    AuthError::Database(err)
}

impl Db {
    /// Create a role with a unique name and optional description.
    pub async fn create_role(
        &self,
        name: &RoleName,
        description: Option<&str>,
    ) -> Result<Role, AuthError> {
        let id = RoleId::new();
        sqlx::query_as::<_, Role>(
            "INSERT INTO allowthem_roles (id, name, description) \
             VALUES (?, ?, ?) \
             RETURNING id, name, description, created_at",
        )
        .bind(id)
        .bind(name)
        .bind(description)
        .fetch_one(self.pool())
        .await
        .map_err(map_unique_violation)
    }

    /// Get a role by ID. Returns `None` if not found.
    pub async fn get_role(&self, id: &RoleId) -> Result<Option<Role>, AuthError> {
        sqlx::query_as::<_, Role>(
            "SELECT id, name, description, created_at FROM allowthem_roles WHERE id = ?",
        )
        .bind(*id)
        .fetch_optional(self.pool())
        .await
        .map_err(AuthError::Database)
    }

    /// Get a role by name. Returns `None` if not found.
    pub async fn get_role_by_name(&self, name: &RoleName) -> Result<Option<Role>, AuthError> {
        sqlx::query_as::<_, Role>(
            "SELECT id, name, description, created_at FROM allowthem_roles WHERE name = ?",
        )
        .bind(name)
        .fetch_optional(self.pool())
        .await
        .map_err(AuthError::Database)
    }

    /// List all roles, ordered by creation time.
    pub async fn list_roles(&self) -> Result<Vec<Role>, AuthError> {
        sqlx::query_as::<_, Role>(
            "SELECT id, name, description, created_at FROM allowthem_roles ORDER BY created_at",
        )
        .fetch_all(self.pool())
        .await
        .map_err(AuthError::Database)
    }

    /// Update a role's name and description. Returns the updated role.
    ///
    /// Returns `AuthError::NotFound` if no role with `id` exists.
    /// Returns `AuthError::Conflict` if `name` is already taken by another role.
    pub async fn update_role(
        &self,
        id: &RoleId,
        name: &RoleName,
        description: Option<&str>,
    ) -> Result<Role, AuthError> {
        sqlx::query_as::<_, Role>(
            "UPDATE allowthem_roles SET name = ?1, description = ?2 WHERE id = ?3 \
             RETURNING id, name, description, created_at",
        )
        .bind(name)
        .bind(description)
        .bind(*id)
        .fetch_optional(self.pool())
        .await
        .map_err(map_unique_violation)?
        .ok_or(AuthError::NotFound)
    }

    /// Delete a role by ID. Returns `true` if a row was deleted, `false` if not found.
    ///
    /// Cascades to `allowthem_user_roles` and `allowthem_role_permissions`.
    pub async fn delete_role(&self, id: &RoleId) -> Result<bool, AuthError> {
        let result = sqlx::query("DELETE FROM allowthem_roles WHERE id = ?")
            .bind(*id)
            .execute(self.pool())
            .await
            .map_err(AuthError::Database)?;
        Ok(result.rows_affected() > 0)
    }

    /// Assign a role to a user. Silently succeeds if already assigned (idempotent).
    pub async fn assign_role(&self, user_id: &UserId, role_id: &RoleId) -> Result<(), AuthError> {
        sqlx::query("INSERT OR IGNORE INTO allowthem_user_roles (user_id, role_id) VALUES (?, ?)")
            .bind(*user_id)
            .bind(*role_id)
            .execute(self.pool())
            .await
            .map_err(AuthError::Database)?;
        Ok(())
    }

    /// Unassign a role from a user. Returns `true` if removed, `false` if the assignment
    /// did not exist.
    pub async fn unassign_role(
        &self,
        user_id: &UserId,
        role_id: &RoleId,
    ) -> Result<bool, AuthError> {
        let result =
            sqlx::query("DELETE FROM allowthem_user_roles WHERE user_id = ? AND role_id = ?")
                .bind(*user_id)
                .bind(*role_id)
                .execute(self.pool())
                .await
                .map_err(AuthError::Database)?;
        Ok(result.rows_affected() > 0)
    }

    /// Check whether a user has a specific role by name.
    pub async fn has_role(
        &self,
        user_id: &UserId,
        role_name: &RoleName,
    ) -> Result<bool, AuthError> {
        let count: i64 = sqlx::query_scalar(
            "SELECT COUNT(*) \
             FROM allowthem_user_roles ur \
             JOIN allowthem_roles r ON r.id = ur.role_id \
             WHERE ur.user_id = ? AND r.name = ?",
        )
        .bind(*user_id)
        .bind(role_name)
        .fetch_one(self.pool())
        .await
        .map_err(AuthError::Database)?;
        Ok(count > 0)
    }

    /// Return all roles assigned to a user, ordered by creation time.
    pub async fn get_user_roles(&self, user_id: &UserId) -> Result<Vec<Role>, AuthError> {
        sqlx::query_as::<_, Role>(
            "SELECT r.id, r.name, r.description, r.created_at \
             FROM allowthem_roles r \
             JOIN allowthem_user_roles ur ON ur.role_id = r.id \
             WHERE ur.user_id = ? \
             ORDER BY r.created_at",
        )
        .bind(*user_id)
        .fetch_all(self.pool())
        .await
        .map_err(AuthError::Database)
    }

    /// Create each named role if it does not already exist.
    ///
    /// Returns roles in the same order as `names`. Idempotent: existing roles
    /// are fetched, not re-created. Duplicates within `names` are allowed; each
    /// name is resolved independently.
    pub async fn bootstrap_roles(&self, names: &[&str]) -> Result<Vec<Role>, AuthError> {
        let mut roles = Vec::with_capacity(names.len());
        for &name in names {
            let rn = RoleName::new(name);
            let role = match self.get_role_by_name(&rn).await? {
                Some(r) => r,
                None => self.create_role(&rn, None).await?,
            };
            roles.push(role);
        }
        Ok(roles)
    }

    /// Return the name of the first role in `hierarchy` that the user holds.
    ///
    /// `hierarchy[0]` is treated as the highest role. Returns `None` if the user
    /// holds none of the listed roles. An empty `hierarchy` always returns `None`.
    pub async fn resolve_highest_role(
        &self,
        user_id: &UserId,
        hierarchy: &[&str],
    ) -> Result<Option<String>, AuthError> {
        for &name in hierarchy {
            let rn = RoleName::new(name);
            if self.has_role(user_id, &rn).await? {
                return Ok(Some(name.to_owned()));
            }
        }
        Ok(None)
    }
}

impl AllowThem {
    pub async fn assign_role(&self, user_id: &UserId, role_id: &RoleId) -> Result<(), AuthError> {
        self.db().assign_role(user_id, role_id).await?;
        self.emit_event(AuthEvent::new(
            "role.assigned",
            Some(*user_id),
            serde_json::json!({ "user_id": user_id, "role_id": role_id }),
        ))
        .await;
        Ok(())
    }

    pub async fn unassign_role(&self, user_id: &UserId, role_id: &RoleId) -> Result<(), AuthError> {
        self.db().unassign_role(user_id, role_id).await?;
        self.emit_event(AuthEvent::new(
            "role.revoked",
            Some(*user_id),
            serde_json::json!({ "user_id": user_id, "role_id": role_id }),
        ))
        .await;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::handle::{AllowThem, AllowThemBuilder};
    use crate::types::Email;

    async fn setup() -> AllowThem {
        AllowThemBuilder::new("sqlite::memory:")
            .cookie_secure(false)
            .build()
            .await
            .unwrap()
    }

    #[tokio::test]
    async fn update_role_changes_name_and_description() {
        let ath = setup().await;
        let db = ath.db();
        let rn = RoleName::new("old-name");
        let role = db.create_role(&rn, Some("old desc")).await.unwrap();
        let new_name = RoleName::new("new-name");
        let updated = db
            .update_role(&role.id, &new_name, Some("new desc"))
            .await
            .unwrap();
        assert_eq!(updated.name.as_str(), "new-name");
        assert_eq!(updated.description.as_deref(), Some("new desc"));
        assert_eq!(updated.id, role.id);
    }

    #[tokio::test]
    async fn update_role_not_found_returns_error() {
        let ath = setup().await;
        let db = ath.db();
        let missing = RoleId::new();
        let name = RoleName::new("x");
        let err = db.update_role(&missing, &name, None).await.unwrap_err();
        assert!(matches!(err, AuthError::NotFound));
    }

    #[tokio::test]
    async fn bootstrap_roles_creates_missing_roles() {
        let ath = setup().await;
        let db = ath.db();
        let roles = db.bootstrap_roles(&["admin", "editor"]).await.unwrap();
        assert_eq!(roles.len(), 2);
        assert_eq!(roles[0].name.as_str(), "admin");
        assert_eq!(roles[1].name.as_str(), "editor");
    }

    #[tokio::test]
    async fn bootstrap_roles_idempotent() {
        let ath = setup().await;
        let db = ath.db();
        let first = db.bootstrap_roles(&["admin", "editor"]).await.unwrap();
        let second = db.bootstrap_roles(&["admin", "editor"]).await.unwrap();
        assert_eq!(first[0].id, second[0].id);
        assert_eq!(first[1].id, second[1].id);
    }

    #[tokio::test]
    async fn bootstrap_roles_returns_in_input_order() {
        let ath = setup().await;
        let db = ath.db();
        let roles = db
            .bootstrap_roles(&["viewer", "admin", "editor"])
            .await
            .unwrap();
        assert_eq!(roles[0].name.as_str(), "viewer");
        assert_eq!(roles[1].name.as_str(), "admin");
        assert_eq!(roles[2].name.as_str(), "editor");
    }

    #[tokio::test]
    async fn bootstrap_roles_mixed_existing_and_new() {
        let ath = setup().await;
        let db = ath.db();
        let rn = RoleName::new("admin");
        db.create_role(&rn, None).await.unwrap();
        let roles = db.bootstrap_roles(&["admin", "viewer"]).await.unwrap();
        assert_eq!(roles.len(), 2);
        assert_eq!(roles[0].name.as_str(), "admin");
        assert_eq!(roles[1].name.as_str(), "viewer");
    }

    #[tokio::test]
    async fn bootstrap_roles_empty_slice_returns_empty_vec() {
        let ath = setup().await;
        let db = ath.db();
        let roles = db.bootstrap_roles(&[]).await.unwrap();
        assert!(roles.is_empty());
    }

    #[tokio::test]
    async fn resolve_highest_role_returns_first_match() {
        let ath = setup().await;
        let db = ath.db();
        let email = Email::new("user@example.com".into()).unwrap();
        let user = db
            .create_user(email, "password123", None, None)
            .await
            .unwrap();
        let roles = db
            .bootstrap_roles(&["admin", "editor", "viewer"])
            .await
            .unwrap();
        db.assign_role(&user.id, &roles[1].id).await.unwrap(); // editor
        db.assign_role(&user.id, &roles[2].id).await.unwrap(); // viewer
        let result = db
            .resolve_highest_role(&user.id, &["admin", "editor", "viewer"])
            .await
            .unwrap();
        assert_eq!(result, Some("editor".to_owned()));
    }

    #[tokio::test]
    async fn resolve_highest_role_returns_none_when_no_roles() {
        let ath = setup().await;
        let db = ath.db();
        let email = Email::new("noroles@example.com".into()).unwrap();
        let user = db
            .create_user(email, "password123", None, None)
            .await
            .unwrap();
        let result = db
            .resolve_highest_role(&user.id, &["admin", "editor"])
            .await
            .unwrap();
        assert!(result.is_none());
    }

    #[tokio::test]
    async fn resolve_highest_role_returns_none_for_empty_hierarchy() {
        let ath = setup().await;
        let db = ath.db();
        let email = Email::new("emptyhier@example.com".into()).unwrap();
        let user = db
            .create_user(email, "password123", None, None)
            .await
            .unwrap();
        let result = db.resolve_highest_role(&user.id, &[]).await.unwrap();
        assert!(result.is_none());
    }

    #[tokio::test]
    async fn resolve_highest_role_returns_highest_when_user_has_all() {
        let ath = setup().await;
        let db = ath.db();
        let email = Email::new("allroles@example.com".into()).unwrap();
        let user = db
            .create_user(email, "password123", None, None)
            .await
            .unwrap();
        let roles = db
            .bootstrap_roles(&["admin", "editor", "viewer"])
            .await
            .unwrap();
        for role in &roles {
            db.assign_role(&user.id, &role.id).await.unwrap();
        }
        let result = db
            .resolve_highest_role(&user.id, &["admin", "editor", "viewer"])
            .await
            .unwrap();
        assert_eq!(result, Some("admin".to_owned()));
    }

    #[tokio::test]
    async fn resolve_highest_role_only_considers_listed_roles() {
        let ath = setup().await;
        let db = ath.db();
        let email = Email::new("unlisted@example.com".into()).unwrap();
        let user = db
            .create_user(email, "password123", None, None)
            .await
            .unwrap();
        let rn = RoleName::new("superuser");
        let role = db.create_role(&rn, None).await.unwrap();
        db.assign_role(&user.id, &role.id).await.unwrap();
        let result = db
            .resolve_highest_role(&user.id, &["admin", "editor"])
            .await
            .unwrap();
        assert!(result.is_none());
    }
}