re-applying 'logging_overhaul_redo' changes to master

CHANGELOG.md

@@ -1,35 +1,7 @@
 # Changelog
 
-## 2.12.0
-
 * Please refer to https://fzyzcjy.github.io/flutter_rust_bridge/guides/miscellaneous/whats-new for what's changed in V2.
-* Add `no_dart_fix`, `no_dart_format` and `no_write_lib` to `flutter_rust_bridge_codegen integrate` #2790 (thanks @xuxiaocheng0201)
-* Check for target dependencies when auto upgrading in codegen #2805 (thanks @turtletongue)
-* Update troubleshooting.md #2806
-* Run scheduled CIs only when the repo owner is correct #2817 (thanks @AlexV525)
-* Use `fvm install` to prevent `flutter_rust_bridge_codegen generate` from hanging #2834 (thanks @ethicnology)
-* Support having a different crate name than the Flutter plugin #2859 (thanks @NathanKolbas)
-* Update GitHub CI workflow to use new iOS simulators #2866 (thanks @NathanKolbas)
-* Add resolution in yaml struct and workspace root resolution logic #2872 (thanks @AadamZ5)
-* Update actions versions of all workflows #2876 (thanks @h3x4d3c1m4l)
-* Add support for optional publish tag in release workflow #2877 (thanks @h3x4d3c1m4l)
-* Support multiple flutter_rust_bridge packages on web #2903 (thanks @dt-iohk)
-* Add encoded types DCO support #2905 (thanks @SilverMira)
-* Fix Windows 10 `flutter_rust_bridge_codegen build-web` failure #2906 (thanks @marcmcd)
-* Use `Vec::with_capacity` instead of `vec![]` in SSE vector decode #2926 (thanks @Shadowcat650)
-* Fix unhandled error in dart_fn_handle_output when sending message #2941 (thanks @khangah)
-* Upgrade versions and CI #2951 #2934 #2810 #2918 #2932 #2811
-* Added suggestion to update cargo in troubleshooting.md #2955 (thanks @dgasparri)
-* Regenerate tests #2973 #2982 (thanks @TrackerSB)
-* Add DevContainer and Dockerfile #2981
-* Add Claude skills and enhance development guidance #2983
-* Add upgrade notice to V1 documentation pages #2984
-* Add web test support to skills and Dockerfile #2986
-* Update PR template and tips #2989
-* Revise troubleshooting steps for Cargokit and Flutter #2994 (thanks @liruohrh)
-* Fix web build with latest wasm-bindgen/js-sys versions #3010
-* Create docker image for development #3025
-* Add configurable log levels to setup functions #3026 (thanks @futpib)
+* Overhaul of the logging implementation, from an opinionated approach to a configurable one. Please consult the [documentation](https://fzyzcjy.github.io/flutter_rust_bridge/guides/logging) for more information. If you implemented logging yourself you might have to migrate your changes.
 
 ## 2.11.1
 

Cargo.toml

@@ -4,6 +4,7 @@ exclude = [
     # Exclude example packages to ensure the example mimics how a typical user will use it.
     # For example, the `target` directory is different with and without workspaces.
     "frb_example/dart_minimal/rust",
+    "frb_example/dart_logging/rust",
     "frb_example/deliberate_bad/rust",
     "frb_example/flutter_via_create/rust",
     "frb_example/flutter_via_integrate/rust",

frb_codegen/assets/integration_template/shared/REPLACE_ME_RUST_CRATE_DIR/Cargo.toml.template

@@ -8,6 +8,8 @@ crate-type = ["cdylib", "staticlib"]
 
 [dependencies]
 flutter_rust_bridge = REPLACE_ME_RUST_FRB_DEPENDENCY
+# Optional - can be removed if you do not want logging
+log = "^0.4.20"
 
 [lints.rust]
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(frb_expand)'] }

frb_codegen/assets/integration_template/shared/REPLACE_ME_RUST_CRATE_DIR/src/lib.rs

@@ -1,2 +1,6 @@
-pub mod api;
+// AUTO INJECTED BY flutter_rust_bridge.
+// The following lines may not be accurate; change them according to your needs.
 mod frb_generated;
+// END of AUTO INJECTED code
+
+pub mod api;

frb_codegen/src/binary/commands_parser.rs

@@ -80,7 +80,6 @@ mod tests {
     use crate::binary::test_utils::set_cwd_test_fixture;
     use clap::Parser;
     use itertools::concat;
-    use lib_flutter_rust_bridge_codegen::utils::logs::configure_opinionated_test_logging;
     use lib_flutter_rust_bridge_codegen::{codegen, if_then_some};
     use serial_test::serial;
 
@@ -89,7 +88,6 @@ mod tests {
     #[serial]
     fn test_compute_codegen_config_mode_from_files_auto_flutter_rust_bridge_yaml(
     ) -> anyhow::Result<()> {
-        configure_opinionated_test_logging();
         set_cwd_test_fixture("binary/commands_parser/flutter_rust_bridge_yaml")?;
 
         let config = run_command_line(vec!["", "generate"])?;
@@ -102,7 +100,6 @@ mod tests {
     #[test]
     #[serial]
     fn test_compute_codegen_config_mode_from_files_auto_pubspec_yaml() -> anyhow::Result<()> {
-        configure_opinionated_test_logging();
         set_cwd_test_fixture("binary/commands_parser/pubspec_yaml")?;
 
         let config = run_command_line(vec!["", "generate"])?;
@@ -116,7 +113,6 @@ mod tests {
     #[serial]
     fn test_compute_codegen_config_mode_from_files_auto_pubspec_yaml_faulty() -> anyhow::Result<()>
     {
-        configure_opinionated_test_logging();
         set_cwd_test_fixture("binary/commands_parser/faulty_pubspec_yaml")?;
 
         let result = run_command_line(vec!["", "generate"]);
@@ -134,7 +130,6 @@ mod tests {
     #[test]
     #[serial]
     fn test_compute_codegen_config_mode_config_file() -> anyhow::Result<()> {
-        configure_opinionated_test_logging();
         set_cwd_test_fixture("binary/commands_parser/config_file")?;
 
         let config = run_command_line(vec!["", "generate", "--config-file", "hello.yaml"])?;
@@ -147,7 +142,6 @@ mod tests {
     #[test]
     #[serial]
     fn test_compute_codegen_config_mode_config_file_faulty_file() -> anyhow::Result<()> {
-        configure_opinionated_test_logging();
         set_cwd_test_fixture("binary/commands_parser/flutter_rust_bridge_yaml")?;
         let result = run_command_line(vec![
             "",
@@ -168,7 +162,6 @@ mod tests {
     #[test]
     #[serial]
     fn test_compute_codegen_config_mode_from_naive_generate_command_args() {
-        configure_opinionated_test_logging();
         set_cwd_test_fixture("binary/commands_parser").unwrap(); // use whatever folder without config file
 
         // bool flags
@@ -196,7 +189,6 @@ mod tests {
     #[test]
     #[serial]
     fn test_compute_codegen_config_from_both_file_and_command_line() -> anyhow::Result<()> {
-        configure_opinionated_test_logging();
         set_cwd_test_fixture("binary/commands_parser/flutter_rust_bridge_yaml")?;
 
         let config = run_command_line(vec!["", "generate", "--llvm-path", "/my/path"])?;

frb_codegen/src/library/codegen/config/internal_config_parser/mod.rs

@@ -206,7 +206,6 @@ mod tests {
     use crate::codegen::config::config::MetaConfig;
     use crate::codegen::config::internal_config::InternalConfig;
     use crate::codegen::Config;
-    use crate::utils::logs::configure_opinionated_test_logging;
     use crate::utils::test_utils::{
         create_path_sanitizers, get_test_fixture_dir, json_golden_test,
     };
@@ -229,7 +228,6 @@ mod tests {
     }
 
     fn body(fixture_name: &str) -> anyhow::Result<()> {
-        configure_opinionated_test_logging();
         let test_fixture_dir = get_test_fixture_dir(fixture_name);
         env::set_current_dir(&test_fixture_dir)?;
         info!("test_fixture_dir={test_fixture_dir:?}");

frb_codegen/src/library/codegen/generator/api_dart/mod.rs

@@ -50,7 +50,6 @@ mod tests {
     use crate::codegen::generator::api_dart::generate;
     use crate::codegen::misc::GeneratorProgressBarPack;
     use crate::codegen::Config;
-    use crate::utils::logs::configure_opinionated_test_logging;
     use crate::utils::test_utils::{get_test_fixture_dir, text_golden_test};
     use serial_test::serial;
     use std::collections::HashMap;
@@ -82,7 +81,6 @@ mod tests {
     }
 
     fn body(fixture_name: &str, expect_outputs: HashMap<&str, &str>) -> anyhow::Result<()> {
-        configure_opinionated_test_logging();
         let test_fixture_dir = get_test_fixture_dir(fixture_name);
         env::set_current_dir(&test_fixture_dir)?;
 

frb_codegen/src/library/codegen/generator/api_dart/spec_generator/sanity_checker.rs

@@ -21,7 +21,7 @@ pub(crate) fn sanity_check_class_name_duplicates(
         );
 
         if std::env::var(SKIP_ENV_VAR).is_ok() {
-            warn!("{}", message);
+            warn!("{message}",);
         } else {
             bail!(
                 "{}Another way to debug is to temporarily set environment variable `{}=1` and check the generated code.",

frb_codegen/src/library/codegen/parser/hir/tree/transformer/pub_use_transformer.rs

@@ -123,10 +123,7 @@ fn transform_module_by_pub_use_single(
     if let Some(src_mod) = module.get_module_nested(&pub_use_info.namespace.path()) {
         // Codecov seems to be buggy by saying this line is not covered (while lines above/below) are
         // frb-coverage:ignore-start
-        log::debug!(
-            "transform_module_by_pub_use_single pub_use_info={:?}",
-            pub_use_info
-        );
+        log::debug!("transform_module_by_pub_use_single pub_use_info={pub_use_info:?}");
         // frb-coverage:ignore-end
 
         if src_mod.meta.is_public() {

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

@@ -71,7 +71,6 @@ mod tests {
         ParserMirInternalConfig, RustInputNamespacePack,
     };
     use crate::codegen::parser::{parse_inner, MirPack};
-    use crate::utils::logs::configure_opinionated_test_logging;
     use crate::utils::namespace::Namespace;
     use crate::utils::test_utils::{
         create_path_sanitizers, get_test_fixture_dir, json_golden_test,
@@ -157,7 +156,6 @@ mod tests {
         fixture_name: &str,
         rust_input_namespace_pack: Option<Box<dyn Fn(&Path) -> RustInputNamespacePack>>,
     ) -> anyhow::Result<(MirPack, PathBuf)> {
-        configure_opinionated_test_logging();
         let test_fixture_dir = get_test_fixture_dir(fixture_name);
         let rust_crate_dir = test_fixture_dir.clone();
         info!("test_fixture_dir={test_fixture_dir:?}");