feat(sozo): add full workspace and accept non-dojo targets (#2207)

bin/sozo/src/commands/build.rs

@@ -3,12 +3,11 @@ use clap::{Args, Parser};
 use dojo_bindgen::{BuiltinPlugins, PluginManager};
 use dojo_lang::scarb_internal::compile_workspace;
 use dojo_world::manifest::MANIFESTS_DIR;
-use dojo_world::metadata::dojo_metadata_from_workspace;
 use prettytable::format::consts::FORMAT_NO_LINESEP_WITH_TITLE;
 use prettytable::{format, Cell, Row, Table};
-use scarb::core::{Config, TargetKind};
+use scarb::core::{Config, Package, TargetKind};
 use scarb::ops::CompileOpts;
-use scarb_ui::args::FeaturesSpec;
+use scarb_ui::args::{FeaturesSpec, PackagesFilter};
 use sozo_ops::statistics::{get_contract_statistics_for_dir, ContractStatistics};
 use tracing::trace;
 
@@ -43,39 +42,32 @@ pub struct BuildArgs {
     /// Specify the features to activate.
     #[command(flatten)]
     pub features: FeaturesSpec,
+
+    /// Specify packages to build.
+    #[command(flatten)]
+    pub packages: Option<PackagesFilter>,
 }
 
 impl BuildArgs {
     pub fn run(self, config: &Config) -> Result<()> {
         let ws = scarb::ops::read_workspace(config.manifest_path(), config)?;
 
-        if let Ok(current_package) = ws.current_package() {
-            if current_package.target(&TargetKind::new("dojo")).is_none() {
-                return Err(anyhow::anyhow!(
-                    "No Dojo target found in the {} package. Add [[target.dojo]] to the {} \
-                     manifest to enable Dojo features and compile with sozo.",
-                    current_package.id.to_string(),
-                    current_package.manifest_path()
-                ));
-            }
-        }
-
-        // Namespaces are required to compute contracts/models data. Hence, we can't continue
-        // if no metadata are found.
-        // Once sozo will support package option, users will be able to do `-p` to select
-        // the package directly from the workspace instead of using `--manifest-path`.
-        let dojo_metadata = dojo_metadata_from_workspace(&ws)?;
+        let packages: Vec<Package> = if let Some(filter) = self.packages {
+            filter.match_many(&ws)?.into_iter().collect()
+        } else {
+            ws.members().collect()
+        };
 
         let profile_name =
             ws.current_profile().expect("Scarb profile is expected at this point.").to_string();
 
-        // Manifest path is always a file, we can unwrap safely to get the
-        // parent folder.
+        // Manifest path is always a file, we can unwrap safely to get the parent folder.
         let manifest_dir = ws.manifest_path().parent().unwrap().to_path_buf();
 
         let profile_dir = manifest_dir.join(MANIFESTS_DIR).join(profile_name);
         CleanArgs::clean_manifests(&profile_dir)?;
-        let packages: Vec<scarb::core::PackageId> = ws.members().map(|p| p.id).collect();
+
+        trace!(?packages);
 
         let compile_info = compile_workspace(
             config,
@@ -85,7 +77,7 @@ impl BuildArgs {
                 exclude_target_kinds: vec![TargetKind::TEST],
                 features: self.features.try_into()?,
             },
-            packages,
+            packages.iter().map(|p| p.id).collect(),
         )?;
         trace!(?compile_info, "Compiled workspace.");
 
@@ -146,9 +138,11 @@ impl BuildArgs {
         };
         trace!(pluginManager=?bindgen, "Generating bindings.");
 
+        // 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(dojo_metadata.skip_migration))
+            .block_on(bindgen.generate(None))
             .expect("Error generating bindings");
 
         Ok(())
@@ -167,6 +161,7 @@ impl Default for BuildArgs {
             unity: false,
             bindings_output: "bindings".to_string(),
             stats: false,
+            packages: None,
         }
     }
 }

bin/sozo/src/commands/test.rs

@@ -14,9 +14,9 @@ use dojo_lang::plugin::dojo_plugin_suite;
 use dojo_lang::scarb_internal::crates_config_for_compilation_unit;
 use scarb::compiler::helpers::collect_main_crate_ids;
 use scarb::compiler::{CairoCompilationUnit, CompilationUnit, CompilationUnitAttributes};
-use scarb::core::{Config, TargetKind};
+use scarb::core::{Config, Package, PackageId, TargetKind};
 use scarb::ops::{self, CompileOpts};
-use scarb_ui::args::FeaturesSpec;
+use scarb_ui::args::{FeaturesSpec, PackagesFilter};
 use tracing::trace;
 
 pub(crate) const LOG_TARGET: &str = "sozo::cli::commands::test";
@@ -62,6 +62,9 @@ pub struct TestArgs {
     /// Specify the features to activate.
     #[command(flatten)]
     features: FeaturesSpec,
+    /// Specify packages to test.
+    #[command(flatten)]
+    pub packages: Option<PackagesFilter>,
 }
 
 impl TestArgs {
@@ -71,6 +74,14 @@ impl TestArgs {
             std::process::exit(1);
         });
 
+        let packages: Vec<Package> = if let Some(filter) = self.packages {
+            filter.match_many(&ws)?.into_iter().collect()
+        } else {
+            ws.members().collect()
+        };
+
+        let package_ids = packages.iter().map(|p| p.id).collect::<Vec<PackageId>>();
+
         let resolve = ops::resolve_workspace(&ws)?;
 
         let opts = CompileOpts {
@@ -87,6 +98,7 @@ impl TestArgs {
                 opts.include_target_kinds.is_empty()
                     || opts.include_target_kinds.contains(&cu.main_component().target_kind())
             })
+            .filter(|cu| package_ids.contains(&cu.main_package_id()))
             .collect::<Vec<_>>();
 
         for unit in compilation_units {
@@ -96,6 +108,11 @@ impl TestArgs {
                 continue;
             };
 
+            config.ui().print(format!("testing {}", unit.name()));
+
+            // Injecting the cfg_set for the unit makes compiler panics.
+            // We rely then on the default namespace for testing...?
+
             let props: Props = unit.main_component().target_props()?;
             let db = build_root_database(&unit)?;
 
@@ -155,10 +172,10 @@ fn build_project_config(unit: &CairoCompilationUnit) -> Result<ProjectConfig> {
     let crate_roots = unit
         .components
         .iter()
-        .filter(|model| !model.package.id.is_core())
+        .filter(|c| !c.package.id.is_core())
         // NOTE: We're taking the first target of each compilation unit, which should always be the
         //       main package source root due to the order maintained by scarb.
-        .map(|model| (model.cairo_package_name(), model.targets[0].source_root().into()))
+        .map(|c| (c.cairo_package_name(), c.targets[0].source_root().into()))
         .collect();
 
     let corelib =

crates/dojo-core/Scarb.lock

@@ -11,4 +11,4 @@ dependencies = [
 [[package]]
 name = "dojo_plugin"
 version = "0.7.3"
-source = "git+https://github.com/dojoengine/dojo?rev=d90b52b#d90b52b89749ac8af82f352dc08aa0b1378cfae6"
+source = "git+https://github.com/dojoengine/dojo?rev=71b1f1a4#71b1f1a467534cbeeb901356f41e612ed4187bd1"

crates/dojo-core/Scarb.toml

@@ -8,9 +8,11 @@ version = "0.7.3"
 [dependencies]
 # Rev points to support for Cairo 2.7.0-rc.3 without any tag yet. Should be
 # updated once a release is cut with `2.7.0-rc.3` support in it.
-dojo_plugin = { git = "https://github.com/dojoengine/dojo", rev = "d90b52b" }
+dojo_plugin = { git = "https://github.com/dojoengine/dojo", rev = "71b1f1a4" }
 starknet = "=2.7.0-rc.3"
 
+[lib]
+
 # Dojo core is tested with sozo, hence we need a namespace for the test
 # command to work.
 [tool.dojo.world]

crates/dojo-lang/Cargo.toml

@@ -42,6 +42,7 @@ once_cell.workspace = true
 regex.workspace = true
 salsa.workspace = true
 scarb.workspace = true
+scarb-ui.workspace = true
 semver.workspace = true
 serde.workspace = true
 serde_json.workspace = true

crates/dojo-lang/src/compiler.rs

@@ -98,8 +98,15 @@ impl Compiler for DojoCompiler {
         let props: Props = unit.main_component().target_props()?;
         let target_dir = unit.target_dir(ws);
 
+        // TODO: if we want to output the manifests at the package level,
+        // we must iterate on the ws members, to find the location of the
+        // sole package with the `dojo` target.
+        // In this case, we can use this path to output the manifests.
+
         let compiler_config = build_compiler_config(&unit, ws);
 
+        trace!(target: LOG_TARGET, unit = %unit.name(), ?props, "Compiling unit dojo compiler.");
+
         let mut main_crate_ids = collect_main_crate_ids(&unit, db);
         let core_crate_ids: Vec<CrateId> = collect_core_crate_ids(db);
         main_crate_ids.extend(core_crate_ids);
@@ -347,10 +354,21 @@ fn update_files(
         fs::create_dir_all(contracts_dir.path_unchecked())?;
     }
 
+    // Ensure `contracts` dir exist event if no contracts are compiled
+    // to avoid errors when loading manifests.
+    let base_contracts_dir = base_manifests_dir.join(CONTRACTS_DIR);
+    let base_contracts_abis_dir = base_abis_dir.join(CONTRACTS_DIR);
+    if !base_contracts_dir.exists() {
+        std::fs::create_dir_all(&base_contracts_dir)?;
+    }
+    if !base_contracts_abis_dir.exists() {
+        std::fs::create_dir_all(&base_contracts_abis_dir)?;
+    }
+
     for (_, (manifest, class, module_id)) in contracts.iter_mut() {
         write_manifest_and_abi(
-            &base_manifests_dir.join(CONTRACTS_DIR),
-            &base_abis_dir.join(CONTRACTS_DIR),
+            &base_contracts_dir,
+            &base_contracts_abis_dir,
             &manifest_dir,
             manifest,
             &class.abi,
@@ -373,10 +391,21 @@ fn update_files(
         fs::create_dir_all(models_dir.path_unchecked())?;
     }
 
+    // Ensure `models` dir exist event if no models are compiled
+    // to avoid errors when loading manifests.
+    let base_models_dir = base_manifests_dir.join(MODELS_DIR);
+    let base_models_abis_dir = base_abis_dir.join(MODELS_DIR);
+    if !base_models_dir.exists() {
+        std::fs::create_dir_all(&base_models_dir)?;
+    }
+    if !base_models_abis_dir.exists() {
+        std::fs::create_dir_all(&base_models_abis_dir)?;
+    }
+
     for (_, (manifest, class, module_id)) in models.iter_mut() {
         write_manifest_and_abi(
-            &base_manifests_dir.join(MODELS_DIR),
-            &base_abis_dir.join(MODELS_DIR),
+            &base_models_dir,
+            &base_models_abis_dir,
             &manifest_dir,
             manifest,
             &class.abi,

crates/dojo-lang/src/manifest_test_data/compiler_cairo/Scarb.lock

@@ -18,4 +18,4 @@ dependencies = [
 [[package]]
 name = "dojo_plugin"
 version = "0.7.3"
-source = "git+https://github.com/dojoengine/dojo?rev=d90b52b#d90b52b89749ac8af82f352dc08aa0b1378cfae6"
+source = "git+https://github.com/dojoengine/dojo?rev=71b1f1a4#71b1f1a467534cbeeb901356f41e612ed4187bd1"

crates/dojo-lang/src/plugin.rs

@@ -7,6 +7,7 @@ use cairo_lang_defs::plugin::{
     PluginDiagnostic, PluginGeneratedFile, PluginResult,
 };
 use cairo_lang_diagnostics::Severity;
+use cairo_lang_filesystem::cfg::Cfg;
 use cairo_lang_semantic::plugin::PluginSuite;
 use cairo_lang_starknet::plugin::aux_data::StarkNetEventAuxData;
 use cairo_lang_syntax::attribute::structured::{AttributeArgVariant, AttributeStructurize};
@@ -37,7 +38,7 @@ use crate::interface::DojoInterface;
 use crate::introspect::{handle_introspect_enum, handle_introspect_struct};
 use crate::model::handle_model_struct;
 use crate::print::{handle_print_enum, handle_print_struct};
-use crate::utils::get_namespace_config;
+use crate::utils;
 
 pub const DOJO_CONTRACT_ATTR: &str = "dojo::contract";
 pub const DOJO_INTERFACE_ATTR: &str = "dojo::interface";
@@ -339,27 +340,49 @@ fn get_additional_derive_attrs_for_model(derive_attr_names: &[String]) -> Vec<St
 }
 
 impl MacroPlugin for BuiltinDojoPlugin {
+    // This function is called for every item in whole db. Hence,
+    // the sooner we can return, the better.
+    // As an example, compiling spawn-and-move project, it's almost 14K calls to this
+    // function.
     fn generate_code(
         &self,
         db: &dyn SyntaxGroup,
         item_ast: ast::ModuleItem,
         metadata: &MacroPluginMetadata<'_>,
     ) -> PluginResult {
-        let namespace_config = match get_namespace_config(db) {
-            Ok(config) => config,
-            Err(e) => {
-                return PluginResult {
-                    code: Option::None,
-                    diagnostics: vec![PluginDiagnostic {
-                        stable_ptr: item_ast.stable_ptr().0,
-                        message: format!("{e}"),
-                        severity: Severity::Error,
-                    }],
-                    remove_original_item: false,
-                };
+        let namespace_config: NamespaceConfig = if db.cfg_set().contains(&Cfg::kv("target", "test"))
+        {
+            // In test mode, we can't inject namespace information into the `CfgSet`
+            // as the compiler panics. We then extract the info from the main component
+            // of the compilation unit.
+            match utils::get_namespace_config(db) {
+                Ok(config) => config,
+                Err(e) => {
+                    return PluginResult {
+                        code: Option::None,
+                        diagnostics: vec![PluginDiagnostic {
+                            stable_ptr: item_ast.stable_ptr().0,
+                            message: format!("{e}"),
+                            severity: Severity::Error,
+                        }],
+                        remove_original_item: false,
+                    };
+                }
             }
+        } else {
+            // Metadata gives information from the crates from where `item_ast` was parsed.
+            // During the compilation phase, we inject namespace information into the `CfgSet`
+            // so that it can be used here.
+            metadata.cfg_set.into()
         };
 
+        // Avoid the whole plugin checks if there is no default namespace.
+        // The compiler already checked for invalid package configuration,
+        // so empty default namespace can be skipped.
+        //         if namespace_config.default.is_empty() {
+        // return PluginResult::default();
+        // }
+
         match item_ast {
             ast::ModuleItem::Module(module_ast) => {
                 self.handle_mod(db, module_ast, &namespace_config, metadata)