routee-compass 0.19.2

use super::{search_app_ops, search_app_result::SearchAppResult};
use crate::{app::compass::CompassAppError, plugin::PluginError};
use chrono::Local;
use routee_compass_core::{
    algorithm::search::{Direction, SearchAlgorithm, SearchError, SearchInstance},
    model::{
        constraint::ConstraintModelService,
        cost::cost_model_service::CostModelService,
        label::label_model_service::LabelModelService,
        map::{MapJsonExtensions, MapModel},
        network::Graph,
        state::StateModel,
        termination::TerminationModel,
        traversal::TraversalModelService,
    },
};
use std::sync::Arc;
use std::time;

/// a configured and loaded application to execute searches.
pub struct SearchApp {
    pub search_algorithm: SearchAlgorithm,
    pub graph: Arc<Graph>,
    pub map_model: Arc<MapModel>,
    pub state_model: Arc<StateModel>,
    pub traversal_model_services: Vec<Arc<dyn TraversalModelService>>,
    pub constraint_model_services: Vec<Arc<dyn ConstraintModelService>>,
    pub cost_model_service: Arc<CostModelService>,
    pub termination_model: Arc<TerminationModel>,
    pub label_model_service: Arc<dyn LabelModelService>,
    pub default_edge_list: Option<usize>,
}

impl SearchApp {
    /// builds a new SearchApp from the required components.
    /// handles all of the specialized boxing that allows for simple parallelization.
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        search_algorithm: SearchAlgorithm,
        graph: Arc<Graph>,
        map_model: Arc<MapModel>,
        state_model: Arc<StateModel>,
        traversal_model_services: Vec<Arc<dyn TraversalModelService>>,
        constraint_model_services: Vec<Arc<dyn ConstraintModelService>>,
        cost_model_service: CostModelService,
        termination_model: TerminationModel,
        label_model_service: Arc<dyn LabelModelService>,
        default_edge_list: Option<usize>,
    ) -> Self {
        SearchApp {
            search_algorithm,
            graph,
            map_model,
            state_model,
            traversal_model_services,
            cost_model_service: Arc::new(cost_model_service),
            constraint_model_services,
            termination_model: Arc::new(termination_model),
            label_model_service,
            default_edge_list,
        }
    }

    /// main interface for running search. takes a user query and builds the instance of the
    /// search assets and then executes a search. if a destination is set on the query, then the
    /// route is computed. if the algorithm produces more than one route, then the result contains
    /// each route. the SearchAlgorithm determines the order and number of routes and trees in the result.
    ///
    /// # Arguments
    ///
    /// * `query` - a JSON search query provided by the user
    ///
    /// # Results
    ///
    /// The complete set of trees, routes, and search assets for this run.
    pub fn run(
        &self,
        query: &mut serde_json::Value,
    ) -> Result<(SearchAppResult, SearchInstance), CompassAppError> {
        let search_start_time = Local::now();
        let si = self.build_search_instance(query)?;
        self.map_model.map_match(query, &si)?;

        // depending on the presence of an origin edge or origin vertex, we run each type of query
        let results = if query.get_origin_edge().is_ok() {
            let o = query.get_origin_edge().map_err(|e| {
                CompassAppError::PluginError(PluginError::BuildFailed(format!("attempting to run search app with query that has an invalid origin_edge value: {e}")))
            })?;
            let d_opt = query.get_destination_edge().map_err(|e| {
                CompassAppError::PluginError(PluginError::BuildFailed(format!("attempting to run search app with query that has an invalid destination_edge value: {e}")))
            })?;
            self.search_algorithm
                .run_edge_oriented(o, d_opt, query, &Direction::Forward, &si)
                .map_err(CompassAppError::SearchFailure)
        } else if query.get_origin_vertex().is_ok() {
            let o = query.get_origin_vertex().map_err(|e| {
                CompassAppError::PluginError(PluginError::BuildFailed(format!("attempting to run search app with query that has an invalid origin_vertex value: {e}")))
            })?;
            let d = query.get_destination_vertex().map_err(|e| {
                CompassAppError::PluginError(PluginError::BuildFailed(format!("attempting to run search app with query that has an invalid origin_vertex value: {e}")))
            })?;

            self.search_algorithm
                .run_vertex_oriented(o, d, query, &Direction::Forward, &si)
                .map_err(CompassAppError::SearchFailure)
        } else {
            Err(CompassAppError::CompassFailure(String::from("SearchApp.run called with query that lacks origin_edge and origin_vertex, at least one required")))
        }?;

        let search_end_time = Local::now();
        let search_runtime = (search_end_time - search_start_time)
            .to_std()
            .unwrap_or(time::Duration::ZERO);

        log::debug!(
            "Search Completed in {:?} miliseconds",
            search_runtime.as_millis()
        );

        let result = SearchAppResult {
            routes: results.routes,
            trees: results.trees,
            search_executed_time: search_start_time.to_rfc3339(),
            search_runtime,
            iterations: results.iterations,
            terminated: results.terminated,
        };

        Ok((result, si))
    }

    /// builds the assets that will run the search for this query instance.
    ///
    /// # Arguments
    ///
    /// * `query` - the user query initiating this search
    ///
    /// # Results
    ///
    /// The SearchInstance which runs this search query.
    pub fn build_search_instance(
        &self,
        query: &serde_json::Value,
    ) -> Result<SearchInstance, SearchError> {
        let traversal_models = self
            .traversal_model_services
            .iter()
            .map(|m| m.build(query))
            .collect::<Result<Vec<_>, _>>()?;

        let output_features = search_app_ops::collect_features(query, &traversal_models)?;
        let state_model_instance = self.state_model.register(vec![], output_features)?;
        let state_model = Arc::new(state_model_instance);

        let cost_constraint = self.search_algorithm.cost_constraint();
        let cost_model = self
            .cost_model_service
            .build(query, state_model.clone(), cost_constraint)
            .map_err(|e| SearchError::BuildError(e.to_string()))?;
        let constraint_models = self
            .constraint_model_services
            .iter()
            .map(|m| m.build(query, state_model.clone()))
            .collect::<Result<Vec<_>, _>>()?;

        let label_model = self.label_model_service.build(query, state_model.clone())?;

        let search_assets = SearchInstance {
            graph: self.graph.clone(),
            map_model: self.map_model.clone(),
            state_model,
            traversal_models,
            cost_model: Arc::new(cost_model),
            constraint_models,
            termination_model: self.termination_model.clone(),
            label_model,
            default_edge_list: self.default_edge_list,
        };

        Ok(search_assets)
    }
}