chore: add skip of sub-build on abi generation to circumvent cargo-near#287

[dj8yfo]

near/cargo-near#287 is indeed a bug,
fix in near/cargo-near#289 will be published with cargo-near-build crate some time later,

while this pr circumvents the issue and also saves on some build time by not running nested build during current contract's abi build

relevant lines are

            // circumvents the issue in 287
            
            .build_skipped_when_env_is(vec![
                // shorter build for `cargo check`
                ("PROFILE", "debug"),
                (cargo_near_build::env_keys::BUILD_RS_ABI_STEP_HINT, "true"),
            ])

and

        // unix path to target sub-contract's crate from root of the repo
        let nep330_contract_path = "web4/treasury-web4";

and rest is just puff

[frol]

@dj8yfo Does it have to be this complex? Is there a way to improve cargo-near-build to hide this whole complexity there?

[dj8yfo]

@frol there's a plan for a task to compute

// unix path to target sub-contract's crate from root of the repo
        let nep330_contract_path = "web4/treasury-web4";

automatically, the rest is pretty much what current documentation snippet suggests (i.e. has been accepted previously).
I've added more output about additional pipeline stage with base64 encoding, so that it's present in console for whoever builds this project for their first time for easier introspection. Not sure if we want to consider this additional stage default functionality of cargo-near-build.

[dj8yfo]

stub_path can probably be computed automatically and not be an option on builder, needed to be configured

[dj8yfo]

good candidate for this looks to be

    fn sub_build_stub_result_path(sub_build_crate_name: &str) -> String {
        let out_dir_env = std::env::var("OUT_DIR").expect("OUT_DIR is always set in build scripts");
        let out_dir = Path::new(&out_dir_env);

        let path = out_dir.join(format!("{}-stub.bin", sub_build_crate_name));
        path.to_str().expect("valid unicode").to_owned()
    }

which is

warning: [email protected]: Build empty artifact stub-file written to: `/home/user/Documents/code/neardevhub-treasury-dashboard/treasury-factory/target/debug/build/treasury-factory-566aa3a029070e78/out/treasury-web4-stub.bin`

as a result

[dj8yfo]

override_cargo_target_dir can probably be made computed automatically too and attempted to be removed from public api, but that has to happen after nep330_contract_path and stub_path iterations

[dj8yfo]

https://bon-rs.com/reference/builder/member/skip

[dj8yfo]

good candidate for this looks to be

    fn sub_build_target_dir(sub_build_crate_name: &str, current_crate_name: &str) -> String {
        let out_dir_env = std::env::var("OUT_DIR").expect("OUT_DIR is always set in build scripts");
        let out_dir = Path::new(&out_dir_env);

        let path = out_dir.join(format!(
            "target-{}-for-{}",
            sub_build_crate_name, current_crate_name
        ));

        path.to_str()
            .unwrap_or_else(|| panic!("valid unicode path expected {}", path.to_string_lossy()))
            .to_owned()
    }

which results in

warning: [email protected]: Build artifact path: /home/jerrick/Documents/code/neardevhub-treasury-dashboard/treasury-factory/target/wasm32-unknown-unknown/release/build/treasury-factory-2b4e19c8a0b12f8f/out/target-treasury-web4-for-treasury-factory/near/treasury_web4.wasm

[dj8yfo]

this has to be tested with how this principle looks on more than 1 level of nesting in near-devhub contract

(comment with an output of tested nested build-scripts pending in this thread)

[dj8yfo]

it looks like above sub_build_target_dir fn is a good default for an override_cargo_target_dir option:

• community built
  • wasm : target/near/devhub_community/devhub_community.wasm
  • sub-build
    • stub : target/debug/build/devhub-community-9df08e869c916c9b/out/discussions-stub.bin
    • wasm : target/wasm32-unknown-unknown/release/build/devhub-community-1515b1be94ff0e90/out/target-discussions-for-community/near/devhub_discussions/devhub_discussions.wasm
• community-factory built
  • wasm : target/near/devhub_community_factory/devhub_community_factory.wasm
  • sub-build
    • stub : target/debug/build/devhub-community-factory-d7fa895f926988cc/out/community-stub.bin
    • wasm : target/wasm32-unknown-unknown/release/build/devhub-community-factory-25fc80ffdbb5bdec/out/target-community-for-community-factory/near/devhub_community/devhub_community.wasm
    • sub-build
      • stub : target/wasm32-unknown-unknown/release/build/devhub-community-factory-25fc80ffdbb5bdec/out/target-community-for-community-factory/debug/build/devhub-community-9df08e869c916c9b/out/discussions-stub.bin
      • wasm : target/wasm32-unknown-unknown/release/build/devhub-community-factory-25fc80ffdbb5bdec/out/target-community-for-community-factory/wasm32-unknown-unknown/release/build/devhub-community-1515b1be94ff0e90/out/target-discussions-for-community/near/devhub_discussions/devhub_discussions.wasm