refactor: remove output_idl_path from <type>CanisterInfo types (#3828)

Author: Eric Swanson

src/dfx/src/lib/builders/custom.rs

@@ -26,8 +26,6 @@ struct CustomBuilderExtra {
     wasm: PathBuf,
     /// Where to download the candid from
     input_candid_url: Option<Url>,
-    /// Where the candid output will be located.
-    candid: PathBuf,
     /// A command to run to build this canister. This is optional if the canister
     /// only needs to exist.
     build: Vec<String>,
@@ -51,15 +49,13 @@ impl CustomBuilderExtra {
         let input_wasm_url = info.get_input_wasm_url().to_owned();
         let wasm = info.get_output_wasm_path().to_owned();
         let input_candid_url = info.get_input_candid_url().to_owned();
-        let candid = info.get_output_idl_path().to_owned();
         let build = info.get_build_tasks().to_owned();
 
         Ok(CustomBuilderExtra {
             dependencies,
             input_wasm_url,
             wasm,
             input_candid_url,
-            candid,
             build,
         })
     }
@@ -103,7 +99,6 @@ impl CanisterBuilder for CustomBuilder {
     ) -> DfxResult<BuildOutput> {
         let CustomBuilderExtra {
             input_candid_url: _,
-            candid,
             input_wasm_url: _,
             wasm,
             build,
@@ -134,26 +129,25 @@ impl CanisterBuilder for CustomBuilder {
         Ok(BuildOutput {
             canister_id,
             wasm: WasmBuildOutput::File(wasm),
-            idl: IdlBuildOutput::File(candid),
+            idl: IdlBuildOutput::File(info.get_output_idl_path().to_path_buf()),
         })
     }
 
     fn get_candid_path(
         &self,
-        pool: &CanisterPool,
+        _pool: &CanisterPool,
         info: &CanisterInfo,
         _config: &BuildConfig,
     ) -> DfxResult<PathBuf> {
         // get the path to candid file
-        let CustomBuilderExtra { candid, .. } = CustomBuilderExtra::try_from(info, pool)?;
-        Ok(candid)
+        Ok(info.get_output_idl_path().to_path_buf())
     }
 }
 
 pub async fn custom_download(info: &CanisterInfo, pool: &CanisterPool) -> DfxResult {
+    let candid = info.get_output_idl_path();
     let CustomBuilderExtra {
         input_candid_url,
-        candid,
         input_wasm_url,
         wasm,
         build: _,
@@ -164,7 +158,7 @@ pub async fn custom_download(info: &CanisterInfo, pool: &CanisterPool) -> DfxRes
         download_file_to_path(&url, &wasm).await?;
     }
     if let Some(url) = input_candid_url {
-        download_file_to_path(&url, &candid).await?;
+        download_file_to_path(&url, candid).await?;
     }
 
     Ok(())

src/dfx/src/lib/builders/mod.rs

@@ -433,9 +433,10 @@ pub fn get_and_write_environment_variables<'a>(
     if let Ok(id) = info.get_canister_id() {
         vars.push((Borrowed("CANISTER_ID"), Owned(format!("{}", id).into())));
     }
-    if let Some(path) = info.get_output_idl_path() {
-        vars.push((Borrowed("CANISTER_CANDID_PATH"), Owned(path.into())))
-    }
+    vars.push((
+        Borrowed("CANISTER_CANDID_PATH"),
+        Owned(info.get_output_idl_path().into()),
+    ));
 
     if let Some(write_path) = write_path {
         write_environment_variables(&vars, write_path)?;

src/dfx/src/lib/builders/motoko.rs

@@ -187,7 +187,7 @@ impl CanisterBuilder for MotokoBuilder {
                 .get_canister_id()
                 .expect("Could not find canister ID."),
             wasm: WasmBuildOutput::File(motoko_info.get_output_wasm_path().to_path_buf()),
-            idl: IdlBuildOutput::File(motoko_info.get_output_idl_path().to_path_buf()),
+            idl: IdlBuildOutput::File(canister_info.get_output_idl_path().to_path_buf()),
         })
     }
 
@@ -198,9 +198,7 @@ impl CanisterBuilder for MotokoBuilder {
         _config: &BuildConfig,
     ) -> DfxResult<PathBuf> {
         // get the path to candid file from dfx build
-        let motoko_info = info.as_info::<MotokoCanisterInfo>()?;
-        let idl_from_build = motoko_info.get_output_idl_path().to_path_buf();
-        Ok(idl_from_build)
+        Ok(info.get_output_idl_path().to_path_buf())
     }
 }
 

src/dfx/src/lib/builders/pull.rs

@@ -48,7 +48,7 @@ impl CanisterBuilder for PullBuilder {
             canister_id: *pull_info.get_canister_id(),
             // It's impossible to know if the downloaded wasm is gzip or not with only the info in `dfx.json`.
             wasm: WasmBuildOutput::None,
-            idl: IdlBuildOutput::File(pull_info.get_output_idl_path().to_path_buf()),
+            idl: IdlBuildOutput::File(canister_info.get_output_idl_path().to_path_buf()),
         })
     }
 
@@ -58,8 +58,6 @@ impl CanisterBuilder for PullBuilder {
         info: &CanisterInfo,
         _config: &BuildConfig,
     ) -> DfxResult<PathBuf> {
-        let pull_info = info.as_info::<PullCanisterInfo>()?;
-        let output_idl_path = pull_info.get_output_idl_path();
-        Ok(output_idl_path.to_path_buf())
+        Ok(info.get_output_idl_path().to_path_buf())
     }
 }

src/dfx/src/lib/builders/rust.rs

@@ -102,7 +102,7 @@ impl CanisterBuilder for RustBuilder {
         Ok(BuildOutput {
             canister_id,
             wasm: WasmBuildOutput::File(rust_info.get_output_wasm_path().to_path_buf()),
-            idl: IdlBuildOutput::File(rust_info.get_output_idl_path().to_path_buf()),
+            idl: IdlBuildOutput::File(canister_info.get_output_idl_path().to_path_buf()),
         })
     }
 
@@ -112,8 +112,6 @@ impl CanisterBuilder for RustBuilder {
         info: &CanisterInfo,
         _config: &BuildConfig,
     ) -> DfxResult<PathBuf> {
-        let rust_info = info.as_info::<RustCanisterInfo>()?;
-        let output_idl_path = rust_info.get_output_idl_path();
-        Ok(output_idl_path.to_path_buf())
+        Ok(info.get_output_idl_path().to_path_buf())
     }
 }

src/dfx/src/lib/canister_info.rs

@@ -15,17 +15,14 @@ use dfx_core::network::provider::get_network_context;
 use dfx_core::util;
 use fn_error_context::context;
 use std::path::{Path, PathBuf};
+use url::Url;
 
 pub mod assets;
 pub mod custom;
 pub mod motoko;
 pub mod pull;
 pub mod rust;
-use self::pull::PullCanisterInfo;
-use assets::AssetsCanisterInfo;
-use custom::CustomCanisterInfo;
-use motoko::MotokoCanisterInfo;
-use rust::RustCanisterInfo;
+use crate::lib::deps::get_candid_path_in_project;
 
 pub trait CanisterInfoFactory {
     fn create(info: &CanisterInfo) -> DfxResult<Self>
@@ -63,6 +60,7 @@ pub struct CanisterInfo {
     gzip: bool,
     init_arg: Option<String>,
     init_arg_file: Option<String>,
+    output_idl_path: PathBuf,
 }
 
 impl CanisterInfo {
@@ -137,6 +135,32 @@ impl CanisterInfo {
 
         let output_root = build_root.join(name);
 
+        let output_idl_path: PathBuf = if let (Some(_id), Some(candid)) =
+            (&remote_id, &remote_candid)
+        {
+            workspace_root.join(candid)
+        } else {
+            match &canister_config.type_specific {
+                CanisterTypeProperties::Rust { package: _, candid } => workspace_root.join(candid),
+                CanisterTypeProperties::Assets { .. } => output_root.join("assetstorage.did"),
+                CanisterTypeProperties::Custom {
+                    wasm: _,
+                    candid,
+                    build: _,
+                } => {
+                    if Url::parse(candid).is_ok() {
+                        output_root.join(name).with_extension("did")
+                    } else {
+                        workspace_root.join(candid)
+                    }
+                }
+                CanisterTypeProperties::Motoko => output_root.join(name).with_extension("did"),
+                CanisterTypeProperties::Pull { id } => {
+                    get_candid_path_in_project(workspace_root, id)
+                }
+            }
+        };
+
         let type_specific = canister_config.type_specific.clone();
 
         let args = match &canister_config.args {
@@ -174,6 +198,7 @@ impl CanisterInfo {
             gzip,
             init_arg,
             init_arg_file,
+            output_idl_path,
         };
 
         Ok(canister_info)
@@ -300,26 +325,8 @@ impl CanisterInfo {
     /// Path to the candid file from canister builder which should contain init types.
     ///
     /// To be separated into service.did and init_args.
-    pub fn get_output_idl_path(&self) -> Option<PathBuf> {
-        match &self.type_specific {
-            CanisterTypeProperties::Motoko { .. } => self
-                .as_info::<MotokoCanisterInfo>()
-                .map(|x| x.get_output_idl_path().to_path_buf()),
-            CanisterTypeProperties::Custom { .. } => self
-                .as_info::<CustomCanisterInfo>()
-                .map(|x| x.get_output_idl_path().to_path_buf()),
-            CanisterTypeProperties::Assets { .. } => self
-                .as_info::<AssetsCanisterInfo>()
-                .map(|x| x.get_output_idl_path().to_path_buf()),
-            CanisterTypeProperties::Rust { .. } => self
-                .as_info::<RustCanisterInfo>()
-                .map(|x| x.get_output_idl_path().to_path_buf()),
-            CanisterTypeProperties::Pull { .. } => self
-                .as_info::<PullCanisterInfo>()
-                .map(|x| x.get_output_idl_path().to_path_buf()),
-        }
-        .ok()
-        .or_else(|| self.remote_candid.clone())
+    pub fn get_output_idl_path(&self) -> &Path {
+        self.output_idl_path.as_path()
     }
 
     #[context("Failed to create <Type>CanisterInfo for canister '{}'.", self.name, )]

src/dfx/src/lib/canister_info/assets.rs

@@ -10,7 +10,6 @@ pub struct AssetsCanisterInfo {
     source_paths: Vec<PathBuf>,
 
     output_wasm_path: PathBuf,
-    output_idl_path: PathBuf,
     build: Vec<String>,
     workspace: Option<String>,
 }
@@ -22,9 +21,6 @@ impl AssetsCanisterInfo {
             .map(|sp| self.input_root.join(sp))
             .collect::<_>()
     }
-    pub fn get_output_idl_path(&self) -> &Path {
-        self.output_idl_path.as_path()
-    }
     pub fn get_build_tasks(&self) -> &[String] {
         &self.build
     }
@@ -76,13 +72,11 @@ impl CanisterInfoFactory for AssetsCanisterInfo {
         let output_root = info.get_output_root();
 
         let output_wasm_path = output_root.join(Path::new("assetstorage.wasm.gz"));
-        let output_idl_path = output_wasm_path.with_extension("").with_extension("did");
 
         Ok(AssetsCanisterInfo {
             input_root,
             source_paths,
             output_wasm_path,
-            output_idl_path,
             build,
             workspace,
         })

src/dfx/src/lib/canister_info/custom.rs

@@ -14,7 +14,6 @@ pub struct CustomCanisterInfo {
     input_wasm_url: Option<Url>,
     output_wasm_path: PathBuf,
     input_candid_url: Option<Url>,
-    output_idl_path: PathBuf,
     build: Vec<String>,
 }
 
@@ -28,9 +27,6 @@ impl CustomCanisterInfo {
     pub fn get_input_candid_url(&self) -> &Option<Url> {
         &self.input_candid_url
     }
-    pub fn get_output_idl_path(&self) -> &Path {
-        self.output_idl_path.as_path()
-    }
     pub fn get_build_tasks(&self) -> &[String] {
         &self.build
     }
@@ -76,24 +72,18 @@ impl CanisterInfoFactory for CustomCanisterInfo {
             let output_wasm_path = workspace_root.join(wasm);
             (None, output_wasm_path)
         };
-        let (input_candid_url, output_idl_path) =
-            if let Some(remote_candid) = info.get_remote_candid_if_remote() {
-                (None, workspace_root.join(remote_candid))
-            } else if let Ok(input_candid_url) = Url::parse(&candid) {
-                let output_candid_path = info
-                    .get_output_root()
-                    .join(info.get_name())
-                    .with_extension("did");
-                (Some(input_candid_url), output_candid_path)
-            } else {
-                (None, workspace_root.join(candid))
-            };
+        let input_candid_url = if info.get_remote_candid_if_remote().is_some() {
+            None
+        } else if let Ok(input_candid_url) = Url::parse(&candid) {
+            Some(input_candid_url)
+        } else {
+            None
+        };
 
         Ok(Self {
             input_wasm_url,
             output_wasm_path,
             input_candid_url,
-            output_idl_path,
             build,
         })
     }

src/dfx/src/lib/canister_info/motoko.rs

@@ -9,7 +9,6 @@ pub struct MotokoCanisterInfo {
     output_root: PathBuf,
 
     output_wasm_path: PathBuf,
-    output_idl_path: PathBuf,
     output_stable_path: PathBuf,
     output_did_js_path: PathBuf,
     output_canister_js_path: PathBuf,
@@ -26,9 +25,6 @@ impl MotokoCanisterInfo {
     pub fn get_output_wasm_path(&self) -> &Path {
         self.output_wasm_path.as_path()
     }
-    pub fn get_output_idl_path(&self) -> &Path {
-        self.output_idl_path.as_path()
-    }
     pub fn get_output_stable_path(&self) -> &Path {
         self.output_stable_path.as_path()
     }
@@ -67,11 +63,6 @@ impl CanisterInfoFactory for MotokoCanisterInfo {
         let input_path = workspace_root.join(main_path);
         let output_root = info.get_output_root().to_path_buf();
         let output_wasm_path = output_root.join(name).with_extension("wasm");
-        let output_idl_path = if let Some(remote_candid) = info.get_remote_candid_if_remote() {
-            workspace_root.join(remote_candid)
-        } else {
-            output_wasm_path.with_extension("did")
-        };
         let output_stable_path = output_wasm_path.with_extension("most");
         let output_did_js_path = output_wasm_path.with_extension("did.js");
         let output_canister_js_path = output_wasm_path.with_extension("js");
@@ -81,7 +72,6 @@ impl CanisterInfoFactory for MotokoCanisterInfo {
             input_path,
             output_root,
             output_wasm_path,
-            output_idl_path,
             output_stable_path,
             output_did_js_path,
             output_canister_js_path,