google_bigquery_v2/src/data/bigquery_table.rs

use std::collections::HashMap;
use std::fmt::Debug;

use crate::prelude::*;
use async_trait::async_trait;
pub use google_bigquery2::api::QueryParameter;
pub use google_bigquery2::api::{QueryParameterType, QueryParameterValue};
use serde_json::Value;

use crate::client::BigqueryClient;
use crate::data::param_conversion::{
    convert_value_to_string, BigDataValueType, ConvertBigQueryParams,
};
use crate::data::query_builder::{
    NoClient, NoStartingData, QueryBuilder, QueryResultType, QueryTypeDelete, QueryTypeInsert,
    QueryTypeNoType, QueryTypeSelect, QueryTypeUpdate, QueryWasNotBuilt,
};
use crate::prelude::*;

#[async_trait]
pub trait BigQueryTableBase {
    fn get_all_params(&self) -> Result<Vec<Option<QueryParameter>>>;
    fn get_parameter_from_field(&self, field_name: &str) -> Result<Option<QueryParameter>>;
    //region get infos
    /// Returns the name of the table in the database.
    fn get_table_name() -> String;
    /// Returns the bigquery-client for the struct.
    fn get_client(&self) -> &BigqueryClient;
    /// Sets the bigquery-client for the struct.
    fn set_client(&mut self, client: BigqueryClient);
    /// Returns the name of the primary key field in the struct.
    fn get_pk_field_name() -> String;
    /// Returns the name of the primary key field in the database.
    fn get_pk_db_name() -> String;
    /// Returns the value of the primary key.
    fn get_pk_value(&self) -> &(dyn BigDataValueType + Send + Sync);
    /// Returns a HashMap with the field name as key and the db name as value.
    fn get_query_fields(include_pk: bool) -> HashMap<String, String>;
    async fn reload(&mut self) -> Result<()>;
    //endregion

    //region set infos
    /// Sets the value of a field by its db name.
    fn set_field_value(&mut self, field_name: &str, value: &Value) -> Result<()>;
    fn get_field_value(&self, field_name: &str) -> Result<Value>;
    /// creates a new instance of the struct from a query result row and a bigquery-client.
    ///
    /// # Arguments
    /// * `client` - The bigquery-client to use.
    /// * `row` - The query result row. The keys are the db names of the fields.
    fn new_from_query_result_row(
        client: BigqueryClient,
        row: &HashMap<String, Value>,
    ) -> Result<Self>
    where
        Self: Sized;

    //region update

    //TODO: fn delete(&mut self) -> Result<()>;

    //endregion

    //endregion
}

#[async_trait]
pub trait BigQueryTable: BigQueryTableBase {
    fn select() -> QueryBuilder<Self, QueryTypeSelect, NoClient, QueryWasNotBuilt, NoStartingData>
    where
        Self: Sized,
    {
        QueryBuilder::<Self, QueryTypeNoType, NoClient, QueryWasNotBuilt, NoStartingData>::select()
    }
    fn insert() -> QueryBuilder<Self, QueryTypeInsert, NoClient, QueryWasNotBuilt, NoStartingData>
    where
        Self: Sized,
    {
        QueryBuilder::<Self, QueryTypeNoType, NoClient, QueryWasNotBuilt, NoStartingData>::insert()
    }
    fn update() -> QueryBuilder<Self, QueryTypeUpdate, NoClient, QueryWasNotBuilt, NoStartingData>
    where
        Self: Sized,
    {
        QueryBuilder::<Self, QueryTypeNoType, NoClient, QueryWasNotBuilt, NoStartingData>::update()
    }
    fn delete() -> QueryBuilder<Self, QueryTypeDelete, NoClient, QueryWasNotBuilt, NoStartingData>
    where
        Self: Sized,
    {
        QueryBuilder::<Self, QueryTypeNoType, NoClient, QueryWasNotBuilt, NoStartingData>::delete()
    }
    fn get_parameter<T>(value: &T, param_name: &String) -> Option<QueryParameter>
    where
        T: BigDataValueType + Debug,
    {
        trace!("get_parameter({:?}, {})", value, param_name);
        let value = value.to_param();
        let param_type = T::convert_type_to_bigquery_type();
        let param_type = QueryParameterType {
            type_: Some(param_type),
            ..Default::default()
        };
        debug!("param_type: {:?}", param_type);
        debug!("param_value: {:?}", value);
        let param_value = convert_value_to_string(value);
        debug!("param_value: {:?}", param_value);
        let param_value = match param_value {
            Ok(param_value) => Some(QueryParameterValue {
                value: Some(param_value),
                ..Default::default()
            }),
            Err(_) => return None,
        };
        debug!("param_value: {:?}", param_value);

        let param = QueryParameter {
            parameter_type: Some(param_type),
            parameter_value: param_value,
            name: Some(param_name.clone()),
        };
        Some(param)
    }
    fn get_field_param_name(field_name: &str) -> Result<String> {
        trace!("get_field_param_name({})", field_name);
        let db_name = Self::get_field_db_name(field_name)?;
        Ok(format!("__PARAM_{}", db_name))
    }
    fn get_field_db_name(field_name: &str) -> Result<String> {
        trace!("get_field_db_name({})", field_name);
        let query_fields = Self::get_query_fields(true);
        let db_name = query_fields.get(field_name);
        match db_name {
            None => Err(format!("Field {} not found.", field_name).into()),
            Some(s) => Ok(s.to_string()),
        }
    }

    fn get_table_identifier(&self) -> String {
        trace!("get_table_identifier()");
        Self::get_table_identifier_from_client(self.get_client())
    }

    fn get_table_identifier_from_client(client: &BigqueryClient) -> String {
        trace!("get_table_identifier_from_client({:?})", client);
        format!(
            "`{}.{}.{}`",
            client.get_project_id(),
            client.get_dataset_id(),
            Self::get_table_name()
        )
    }

    async fn get_by_pk<PK>(client: BigqueryClient, pk_value: &PK) -> Result<Self>
    where
        PK: BigDataValueType + Send + Sync + 'static,
        Self: Sized + Debug,
    {
        trace!("get_by_pk({:?}, {:?})", client, pk_value);
        let pk_field_name = Self::get_pk_field_name();
        let pk_db_name = Self::get_pk_db_name();
        let result = Self::select()
            .with_client(client)
            .add_where_eq(&pk_field_name, Some(pk_value))?
            .build_query()?
            .run()
            .await?;
        let mut rows = match result {
            QueryResultType::WithRowData(data) => data,
            QueryResultType::WithoutRowData(success) => {
                return Err(format!(
                    "something went wrong when getting for {} = {:?};\tresult: {:?}",
                    pk_field_name, pk_value, success
                )
                .into());
            }
        };

        if rows.len() == 0 {
            Err(format!("No entry found for {} = {:?}", pk_db_name, pk_value).into())
        } else if rows.len() > 1 {
            Err(format!(
                "More than one entry found for {} = {:?}",
                pk_db_name, pk_value
            )
            .into())
        } else {
            Ok(rows.remove(0))
        }
    }

    async fn upsert(&mut self) -> Result<()>
    where
        Self: Sized + Clone + Send + Sync + Debug + Default,
    {
        trace!("upsert()");

        let exists = self.clone().reload().await; //TODO: this is not very efficient
        match exists {
            Ok(_) => {
                debug!("Updating entry on db.");
                self.save().await
            }
            Err(_) => {
                debug!("Inserting new entry.");
                Self::insert()
                    .with_client(self.get_client().clone())
                    .set_data(self.clone())
                    .build_query()?
                    .run()
                    .await?
                    .map_err_without_data("upsert should not return data.")
            }
        }
    }

    /// proxy for update
    async fn save(&self) -> Result<()>
    where
        Self: Sized + Clone + Send + Sync + Debug + Default,
    {
        trace!("save(): {:?}", self);
        let result = Self::update()
            .with_client(self.get_client().clone())
            .set_data(self.clone())
            .build_query()?
            .run()
            .await?;
        trace!("save() result: {:?}", result);
        let count = result
            .expect_with_data("save should return empty data.")
            .len();
        if count == 0 {
            Ok(())
        } else {
            Err(format!(
                "save should return empty data, but returned {} rows.",
                count
            )
            .into())
        }
    }

    /// updates the current instance from another instance.
    /// Does not save the changes to the database.
    fn update_from(&mut self, other: &Self) -> Result<()> {
        for (field_name, _) in Self::get_query_fields(true) {
            let value = other.get_field_value(&field_name)?;
            self.set_field_value(&field_name, &value)?;
        }
        Ok(())
    }

    /// converts the value to Result<T> by using T::from_param(value)
    ///
    /// this is basically just a wrapper so we don't need to know the type
    /// of the field in the derive macro (or at least we don't need to write it)
    /// like this:
    ///
    /// self.info1 = Option::<String>::from_param(value)?
    ///
    /// instead we can just call:
    ///
    /// self.info1 = Self::from_param(value)?;
    ///
    /// and the types will be inferred
    fn from_param<T: ConvertBigQueryParams>(value: &Value) -> Result<T> {
        T::from_param(value)
    }
}

impl<T> BigQueryTable for T where T: BigQueryTableBase {}

#[derive(Debug, Clone)]
pub enum OrderDirection {
    Ascending,
    Descending,
}

impl OrderDirection {
    pub(crate) fn to_query_str(&self) -> String {
        match self {
            OrderDirection::Ascending => String::from("ASC"),
            OrderDirection::Descending => String::from("DESC"),
        }
    }
}