keepsake 0.5.1

Deterministic lifecycle model for auditable relation assignments
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

//! Provider traits for persistence and fulfillment snapshots.

use std::error::Error;
use std::future::Future;
use std::pin::Pin;

use crate::command::{ApplyKeepsake, RevokeKeepsake};
use crate::model::{
    ActiveRelation, FulfillmentSnapshot, Keepsake, KeepsakeId, RelationId, RelationKey, SubjectRef,
};

#[cfg(any(test, feature = "test"))]
mod memory;

#[cfg(any(test, feature = "test"))]
pub use memory::{
    ActiveRelationSeed, InMemoryActiveRelations, InMemoryActiveRelationsError,
    InMemoryFulfillmentProvider, InMemoryFulfillmentProviderError, InMemoryKeepsakeStore,
    InMemoryKeepsakeStoreError,
};

/// Result alias for provider operations.
pub type ProviderResult<T, E> = core::result::Result<T, E>;

/// Application-owned fulfillment snapshot provider.
pub trait FulfillmentProvider: Send + Sync {
    /// Provider-specific error type.
    type Error: Error + Send + Sync + 'static;

    /// Returns the current fulfillment snapshot for a keepsake.
    fn snapshot(
        &self,
        keepsake: &Keepsake,
    ) -> ProviderResult<Option<FulfillmentSnapshot>, Self::Error>;
}

/// Persistence boundary for keepsake operations.
pub trait KeepsakeStore: Send + Sync {
    /// Store-specific error type.
    type Error: Error + Send + Sync + 'static;

    /// Applies a keepsake.
    fn apply(&self, command: &ApplyKeepsake) -> ProviderResult<Keepsake, Self::Error>;

    /// Revokes a keepsake.
    fn revoke(&self, command: &RevokeKeepsake) -> ProviderResult<Keepsake, Self::Error>;

    /// Finds active keepsakes for a subject.
    fn active_for_subject(
        &self,
        subject: &SubjectRef,
    ) -> ProviderResult<Vec<Keepsake>, Self::Error>;

    /// Finds a keepsake by id.
    fn get(&self, id: KeepsakeId) -> ProviderResult<Option<Keepsake>, Self::Error>;
}

/// Async read-side boundary for active relation state.
///
/// Prefer generic callers such as `S: ActiveRelationSource` for library and
/// adapter code. Use [`DynActiveRelationSource`] only where application
/// composition needs runtime erasure.
pub trait ActiveRelationSource: Send + Sync {
    /// Source-specific error type.
    type Error: Error + Send + Sync + 'static;

    /// Finds active relation memberships for a subject.
    fn active_relations_for_subject<'a>(
        &'a self,
        subject: &'a SubjectRef,
    ) -> impl Future<Output = ProviderResult<Vec<ActiveRelation>, Self::Error>> + Send + 'a;

    /// Finds active relation memberships for a subject, filtered by relation ids.
    fn active_relations_for_subject_by_ids<'a>(
        &'a self,
        subject: &'a SubjectRef,
        relation_ids: &'a [RelationId],
    ) -> impl Future<Output = ProviderResult<Vec<ActiveRelation>, Self::Error>> + Send + 'a;

    /// Finds active relation memberships for a subject, filtered by relation keys.
    fn active_relations_for_subject_by_keys<'a>(
        &'a self,
        subject: &'a SubjectRef,
        keys: &'a [RelationKey],
    ) -> impl Future<Output = ProviderResult<Vec<ActiveRelation>, Self::Error>> + Send + 'a;
}

/// Boxed future returned by erased active relation sources.
pub type DynActiveRelationFuture<'a, E> =
    Pin<Box<dyn Future<Output = ProviderResult<Vec<ActiveRelation>, E>> + Send + 'a>>;

/// Object-safe active relation source for application composition boundaries.
///
/// This trait exists for places that genuinely need heterogeneous runtime
/// storage, such as `Arc<dyn DynActiveRelationSource<Error = E>>`. Prefer
/// [`ActiveRelationSource`] in reusable library APIs.
pub trait DynActiveRelationSource: Send + Sync {
    /// Source-specific error type.
    type Error: Error + Send + Sync + 'static;

    /// Finds active relation memberships for a subject.
    fn active_relations_for_subject<'a>(
        &'a self,
        subject: &'a SubjectRef,
    ) -> DynActiveRelationFuture<'a, Self::Error>;

    /// Finds active relation memberships for a subject, filtered by relation ids.
    fn active_relations_for_subject_by_ids<'a>(
        &'a self,
        subject: &'a SubjectRef,
        relation_ids: &'a [RelationId],
    ) -> DynActiveRelationFuture<'a, Self::Error>;

    /// Finds active relation memberships for a subject, filtered by relation keys.
    fn active_relations_for_subject_by_keys<'a>(
        &'a self,
        subject: &'a SubjectRef,
        keys: &'a [RelationKey],
    ) -> DynActiveRelationFuture<'a, Self::Error>;
}

impl<T> DynActiveRelationSource for T
where
    T: ActiveRelationSource,
{
    type Error = T::Error;

    fn active_relations_for_subject<'a>(
        &'a self,
        subject: &'a SubjectRef,
    ) -> DynActiveRelationFuture<'a, Self::Error> {
        Box::pin(ActiveRelationSource::active_relations_for_subject(
            self, subject,
        ))
    }

    fn active_relations_for_subject_by_ids<'a>(
        &'a self,
        subject: &'a SubjectRef,
        relation_ids: &'a [RelationId],
    ) -> DynActiveRelationFuture<'a, Self::Error> {
        Box::pin(ActiveRelationSource::active_relations_for_subject_by_ids(
            self,
            subject,
            relation_ids,
        ))
    }

    fn active_relations_for_subject_by_keys<'a>(
        &'a self,
        subject: &'a SubjectRef,
        keys: &'a [RelationKey],
    ) -> DynActiveRelationFuture<'a, Self::Error> {
        Box::pin(ActiveRelationSource::active_relations_for_subject_by_keys(
            self, subject, keys,
        ))
    }
}