fedimint-core 0.11.0

fedimint-core provides common code used by both client and server.
Documentation
use tokio::sync::oneshot;

use super::mem_impl::MemDatabase;
use super::{
    Database, GlobalDBTxAccessToken, IDatabaseTransactionOpsCoreTyped, IRawDatabaseExt, TestKey,
    TestVal, future_returns_shortly,
};
use crate::runtime::spawn;

async fn waiter(db: &Database, key: TestKey) -> tokio::task::JoinHandle<TestVal> {
    let db = db.clone();
    let (tx, rx) = oneshot::channel::<()>();
    let join_handle = spawn("wait key exists", async move {
        let sub = db.wait_key_exists(&key);
        tx.send(()).unwrap();
        sub.await
    });
    rx.await.unwrap();
    join_handle
}

#[tokio::test]
async fn test_wait_key_before_transaction() {
    let key = TestKey(1);
    let val = TestVal(2);
    let db = MemDatabase::new().into_database();

    let key_task = waiter(&db, TestKey(1)).await;

    let mut tx = db.begin_transaction().await;
    tx.insert_new_entry(&key, &val).await;
    tx.commit_tx().await;

    assert_eq!(
        future_returns_shortly(async { key_task.await.unwrap() }).await,
        Some(TestVal(2)),
        "should notify"
    );
}

#[tokio::test]
async fn test_wait_key_before_insert() {
    let key = TestKey(1);
    let val = TestVal(2);
    let db = MemDatabase::new().into_database();

    let mut tx = db.begin_transaction().await;
    let key_task = waiter(&db, TestKey(1)).await;
    tx.insert_new_entry(&key, &val).await;
    tx.commit_tx().await;

    assert_eq!(
        future_returns_shortly(async { key_task.await.unwrap() }).await,
        Some(TestVal(2)),
        "should notify"
    );
}

#[tokio::test]
async fn test_wait_key_after_insert() {
    let key = TestKey(1);
    let val = TestVal(2);
    let db = MemDatabase::new().into_database();

    let mut tx = db.begin_transaction().await;
    tx.insert_new_entry(&key, &val).await;

    let key_task = waiter(&db, TestKey(1)).await;

    tx.commit_tx().await;

    assert_eq!(
        future_returns_shortly(async { key_task.await.unwrap() }).await,
        Some(TestVal(2)),
        "should notify"
    );
}

#[tokio::test]
async fn test_wait_key_after_commit() {
    let key = TestKey(1);
    let val = TestVal(2);
    let db = MemDatabase::new().into_database();

    let mut tx = db.begin_transaction().await;
    tx.insert_new_entry(&key, &val).await;
    tx.commit_tx().await;

    let key_task = waiter(&db, TestKey(1)).await;
    assert_eq!(
        future_returns_shortly(async { key_task.await.unwrap() }).await,
        Some(TestVal(2)),
        "should notify"
    );
}

#[tokio::test]
async fn test_wait_key_isolated_db() {
    let module_instance_id = 10;
    let key = TestKey(1);
    let val = TestVal(2);
    let db = MemDatabase::new().into_database();
    let db = db.with_prefix_module_id(module_instance_id).0;

    let key_task = waiter(&db, TestKey(1)).await;

    let mut tx = db.begin_transaction().await;
    tx.insert_new_entry(&key, &val).await;
    tx.commit_tx().await;

    assert_eq!(
        future_returns_shortly(async { key_task.await.unwrap() }).await,
        Some(TestVal(2)),
        "should notify"
    );
}

#[tokio::test]
async fn test_wait_key_isolated_tx() {
    let module_instance_id = 10;
    let key = TestKey(1);
    let val = TestVal(2);
    let db = MemDatabase::new().into_database();

    let key_task = waiter(&db.with_prefix_module_id(module_instance_id).0, TestKey(1)).await;

    let mut tx = db.begin_transaction().await;
    let mut tx_mod = tx.to_ref_with_prefix_module_id(module_instance_id).0;
    tx_mod.insert_new_entry(&key, &val).await;
    drop(tx_mod);
    tx.commit_tx().await;

    assert_eq!(
        future_returns_shortly(async { key_task.await.unwrap() }).await,
        Some(TestVal(2)),
        "should notify"
    );
}

#[tokio::test]
async fn test_wait_key_no_transaction() {
    let db = MemDatabase::new().into_database();

    let key_task = waiter(&db, TestKey(1)).await;
    assert_eq!(
        future_returns_shortly(async { key_task.await.unwrap() }).await,
        None,
        "should not notify"
    );
}

#[tokio::test]
async fn test_prefix_global_dbtx() {
    let module_instance_id = 10;
    let db = MemDatabase::new().into_database();

    {
        // Plain module id prefix, can use `global_dbtx` to access global_dbtx
        let (db, access_token) = db.with_prefix_module_id(module_instance_id);

        let mut tx = db.begin_transaction().await;
        let mut tx = tx.global_dbtx(access_token);
        tx.insert_new_entry(&TestKey(1), &TestVal(1)).await;
        tx.commit_tx().await;
    }

    assert_eq!(
        db.begin_transaction_nc().await.get_value(&TestKey(1)).await,
        Some(TestVal(1))
    );

    {
        // Additional non-module inner prefix, does not interfere with `global_dbtx`
        let (db, access_token) = db.with_prefix_module_id(module_instance_id);

        let db = db.with_prefix(vec![3, 4]);

        let mut tx = db.begin_transaction().await;
        let mut tx = tx.global_dbtx(access_token);
        tx.insert_new_entry(&TestKey(2), &TestVal(2)).await;
        tx.commit_tx().await;
    }

    assert_eq!(
        db.begin_transaction_nc().await.get_value(&TestKey(2)).await,
        Some(TestVal(2))
    );
}

#[tokio::test]
#[should_panic(expected = "Illegal to call global_dbtx on BaseDatabaseTransaction")]
async fn test_prefix_global_dbtx_panics_on_global_db() {
    let db = MemDatabase::new().into_database();

    let mut tx = db.begin_transaction().await;
    let _tx = tx.global_dbtx(GlobalDBTxAccessToken::from_prefix(&[1]));
}

#[tokio::test]
#[should_panic(expected = "Illegal to call global_dbtx on BaseDatabaseTransaction")]
async fn test_prefix_global_dbtx_panics_on_non_module_prefix() {
    let db = MemDatabase::new().into_database();

    let prefix = vec![3, 4];
    let db = db.with_prefix(prefix.clone());

    let mut tx = db.begin_transaction().await;
    let _tx = tx.global_dbtx(GlobalDBTxAccessToken::from_prefix(&prefix));
}

#[tokio::test]
#[should_panic(expected = "Illegal to call global_dbtx on BaseDatabaseTransaction")]
async fn test_prefix_global_dbtx_panics_on_wrong_access_token() {
    let db = MemDatabase::new().into_database();

    let prefix = vec![3, 4];
    let db = db.with_prefix(prefix.clone());

    let mut tx = db.begin_transaction().await;
    let _tx = tx.global_dbtx(GlobalDBTxAccessToken::from_prefix(&[1]));
}