lexe 0.1.5

//! Lexe wallet database.

use anyhow::Context;
use lexe_node_client::client::NodeClient;
use tracing::{info, warn};

use super::{
    ffs::{DiskFs, fsext},
    payments_db::{self, PaymentsDb},
};
use crate::{config::WalletUserDbConfig, types::command::PaymentSyncSummary};

/// Persistent wallet database which can be used with [`LexeWallet`].
///
/// [`LexeWallet`]: crate::wallet::LexeWallet
pub struct WalletDb<F> {
    #[allow(dead_code)] // TODO(max): Remove once stable
    user_db_config: WalletUserDbConfig,

    payments_db: PaymentsDb<F>,
    payment_sync_lock: tokio::sync::Mutex<()>,
}

// TODO(max): Rework Ffs so this impl can be generic across all Ffs impls.
// The user should just be able to give us a Ffs impl set to some base path
// which is the lexe_data_dir. From there we should be able to create sub-Ffs's
// for the wallet env, user, payments db, etc. Probably instead of one level of
// directory it should be prefix-based. As the Ffs is currently designed, end
// users have to manually create all the subdivisions, all the way down to e.g.
// `payments_db`, which is tedious and error-prone. Also, it might need to be
// renamed, since it won't be flat anymore.
impl WalletDb<DiskFs> {
    /// Create a fresh [`WalletDb`], deleting any existing data for this user.
    pub fn fresh(user_db_config: WalletUserDbConfig) -> anyhow::Result<Self> {
        let payments_ffs =
            DiskFs::create_clean_dir_all(user_db_config.payments_db_dir())
                .context("Could not create payments ffs")?;

        // Delete the old payments_db dir just in case it exists.
        for old_dir in user_db_config.old_payment_db_dirs() {
            match fsext::remove_dir_all_idempotent(&old_dir) {
                Ok(true) => info!("Deleted old payments_db dir: {old_dir:?}"),
                Ok(false) => (),
                Err(e) => warn!(?old_dir, "Couldn't delete old dir: {e:#}"),
            }
        }

        Ok(Self {
            user_db_config,
            payments_db: PaymentsDb::empty(payments_ffs),
            payment_sync_lock: tokio::sync::Mutex::new(()),
        })
    }

    /// Load an existing [`WalletDb`]. Returns [`None`] if no local data exists.
    pub fn load(
        user_db_config: WalletUserDbConfig,
    ) -> anyhow::Result<Option<Self>> {
        if !user_db_config.user_db_dir().exists() {
            return Ok(None);
        }

        let payments_ffs =
            DiskFs::create_dir_all(user_db_config.payments_db_dir())
                .context("Could not create payments ffs")?;

        let payments_db = PaymentsDb::read(payments_ffs)
            .context("Failed to load payments db")?;

        // If the payments_db contains 0 payments, the user may have just
        // upgraded to the latest format. Delete the old dirs just in case.
        let num_payments = payments_db.num_payments();
        if num_payments == 0 {
            for old_dir in user_db_config.old_payment_db_dirs() {
                match fsext::remove_dir_all_idempotent(&old_dir) {
                    Ok(true) =>
                        info!("Deleted old payments_db dir: {old_dir:?}"),
                    Ok(false) => (),
                    Err(e) => warn!(?old_dir, "Couldn't delete old dir: {e:#}"),
                }
            }
        }

        // Try to delete old provision_db since provision history is now on the
        // backend.
        let old_provision_db_dir = user_db_config.old_provision_db_dir();
        match fsext::remove_dir_all_idempotent(&old_provision_db_dir) {
            Ok(true) =>
                info!("Deleted old provision_db dir: {old_provision_db_dir:?}"),
            Ok(false) => (),
            Err(e) =>
                warn!(?old_provision_db_dir, "Couldn't delete old dir: {e:#}"),
        }

        let num_pending = payments_db.num_pending();
        let latest_updated_index = payments_db.latest_updated_index();
        info!(
            %num_payments, %num_pending, ?latest_updated_index,
            "Loaded WalletDb."
        );

        Ok(Some(Self {
            user_db_config,
            payments_db,
            payment_sync_lock: tokio::sync::Mutex::new(()),
        }))
    }

    /// Load an existing [`WalletDb`], or create a fresh one if none exists.
    pub fn load_or_fresh(
        user_db_config: WalletUserDbConfig,
    ) -> anyhow::Result<Self> {
        let maybe_db = Self::load(user_db_config.clone())
            .context("Failed to load wallet db")?;

        let db = match maybe_db {
            Some(d) => d,
            None => Self::fresh(user_db_config)
                .context("Failed to create fresh wallet db")?,
        };

        Ok(db)
    }

    /// Get the user database configuration.
    #[allow(dead_code)] // TODO(max): Remove once stable
    pub fn user_db_config(&self) -> &WalletUserDbConfig {
        &self.user_db_config
    }

    /// Get a reference to the payments database.
    pub fn payments_db(&self) -> &PaymentsDb<DiskFs> {
        &self.payments_db
    }

    /// Sync payments from the node to the local payments database.
    ///
    /// If another sync is already in progress, waits for it to complete
    /// before starting a new one.
    pub async fn sync_payments(
        &self,
        node_client: &NodeClient,
        batch_size: u16,
    ) -> anyhow::Result<PaymentSyncSummary> {
        let _lock = self.payment_sync_lock.lock().await;
        payments_db::sync_payments(&self.payments_db, node_client, batch_size)
            .await
    }
}