tideway 0.7.17

A batteries-included Rust web framework built on Axum for building SaaS applications quickly
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
//! Membership manager.
//!
//! Handles membership operations with permission checks and seat validation.

use super::audit::{OrgAuditEntry, OrgAuditEvent};
use super::error::{OrganizationError, Result};
use super::manager::MembershipCreateParams;
use super::seats::{SeatChecker, UnlimitedSeats};
use super::storage::{MembershipStore, OptionalAuditStore, OrgAuditStore, WithAuditStore};
use super::utils::current_timestamp;
use tracing::{debug, info, instrument};

/// Membership manager - handles member operations with permission checks.
///
/// # Example
///
/// ```rust,ignore
/// use tideway::organizations::{MembershipManager, UnlimitedSeats};
///
/// let manager = MembershipManager::new(
///     membership_store,
///     org_store,
///     UnlimitedSeats,
/// );
///
/// // Add a member
/// let membership = manager.add_member(
///     "org_123",
///     "user_456",
///     "admin_user_id",
///     |params| MyMembership {
///         org_id: params.org_id,
///         user_id: params.user_id,
///         role: MyRole::Member,
///         joined_at: params.joined_at,
///     },
/// ).await?;
/// ```
///
/// # Audit Logging
///
/// Enable audit logging with `with_audit_store`:
///
/// ```rust,ignore
/// let manager = MembershipManager::new(...)
///     .with_audit_store(my_audit_store);
/// ```
pub struct MembershipManager<M, S = UnlimitedSeats, A = ()>
where
    M: MembershipStore,
    S: SeatChecker,
    A: OptionalAuditStore,
{
    membership_store: M,
    seat_checker: S,
    audit_store: A,
}

impl<M> MembershipManager<M, UnlimitedSeats, ()>
where
    M: MembershipStore,
{
    /// Create a manager without seat checking.
    #[must_use]
    pub fn new_without_seats(membership_store: M) -> Self {
        Self {
            membership_store,
            seat_checker: UnlimitedSeats,
            audit_store: (),
        }
    }
}

impl<M, S> MembershipManager<M, S, ()>
where
    M: MembershipStore,
    S: SeatChecker,
{
    /// Create a new membership manager.
    #[must_use]
    pub fn new(membership_store: M, seat_checker: S) -> Self {
        Self {
            membership_store,
            seat_checker,
            audit_store: (),
        }
    }

    /// Enable audit logging with the given store.
    pub fn with_audit_store<AuditStore: OrgAuditStore + Clone + 'static>(
        self,
        audit_store: AuditStore,
    ) -> MembershipManager<M, S, WithAuditStore<AuditStore>> {
        MembershipManager {
            membership_store: self.membership_store,
            seat_checker: self.seat_checker,
            audit_store: WithAuditStore(audit_store),
        }
    }
}

impl<M, S, A> MembershipManager<M, S, A>
where
    M: MembershipStore,
    S: SeatChecker,
    A: OptionalAuditStore,
{
    /// Get a reference to the membership store.
    pub fn membership_store(&self) -> &M {
        &self.membership_store
    }

    /// Get a reference to the seat checker.
    pub fn seat_checker(&self) -> &S {
        &self.seat_checker
    }

    /// Add a member to an organization (checks seat availability).
    ///
    /// User provides factory to create their Membership type with their Role.
    #[instrument(skip(self, membership_factory))]
    pub async fn add_member<F>(
        &self,
        org_id: &str,
        user_id: &str,
        actor_id: &str,
        membership_factory: F,
    ) -> Result<M::Membership>
    where
        F: FnOnce(MembershipCreateParams) -> M::Membership,
    {
        // Check actor has permission to add members
        let actor_membership = self
            .membership_store
            .get_membership(org_id, actor_id)
            .await?
            .ok_or(OrganizationError::NotMember)?;

        let actor_role = self.membership_store.membership_role(&actor_membership);
        if !self.membership_store.can_manage_members(&actor_role) {
            return Err(OrganizationError::insufficient_permission(
                "can_manage_members",
            ));
        }

        // Check user is not already a member
        if self.membership_store.is_member(org_id, user_id).await? {
            return Err(OrganizationError::AlreadyMember);
        }

        // Check seat availability
        let current_count = self.membership_store.count_members(org_id).await?;
        if !self
            .seat_checker
            .has_seat_available(org_id, current_count)
            .await?
        {
            let limit = self
                .seat_checker
                .get_seat_limit(org_id)
                .await?
                .unwrap_or(current_count);
            return Err(OrganizationError::seat_limit_reached(current_count, limit));
        }

        let now = current_timestamp();

        // Create membership using user's factory
        let membership = membership_factory(MembershipCreateParams {
            org_id: org_id.to_string(),
            user_id: user_id.to_string(),
            is_owner: false,
            joined_at: now,
        });

        // Persist membership
        self.membership_store.add_member(&membership).await?;

        info!(org_id, user_id, actor_id, "Member added");

        // Record audit event
        self.audit_store
            .record(
                OrgAuditEntry::new(OrgAuditEvent::MemberAdded, org_id, actor_id)
                    .with_target(user_id),
            )
            .await;

        Ok(membership)
    }

    /// Remove a member from an organization (Owner cannot be removed).
    #[instrument(skip(self))]
    pub async fn remove_member(&self, org_id: &str, user_id: &str, actor_id: &str) -> Result<()> {
        // Check actor has permission
        let actor_membership = self
            .membership_store
            .get_membership(org_id, actor_id)
            .await?
            .ok_or(OrganizationError::NotMember)?;

        let actor_role = self.membership_store.membership_role(&actor_membership);
        if !self.membership_store.can_manage_members(&actor_role) {
            return Err(OrganizationError::insufficient_permission(
                "can_manage_members",
            ));
        }

        // Check target is a member
        let target_membership = self
            .membership_store
            .get_membership(org_id, user_id)
            .await?
            .ok_or(OrganizationError::NotMember)?;

        // Cannot remove owner
        let target_role = self.membership_store.membership_role(&target_membership);
        if self.membership_store.is_owner(&target_role) {
            return Err(OrganizationError::CannotRemoveOwner);
        }

        // Remove membership
        self.membership_store.remove_member(org_id, user_id).await?;

        info!(org_id, user_id, actor_id, "Member removed");

        // Record audit event
        self.audit_store
            .record(
                OrgAuditEntry::new(OrgAuditEvent::MemberRemoved, org_id, actor_id)
                    .with_target(user_id),
            )
            .await;

        Ok(())
    }

    /// Leave an organization (member removes themselves).
    ///
    /// Owners cannot leave - they must transfer ownership first.
    #[instrument(skip(self))]
    pub async fn leave(&self, org_id: &str, user_id: &str) -> Result<()> {
        // Check user is a member
        let membership = self
            .membership_store
            .get_membership(org_id, user_id)
            .await?
            .ok_or(OrganizationError::NotMember)?;

        // Owners cannot leave
        let role = self.membership_store.membership_role(&membership);
        if self.membership_store.is_owner(&role) {
            return Err(OrganizationError::CannotRemoveOwner);
        }

        // Remove membership
        self.membership_store.remove_member(org_id, user_id).await?;

        info!(org_id, user_id, "Member left organization");

        // Record audit event (actor is the member themselves)
        self.audit_store
            .record(OrgAuditEntry::new(
                OrgAuditEvent::MemberLeft,
                org_id,
                user_id,
            ))
            .await;

        Ok(())
    }

    /// Update a member's data (role change, etc).
    #[instrument(skip(self, updater))]
    pub async fn update_membership<F>(
        &self,
        org_id: &str,
        user_id: &str,
        actor_id: &str,
        updater: F,
    ) -> Result<M::Membership>
    where
        F: FnOnce(&M::Membership) -> M::Membership,
    {
        // Check actor has permission
        let actor_membership = self
            .membership_store
            .get_membership(org_id, actor_id)
            .await?
            .ok_or(OrganizationError::NotMember)?;

        let actor_role = self.membership_store.membership_role(&actor_membership);
        if !self.membership_store.can_manage_members(&actor_role) {
            return Err(OrganizationError::insufficient_permission(
                "can_manage_members",
            ));
        }

        // Get current membership
        let current = self
            .membership_store
            .get_membership(org_id, user_id)
            .await?
            .ok_or(OrganizationError::NotMember)?;

        // Cannot modify owner role (use transfer_ownership instead)
        let current_role = self.membership_store.membership_role(&current);
        if self.membership_store.is_owner(&current_role) {
            return Err(OrganizationError::insufficient_permission(
                "cannot modify owner role directly",
            ));
        }

        // Apply update
        let updated = updater(&current);

        // Prevent promoting to owner via update (must use transfer_ownership)
        let new_role = self.membership_store.membership_role(&updated);
        if self.membership_store.is_owner(&new_role) {
            return Err(OrganizationError::insufficient_permission(
                "cannot promote to owner via update, use transfer_ownership instead",
            ));
        }

        // Persist
        self.membership_store.update_membership(&updated).await?;

        debug!(org_id, user_id, actor_id, "Membership updated");

        // Record audit event
        self.audit_store
            .record(
                OrgAuditEntry::new(OrgAuditEvent::MemberRoleChanged, org_id, actor_id)
                    .with_target(user_id),
            )
            .await;

        Ok(updated)
    }

    /// Transfer ownership to another member.
    #[instrument(skip(self, make_owner, demote_owner))]
    pub async fn transfer_ownership<F, G>(
        &self,
        org_id: &str,
        new_owner_id: &str,
        actor_id: &str,
        make_owner: F,
        demote_owner: G,
    ) -> Result<()>
    where
        F: FnOnce(&M::Membership) -> M::Membership,
        G: FnOnce(&M::Membership) -> M::Membership,
    {
        // Check actor has permission
        let actor_membership = self
            .membership_store
            .get_membership(org_id, actor_id)
            .await?
            .ok_or(OrganizationError::NotMember)?;

        let actor_role = self.membership_store.membership_role(&actor_membership);
        if !self.membership_store.can_transfer_ownership(&actor_role) {
            return Err(OrganizationError::insufficient_permission(
                "can_transfer_ownership",
            ));
        }

        // Check new owner is a member
        let new_owner_membership = self
            .membership_store
            .get_membership(org_id, new_owner_id)
            .await?
            .ok_or(OrganizationError::NotMember)?;

        // Prepare both updates
        let demoted = demote_owner(&actor_membership);
        let promoted = make_owner(&new_owner_membership);

        // Update both atomically (uses transaction in SeaORM, sequential in default impl)
        self.membership_store
            .update_memberships_atomic(&[demoted, promoted])
            .await?;

        info!(
            org_id,
            new_owner_id,
            former_owner = actor_id,
            "Ownership transferred"
        );

        // Record audit event
        self.audit_store
            .record(
                OrgAuditEntry::new(OrgAuditEvent::OwnershipTransferred, org_id, actor_id)
                    .with_target(new_owner_id),
            )
            .await;

        Ok(())
    }

    /// Get membership for a user.
    pub async fn get_membership(
        &self,
        org_id: &str,
        user_id: &str,
    ) -> Result<Option<M::Membership>> {
        self.membership_store
            .get_membership(org_id, user_id)
            .await
            .map_err(Into::into)
    }

    /// List all members of an organization.
    pub async fn list_members(&self, org_id: &str) -> Result<Vec<M::Membership>> {
        self.membership_store
            .list_members(org_id)
            .await
            .map_err(Into::into)
    }

    /// Check if user is a member.
    pub async fn is_member(&self, org_id: &str, user_id: &str) -> Result<bool> {
        self.membership_store
            .is_member(org_id, user_id)
            .await
            .map_err(Into::into)
    }

    /// Check if user has can_manage_members permission.
    pub async fn can_manage_members(&self, org_id: &str, user_id: &str) -> Result<bool> {
        let membership = self
            .membership_store
            .get_membership(org_id, user_id)
            .await?;
        Ok(membership.is_some_and(|m| {
            let role = self.membership_store.membership_role(&m);
            self.membership_store.can_manage_members(&role)
        }))
    }

    /// Check if user has can_manage_settings permission.
    pub async fn can_manage_settings(&self, org_id: &str, user_id: &str) -> Result<bool> {
        let membership = self
            .membership_store
            .get_membership(org_id, user_id)
            .await?;
        Ok(membership.is_some_and(|m| {
            let role = self.membership_store.membership_role(&m);
            self.membership_store.can_manage_settings(&role)
        }))
    }

    /// Check if user has can_delete_org permission.
    pub async fn can_delete_org(&self, org_id: &str, user_id: &str) -> Result<bool> {
        let membership = self
            .membership_store
            .get_membership(org_id, user_id)
            .await?;
        Ok(membership.is_some_and(|m| {
            let role = self.membership_store.membership_role(&m);
            self.membership_store.can_delete_org(&role)
        }))
    }

    /// Count members in an organization.
    pub async fn count_members(&self, org_id: &str) -> Result<u32> {
        self.membership_store
            .count_members(org_id)
            .await
            .map_err(Into::into)
    }
}