AppFlowy/frontend/rust-lib/flowy-grid/tests/grid/field_test/test.rs

use crate::grid::field_test::script::FieldScript::*;
use crate::grid::field_test::script::GridFieldTest;
use crate::grid::field_test::util::*;
use bytes::Bytes;
use flowy_grid::entities::{FieldChangesetParams, FieldType};
use flowy_grid::services::field::selection_type_option::SelectOptionPB;
use flowy_grid::services::field::{gen_option_id, SingleSelectTypeOptionPB, CHECK, UNCHECK};

#[tokio::test]
async fn grid_create_field() {
    let mut test = GridFieldTest::new().await;
    let (params, field_rev) = create_text_field(&test.view_id());

    let scripts = vec![
        CreateField { params },
        AssertFieldTypeOptionEqual {
            field_index: test.field_count(),
            expected_type_option_data: field_rev.get_type_option_str(field_rev.ty).unwrap().to_owned(),
        },
    ];
    test.run_scripts(scripts).await;

    let (params, field_rev) = create_single_select_field(&test.view_id());
    let scripts = vec![
        CreateField { params },
        AssertFieldTypeOptionEqual {
            field_index: test.field_count(),
            expected_type_option_data: field_rev.get_type_option_str(field_rev.ty).unwrap().to_owned(),
        },
    ];
    test.run_scripts(scripts).await;
}

#[tokio::test]
async fn grid_create_duplicate_field() {
    let mut test = GridFieldTest::new().await;
    let (params, _) = create_text_field(&test.view_id());
    let field_count = test.field_count();
    let expected_field_count = field_count + 1;
    let scripts = vec![
        CreateField { params: params.clone() },
        AssertFieldCount(expected_field_count),
    ];
    test.run_scripts(scripts).await;
}

#[tokio::test]
async fn grid_update_field_with_empty_change() {
    let mut test = GridFieldTest::new().await;
    let (params, _) = create_single_select_field(&test.view_id());
    let create_field_index = test.field_count();
    let scripts = vec![CreateField { params }];
    test.run_scripts(scripts).await;

    let field_rev = (*test.field_revs.clone().pop().unwrap()).clone();
    let changeset = FieldChangesetParams {
        field_id: field_rev.id.clone(),
        grid_id: test.view_id(),
        ..Default::default()
    };

    let scripts = vec![
        UpdateField { changeset },
        AssertFieldTypeOptionEqual {
            field_index: create_field_index,
            expected_type_option_data: field_rev.get_type_option_str(field_rev.ty).unwrap().to_owned(),
        },
    ];
    test.run_scripts(scripts).await;
}

#[tokio::test]
async fn grid_update_field() {
    let mut test = GridFieldTest::new().await;
    let (params, _) = create_single_select_field(&test.view_id());
    let scripts = vec![CreateField { params }];
    let create_field_index = test.field_count();
    test.run_scripts(scripts).await;
    //
    let single_select_field = (*test.field_revs.clone().pop().unwrap()).clone();
    let mut single_select_type_option = SingleSelectTypeOptionPB::from(&single_select_field);
    single_select_type_option.options.push(SelectOptionPB::new("Unknown"));

    let changeset = FieldChangesetParams {
        field_id: single_select_field.id.clone(),
        grid_id: test.view_id(),
        frozen: Some(true),
        width: Some(1000),
        ..Default::default()
    };

    // The expected_field must be equal to the field that applied the changeset
    let mut expected_field_rev = single_select_field.clone();
    expected_field_rev.frozen = true;
    expected_field_rev.width = 1000;
    expected_field_rev.insert_type_option(&single_select_type_option);

    let scripts = vec![
        UpdateField { changeset },
        AssertFieldFrozen {
            field_index: create_field_index,
            frozen: true,
        },
    ];
    test.run_scripts(scripts).await;
}

#[tokio::test]
async fn grid_delete_field() {
    let mut test = GridFieldTest::new().await;
    let original_field_count = test.field_count();
    let (params, _) = create_text_field(&test.view_id());
    let scripts = vec![CreateField { params }];
    test.run_scripts(scripts).await;

    let text_field_rev = (*test.field_revs.clone().pop().unwrap()).clone();
    let scripts = vec![
        DeleteField {
            field_rev: text_field_rev,
        },
        AssertFieldCount(original_field_count),
    ];
    test.run_scripts(scripts).await;
}

#[tokio::test]
async fn grid_switch_from_select_option_to_checkbox_test() {
    let mut test = GridFieldTest::new().await;
    let field_rev = test.get_first_field_rev(FieldType::SingleSelect);

    // Update the type option data of single select option
    let mut single_select_type_option = test.get_single_select_type_option(&field_rev.id);
    single_select_type_option.options.clear();
    // Add a new option with name CHECK
    single_select_type_option.options.push(SelectOptionPB {
        id: gen_option_id(),
        name: CHECK.to_string(),
        color: Default::default(),
    });
    // Add a new option with name UNCHECK
    single_select_type_option.options.push(SelectOptionPB {
        id: gen_option_id(),
        name: UNCHECK.to_string(),
        color: Default::default(),
    });

    let bytes: Bytes = single_select_type_option.try_into().unwrap();
    let scripts = vec![
        UpdateTypeOption {
            field_id: field_rev.id.clone(),
            type_option: bytes.to_vec(),
        },
        SwitchToField {
            field_id: field_rev.id.clone(),
            new_field_type: FieldType::Checkbox,
        },
    ];
    test.run_scripts(scripts).await;
}

#[tokio::test]
async fn grid_switch_from_checkbox_to_select_option_test() {
    let mut test = GridFieldTest::new().await;
    let field_rev = test.get_first_field_rev(FieldType::Checkbox).clone();
    let scripts = vec![
        // switch to single-select field type
        SwitchToField {
            field_id: field_rev.id.clone(),
            new_field_type: FieldType::SingleSelect,
        },
        // Assert the cell content after switch the field type. The cell content will be changed if
        // the FieldType::SingleSelect implement the cell data TypeOptionTransform. Check out the
        // TypeOptionTransform trait for more information.
        //
        // Make sure which cell of the row you want to check.
        AssertCellContent {
            field_id: field_rev.id.clone(),
            // the mock data of the checkbox with row_index one is "true"
            row_index: 1,
            // the from_field_type represents as the current field type
            from_field_type: FieldType::Checkbox,
            // The content of the checkbox should transform to the corresponding option name.
            expected_content: CHECK.to_string(),
        },
    ];
    test.run_scripts(scripts).await;

    let single_select_type_option = test.get_single_select_type_option(&field_rev.id);
    assert_eq!(single_select_type_option.options.len(), 2);
    assert!(single_select_type_option
        .options
        .iter()
        .any(|option| option.name == UNCHECK));
    assert!(single_select_type_option
        .options
        .iter()
        .any(|option| option.name == CHECK));
}

// Test when switching the current field from Multi-select to Text test
// The build-in test data is located in `make_test_grid` method(flowy-grid/tests/grid_editor.rs).
// input:
//      option1, option2 -> "option1.name, option2.name"
#[tokio::test]
async fn grid_switch_from_multi_select_to_text_test() {
    let mut test = GridFieldTest::new().await;
    let field_rev = test.get_first_field_rev(FieldType::MultiSelect).clone();

    let multi_select_type_option = test.get_multi_select_type_option(&field_rev.id);

    let script_switch_field = vec![SwitchToField {
        field_id: field_rev.id.clone(),
        new_field_type: FieldType::RichText,
    }];

    test.run_scripts(script_switch_field).await;

    let script_assert_field = vec![AssertCellContent {
        field_id: field_rev.id.clone(),
        row_index: 0,
        from_field_type: FieldType::MultiSelect,
        expected_content: format!(
            "{},{}",
            multi_select_type_option.get(0).unwrap().name,
            multi_select_type_option.get(1).unwrap().name
        ),
    }];

    test.run_scripts(script_assert_field).await;
}

// Test when switching the current field from Checkbox to Text test
// input:
//      check -> "Yes"
//      unchecked -> ""
#[tokio::test]
async fn grid_switch_from_checkbox_to_text_test() {
    let mut test = GridFieldTest::new().await;
    let field_rev = test.get_first_field_rev(FieldType::Checkbox);

    let scripts = vec![
        SwitchToField {
            field_id: field_rev.id.clone(),
            new_field_type: FieldType::RichText,
        },
        AssertCellContent {
            field_id: field_rev.id.clone(),
            row_index: 1,
            from_field_type: FieldType::Checkbox,
            expected_content: "Yes".to_string(),
        },
        AssertCellContent {
            field_id: field_rev.id.clone(),
            row_index: 2,
            from_field_type: FieldType::Checkbox,
            expected_content: "No".to_string(),
        },
    ];
    test.run_scripts(scripts).await;
}

// Test when switching the current field from Checkbox to Text test
// input:
//      "Yes" -> check
//      "" -> unchecked
#[tokio::test]
async fn grid_switch_from_text_to_checkbox_test() {
    let mut test = GridFieldTest::new().await;
    let field_rev = test.get_first_field_rev(FieldType::RichText).clone();

    let scripts = vec![
        SwitchToField {
            field_id: field_rev.id.clone(),
            new_field_type: FieldType::Checkbox,
        },
        AssertCellContent {
            field_id: field_rev.id.clone(),
            row_index: 0,
            from_field_type: FieldType::RichText,
            expected_content: "".to_string(),
        },
    ];
    test.run_scripts(scripts).await;
}

// Test when switching the current field from Date to Text test
// input:
//      1647251762 -> Mar 14,2022 (This string will be different base on current data setting)
#[tokio::test]
async fn grid_switch_from_date_to_text_test() {
    let mut test = GridFieldTest::new().await;
    let field_rev = test.get_first_field_rev(FieldType::DateTime).clone();
    let scripts = vec![
        SwitchToField {
            field_id: field_rev.id.clone(),
            new_field_type: FieldType::RichText,
        },
        AssertCellContent {
            field_id: field_rev.id.clone(),
            row_index: 2,
            from_field_type: FieldType::DateTime,
            expected_content: "2022/03/14".to_string(),
        },
        AssertCellContent {
            field_id: field_rev.id.clone(),
            row_index: 3,
            from_field_type: FieldType::DateTime,
            expected_content: "2022/11/17".to_string(),
        },
    ];
    test.run_scripts(scripts).await;
}

// Test when switching the current field from Number to Text test
// input:
//      $1 -> "$1"(This string will be different base on current data setting)
#[tokio::test]
async fn grid_switch_from_number_to_text_test() {
    let mut test = GridFieldTest::new().await;
    let field_rev = test.get_first_field_rev(FieldType::Number).clone();

    let scripts = vec![
        SwitchToField {
            field_id: field_rev.id.clone(),
            new_field_type: FieldType::RichText,
        },
        AssertCellContent {
            field_id: field_rev.id.clone(),
            row_index: 0,
            from_field_type: FieldType::Number,
            expected_content: "$1".to_string(),
        },
        AssertCellContent {
            field_id: field_rev.id.clone(),
            row_index: 4,
            from_field_type: FieldType::Number,
            expected_content: "".to_string(),
        },
    ];

    test.run_scripts(scripts).await;
}