inc-complete 0.10.2

use inc_complete::{
    Db, DbHandle, StorageFor, define_input, define_intermediate, impl_storage,
    storage::{HashMapStorage, TreeIndexStorage},
};
use serde::{Deserialize, Serialize};

#[derive(Default, Serialize, Deserialize)]
struct StorageWithoutAsPlusBs {
    strings: HashMapStorage<Strings>,
    count_as: TreeIndexStorage<CountAs>,
    count_bs: HashMapStorage<CountBs>,
}

impl_storage!(StorageWithoutAsPlusBs,
    strings: Strings,
    count_as: CountAs,
    count_bs: CountBs,
);

/// In a real program this would be a future version of the same struct but
/// we need both at the same time in the program so we have to define both.
///
/// Note how the new field `as_plus_bs` is annotated with `serde(default)`.
/// This is all we need to deserialize `StorageWithoutAsPlusBs` as `Storage`
/// for json at least - this may depend on your exact serialization format.
#[derive(Default, Serialize, Deserialize)]
struct Storage {
    strings: HashMapStorage<Strings>,
    count_as: TreeIndexStorage<CountAs>,
    count_bs: HashMapStorage<CountBs>,

    #[serde(default)]
    as_plus_bs: HashMapStorage<AsPlusBs>,
}

impl_storage!(Storage,
    strings: Strings,
    count_as: CountAs,
    count_bs: CountBs,
    as_plus_bs: AsPlusBs,
);

// `Storage | StorageWithoutAsPlusBs` is syntax to implement `Run` for multiple storage types.
define_input!(0, Strings -> String, Storage | StorageWithoutAsPlusBs);
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, Hash)]
struct Strings {
    name: String,
}

define_intermediate!(1, CountAs -> usize, Storage | StorageWithoutAsPlusBs, count_as_impl);
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, Ord, PartialOrd)]
struct CountAs {
    name: String,
}

define_intermediate!(2, CountBs -> usize, Storage | StorageWithoutAsPlusBs, count_bs_impl);
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, Hash)]
struct CountBs {
    name: String,
}

define_intermediate!(3, AsPlusBs -> usize, Storage | StorageWithoutAsPlusBs, as_plus_bs_impl);
#[derive(Debug, Serialize, Deserialize, Clone, Hash, PartialEq, Eq)]
struct AsPlusBs {
    name: String,
}

fn count_as_impl<S: inc_complete::Storage + StorageFor<Strings>>(
    this: &CountAs,
    db: &DbHandle<S>,
) -> usize {
    let input = db.get(Strings {
        name: this.name.clone(),
    });
    input.chars().filter(|c| *c == 'a').count()
}

fn count_bs_impl<S: inc_complete::Storage + StorageFor<Strings>>(
    this: &CountBs,
    db: &DbHandle<S>,
) -> usize {
    let input = db.get(Strings {
        name: this.name.clone(),
    });
    input.chars().filter(|c| *c == 'b').count()
}

fn as_plus_bs_impl<S>(params: &AsPlusBs, db: &DbHandle<S>) -> usize
where
    S: inc_complete::Storage + StorageFor<Strings> + StorageFor<CountAs> + StorageFor<CountBs>,
{
    let name = &params.name;
    let a_count = db.get(CountAs { name: name.clone() });
    let b_count = db.get(CountBs { name: name.clone() });
    a_count + b_count
}

/// Test basic serialization and deserialization with no changes to Db structure
#[test]
fn still_cached_after_serialize() {
    let mut db = Db::<Storage>::new();
    let half = "50%".to_string();
    db.update_input(
        Strings { name: half.clone() },
        "ababababab ababababab".to_string(),
    );

    assert_eq!(db.get(CountAs { name: half.clone() }), 10);

    let serialized = serde_json::to_string(&db).unwrap();
    let new_db: Db<Storage> = serde_json::from_str(&serialized).unwrap();

    assert!(!new_db.is_stale(&CountAs { name: half.clone() }));
    assert!(new_db.is_stale(&AsPlusBs { name: half.clone() }));

    assert_eq!(new_db.get(AsPlusBs { name: half.clone() }), 20);

    assert!(!new_db.is_stale(&AsPlusBs { name: half.clone() }));
    assert!(db.is_stale(&AsPlusBs { name: half.clone() }));
}

/// Emulate a case where a user wants to add a new cached computation but also
/// remain backward-compatible with existing serialization.
///
/// The internal structure of the `Db` is completely storage-agnostic, it only
/// stores computation ids and version metadata. So backwards compatibility
/// is entirely dependent on the storage type used. In this example, we already
/// made sure `Storage` is backwards-compatible with `StorageWithoutAsPlusBs` when
/// defining the types, so we should be able to deserialize the former as the later.
/// The new field containing `AsPlusBs` isn't part of `StorageWithoutAsPlusBs`, so
/// we expect it to be empty in `Storage`.
#[test]
fn extend_preexisting_db_from_end() {
    let mut db = Db::<StorageWithoutAsPlusBs>::new();
    let half = "50%".to_string();
    db.update_input(
        Strings { name: half.clone() },
        "ababababab ababababab".to_string(),
    );

    // Ensure everything in the original database is filled so we can assert
    // the new item in the new_db later on is not
    assert_eq!(db.get(CountAs { name: half.clone() }), 10);
    assert_eq!(db.get(CountBs { name: half.clone() }), 10);

    let serialized = serde_json::to_string(&db).unwrap();

    // Deserializing a Db<Storage> here, not a Db<StorageWithoutAsPlusBs>!
    let extended_db: Db<Storage> = serde_json::from_str(&serialized).unwrap();

    assert!(!extended_db.is_stale(&CountAs { name: half.clone() }));
    assert!(!extended_db.is_stale(&CountBs { name: half.clone() }));
    assert!(extended_db.is_stale(&AsPlusBs { name: half.clone() }));

    assert_eq!(extended_db.get(AsPlusBs { name: half.clone() }), 20);
}