canic 0.19.0

Canic — a canister orchestration and management toolkit for the Internet Computer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use std::path::PathBuf;

fn main() {
    // The exported endpoint macros use these cfg names when optional endpoint
    // groups are compiled out for a role-specific canister build.
    println!("cargo:rustc-check-cfg=cfg(canic_accepts_delegation_signer_proof)");
    println!("cargo:rustc-check-cfg=cfg(canic_accepts_delegation_verifier_proof)");
    println!("cargo:rustc-check-cfg=cfg(canic_delegated_tokens_enabled)");
    println!("cargo:rustc-check-cfg=cfg(canic_icrc21_enabled)");
    println!("cargo:rustc-check-cfg=cfg(canic_is_root)");
    println!("cargo:rustc-check-cfg=cfg(canic_has_scaling)");
    println!("cargo:rustc-check-cfg=cfg(canic_has_sharding)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_standards_icrc)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_standards_canic)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_observability_memory)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_observability_env)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_observability_log)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_metrics)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_auth_attestation)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_topology_state)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_topology_directory)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_topology_children)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_topology_cycles)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_topology_placement)");
    println!("cargo:rustc-check-cfg=cfg(canic_disable_bundle_nonroot_sync_topology)");

    // If the env var changes, we must re-run to pick up a different config.
    println!("cargo:rerun-if-env-changed=CANIC_CONFIG_PATH");

    // Path to this crate at build time.
    let manifest_dir =
        PathBuf::from(std::env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR must be set"));

    // Repo-default config location (works in workspace builds).
    // NOTE: This path will NOT exist in `cargo package` / `cargo publish` builds because
    // Cargo builds from a staged directory under target/package/ that does not include
    // workspace siblings.
    let repo_cfg = manifest_dir.join("../canisters/canic.toml");

    // Determine the config path:
    // - If CANIC_CONFIG_PATH is set, it is authoritative (relative paths resolved from the crate).
    // - Otherwise, fall back to the repo default.
    let env_cfg = std::env::var("CANIC_CONFIG_PATH").ok();
    let cfg_path = env_cfg.as_ref().map_or(repo_cfg, |val| {
        let path = PathBuf::from(val);
        if path.is_relative() {
            manifest_dir.join(path)
        } else {
            path
        }
    });

    // If the user explicitly set CANIC_CONFIG_PATH, missing config is a hard error.
    if env_cfg.is_some() {
        assert!(
            cfg_path.exists(),
            "Missing Canic config at {}",
            cfg_path.display()
        );
    } else if !cfg_path.exists() {
        // Packaged builds won't include ../canisters. Skip build-time validation.
        // This keeps `cargo package` / `cargo publish` working.
        //
        // IMPORTANT: Any code that consumes CANIC_CONFIG_PATH must tolerate it being unset
        // in packaged builds (e.g., via option_env!).
        println!(
            "cargo:warning=CANIC_CONFIG_PATH not set and default config not found at {}; \
             skipping config validation (likely a packaged build)",
            cfg_path.display()
        );
        return;
    }

    // Re-run if the config changes.
    println!("cargo:rerun-if-changed={}", cfg_path.display());
    if let Some(parent) = cfg_path.parent() {
        // Directory watch is not recursive, but it helps in common cases (file replaced/renamed).
        println!("cargo:rerun-if-changed={}", parent.display());
    }

    // Validate the config early so failures are caught at build time.
    let config_str = std::fs::read_to_string(&cfg_path).expect("read canic config for validation");
    canic_core::bootstrap::init_config(&config_str).expect("invalid canic config");

    // Export the canonicalized path for compile-time use.
    println!(
        "cargo:rustc-env=CANIC_CONFIG_PATH={}",
        cfg_path
            .canonicalize()
            .expect("canonicalize canic config path")
            .display()
    );
}