path: root/src/tools/rust-analyzer/crates/ide-diagnostics/src/handlers/json_is_not_rust.rs

//! This diagnostic provides an assist for creating a struct definition from a JSON
//! example.

use hir::{PathResolution, Semantics};
use ide_db::{
    base_db::FileId,
    helpers::mod_path_to_ast,
    imports::insert_use::{insert_use, ImportScope},
    source_change::SourceChangeBuilder,
    RootDatabase,
};
use itertools::Itertools;
use stdx::{format_to, never};
use syntax::{
    ast::{self, make},
    SyntaxKind, SyntaxNode,
};
use text_edit::TextEdit;

use crate::{fix, Diagnostic, DiagnosticsConfig, Severity};

#[derive(Default)]
struct State {
    result: String,
    struct_counts: usize,
    has_serialize: bool,
    has_deserialize: bool,
}

impl State {
    fn generate_new_name(&mut self) -> ast::Name {
        self.struct_counts += 1;
        make::name(&format!("Struct{}", self.struct_counts))
    }

    fn serde_derive(&self) -> String {
        let mut v = vec![];
        if self.has_serialize {
            v.push("Serialize");
        }
        if self.has_deserialize {
            v.push("Deserialize");
        }
        match v.as_slice() {
            [] => "".to_string(),
            [x] => format!("#[derive({x})]\n"),
            [x, y] => format!("#[derive({x}, {y})]\n"),
            _ => {
                never!();
                "".to_string()
            }
        }
    }

    fn build_struct(&mut self, value: &serde_json::Map<String, serde_json::Value>) -> ast::Type {
        let name = self.generate_new_name();
        let ty = make::ty(&name.to_string());
        let strukt = make::struct_(
            None,
            name,
            None,
            make::record_field_list(value.iter().sorted_unstable_by_key(|x| x.0).map(
                |(name, value)| make::record_field(None, make::name(name), self.type_of(value)),
            ))
            .into(),
        );
        format_to!(self.result, "{}{}\n", self.serde_derive(), strukt);
        ty
    }

    fn type_of(&mut self, value: &serde_json::Value) -> ast::Type {
        match value {
            serde_json::Value::Null => make::ty_unit(),
            serde_json::Value::Bool(_) => make::ty("bool"),
            serde_json::Value::Number(it) => make::ty(if it.is_i64() { "i64" } else { "f64" }),
            serde_json::Value::String(_) => make::ty("String"),
            serde_json::Value::Array(it) => {
                let ty = match it.iter().next() {
                    Some(x) => self.type_of(x),
                    None => make::ty_placeholder(),
                };
                make::ty(&format!("Vec<{ty}>"))
            }
            serde_json::Value::Object(x) => self.build_struct(x),
        }
    }
}

pub(crate) fn json_in_items(
    sema: &Semantics<'_, RootDatabase>,
    acc: &mut Vec<Diagnostic>,
    file_id: FileId,
    node: &SyntaxNode,
    config: &DiagnosticsConfig,
) {
    (|| {
        if node.kind() == SyntaxKind::ERROR
            && node.first_token().map(|x| x.kind()) == Some(SyntaxKind::L_CURLY)
            && node.last_token().map(|x| x.kind()) == Some(SyntaxKind::R_CURLY)
        {
            let node_string = node.to_string();
            if let Ok(it) = serde_json::from_str(&node_string) {
                if let serde_json::Value::Object(it) = it {
                    let import_scope = ImportScope::find_insert_use_container(node, sema)?;
                    let range = node.text_range();
                    let mut edit = TextEdit::builder();
                    edit.delete(range);
                    let mut state = State::default();
                    let semantics_scope = sema.scope(node)?;
                    let scope_resolve =
                        |it| semantics_scope.speculative_resolve(&make::path_from_text(it));
                    let scope_has = |it| scope_resolve(it).is_some();
                    let deserialize_resolved = scope_resolve("::serde::Deserialize");
                    let serialize_resolved = scope_resolve("::serde::Serialize");
                    state.has_deserialize = deserialize_resolved.is_some();
                    state.has_serialize = serialize_resolved.is_some();
                    state.build_struct(&it);
                    edit.insert(range.start(), state.result);
                    acc.push(
                        Diagnostic::new(
                            "json-is-not-rust",
                            "JSON syntax is not valid as a Rust item",
                            range,
                        )
                        .severity(Severity::WeakWarning)
                        .with_fixes(Some(vec![{
                            let mut scb = SourceChangeBuilder::new(file_id);
                            let scope = match import_scope.clone() {
                                ImportScope::File(it) => ImportScope::File(scb.make_mut(it)),
                                ImportScope::Module(it) => ImportScope::Module(scb.make_mut(it)),
                                ImportScope::Block(it) => ImportScope::Block(scb.make_mut(it)),
                            };
                            let current_module = semantics_scope.module();
                            if !scope_has("Serialize") {
                                if let Some(PathResolution::Def(it)) = serialize_resolved {
                                    if let Some(it) = current_module.find_use_path_prefixed(
                                        sema.db,
                                        it,
                                        config.insert_use.prefix_kind,
                                    ) {
                                        insert_use(
                                            &scope,
                                            mod_path_to_ast(&it),
                                            &config.insert_use,
                                        );
                                    }
                                }
                            }
                            if !scope_has("Deserialize") {
                                if let Some(PathResolution::Def(it)) = deserialize_resolved {
                                    if let Some(it) = current_module.find_use_path_prefixed(
                                        sema.db,
                                        it,
                                        config.insert_use.prefix_kind,
                                    ) {
                                        insert_use(
                                            &scope,
                                            mod_path_to_ast(&it),
                                            &config.insert_use,
                                        );
                                    }
                                }
                            }
                            let mut sc = scb.finish();
                            sc.insert_source_edit(file_id, edit.finish());
                            fix("convert_json_to_struct", "Convert JSON to struct", sc, range)
                        }])),
                    );
                }
            }
        }
        Some(())
    })();
}

#[cfg(test)]
mod tests {
    use crate::{
        tests::{check_diagnostics_with_config, check_fix, check_no_fix},
        DiagnosticsConfig,
    };

    #[test]
    fn diagnostic_for_simple_case() {
        let mut config = DiagnosticsConfig::test_sample();
        config.disabled.insert("syntax-error".to_string());
        check_diagnostics_with_config(
            config,
            r#"
            { "foo": "bar" }
         // ^^^^^^^^^^^^^^^^ 💡 weak: JSON syntax is not valid as a Rust item
"#,
        );
    }

    #[test]
    fn types_of_primitives() {
        check_fix(
            r#"
            //- /lib.rs crate:lib deps:serde
            use serde::Serialize;

            fn some_garbage() {

            }

            {$0
                "foo": "bar",
                "bar": 2.3,
                "baz": null,
                "bay": 57,
                "box": true
            }
            //- /serde.rs crate:serde

            pub trait Serialize {
                fn serialize() -> u8;
            }
            "#,
            r#"
            use serde::Serialize;

            fn some_garbage() {

            }

            #[derive(Serialize)]
            struct Struct1{ bar: f64, bay: i64, baz: (), r#box: bool, foo: String }

            "#,
        );
    }

    #[test]
    fn nested_structs() {
        check_fix(
            r#"
            {$0
                "foo": "bar",
                "bar": {
                    "kind": "Object",
                    "value": {}
                }
            }
            "#,
            r#"
            struct Struct3{  }
            struct Struct2{ kind: String, value: Struct3 }
            struct Struct1{ bar: Struct2, foo: String }

            "#,
        );
    }

    #[test]
    fn arrays() {
        check_fix(
            r#"
            //- /lib.rs crate:lib deps:serde
            {
                "of_string": ["foo", "2", "x"], $0
                "of_object": [{
                    "x": 10,
                    "y": 20
                }, {
                    "x": 10,
                    "y": 20
                }],
                "nested": [[[2]]],
                "empty": []
            }
            //- /serde.rs crate:serde

            pub trait Serialize {
                fn serialize() -> u8;
            }
            pub trait Deserialize {
                fn deserialize() -> u8;
            }
            "#,
            r#"
            use serde::Serialize;
            use serde::Deserialize;

            #[derive(Serialize, Deserialize)]
            struct Struct2{ x: i64, y: i64 }
            #[derive(Serialize, Deserialize)]
            struct Struct1{ empty: Vec<_>, nested: Vec<Vec<Vec<i64>>>, of_object: Vec<Struct2>, of_string: Vec<String> }

            "#,
        );
    }

    #[test]
    fn no_emit_outside_of_item_position() {
        check_no_fix(
            r#"
            fn foo() {
                let json = {$0
                    "foo": "bar",
                    "bar": {
                        "kind": "Object",
                        "value": {}
                    }
                };
            }
            "#,
        );
    }
}