feat: add sozo stats back

bin/sozo/Cargo.toml

@@ -35,6 +35,7 @@ scarb.workspace = true
 scarb-ui.workspace = true
 semver.workspace = true
 serde.workspace = true
+serde_json.workspace = true
 smol_str.workspace = true
 sozo-ops.workspace = true
 sozo-walnut = { workspace = true, optional = true }
@@ -43,7 +44,6 @@ starknet.workspace = true
 starknet-crypto.workspace = true
 thiserror.workspace = true
 toml.workspace = true
-tokio.workspace = true
 tracing.workspace = true
 tracing-log.workspace = true
 tracing-subscriber.workspace = true
@@ -55,6 +55,7 @@ reqwest = { workspace = true, features = [ "json" ], optional = true }
 dojo-test-utils = { workspace = true, features = [ "build-examples" ] }
 katana-runner.workspace = true
 serde_json.workspace = true
+tokio.workspace = true
 
 [features]
 default = [ "controller", "walnut" ]

bin/sozo/src/commands/build.rs

@@ -1,10 +1,17 @@
+use std::cmp::Reverse;
+
 use anyhow::Result;
 use clap::{Args, Parser};
+use colored::{ColoredString, Colorize};
 use dojo_bindgen::{BuiltinPlugins, PluginManager};
+use dojo_world::local::{ResourceLocal, WorldLocal};
+use dojo_world::ResourceType;
 use scarb::core::{Config, Package, TargetKind};
 use scarb::ops::CompileOpts;
 use scarb_ui::args::{FeaturesSpec, PackagesFilter};
 use sozo_scarbext::WorkspaceExt;
+use tabled::settings::Style;
+use tabled::{Table, Tabled};
 use tracing::debug;
 
 use crate::commands::check_package_dojo_version;
@@ -27,9 +34,6 @@
     #[arg(help = "Output directory.", default_value = "bindings")]
     pub bindings_output: String,
 
-    #[arg(long, help = "Display statistics about the compiled contracts")]
-    pub stats: bool,
-
     /// Specify the features to activate.
     #[command(flatten)]
     pub features: FeaturesSpec,
@@ -38,9 +42,37 @@
     #[command(flatten)]
     pub packages: Option<PackagesFilter>,
 
-    #[arg(long)]
-    #[arg(help = "Output the Sierra debug information for the compiled contracts.")]
-    pub output_debug_info: bool,
+    /// Display statistics about the compiled contracts.
+    #[command(flatten)]
+    pub stats: StatOptions,
+}
+
+#[derive(Debug, Clone, Args, Default, PartialEq)]
+#[command(next_help_heading = "Statistics options")]
+pub struct StatOptions {
+    #[arg(long = "stats.by-tag")]
+    #[arg(help = "Sort the stats by tag.")]
+    #[arg(conflicts_with_all = ["stats.by-sierra-mb", "stats.by-sierra-felts", "stats.by-casm-felts"])]
+    #[arg(default_value_t = false)]
+    pub sort_by_tag: bool,
+
+    #[arg(long = "stats.by-sierra-mb")]
+    #[arg(help = "Sort the stats by Sierra file size in MB.")]
+    #[arg(conflicts_with_all = ["stats.by-tag", "stats.by-sierra-felts", "stats.by-casm-felts"])]
+    #[arg(default_value_t = false)]
+    pub sort_by_sierra_mb: bool,
+
+    #[arg(long = "stats.by-sierra-felts")]
+    #[arg(help = "Sort the stats by Sierra program size in felts.")]
+    #[arg(conflicts_with_all = ["stats.by-tag", "stats.by-sierra-mb", "stats.by-casm-felts"])]
+    #[arg(default_value_t = false)]
+    pub sort_by_sierra_felts: bool,
+
+    #[arg(long = "stats.by-casm-felts")]
+    #[arg(help = "Sort the stats by Casm bytecode size in felts.")]
+    #[arg(conflicts_with_all = ["stats.by-tag", "stats.by-sierra-mb", "stats.by-sierra-felts"])]
+    #[arg(default_value_t = false)]
+    pub sort_by_casm_felts: bool,
 }
 
 impl BuildArgs {
@@ -104,10 +136,59 @@
 
         // TODO: check about the skip migration as now we process the metadata
         // directly during the compilation to get the data we need from it.
-        tokio::runtime::Runtime::new()
-            .unwrap()
-            .block_on(bindgen.generate(None))
-            .expect("Error generating bindings");
+        config.tokio_handle().block_on(bindgen.generate(None)).expect("Error generating bindings");
+
+        if self.stats != StatOptions::default() {
+            let world = WorldLocal::from_directory(
+                ws.target_dir_profile().to_string(),
+                ws.load_profile_config().unwrap(),
+            )?;
+
+            let world_stat = world.to_stat_item();
+            let mut stats = vec![world_stat];
+
+            for r in world.resources.values() {
+                if r.resource_type() != ResourceType::Namespace {
+                    stats.push(r.to_stat_item());
+                }
+            }
+
+            if self.stats.sort_by_tag {
+                stats.sort_by_key(|s| s.tag.clone());
+            } else if self.stats.sort_by_sierra_mb {
+                stats.sort_by_key(|s| Reverse(s.sierra_file_size));
+            } else if self.stats.sort_by_sierra_felts {
+                stats.sort_by_key(|s| Reverse(s.sierra_program_size));
+            } else if self.stats.sort_by_casm_felts {
+                stats.sort_by_key(|s| Reverse(s.casm_bytecode_size));
+            }
+
+            let mut table = Table::new(stats.iter().map(StatItemPrint::from).collect::<Vec<_>>());
+            table.with(Style::psql());
+
+            println!();
+            println!("{table}");
+
+            if stats.iter().all(|s| s.casm_bytecode_size == 0) {
+                println!(
+                    "{}",
+                    r#"
+All the casm bytecode sizes are 0, did you forget to enable casm compilation?
+To enable casm compilation, add the following to your Scarb.toml:
+
+[[target.starknet-contract]]
+sierra = true
+casm = true
+            "#
+                    .bright_yellow()
+                );
+            }
+
+            println!(
+                "\nRefer to https://docs.starknet.io/tools/limits-and-triggers/ for more \
+                 information about the public networks limits."
+            );
+        }
 
         Ok(())
     }
@@ -124,9 +205,114 @@
             typescript_v2: false,
             unity: false,
             bindings_output: "bindings".to_string(),
-            stats: false,
+            stats: StatOptions::default(),
             packages: None,
-            output_debug_info: false,
         }
     }
 }
+
+trait ContractStats {
+    fn to_stat_item(&self) -> StatItem;
+    fn sierra_file_size(&self) -> Result<usize>;
+    fn sierra_program_felt_size(&self) -> usize;
+    fn casm_program_felt_size(&self) -> usize;
+}
+
+#[derive(Debug, Tabled)]
+struct StatItemPrint {
+    #[tabled(rename = "")]
+    tag: ColoredString,
+    #[tabled(rename = "Sierra size (byte)")]
+    sierra_file_size: ColoredString,
+    #[tabled(rename = "Sierra felts")]
+    sierra_program_size: ColoredString,
+    #[tabled(rename = "Casm felts")]
+    casm_bytecode_size: ColoredString,
+}
+
+impl From<&StatItem> for StatItemPrint {
+    fn from(item: &StatItem) -> Self {
+        const MAX_SIERRA_SIZE_BYTES: usize = 4_089_446;
+        const MAX_CASM_FELTS: usize = 81_290;
+
+        let tag = if item.tag == "world" {
+            "World".to_string().bright_magenta()
+        } else {
+            item.tag.to_string().bright_blue()
+        };
+
+        let sierra_file_size = if item.sierra_file_size > MAX_SIERRA_SIZE_BYTES {
+            item.sierra_file_size.to_string().bright_red()
+        } else {
+            item.sierra_file_size.to_string().bright_green()
+        };
+
+        let sierra_program_size = item.sierra_program_size.to_string().bright_black();
+
+        let casm_bytecode_size = if item.casm_bytecode_size > MAX_CASM_FELTS {
+            item.casm_bytecode_size.to_string().bright_red()
+        } else {
+            item.casm_bytecode_size.to_string().bright_green()
+        };
+
+        Self { tag, sierra_file_size, sierra_program_size, casm_bytecode_size }
+    }
+}
+
+#[derive(Debug)]
+struct StatItem {
+    tag: String,
+    sierra_file_size: usize,
+    sierra_program_size: usize,
+    casm_bytecode_size: usize,
+}
+
+impl ContractStats for ResourceLocal {
+    fn to_stat_item(&self) -> StatItem {
+        StatItem {
+            tag: self.tag(),
+            sierra_file_size: self.sierra_file_size().unwrap(),
+            sierra_program_size: self.sierra_program_felt_size(),
+            casm_bytecode_size: self.casm_program_felt_size(),
+        }
+    }
+
+    fn sierra_file_size(&self) -> Result<usize> {
+        // Easiest way to get the file size if by reserializing into the original json
+        // the class file.
+        Ok(serde_json::to_string(&self.common().class)?.len())
+    }
+
+    fn sierra_program_felt_size(&self) -> usize {
+        self.common().class.sierra_program.len()
+    }
+
+    fn casm_program_felt_size(&self) -> usize {
+        self.common().casm_class.as_ref().map_or(0, |casm| casm.bytecode.len())
+    }
+}
+
+impl ContractStats for WorldLocal {
+    fn to_stat_item(&self) -> StatItem {
+        StatItem {
+            tag: "world".to_string(),
+            sierra_file_size: self.sierra_file_size().unwrap(),
+            sierra_program_size: self.sierra_program_felt_size(),
+            casm_bytecode_size: self.casm_program_felt_size(),
+        }
+    }
+
+    fn sierra_file_size(&self) -> Result<usize> {
+        // Easiest way to get the file size if by reserializing into the original json
+        // the class file.
+        Ok(serde_json::to_string(&self.class)?.len())
+    }
+
+    fn sierra_program_felt_size(&self) -> usize {
+        self.class.sierra_program.len()
+    }
+
+    fn casm_program_felt_size(&self) -> usize {
+        self.casm_class.as_ref().map_or(0, |casm| casm.bytecode.len())
+    }
+}

crates/dojo/world/src/contracts/contract_info.rs

@@ -190,6 +190,7 @@ mod tests {
                     },
                     abi: vec![],
                 },
+                casm_class: None,
                 class_hash: felt!("0x2222"),
                 casm_class_hash: felt!("0x2222"),
             },

crates/dojo/world/src/diff/compare.rs

@@ -93,6 +93,7 @@ mod tests {
                 name: "model1".to_string(),
                 namespace: "ns1".to_string(),
                 class: empty_sierra_class(),
+                casm_class: None,
                 class_hash: Felt::ZERO,
                 casm_class_hash: Felt::ZERO,
             },
@@ -127,6 +128,7 @@ mod tests {
                 name: "event1".to_string(),
                 namespace: "ns1".to_string(),
                 class: empty_sierra_class(),
+                casm_class: None,
                 class_hash: Felt::ZERO,
                 casm_class_hash: Felt::ZERO,
             },
@@ -175,6 +177,7 @@ mod tests {
                 name: "contract1".to_string(),
                 namespace: "ns1".to_string(),
                 class: empty_sierra_class(),
+                casm_class: None,
                 class_hash: Felt::ZERO,
                 casm_class_hash: Felt::ZERO,
             },

crates/dojo/world/src/diff/mod.rs

@@ -379,6 +379,7 @@ mod tests {
                 name: "c".to_string(),
                 namespace: ns.clone(),
                 class: empty_sierra_class(),
+                casm_class: None,
                 class_hash: Felt::ONE,
                 casm_class_hash: Felt::ZERO,
             },
@@ -417,6 +418,7 @@ mod tests {
                 name: "c".to_string(),
                 namespace: ns.clone(),
                 class: empty_sierra_class(),
+                casm_class: None,
                 class_hash: Felt::TWO,
                 casm_class_hash: Felt::ZERO,
             },