rumtk-web 0.7.2

/*
 * rumtk attempts to implement HL7 and medical protocols for interoperability in medicine.
 * This toolkit aims to be reliable, simple, performant, and standards compliant.
 * Copyright (C) 2025  Luis M. Santos, M.D. <lsantos@medicalmasses.com>
 * Copyright (C) 2025  Ethan Dixon
 * Copyright (C) 2025  MedicalMasses L.L.C. <contact@medicalmasses.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
#![feature(once_cell_get_mut)]
#![feature(macro_metavar_expr)]
extern crate core;

pub mod api;
pub mod components;
pub mod css;
pub mod pages;
pub mod static_components;
pub mod utils;
pub mod js;

pub use app::*;
pub use utils::*;

///
/// Add utils unit tests here to ensure internal functions work.
///
#[cfg(test)]
mod tests {
    use crate::defaults::{DEFAULT_NO_TEXT, DEFAULT_TEXT_ITEM, PARAMS_CSS_CLASS, PARAMS_ID, PARAMS_TITLE};
    use crate::jobs::JobResult;
    use crate::testdata::data::{create_test_form, RAW_HTML_PREFORMATTED, TESTDATA_EXPECTED_FORMDATA, TESTDATA_EXPECTED_FORMDATA_EMPTY, TESTDATA_FORMDATA_EMPTY_REQUEST, TESTDATA_FORMDATA_EMPTY_REQUEST_WITH_BOUNDARIES, TESTDATA_FORMDATA_REQUEST, TRIMMED_HTML_PREFORMATTED, TRIMMED_HTML_TITLE_RENDER};
    use crate::{rumtk_web_check_on_job, rumtk_web_get_job_manager, rumtk_web_get_text_item, rumtk_web_init_components, rumtk_web_init_job_manager, rumtk_web_post_process_html, rumtk_web_render, rumtk_web_render_component, rumtk_web_render_redirect, rumtk_web_render_template, rumtk_web_trim_rendered_html, AppState, HTMLResult, RUMWebData, RUMWebRedirect, SharedAppState, URLParams, URLPath};
    use crate::{RUMWebResponse, RUMWebTemplate};
    use rumtk_core::strings::{RUMString, RUMStringConversions, ToCompactString};
    use rumtk_core::{rumtk_new_lock, rumtk_sleep};

    ///////////////////////////////////FormData/////////////////////////////////////////////////
    #[test]
    fn test_compile_form() {
        let expected_form = TESTDATA_EXPECTED_FORMDATA();
        let form_data = create_test_form(TESTDATA_FORMDATA_REQUEST).expect("Form");

        assert_eq!(form_data, expected_form, "Form results mismatch!");
    }

    #[test]
    fn test_compile_empty_form() {
        let expected_form = TESTDATA_EXPECTED_FORMDATA_EMPTY();
        let form_data = create_test_form(TESTDATA_FORMDATA_EMPTY_REQUEST).expect("Form");

        assert_eq!(form_data, expected_form, "Form results mismatch!");
    }

    #[test]
    fn test_compile_empty_form_with_boundaries() {
        let expected_form = TESTDATA_EXPECTED_FORMDATA_EMPTY();
        let form_data = create_test_form(TESTDATA_FORMDATA_EMPTY_REQUEST_WITH_BOUNDARIES).expect("Form");

        assert_eq!(form_data, expected_form, "Form results mismatch!");
    }

    ///////////////////////////////////Response/////////////////////////////////////////////////
    #[test]
    fn test_render_redirect_response() {
        let url = "http://localhost/redirected";
        let redirect =
            rumtk_web_render_redirect!(RUMWebRedirect::Redirect(url.to_rumstring())).unwrap();
        let redirect_code = redirect.get_code();
        let redirect_url = redirect.get_url();
        assert_eq!(redirect_url, url, "Redirect url mismatch!");
        assert_eq!(redirect_code, 303, "Wrong redirect code!");
    }

    #[test]
    fn test_render_redirect_response_temporary() {
        let url = "http://localhost/redirected";
        let redirect =
            rumtk_web_render_redirect!(RUMWebRedirect::RedirectTemporary(url.to_rumstring()))
                .unwrap();
        let redirect_code = redirect.get_code();
        let redirect_url = redirect.get_url();
        assert_eq!(redirect_url, url, "Redirect url mismatch!");
        assert_eq!(redirect_code, 307, "Wrong redirect code!");
    }

    #[test]
    fn test_render_redirect_response_permanent() {
        let url = "http://localhost/redirected";
        let redirect =
            rumtk_web_render_redirect!(RUMWebRedirect::RedirectPermanent(url.to_rumstring()))
                .unwrap();
        let redirect_code = redirect.get_code();
        let redirect_url = redirect.get_url();
        assert_eq!(redirect_url, url, "Redirect url mismatch!");
        assert_eq!(redirect_code, 308, "Wrong redirect code!");
    }

    #[test]
    fn test_render_standard_web_component() {
        rumtk_web_init_components!(None);

        let params = [(PARAMS_TITLE, "Hello World!")];
        let state = SharedAppState::default();
        let rendered = rumtk_web_render_component!("title", params, state).unwrap().to_rumstring();

        assert_eq!(
            rendered, TRIMMED_HTML_TITLE_RENDER,
            "Commponent rendered improperly!"
        );
    }

    #[test]
    fn test_render() {
        #[derive(RUMWebTemplate)]
        #[template(source = "<div></div>", ext = "html")]
        struct Div {}

        let result = rumtk_web_render(Div {}, RUMWebRedirect::None).unwrap();
        let expected = RUMWebResponse::into_get_response("<div></div>");

        assert_eq!(result, expected, "Test Div template rendered improperly!");
    }


    #[test]
    fn test_trim_preformatted_component() {
        let result = rumtk_web_trim_rendered_html(RAW_HTML_PREFORMATTED.to_string()).unwrap();

        assert_eq!(result, TRIMMED_HTML_PREFORMATTED.to_string(), "Preformatted html string was filtered inappropriately.!");
    }

    ///////////////////////////////////Jobs/////////////////////////////////////////////////
    #[test]
    fn test_job_run() {
        const HELLO_STR: &str = "Hello World";

        let workers: usize = 5;
        rumtk_web_init_job_manager!(&workers);
        rumtk_web_init_components!(
            Some(vec![
                ("my_element", my_element)
            ])
        );

        async fn basic_processor() -> JobResult {
            Ok(Some(rumtk_web_post_process_html!(RUMString::new(HELLO_STR))))
        }

        fn my_element(_path_components: URLPath, params: URLParams, state: SharedAppState) -> HTMLResult {
            let job_id = rumtk_web_get_text_item!(params, PARAMS_ID, DEFAULT_NO_TEXT);
            let css_class = rumtk_web_get_text_item!(params, PARAMS_CSS_CLASS, DEFAULT_TEXT_ITEM);

            let job_result = rumtk_web_check_on_job!("my_element", job_id, state);

            let job_data = job_result.unwrap()?.to_rumstring();

            rumtk_web_post_process_html!(job_data)
        }

        let app_state = rumtk_new_lock!(AppState::default());
        let mut params = RUMWebData::new();
        let job_id = rumtk_web_get_job_manager!().unwrap().spawn_task(basic_processor()).unwrap();
        params.insert(RUMString::from(PARAMS_ID), job_id.to_compact_string());

        rumtk_sleep!(1);
        let rendered = my_element(&[], &params, app_state.clone()).unwrap().to_rumstring();

        assert!(rendered.is_empty(), "Element results survived the rendering process's filtering!");
    }
}