bevy_persistence_database 0.5.0

A persistence and database integration solution for the Bevy game engine
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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
use super::runtime::TokioRuntime;
use crate::bevy::components::Guid;
use crate::core::db::{DatabaseConnection, PersistenceError, TransactionOperation};
use crate::core::session::PersistenceSession;
use crate::core::session::persistence_session::DirtyState;
use crate::core::versioning::version_manager::VersionKey;
use bevy::prelude::*;
use std::any::TypeId;
use std::collections::{HashMap, HashSet};
use std::sync::{
    Arc,
    atomic::{AtomicUsize, Ordering},
};
use tokio::sync::oneshot;

#[derive(Component)]
pub(super) struct CommitTask {
    receiver: Option<oneshot::Receiver<Result<(Vec<String>, Vec<Entity>), PersistenceError>>>,
}

/// Message emitted when a background commit task is complete.
#[derive(Message)]
pub struct CommitCompleted {
    pub result: Result<Vec<String>, PersistenceError>,
    pub dirty_entities: Vec<Entity>,
    pub correlation_id: Option<u64>,
}

/// Message that users send to trigger a commit.
#[derive(Message, Clone)]
pub struct TriggerCommit {
    /// An optional ID to correlate this trigger with a `CommitCompleted` event.
    pub correlation_id: Option<u64>,
    /// Connection to use directly for this commit.
    pub target_connection: Arc<dyn DatabaseConnection>,
    /// Store to write into for this commit.
    pub store: String,
}

/// A state machine resource to track the commit lifecycle.
#[derive(Resource, Default, PartialEq, Debug)]
pub enum CommitStatus {
    #[default]
    Idle,
    InProgress,
    InProgressAndDirty,
}

/// Run-condition: `true` while a commit is in progress or queued.
///
/// Gate a commit-trigger system with `.run_if(not(commit_in_flight))` to avoid
/// preparing a redundant trigger while one is still running.
pub fn commit_in_flight(status: Res<CommitStatus>) -> bool {
    !matches!(*status, CommitStatus::Idle)
}

#[derive(Component)]
pub(super) struct TriggerId {
    correlation_id: Option<u64>,
}

#[derive(Component)]
pub(super) struct CommitMeta {
    /// Original dirty sets taken at trigger time — restored on failure.
    dirty_entity_components: HashMap<Entity, HashSet<TypeId>>,
    despawned_entities: HashSet<Entity>,
    dirty_resources: HashSet<TypeId>,
    despawned_resources: HashSet<TypeId>,
    /// Effective sets that produced DB operations — applied on success.
    committed_entity_components: HashMap<Entity, HashSet<TypeId>>,
    committed_despawned_entities: HashSet<Entity>,
    committed_dirty_resources: HashSet<TypeId>,
    committed_despawned_resources: HashSet<TypeId>,
    connection: Arc<dyn DatabaseConnection>,
    store: String,
    /// Updated edge snapshot to apply on success.
    new_edge_snapshot: HashSet<String>,
    /// Client-side preassigned keys for new entities.
    preassigned_keys: HashMap<Entity, String>,
}

pub(super) fn handle_commit_trigger(ecs: &mut World) {
    let mut should_commit = false;
    let mut correlation_id = None;
    let mut requested_connection: Option<Arc<dyn DatabaseConnection>> = None;
    let mut requested_store: Option<String> = None;

    ecs.resource_scope(|ecs, mut events: Mut<Messages<TriggerCommit>>| {
        let mut status = ecs.resource_mut::<CommitStatus>();
        if !events.is_empty() {
            let first_trigger = events.drain().next().unwrap();
            requested_connection = Some(first_trigger.target_connection.clone());
            requested_store = Some(first_trigger.store.clone());

            match *status {
                CommitStatus::Idle => {
                    bevy::log::debug!(
                        "[handle_commit_trigger] TriggerCommit received while Idle"
                    );
                    should_commit = true;
                    correlation_id = first_trigger.correlation_id;
                }
                CommitStatus::InProgress => {
                    bevy::log::debug!(
                        "[handle_commit_trigger] TriggerCommit received while busy; queueing"
                    );
                    *status = CommitStatus::InProgressAndDirty;
                }
                CommitStatus::InProgressAndDirty => {
                    // A commit is already in progress and another is already queued.
                }
            }
        }
    });

    if !should_commit {
        return;
    }

    let connection = if let Some(conn) = requested_connection {
        conn
    } else {
        let err = PersistenceError::new("TriggerCommit missing target_connection");
        ecs.write_message(CommitCompleted {
            result: Err(err.clone()),
            dirty_entities: vec![],
            correlation_id,
        });
        bevy::log::error!(%err, "failed to select database connection before commit");
        return;
    };

    let store = if let Some(store) = requested_store {
        if store.is_empty() {
            let err = PersistenceError::new("TriggerCommit store must be non-empty");
            ecs.write_message(CommitCompleted {
                result: Err(err.clone()),
                dirty_entities: vec![],
                correlation_id,
            });
            bevy::log::error!(%err, "invalid store for commit");
            return;
        }
        store
    } else {
        let err = PersistenceError::new("TriggerCommit missing store");
        ecs.write_message(CommitCompleted {
            result: Err(err.clone()),
            dirty_entities: vec![],
            correlation_id,
        });
        bevy::log::error!(%err, "failed to select store before commit");
        return;
    };

    // 1) isolate dirty sets from the session
    let (dirty_entity_components, despawned_entities, dirty_resources, despawned_resources, dirty_relationship_entities) = {
        let mut session = ecs.resource_mut::<PersistenceSession>();
        session.take_dirty_state().into_parts()
    };

    // 2) prepare commit with those sets
    let commit_data = match PersistenceSession::_prepare_commit(
        ecs.resource::<PersistenceSession>(),
        ecs,
        &dirty_entity_components,
        &despawned_entities,
        &dirty_resources,
        &despawned_resources,
        &dirty_relationship_entities,
        ecs.get_resource::<super::plugin::PersistenceThreadPool>().map(|p| p.get()),
        connection.document_key_field(),
        &store,
    ) {
        Ok(data) if data.operations.is_empty() => {
            ecs.write_message(CommitCompleted {
                result: Ok(vec![]),
                dirty_entities: vec![],
                correlation_id,
            });
            let mut session = ecs.resource_mut::<PersistenceSession>();
            session.restore_dirty_state(DirtyState::from_parts_with_relationships(
                dirty_entity_components,
                despawned_entities,
                dirty_resources,
                despawned_resources,
                dirty_relationship_entities,
            ));
            return;
        }
        Ok(data) => data,
        Err(e) => {
            ecs.write_message(CommitCompleted {
                result: Err(e.clone()),
                dirty_entities: vec![],
                correlation_id,
            });
            let mut session = ecs.resource_mut::<PersistenceSession>();
            session.restore_dirty_state(DirtyState::from_parts_with_relationships(
                dirty_entity_components,
                despawned_entities,
                dirty_resources,
                despawned_resources,
                dirty_relationship_entities,
            ));
            return;
        }
    };

    // 3) spawn the async DB transaction
    *ecs.resource_mut::<CommitStatus>() = CommitStatus::InProgress;
    let runtime = ecs.resource::<TokioRuntime>().runtime.clone();
    let db = connection.clone();

    spawn_commit_task(
        ecs,
        CommitRequest {
            correlation_id,
            runtime,
            db,
            store,
            operations: commit_data.operations,
            new_entities: commit_data.new_entities,
            dirty_entity_components,
            despawned_entities,
            dirty_resources,
            despawned_resources,
            committed_entity_components: commit_data.committed_entity_components,
            committed_despawned_entities: commit_data.committed_despawned_entities,
            committed_dirty_resources: commit_data.committed_dirty_resources,
            committed_despawned_resources: commit_data.committed_despawned_resources,
            new_edge_snapshot: commit_data.new_edge_snapshot,
            preassigned_keys: commit_data.preassigned_keys,
        },
    );
}

/// Bundles all per-commit data so spawn/handle helpers have a clean signature.
struct CommitRequest {
    correlation_id: Option<u64>,
    runtime: Arc<tokio::runtime::Runtime>,
    db: Arc<dyn DatabaseConnection>,
    store: String,
    operations: Vec<TransactionOperation>,
    new_entities: Vec<Entity>,
    dirty_entity_components: HashMap<Entity, HashSet<TypeId>>,
    despawned_entities: HashSet<Entity>,
    dirty_resources: HashSet<TypeId>,
    despawned_resources: HashSet<TypeId>,
    committed_entity_components: HashMap<Entity, HashSet<TypeId>>,
    committed_despawned_entities: HashSet<Entity>,
    committed_dirty_resources: HashSet<TypeId>,
    committed_despawned_resources: HashSet<TypeId>,
    new_edge_snapshot: HashSet<String>,
    preassigned_keys: HashMap<Entity, String>,
}

fn spawn_commit_task(ecs: &mut World, request: CommitRequest) {
    let CommitRequest {
        correlation_id,
        runtime,
        db,
        store,
        operations,
        new_entities,
        dirty_entity_components,
        despawned_entities,
        dirty_resources,
        despawned_resources,
        committed_entity_components,
        committed_despawned_entities,
        committed_dirty_resources,
        committed_despawned_resources,
        new_edge_snapshot,
        preassigned_keys,
    } = request;

    let db_for_task = db.clone();
    let (tx, rx) = oneshot::channel();
    runtime.spawn(async move {
        bevy::log::trace!(
            "commit task started ({} operations)",
            operations.len()
        );
        let res = db_for_task
            .execute_transaction(operations)
            .await
            .map(|keys| (keys, new_entities));
        bevy::log::trace!("commit runtime task completed send");
        let _ = tx.send(res);
    });

    ecs.spawn((
        CommitTask { receiver: Some(rx) },
        TriggerId { correlation_id },
        CommitMeta {
            dirty_entity_components,
            despawned_entities,
            dirty_resources,
            despawned_resources,
            committed_entity_components,
            committed_despawned_entities,
            committed_dirty_resources,
            committed_despawned_resources,
            connection: db,
            store,
            new_edge_snapshot,
            preassigned_keys,
        },
    ));
}

pub(super) fn handle_commit_completed(
    mut commands: Commands,
    mut query: Query<(Entity, &mut CommitTask, &TriggerId, Option<&mut CommitMeta>)>,
    mut session: ResMut<PersistenceSession>,
    mut status: ResMut<CommitStatus>,
    mut completed: MessageWriter<CommitCompleted>,
    mut triggers: MessageWriter<TriggerCommit>,
) {
    static PENDING_LOG_COUNT: AtomicUsize = AtomicUsize::new(0);

    let mut to_despawn = Vec::new();
    let mut had_error = false;

    for (ent, mut task, trigger_id, meta_opt) in &mut query {
        if let Some(mut receiver) = task.receiver.take() {
            let result: Result<(Vec<String>, Vec<Entity>), PersistenceError> =
                match receiver.try_recv() {
                    Ok(res) => res,
                    Err(tokio::sync::oneshot::error::TryRecvError::Empty) => {
                        task.receiver = Some(receiver);
                        continue;
                    }
                    Err(tokio::sync::oneshot::error::TryRecvError::Closed) => {
                        bevy::log::error!("commit task channel closed before result");
                        Err(PersistenceError::new(
                            "Commit task cancelled before completion",
                        ))
                    }
                };

            let cid = trigger_id.correlation_id;
            let mut commit_connection: Option<Arc<dyn DatabaseConnection>> = None;
            let mut commit_store: Option<String> = None;

            if result.is_err() {
                had_error = true;
            }

            if let Err(err) = &result {
                bevy::log::error!(
                    "commit completed with error (cid={:?} err={})",
                    cid,
                    err
                );
            } else {
                bevy::log::trace!("commit completed ok (cid={:?})", cid);
            }

            if let Some(mut meta) = meta_opt {
                commit_connection = Some(meta.connection.clone());
                commit_store = Some(meta.store.clone());

                let event_res = match &result {
                    Ok(_) => {
                        apply_commit_success(&mut commands, &mut session, &meta);
                        Some(Ok(vec![]))
                    }
                    Err(err) => {
                        restore_dirty_state_on_failure(&mut session, &mut meta);
                        Some(Err(err.clone()))
                    }
                };

                if let Some(event_res) = event_res {
                    bevy::log::debug!(
                        "emitting CommitCompleted for cid={:?} err={}",
                        cid,
                        result.is_err()
                    );
                    completed.write(CommitCompleted {
                        result: event_res,
                        dirty_entities: vec![],
                        correlation_id: cid,
                    });
                }
            } else if let Err(e) = &result {
                completed.write(CommitCompleted {
                    result: Err(e.clone()),
                    dirty_entities: vec![],
                    correlation_id: cid,
                });
            }

            to_despawn.push(ent);

            let should_trigger_next = !had_error && *status == CommitStatus::InProgressAndDirty;
            *status = CommitStatus::Idle;

            if should_trigger_next {
                if let (Some(conn), Some(store)) = (commit_connection.clone(), commit_store.clone())
                {
                    triggers.write(TriggerCommit {
                        correlation_id: None,
                        target_connection: conn,
                        store,
                    });
                }
            }
        } else if PENDING_LOG_COUNT.fetch_add(1, Ordering::Relaxed) < 5 {
            bevy::log::debug!("commit task still pending (cid={:?})", trigger_id.correlation_id);
        }
    }

    if had_error {
        *status = CommitStatus::Idle;
    }

    for entity in to_despawn {
        commands.entity(entity).despawn();
    }
}

fn apply_commit_success(
    commands: &mut Commands,
    session: &mut PersistenceSession,
    meta: &CommitMeta,
) {
    // Assign GUIDs using the client-side preassigned keys.
    // These keys were embedded in the documents sent to the DB, so the DB
    // already has them — we just need to reflect them in the ECS world.
    for (entity, key) in &meta.preassigned_keys {
        commands.entity(*entity).insert(Guid::new(key.clone()));
        session.insert_entity_key(*entity, key.clone());
        session
            .version_manager_mut()
            .set_version(VersionKey::Entity(key.clone()), 1);
    }

    for tid in &meta.committed_dirty_resources {
        let vk = VersionKey::Resource(*tid);
        let nv = session.version_manager().get_version(&vk).unwrap_or(0) + 1;
        session.version_manager_mut().set_version(vk, nv);
    }

    for tid in &meta.committed_despawned_resources {
        session
            .version_manager_mut()
            .remove_version(&VersionKey::Resource(*tid));
    }

    for &entity in meta.committed_entity_components.keys() {
        if meta.preassigned_keys.contains_key(&entity) {
            continue;
        }
        if let Some(key) = session.entity_key(entity) {
            let vk = VersionKey::Entity(key.clone());
            if let Some(v) = session.version_manager().get_version(&vk) {
                session.version_manager_mut().set_version(vk, v + 1);
            }
        }
    }

    for e in &meta.committed_despawned_entities {
        if let Some(key) = session.entity_key(*e).cloned() {
            session
                .version_manager_mut()
                .remove_version(&VersionKey::Entity(key));
        }
    }

    // Apply the edge snapshot on successful commit
    if !meta.new_edge_snapshot.is_empty() {
        session.set_edge_snapshot(meta.new_edge_snapshot.clone());
    }
}

fn restore_dirty_state_on_failure(session: &mut PersistenceSession, meta: &mut CommitMeta) {
    let dirty_entity_components: HashMap<Entity, HashSet<TypeId>> =
        meta.dirty_entity_components.drain().collect();
    let despawned_entities = std::mem::take(&mut meta.despawned_entities);
    let dirty_resources = std::mem::take(&mut meta.dirty_resources);
    let despawned_resources = std::mem::take(&mut meta.despawned_resources);
    session.restore_dirty_state(DirtyState::from_parts(
        dirty_entity_components,
        despawned_entities,
        dirty_resources,
        despawned_resources,
    ));
}