Merge pull request #1978 from fzyzcjy/feat/12081

Hint users when using opaque types inside non opaque structs

Author: fzyzcjy

frb_codegen/src/library/codegen/parser/auto_accessor_parser/field.rs

@@ -14,6 +14,7 @@ use crate::codegen::parser::function_parser::{
     compute_codec_mode_pack, parse_effective_function_name_of_method,
 };
 use crate::codegen::parser::internal_config::ParserInternalConfig;
+use crate::codegen::parser::sanity_checker::auto_accessor_checker;
 use crate::codegen::parser::type_parser::{TypeParser, TypeParserParsingContext};
 use sha1::{Digest, Sha1};
 
@@ -88,7 +89,7 @@ pub(super) fn parse_auto_accessor_of_field(
 
     Ok(IrFuncAndSanityCheckInfo {
         ir_func,
-        sanity_check_hint: super::sanity_checker::check_field(struct_name, field),
+        sanity_check_hint: auto_accessor_checker::check_field(struct_name, field),
     })
 }
 

frb_codegen/src/library/codegen/parser/auto_accessor_parser/mod.rs

@@ -1,5 +1,4 @@
 mod field;
-mod sanity_checker;
 
 use crate::codegen::generator::codec::structs::CodecMode;
 use crate::codegen::ir::func::{IrFunc, IrFuncAccessorMode};
@@ -9,6 +8,7 @@ use crate::codegen::ir::ty::{IrContext, IrType};
 use crate::codegen::parser::attribute_parser::FrbAttributes;
 use crate::codegen::parser::internal_config::ParserInternalConfig;
 use crate::codegen::parser::misc::extract_src_types_in_paths;
+use crate::codegen::parser::sanity_checker::auto_accessor_checker;
 use crate::codegen::parser::source_graph::modules::Struct;
 use crate::codegen::parser::type_parser::{
     TypeParser, TypeParserParsingContext, TypeParserWithContext,
@@ -36,7 +36,7 @@ pub(crate) fn parse_auto_accessors(
         .flatten()
         .collect_vec();
 
-    sanity_checker::report(
+    auto_accessor_checker::report(
         &infos
             .iter()
             .flat_map(|x| x.sanity_check_hint.clone())
@@ -113,5 +113,5 @@ fn create_parsing_context(
 
 struct IrFuncAndSanityCheckInfo {
     ir_func: IrFunc,
-    sanity_check_hint: Option<sanity_checker::SanityCheckHint>,
+    sanity_check_hint: Option<auto_accessor_checker::SanityCheckHint>,
 }

frb_codegen/src/library/codegen/parser/mod.rs

@@ -6,11 +6,10 @@ pub(crate) mod function_parser;
 pub(crate) mod internal_config;
 pub(crate) mod misc;
 pub(crate) mod reader;
-mod sanity_checker;
+pub(crate) mod sanity_checker;
 pub(crate) mod source_graph;
 pub(crate) mod type_alias_resolver;
 pub(crate) mod type_parser;
-mod unused_checker;
 
 use crate::codegen::dumper::Dumper;
 use crate::codegen::ir::func::IrFunc;
@@ -25,11 +24,12 @@ use crate::codegen::parser::function_parser::FunctionParser;
 use crate::codegen::parser::internal_config::ParserInternalConfig;
 use crate::codegen::parser::misc::parse_has_executor;
 use crate::codegen::parser::reader::CachedRustReader;
-use crate::codegen::parser::sanity_checker::check_suppressed_input_path_no_content;
+use crate::codegen::parser::sanity_checker::misc_checker::check_suppressed_input_path_no_content;
+use crate::codegen::parser::sanity_checker::opaque_inside_translatable_checker::check_opaque_inside_translatable;
+use crate::codegen::parser::sanity_checker::unused_checker::get_unused_types;
 use crate::codegen::parser::source_graph::modules::Struct;
 use crate::codegen::parser::type_alias_resolver::resolve_type_aliases;
 use crate::codegen::parser::type_parser::TypeParser;
-use crate::codegen::parser::unused_checker::get_unused_types;
 use crate::codegen::ConfigDumpContent;
 use crate::library::misc::consts::HANDLER_NAME;
 use anyhow::ensure;
@@ -109,6 +109,8 @@ pub(crate) fn parse(
         &config.rust_crate_dir,
     )?;
 
+    check_opaque_inside_translatable(&ans);
+
     Ok(ans)
 }
 

…r/auto_accessor_parser/sanity_checker.rs …/sanity_checker/auto_accessor_checker.rsfrb_codegen/src/library/codegen/parser/auto_accessor_parser/sanity_checker.rs renamed to frb_codegen/src/library/codegen/parser/sanity_checker/auto_accessor_checker.rs frb_codegen/src/library/codegen/parser/auto_accessor_parser/sanity_checker.rs renamed to frb_codegen/src/library/codegen/parser/sanity_checker/auto_accessor_checker.rs

@@ -4,7 +4,7 @@ use crate::library::codegen::ir::ty::IrTypeTrait;
 use itertools::Itertools;
 use log::warn;
 
-pub(super) fn check_field(
+pub(crate) fn check_field(
     struct_name: &NamespacedName,
     field: &IrField,
 ) -> Option<SanityCheckHint> {
@@ -13,7 +13,7 @@ pub(super) fn check_field(
     })
 }
 
-pub(super) fn report(hints: &[SanityCheckHint]) {
+pub(crate) fn report(hints: &[SanityCheckHint]) {
     if hints.is_empty() {
         return;
     }
@@ -27,7 +27,7 @@ pub(super) fn report(hints: &[SanityCheckHint]) {
 }
 
 #[derive(Clone)]
-pub(super) struct SanityCheckHint {
+pub(crate) struct SanityCheckHint {
     name: String,
 }
 

…library/codegen/parser/sanity_checker.rs …en/parser/sanity_checker/misc_checker.rsfrb_codegen/src/library/codegen/parser/sanity_checker.rs renamed to frb_codegen/src/library/codegen/parser/sanity_checker/misc_checker.rs frb_codegen/src/library/codegen/parser/sanity_checker.rs renamed to frb_codegen/src/library/codegen/parser/sanity_checker/misc_checker.rs

@@ -0,0 +1,4 @@
+pub(crate) mod auto_accessor_checker;
+pub(crate) mod misc_checker;
+pub(crate) mod opaque_inside_translatable_checker;
+pub(crate) mod unused_checker;

frb_codegen/src/library/codegen/parser/sanity_checker/mod.rs

@@ -0,0 +1,59 @@
+use crate::codegen::ir::field::IrField;
+use crate::codegen::ir::pack::IrPack;
+use crate::codegen::ir::ty::enumeration::IrVariantKind;
+use crate::codegen::ir::ty::structure::IrStruct;
+use crate::codegen::ir::ty::IrType;
+use itertools::Itertools;
+use log::info;
+
+pub(crate) fn check_opaque_inside_translatable(pack: &IrPack) {
+    let hint_names = (pack.distinct_types(None).into_iter())
+        .flat_map(|ty| handle_type(pack, ty))
+        .collect_vec();
+    if !hint_names.is_empty() {
+        info!(
+            "It is suggested (but not required) to wrap opaque inside non-opaque type with `RustAutoOpaque<..>`. \
+            See https://fzyzcjy.github.io/flutter_rust_bridge/guides/types/arbitrary/rust-auto-opaque/opaque-in-translatable for more details. \
+            Related types: {}",
+            hint_names.join(", "),
+        );
+    }
+}
+
+fn handle_type(pack: &IrPack, ty: IrType) -> Vec<String> {
+    match ty {
+        IrType::StructRef(ty) => {
+            let st = ty.get(pack);
+            handle_struct(st, &ty.ident.0.rust_style())
+        }
+        IrType::EnumRef(ty) => {
+            let en = ty.get(pack);
+            en.variants
+                .iter()
+                .flat_map(|variant| match &variant.kind {
+                    IrVariantKind::Value => vec![],
+                    IrVariantKind::Struct(st) => handle_struct(
+                        st,
+                        &format!("{}.{}", ty.ident.0.rust_style(), variant.name.rust_style()),
+                    ),
+                })
+                .collect_vec()
+        }
+        // TODO also check and hint `Vec<OpaqueType>`, etc
+        _ => vec![],
+    }
+}
+
+fn handle_struct(st: &IrStruct, partial_name: &str) -> Vec<String> {
+    (st.fields.iter())
+        .filter_map(|field| handle_field(field, partial_name))
+        .collect()
+}
+
+fn handle_field(field: &IrField, partial_name: &str) -> Option<String> {
+    if matches!(field.ty, IrType::RustAutoOpaqueImplicit(_)) {
+        Some(format!("{partial_name}.{}", field.name.rust_style()))
+    } else {
+        None
+    }
+}

frb_codegen/src/library/codegen/parser/sanity_checker/opaque_inside_translatable_checker.rs

@@ -10,7 +10,7 @@ use std::collections::{HashMap, HashSet};
 use std::path::{Path, PathBuf};
 use syn::Type;
 
-pub(super) fn get_unused_types(
+pub(crate) fn get_unused_types(
     pack: &IrPack,
     src_structs: &HashMap<String, &Struct>,
     src_enums: &HashMap<String, &Enum>,

…library/codegen/parser/unused_checker.rs …/parser/sanity_checker/unused_checker.rsfrb_codegen/src/library/codegen/parser/unused_checker.rs renamed to frb_codegen/src/library/codegen/parser/sanity_checker/unused_checker.rs frb_codegen/src/library/codegen/parser/unused_checker.rs renamed to frb_codegen/src/library/codegen/parser/sanity_checker/unused_checker.rs

@@ -5,17 +5,13 @@ There is no need to memorize anything here (or anything in doc) -
 the code generator will provide warnings when detecting non-best-practices.
 :::
 
-Suppose you want to have a translatable struct, and it has an auto opaque field:
+Suppose you want to have a translatable struct, and it has an (auto) opaque field:
 
 ```rust
-pub struct A {
-    pub name: String,
-    pub b: B,
-}
+pub struct A { pub b: B }
 
-pub struct B {
-    db: FancyDatabaseConnection,
-}
+// Suppose it is opaque
+pub struct B { ... }
 ```
 
 If you want to use the same object of type `A` multiple times,