taskchampion-sync-server/sqlite/tests/concurrency.rs

use std::thread;
use taskchampion_sync_server_core::{Storage, NIL_VERSION_ID};
use taskchampion_sync_server_storage_sqlite::SqliteStorage;
use tempfile::TempDir;
use tokio::runtime;
use uuid::Uuid;

/// Test that calls to `add_version` from different threads maintain sequential consistency.
///
/// This uses `std::thread` to ensure actual parallelism, with a different, single-threaded Tokio runtime
/// in each thread. Asynchronous concurrency does not actually test consistency.
#[tokio::test]
async fn add_version_concurrency() -> anyhow::Result<()> {
    let tmp_dir = TempDir::new()?;
    let client_id = Uuid::new_v4();

    {
        let con = SqliteStorage::new(tmp_dir.path())?;
        let mut txn = con.txn(client_id).await?;
        txn.new_client(NIL_VERSION_ID).await?;
        txn.commit().await?;
    }

    const N: i32 = 100;
    const T: i32 = 4;

    // Add N versions to the DB.
    let add_versions = |tmp_dir, client_id| {
        let rt = runtime::Builder::new_current_thread().build()?;
        rt.block_on(async {
            let con = SqliteStorage::new(tmp_dir)?;

            for _ in 0..N {
                let mut txn = con.txn(client_id).await?;
                let client = txn.get_client().await?.unwrap();
                let version_id = Uuid::new_v4();
                let parent_version_id = client.latest_version_id;
                std::thread::yield_now(); // Make failure more likely.
                txn.add_version(version_id, parent_version_id, b"data".to_vec())
                    .await?;
                txn.commit().await?;
            }

            Ok::<_, anyhow::Error>(())
        })
    };

    thread::scope(|s| {
        // Spawn T threads.
        for _ in 0..T {
            let tmp_dir = tmp_dir.path();
            s.spawn(move || add_versions(tmp_dir, client_id));
        }
    });

    // There should now be precisely N*T versions. This number will be smaller if there were
    // concurrent transactions, which would have allowed two `add_version` calls with the
    // same `parent_version_id`.
    {
        let con = SqliteStorage::new(tmp_dir.path())?;
        let mut txn = con.txn(client_id).await?;
        let client = txn.get_client().await?.unwrap();

        let mut n = 0;
        let mut version_id = client.latest_version_id;
        while version_id != NIL_VERSION_ID {
            let version = txn
                .get_version(version_id)
                .await?
                .expect("version should exist");
            n += 1;
            version_id = version.parent_version_id;
        }

        assert_eq!(n, N * T);
    }

    Ok(())
}