icydb-cli 0.296.10

Developer CLI tools for IcyDB
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

//! Module: schema report command handling.
//! Responsibility: call the generated accepted-schema endpoint and render schema reports.
//! Does not own: schema reconciliation, endpoint publication, or generic ICP command construction.
//! Boundary: exposes the schema show command and test-covered report rendering through observability.

mod render;

use icydb::__macro::RpcMethod;

use crate::{
    cli::{CanisterTarget, DiagnosticArtifactArgs, DiagnosticSourceMetadataArgs},
    diagnostic::artifact::DiagnosticSchemaArtifact,
    icp::{IcpCallKind, require_created_canister},
    observability::call_endpoint,
};
use ic_host_text::escape::terminal_text;

/// Read and print the generated accepted-schema endpoint.
pub(super) fn run_schema_show_command(target: CanisterTarget) -> Result<(), String> {
    let report = load_schema_report(target.environment(), target.canister_name())?;
    print!("{}", render_schema_report(report.as_slice()));
    Ok(())
}

pub(super) fn run_diagnostic_artifact_command(args: DiagnosticArtifactArgs) -> Result<(), String> {
    let target = args.target();
    let report = load_schema_report(target.environment(), target.canister_name())?;
    let artifact = DiagnosticSchemaArtifact::from_report(
        target.environment(),
        target.canister_name(),
        report.as_slice(),
    )?;
    artifact.write_new(args.output())?;
    println!(
        "wrote {}",
        terminal_text(&args.output().display().to_string())
    );
    Ok(())
}

pub(super) fn run_diagnostic_source_metadata_command(
    args: DiagnosticSourceMetadataArgs,
) -> Result<(), String> {
    let metadata = DiagnosticSchemaArtifact::read_deployment(args.artifact())?
        .bind_to_source(args.source())?;
    metadata.write_new(args.output())?;
    println!(
        "wrote {}",
        terminal_text(&args.output().display().to_string())
    );
    Ok(())
}

pub(super) fn load_schema_report(
    environment: &str,
    canister: &str,
) -> Result<Vec<icydb::db::EntitySchemaDescription>, String> {
    require_created_canister(environment, canister)?;
    call_endpoint(
        environment,
        canister,
        RpcMethod::Schema,
        (),
        "schema",
        IcpCallKind::Query,
    )
}

pub(super) fn render_schema_report(report: &[icydb::db::EntitySchemaDescription]) -> String {
    render::render_schema_report(report)
}