canic-host 0.107.1

Host-side App build, Fleet install, deployment, and release-set library for Canic workspaces
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Module: install_root::fleet_component_provisioning_journal::model
//!
//! Responsibility: define the durable fresh-install provisioning document and typed host phases.
//! Does not own: transition orchestration, authority validation, filesystem I/O, or remote effects.
//! Boundary: this schema is the exact reinstall-only JSON document persisted by the host.

use crate::{
    fleet_catalog::FleetCatalogEntryV1, fleet_install_plan::PersistedFleetInstallPlan,
    install_root::fleet_component_provisioning_plan::CompiledFleetComponentProvisioningPlan,
};
use std::{io, path::PathBuf};

use candid::Principal;
use canic_core::{
    dto::component_provisioning::{
        FleetComponentProvisioningAdvanceRequest, FleetComponentProvisioningPrepareRequest,
        FleetComponentProvisioningStatusResponse,
    },
    ids::FleetName,
};
use serde::{Deserialize, Serialize};
use thiserror::Error as ThisError;

pub(super) const JOURNAL_SCHEMA_VERSION: u32 = 1;

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub(in crate::install_root) enum FleetComponentProvisioningInstallPhase {
    Planned,
    PreparationInFlight,
    Prepared,
    AdvanceInFlight,
    RuntimesActivated,
    CatalogPublicationInFlight,
    CatalogPublished,
    Complete,
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(deny_unknown_fields)]
pub(in crate::install_root) struct FleetComponentProvisioningInstallJournal {
    pub schema_version: u32,
    pub sequence: u64,
    pub phase: FleetComponentProvisioningInstallPhase,
    pub fleet_install_plan_digest: [u8; 32],
    pub coordinator: Principal,
    pub fleet_name: FleetName,
    pub environment: String,
    pub prepare_request: FleetComponentProvisioningPrepareRequest,
    pub plan_hash: [u8; 32],
    pub last_status: Option<FleetComponentProvisioningStatusResponse>,
    pub advance_request: Option<FleetComponentProvisioningAdvanceRequest>,
    pub catalog_entry: Option<FleetCatalogEntryV1>,
    pub catalog_hash: Option<[u8; 32]>,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub(in crate::install_root) struct ResolvedFleetComponentProvisioningInstall {
    pub journal: FleetComponentProvisioningInstallJournal,
    pub path: PathBuf,
}

pub(in crate::install_root) struct PlanFleetComponentProvisioningInstallRequest<'a> {
    pub fleet_install_plan: &'a PersistedFleetInstallPlan,
    pub coordinator: Principal,
    pub fleet_name: FleetName,
    pub environment: String,
    pub compiled: CompiledFleetComponentProvisioningPlan,
}

#[derive(Debug, ThisError)]
pub(in crate::install_root) enum FleetComponentProvisioningInstallJournalError {
    #[error(
        "Fleet Component provisioning install journal already has different immutable authority: {path}"
    )]
    ConflictingAuthority { path: PathBuf },

    #[error("invalid Fleet Component provisioning install journal {path}: {reason}")]
    InvalidDocument { path: PathBuf, reason: String },

    #[error(
        "Fleet Component provisioning install journal cannot transition from {observed:?} to {requested:?}"
    )]
    InvalidTransition {
        observed: FleetComponentProvisioningInstallPhase,
        requested: FleetComponentProvisioningInstallPhase,
    },

    #[error("failed to access Fleet Component provisioning install journal {path}: {source}")]
    Io {
        path: PathBuf,
        #[source]
        source: io::Error,
    },

    #[error("Fleet Component provisioning install journal is not a regular no-follow file: {path}")]
    UnsafeFile { path: PathBuf },

    #[error(
        "Fleet Component provisioning install journal lock is not a regular no-follow file: {path}"
    )]
    UnsafeLock { path: PathBuf },
}

pub(super) const fn resolved(
    journal: FleetComponentProvisioningInstallJournal,
    path: PathBuf,
) -> ResolvedFleetComponentProvisioningInstall {
    ResolvedFleetComponentProvisioningInstall { journal, path }
}