canic-core 0.27.7

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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use crate::{
    InternalError,
    dto::state::{AppCommand, AppStateInput, AppStateResponse, AppStatus},
    ops::storage::state::mapper::{AppStateCommandMapper, AppStateMapper},
    ops::{prelude::*, storage::StorageOpsError},
    storage::stable::state::app::{AppMode, AppState, AppStateRecord},
};
use thiserror::Error as ThisError;

///
/// AppStateCommand
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum AppStateCommand {
    SetStatus(AppStatus),
    SetCyclesFundingEnabled(bool),
}

///
/// AppStateOpsError
///

#[derive(Debug, ThisError)]
pub enum AppStateOpsError {
    #[error("app is already in {0} mode")]
    AlreadyInMode(AppMode),

    #[error("cycles funding already set to {0}")]
    CyclesFundingAlreadySet(bool),
}

impl From<AppStateOpsError> for InternalError {
    fn from(err: AppStateOpsError) -> Self {
        StorageOpsError::from(err).into()
    }
}

///
/// AppStateOps
///

pub struct AppStateOps;

impl AppStateOps {
    // -------------------------------------------------------------
    // Getters
    // -------------------------------------------------------------

    #[must_use]
    pub(crate) fn get_mode() -> AppMode {
        AppState::get_mode()
    }

    #[must_use]
    pub(crate) fn cycles_funding_enabled() -> bool {
        AppState::cycles_funding_enabled()
    }

    // -------------------------------------------------------------
    // Commands
    // -------------------------------------------------------------

    pub fn execute_command(cmd: AppStateCommand) -> Result<(), InternalError> {
        match cmd {
            AppStateCommand::SetStatus(status) => {
                let old_mode = AppState::get_mode();
                let new_mode = match status {
                    AppStatus::Active => AppMode::Enabled,
                    AppStatus::Readonly => AppMode::Readonly,
                    AppStatus::Stopped => AppMode::Disabled,
                };

                if old_mode == new_mode {
                    return Err(AppStateOpsError::AlreadyInMode(old_mode).into());
                }

                AppState::set_mode(new_mode);
                log!(Topic::App, Ok, "app: mode changed {old_mode} -> {new_mode}");
            }
            AppStateCommand::SetCyclesFundingEnabled(enabled) => {
                let old = AppState::cycles_funding_enabled();
                if old == enabled {
                    return Err(AppStateOpsError::CyclesFundingAlreadySet(old).into());
                }
                AppState::set_cycles_funding_enabled(enabled);
                log!(
                    Topic::App,
                    Ok,
                    "app: cycles_funding_enabled changed {old} -> {enabled}"
                );
            }
        }

        Ok(())
    }

    pub fn apply_command(cmd: AppCommand) -> Result<(), InternalError> {
        let internal = AppStateCommandMapper::dto_to_record(cmd);
        Self::execute_command(internal)
    }

    /// Initialize app state directly from configuration.
    ///
    /// This is intended for install-time bootstraps only.
    pub fn init_mode(mode: AppMode) {
        AppState::import(AppStateRecord {
            mode,
            cycles_funding_enabled: true,
        });
    }

    // -------------------------------------------------------------
    // Data / Import
    // -------------------------------------------------------------

    /// Export the current application state as a DTO snapshot.
    #[must_use]
    pub fn snapshot_input() -> AppStateInput {
        AppStateMapper::record_to_input(AppState::export())
    }

    /// Export the current application state as a response snapshot.
    #[must_use]
    pub fn snapshot_response() -> AppStateResponse {
        AppStateMapper::record_to_response(AppState::export())
    }

    /// Import application state from an operational snapshot.
    ///
    /// Validation occurs during snapshot → data conversion.
    #[allow(dead_code)]
    pub fn import(data: AppStateRecord) {
        AppState::import(data);
    }

    /// Import application state from a DTO snapshot.
    pub fn import_input(view: AppStateInput) {
        let record = AppStateMapper::input_to_record(view);
        AppState::import(record);
    }
}