Run cargo fetch on workspace resolve (#1150)

commit-id:aeeb309e

---

**Stack**:
- #1161
- #1159
- #1157
- #1143
- #1155
- #1151
- #1150 ⬅


⚠️ *Part of a stack created by [spr](https://github.com/ejoffe/spr). Do
not merge manually using the UI - doing so may have unexpected results.*

Author: maciektr

scarb/src/compiler/plugin/mod.rs

@@ -5,14 +5,35 @@ use std::fmt;
 use anyhow::{anyhow, bail, Result};
 use cairo_lang_semantic::plugin::PluginSuite;
 use itertools::Itertools;
+use serde::{Deserialize, Serialize};
 
-use crate::core::PackageId;
+use crate::core::{Package, PackageId, TargetKind, Workspace};
 
 use self::builtin::{BuiltinStarkNetPlugin, BuiltinTestPlugin};
 
 pub mod builtin;
 pub mod proc_macro;
 
+/// Properties that can be defined on Cairo plugin target.
+#[derive(Debug, Serialize, Deserialize, Default)]
+#[serde(rename_all = "kebab-case")]
+pub struct CairoPluginProps {
+    /// Mark this macro plugin as builtin.
+    /// Builtin plugins are assumed to be available in `CairoPluginRepository` for the whole Scarb execution.
+    pub builtin: bool,
+}
+
+pub fn fetch_cairo_plugin(package: &Package, ws: &Workspace<'_>) -> Result<()> {
+    assert!(package.is_cairo_plugin());
+    let target = package.fetch_target(&TargetKind::CAIRO_PLUGIN)?;
+    let props: CairoPluginProps = target.props()?;
+    // No need to fetch for buildin plugins.
+    if !props.builtin {
+        proc_macro::fetch_package(package, ws)?;
+    }
+    Ok(())
+}
+
 pub trait CairoPlugin: Sync {
     fn id(&self) -> PackageId;
     fn instantiate(&self) -> Result<Box<dyn CairoPluginInstance>>;

scarb/src/compiler/plugin/proc_macro/compilation.rs

@@ -45,19 +45,24 @@ impl SharedLibraryProvider for Package {
 }
 
 pub fn compile_unit(unit: CompilationUnit, ws: &Workspace<'_>) -> Result<()> {
-    run_cargo(CargoAction::Build, unit, ws)
+    let package = unit.components.first().unwrap().package.clone();
+    run_cargo(CargoAction::Build, &package, ws)
 }
 
 pub fn check_unit(unit: CompilationUnit, ws: &Workspace<'_>) -> Result<()> {
-    run_cargo(CargoAction::Check, unit, ws)
+    let package = unit.components.first().unwrap().package.clone();
+    run_cargo(CargoAction::Check, &package, ws)
 }
 
-fn run_cargo(action: CargoAction, unit: CompilationUnit, ws: &Workspace<'_>) -> Result<()> {
-    let main_package = unit.components.first().unwrap().package.clone();
+pub fn fetch_package(package: &Package, ws: &Workspace<'_>) -> Result<()> {
+    run_cargo(CargoAction::Fetch, package, ws)
+}
+
+fn run_cargo(action: CargoAction, package: &Package, ws: &Workspace<'_>) -> Result<()> {
     let cmd = CargoCommand {
         action,
-        current_dir: main_package.root().to_path_buf(),
-        target_dir: main_package
+        current_dir: package.root().to_path_buf(),
+        target_dir: package
             .target_path(ws.config())
             .path_unchecked()
             .to_path_buf(),
@@ -72,6 +77,7 @@ fn run_cargo(action: CargoAction, unit: CompilationUnit, ws: &Workspace<'_>) ->
 enum CargoAction {
     Build,
     Check,
+    Fetch,
 }
 
 struct CargoCommand {
@@ -85,12 +91,18 @@ impl From<CargoCommand> for Command {
         let mut cmd = Command::new("cargo");
         cmd.current_dir(args.current_dir);
         match args.action {
+            CargoAction::Fetch => cmd.arg("fetch"),
             CargoAction::Build => cmd.arg("build"),
             CargoAction::Check => cmd.arg("check"),
         };
-        cmd.arg("--release");
-        cmd.arg("--target-dir");
-        cmd.arg(args.target_dir);
+        match args.action {
+            CargoAction::Fetch => (),
+            _ => {
+                cmd.arg("--release");
+                cmd.arg("--target-dir");
+                cmd.arg(args.target_dir);
+            }
+        }
         cmd
     }
 }

scarb/src/compiler/plugin/proc_macro/mod.rs

@@ -2,6 +2,6 @@ pub mod compilation;
 mod ffi;
 mod host;
 
-pub use compilation::{check_unit, compile_unit};
+pub use compilation::{check_unit, compile_unit, fetch_package};
 pub use ffi::*;
 pub use host::*;

scarb/src/ops/resolve.rs

@@ -1,12 +1,4 @@
-use std::collections::HashMap;
-
-use anyhow::{bail, Result};
-use cairo_lang_filesystem::cfg::{Cfg, CfgSet};
-use futures::TryFutureExt;
-use indoc::formatdoc;
-use itertools::Itertools;
-use serde::{Deserialize, Serialize};
-
+use crate::compiler::plugin::{fetch_cairo_plugin, CairoPluginProps};
 use crate::compiler::{CompilationUnit, CompilationUnitCairoPlugin, CompilationUnitComponent};
 use crate::core::lockfile::Lockfile;
 use crate::core::package::{Package, PackageClass, PackageId};
@@ -24,6 +16,12 @@ use crate::core::{
 use crate::internal::to_version::ToVersion;
 use crate::ops::lockfile::{read_lockfile, write_lockfile};
 use crate::{resolver, DEFAULT_SOURCE_PATH};
+use anyhow::{bail, Result};
+use cairo_lang_filesystem::cfg::{Cfg, CfgSet};
+use futures::TryFutureExt;
+use indoc::formatdoc;
+use itertools::Itertools;
+use std::collections::HashMap;
 
 pub struct WorkspaceResolve {
     pub resolve: Resolve,
@@ -122,6 +120,12 @@ pub fn resolve_workspace_with_opts(
 
             let packages = collect_packages_from_resolve_graph(&resolve, &patched).await?;
 
+            packages
+                .values()
+                .filter(|p| p.is_cairo_plugin())
+                .map(|p| fetch_cairo_plugin(p, ws))
+                .collect::<Result<Vec<()>>>()?;
+
             Ok(WorkspaceResolve { resolve, packages })
         }
         .into_future(),
@@ -298,15 +302,6 @@ fn generate_cairo_compilation_units(
         .collect::<Result<Vec<CompilationUnit>>>()
 }
 
-/// Properties that can be defined on Cairo plugin target.
-#[derive(Debug, Serialize, Deserialize, Default)]
-#[serde(rename_all = "kebab-case")]
-struct CairoPluginProps {
-    /// Mark this macro plugin as builtin.
-    /// Builtin plugins are assumed to be available in `CairoPluginRepository` for the whole Scarb execution.
-    pub builtin: bool,
-}
-
 pub struct PackageSolutionCollector<'a> {
     member: &'a Package,
     resolve: &'a WorkspaceResolve,

scarb/tests/build_cairo_plugin.rs

@@ -145,6 +145,26 @@ fn check_cairo_plugin() {
     assert_matches(r#"[..]Finished release [optimized] target(s) in[..]"#, last);
 }
 
+#[test]
+fn resolve_fetched_plugins() {
+    let t = TempDir::new().unwrap();
+    simple_project(&t);
+    assert!(!t.child("Cargo.lock").exists());
+    let output = Scarb::quick_snapbox()
+        .arg("fetch")
+        // Disable colors in Cargo output.
+        .env("CARGO_TERM_COLOR", "never")
+        .current_dir(&t)
+        .output()
+        .unwrap();
+    assert!(
+        output.status.success(),
+        "{}",
+        String::from_utf8_lossy(&output.stderr)
+    );
+    assert!(t.child("Cargo.lock").exists())
+}
+
 #[test]
 fn compile_cairo_plugin_with_lib_target() {
     let t = TempDir::new().unwrap();