feat: allow specifying features for cargo near abi (#366)

Author: pityjllk

cargo-near-build/src/near/abi/mod.rs

@@ -33,6 +33,14 @@ pub fn build(args: abi_types::Opts) -> eyre::Result<camino::Utf8PathBuf> {
         .get_out_dir()
         .clone();
 
+    let cargo_feature_args = {
+        let mut feat_args = vec![];
+        if let Some(features) = args.features.as_deref() {
+            feat_args.extend_from_slice(&["--features", features]);
+        }
+        feat_args
+    };
+
     let format = if args.compact_abi {
         abi_types::Format::JsonMin
     } else {
@@ -43,7 +51,7 @@ pub fn build(args: abi_types::Opts) -> eyre::Result<camino::Utf8PathBuf> {
         args.no_locked,
         !args.no_doc,
         false,
-        &[],
+        &cargo_feature_args,
         &[],
         color,
     )?;

cargo-near-build/src/types/near/abi.rs

@@ -12,6 +12,8 @@ pub struct Opts {
     pub out_dir: Option<camino::Utf8PathBuf>,
     /// Path to the `Cargo.toml` of the contract to build
     pub manifest_path: Option<camino::Utf8PathBuf>,
+    /// Activate additional cargo features during ABI generation
+    pub features: Option<String>,
     /// Coloring: auto, always, never
     pub color: Option<ColorPreference>,
 }

cargo-near/src/commands/abi/mod.rs

@@ -38,6 +38,15 @@ pub struct Command {
     #[interactive_clap(skip_interactive_input)]
     #[interactive_clap(verbatim_doc_comment)]
     pub manifest_path: Option<crate::types::utf8_path_buf::Utf8PathBuf>,
+    /// Space or comma separated list of features to activate
+    ///
+    /// e.g. --features 'feature0 crate3/feature1 feature3'
+    /// This just passes the argument as `--features` argument to downstream `cargo` command.
+    /// Unlike `cargo` argument, this argument doesn't support repetition, at most 1 argument can be specified.
+    #[interactive_clap(long)]
+    #[interactive_clap(skip_interactive_input)]
+    #[interactive_clap(verbatim_doc_comment)]
+    pub features: Option<String>,
     /// Whether to color output to stdout and stderr by printing ANSI escape sequences: auto, always, never
     #[interactive_clap(long)]
     #[interactive_clap(value_enum)]
@@ -53,6 +62,7 @@ impl From<Command> for AbiOpts {
             compact_abi: value.compact_abi,
             out_dir: value.out_dir.map(Into::into),
             manifest_path: value.manifest_path.map(Into::into),
+            features: value.features,
             color: value.color.map(Into::into),
         }
     }
@@ -72,6 +82,7 @@ impl AbiCommandlContext {
             compact_abi: scope.compact_abi,
             out_dir: scope.out_dir.clone(),
             manifest_path: scope.manifest_path.clone(),
+            features: scope.features.clone(),
             color: scope.color.clone(),
         };
         cargo_near_build::abi::build(args.into())?;

integration-tests/src/lib.rs

@@ -111,6 +111,7 @@ pub fn invoke_cargo_near(
                 compact_abi: cmd.compact_abi,
                 out_dir: cmd.out_dir.map(Into::into),
                 manifest_path: Some(cargo_path),
+                features: cmd.features,
                 color: cmd.color.map(Into::into),
             };
             tracing::debug!("AbiOpts: {:#?}", args);

integration-tests/templates/abi/_Cargo_features.toml

@@ -0,0 +1,25 @@
+[package]
+name = "::name::"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+crate-type = ["cdylib"]
+
+[features]
+default = []
+gated = []
+
+[dependencies]
+near-sdk = { features = ["unstable"], ::sdk-git-version-toml:: }
+serde = { version = "1", features = ["derive"] }
+
+[workspace]
+members = []
+
+[profile.release]
+codegen-units = 1
+opt-level = "z"
+lto = true
+debug = false
+panic = "abort"

integration-tests/tests/abi/opts.rs

@@ -74,3 +74,32 @@ fn test_abi_opt_out_dir() -> cargo_near::CliResult {
 
     Ok(())
 }
+
+#[test]
+#[named]
+fn test_abi_opt_features() -> cargo_near::CliResult {
+    setup_tracing();
+    let abi_root = generate_abi_fn_with! {
+        Cargo: "/templates/abi/_Cargo_features.toml";
+        Opts: "--features gated";
+        Code:
+        #[cfg(feature = "gated")]
+        pub fn gated_only(&self) -> bool {
+            true
+        }
+    };
+
+    let function_names: Vec<&str> = abi_root
+        .body
+        .functions
+        .iter()
+        .map(|function| function.name.as_str())
+        .collect();
+
+    assert!(
+        function_names.contains(&"gated_only"),
+        "expected the ABI to include `gated_only` when the feature is enabled"
+    );
+
+    Ok(())
+}