allsource-core 0.19.1

High-performance event store core built in Rust
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
use crate::{
    domain::{
        entities::Event,
        value_objects::{EntityId, PartitionKey},
    },
    error::{AllSourceError, Result},
};
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

/// Event Stream aggregate enforcing gapless version numbers
///
/// Inspired by SierraDB's watermark pattern for consistent event sourcing.
/// Ensures no gaps in version sequences, critical for proper event replay.
///
/// # SierraDB Pattern
/// - Watermark tracks "highest continuously confirmed sequence"
/// - Prevents gaps that would break event sourcing guarantees
/// - Uses optimistic locking for concurrency control
///
/// # Invariants
/// - Versions start at 1 and increment sequentially
/// - No gaps allowed in version sequence
/// - Watermark <= max version always
/// - All versions below watermark are confirmed (gapless)
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EventStream {
    /// Stream identifier (usually entity ID)
    stream_id: EntityId,

    /// Partition key for distribution
    partition_key: PartitionKey,

    /// Current version (last event)
    current_version: u64,

    /// Watermark: highest continuously confirmed version
    /// All versions <= watermark are guaranteed gapless
    watermark: u64,

    /// Events in this stream
    events: Vec<Event>,

    /// Expected version for optimistic locking
    /// Used to detect concurrent modifications
    expected_version: Option<u64>,

    /// Stream metadata
    created_at: DateTime<Utc>,
    updated_at: DateTime<Utc>,
}

impl EventStream {
    /// Create a new event stream
    pub fn new(stream_id: EntityId) -> Self {
        let partition_key = PartitionKey::from_entity_id(stream_id.as_str());
        let now = Utc::now();

        Self {
            stream_id,
            partition_key,
            current_version: 0,
            watermark: 0,
            events: Vec::new(),
            expected_version: None,
            created_at: now,
            updated_at: now,
        }
    }

    /// Reconstruct an EventStream from persistent storage
    ///
    /// Used by repository implementations to restore streams from database.
    /// Bypasses validation since data is already validated at creation time.
    ///
    /// # Arguments
    /// - `stream_id`: Entity ID of the stream
    /// - `partition_key`: Pre-computed partition assignment
    /// - `current_version`: Latest version number
    /// - `watermark`: Highest continuously confirmed version
    /// - `events`: All events in the stream
    /// - `expected_version`: Optional optimistic lock version
    /// - `created_at`: Stream creation timestamp
    /// - `updated_at`: Last modification timestamp
    pub fn reconstruct(
        stream_id: EntityId,
        partition_key: PartitionKey,
        current_version: u64,
        watermark: u64,
        events: Vec<Event>,
        expected_version: Option<u64>,
        created_at: DateTime<Utc>,
        updated_at: DateTime<Utc>,
    ) -> Result<Self> {
        // Basic validation
        if watermark > current_version {
            return Err(AllSourceError::InvalidInput(format!(
                "Watermark ({watermark}) cannot exceed current version ({current_version})"
            )));
        }

        if events.len() as u64 != current_version {
            return Err(AllSourceError::InvalidInput(format!(
                "Event count ({}) must match current version ({})",
                events.len(),
                current_version
            )));
        }

        Ok(Self {
            stream_id,
            partition_key,
            current_version,
            watermark,
            events,
            expected_version,
            created_at,
            updated_at,
        })
    }

    /// Append an event with optimistic locking
    ///
    /// # SierraDB Pattern
    /// - Checks expected_version matches current_version
    /// - Prevents concurrent modification conflicts
    /// - Ensures gapless version sequence
    pub fn append_event(&mut self, event: Event) -> Result<u64> {
        // Optimistic locking check
        if let Some(expected) = self.expected_version
            && expected != self.current_version
        {
            return Err(AllSourceError::ConcurrencyError(format!(
                "Version conflict: expected {}, got {}",
                expected, self.current_version
            )));
        }

        // Increment version
        self.current_version += 1;
        let new_version = self.current_version;

        // Store event
        self.events.push(event);

        // Advance watermark (all previous events confirmed)
        self.watermark = new_version;

        self.updated_at = Utc::now();

        Ok(new_version)
    }

    /// Set expected version for next append (optimistic locking)
    pub fn expect_version(&mut self, version: u64) {
        self.expected_version = Some(version);
    }

    /// Clear expected version
    pub fn clear_expected_version(&mut self) {
        self.expected_version = None;
    }

    /// Get events from version (inclusive)
    pub fn events_from(&self, from_version: u64) -> Vec<&Event> {
        if from_version == 0 || from_version > self.current_version {
            return Vec::new();
        }

        let start_idx = (from_version - 1) as usize;
        self.events[start_idx..].iter().collect()
    }

    /// Check if stream has gapless versions up to watermark
    pub fn is_gapless(&self) -> bool {
        if self.watermark > self.current_version {
            return false; // Watermark shouldn't exceed current version
        }

        // Check all versions up to watermark exist
        for version in 1..=self.watermark {
            let idx = (version - 1) as usize;
            if idx >= self.events.len() {
                return false;
            }
        }

        true
    }

    // Getters
    pub fn stream_id(&self) -> &EntityId {
        &self.stream_id
    }

    pub fn partition_key(&self) -> &PartitionKey {
        &self.partition_key
    }

    pub fn current_version(&self) -> u64 {
        self.current_version
    }

    pub fn watermark(&self) -> u64 {
        self.watermark
    }

    pub fn event_count(&self) -> usize {
        self.events.len()
    }

    pub fn created_at(&self) -> DateTime<Utc> {
        self.created_at
    }

    pub fn updated_at(&self) -> DateTime<Utc> {
        self.updated_at
    }

    pub fn expected_version(&self) -> Option<u64> {
        self.expected_version
    }

    // Tenant isolation methods

    /// Get the tenant ID for this stream
    ///
    /// Returns the tenant_id from the first event, or None if the stream is empty.
    /// All events in a stream should belong to the same tenant.
    pub fn tenant_id(&self) -> Option<&crate::domain::value_objects::TenantId> {
        self.events.first().map(super::event::Event::tenant_id)
    }

    /// Validate that all events in the stream belong to the same tenant
    ///
    /// Returns true if the stream is empty or all events have the same tenant_id.
    /// This is a safety check to detect tenant isolation violations.
    pub fn has_consistent_tenant(&self) -> bool {
        if self.events.is_empty() {
            return true;
        }

        let first_tenant = self.events[0].tenant_id();
        self.events.iter().all(|e| e.tenant_id() == first_tenant)
    }

    /// Validate that an event belongs to this stream's tenant
    ///
    /// Returns an error if:
    /// - The stream has events and the new event's tenant doesn't match
    ///
    /// This ensures tenant isolation at the stream level.
    pub fn validate_event_tenant(&self, event: &Event) -> Result<()> {
        if let Some(stream_tenant) = self.tenant_id()
            && event.tenant_id() != stream_tenant
        {
            return Err(AllSourceError::ValidationError(format!(
                "Tenant mismatch: stream belongs to '{}', but event belongs to '{}'",
                stream_tenant.as_str(),
                event.tenant_id().as_str()
            )));
        }
        Ok(())
    }

    /// Append an event with tenant validation
    ///
    /// Like `append_event`, but also validates tenant consistency.
    /// Prevents cross-tenant event appends for security.
    pub fn append_event_with_tenant_check(&mut self, event: Event) -> Result<u64> {
        // Validate tenant consistency
        self.validate_event_tenant(&event)?;

        // Proceed with normal append
        self.append_event(event)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    fn create_test_event(entity_id: &str) -> Event {
        Event::from_strings(
            "test.event".to_string(),
            entity_id.to_string(),
            "default".to_string(),
            json!({"data": "test"}),
            None,
        )
        .unwrap()
    }

    #[test]
    fn test_new_stream() {
        let stream_id = EntityId::new("stream-1".to_string()).unwrap();
        let stream = EventStream::new(stream_id.clone());

        assert_eq!(stream.current_version(), 0);
        assert_eq!(stream.watermark(), 0);
        assert_eq!(stream.event_count(), 0);
        assert!(stream.is_gapless());
    }

    #[test]
    fn test_append_event() {
        let stream_id = EntityId::new("stream-1".to_string()).unwrap();
        let mut stream = EventStream::new(stream_id.clone());

        let event = create_test_event("stream-1");
        let version = stream.append_event(event).unwrap();

        assert_eq!(version, 1);
        assert_eq!(stream.current_version(), 1);
        assert_eq!(stream.watermark(), 1);
        assert_eq!(stream.event_count(), 1);
        assert!(stream.is_gapless());
    }

    #[test]
    fn test_multiple_appends() {
        let stream_id = EntityId::new("stream-1".to_string()).unwrap();
        let mut stream = EventStream::new(stream_id.clone());

        for i in 1..=10 {
            let event = create_test_event("stream-1");
            let version = stream.append_event(event).unwrap();
            assert_eq!(version, i);
        }

        assert_eq!(stream.current_version(), 10);
        assert_eq!(stream.watermark(), 10);
        assert_eq!(stream.event_count(), 10);
        assert!(stream.is_gapless());
    }

    #[test]
    fn test_optimistic_locking_success() {
        let stream_id = EntityId::new("stream-1".to_string()).unwrap();
        let mut stream = EventStream::new(stream_id);

        // Set expected version
        stream.expect_version(0);

        let event = create_test_event("stream-1");
        let result = stream.append_event(event);

        assert!(result.is_ok());
        assert_eq!(result.unwrap(), 1);
    }

    #[test]
    fn test_optimistic_locking_failure() {
        let stream_id = EntityId::new("stream-1".to_string()).unwrap();
        let mut stream = EventStream::new(stream_id);

        // Append first event
        let event1 = create_test_event("stream-1");
        stream.append_event(event1).unwrap();

        // Set wrong expected version
        stream.expect_version(0);

        let event2 = create_test_event("stream-1");
        let result = stream.append_event(event2);

        assert!(result.is_err());
        assert!(matches!(result, Err(AllSourceError::ConcurrencyError(_))));
    }

    #[test]
    fn test_events_from() {
        let stream_id = EntityId::new("stream-1".to_string()).unwrap();
        let mut stream = EventStream::new(stream_id);

        // Append 5 events
        for _ in 0..5 {
            let event = create_test_event("stream-1");
            stream.append_event(event).unwrap();
        }

        let events = stream.events_from(3);
        assert_eq!(events.len(), 3); // Events 3, 4, 5
    }

    #[test]
    fn test_partition_assignment() {
        let stream_id = EntityId::new("stream-1".to_string()).unwrap();
        let stream = EventStream::new(stream_id);

        let partition_key = stream.partition_key();
        assert!(partition_key.partition_id() < PartitionKey::DEFAULT_PARTITION_COUNT);
    }

    #[test]
    fn test_clear_expected_version() {
        let stream_id = EntityId::new("stream-1".to_string()).unwrap();
        let mut stream = EventStream::new(stream_id);

        stream.expect_version(0);
        stream.clear_expected_version();

        // Should succeed without version check
        let event = create_test_event("stream-1");
        let result = stream.append_event(event);
        assert!(result.is_ok());
    }

    #[test]
    fn test_events_from_edge_cases() {
        let stream_id = EntityId::new("stream-1".to_string()).unwrap();
        let mut stream = EventStream::new(stream_id);

        // Append 3 events
        for _ in 0..3 {
            let event = create_test_event("stream-1");
            stream.append_event(event).unwrap();
        }

        // Test edge cases
        assert_eq!(stream.events_from(0).len(), 0); // Invalid version 0
        assert_eq!(stream.events_from(1).len(), 3); // From beginning
        assert_eq!(stream.events_from(3).len(), 1); // Last event
        assert_eq!(stream.events_from(4).len(), 0); // Beyond current
    }
}