cf-module-orchestrator 0.1.22

Module Orchestrator - system module for service discovery and module management
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

use std::collections::HashMap;
use uuid::Uuid;

use modkit::runtime::InstanceState;

use crate::domain::model::{DeploymentMode, InstanceInfo, ModuleInfo};

/// Deployment mode of a module
#[derive(Debug, Clone)]
#[modkit_macros::api_dto(response)]
pub enum DeploymentModeDto {
    /// Module is compiled into the host binary
    CompiledIn,
    /// Module runs as a separate process
    OutOfProcess,
}

/// Response DTO for a single registered module
#[modkit_macros::api_dto(response)]
pub struct ModuleDto {
    /// Module name
    pub name: String,
    /// Module version (if reported by a running instance)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    /// Declared capabilities (e.g., "rest", "grpc", "system", "db")
    pub capabilities: Vec<String>,
    /// Module dependencies (other module names)
    pub dependencies: Vec<String>,
    /// Whether the module is compiled-in or out-of-process
    pub deployment_mode: DeploymentModeDto,
    /// Running instances of this module
    pub instances: Vec<ModuleInstanceDto>,
    /// Plugins provided by this module (reserved for follow-up implementation)
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub plugins: Vec<PluginDto>,
}

/// Response DTO for a running module instance
#[modkit_macros::api_dto(response)]
pub struct ModuleInstanceDto {
    /// Unique instance ID
    pub instance_id: Uuid,
    /// Module version (if reported during registration)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    /// Current instance state (e.g., "registered", "healthy", "quarantined")
    pub state: String,
    /// gRPC services provided by this instance (service name -> endpoint URI)
    pub grpc_services: HashMap<String, String>,
}

/// Response DTO for a plugin (reserved for follow-up implementation)
#[modkit_macros::api_dto(response)]
pub struct PluginDto {
    /// Plugin GTS identifier
    pub gts_id: String,
    /// Plugin version
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
}

impl From<&ModuleInfo> for ModuleDto {
    fn from(module: &ModuleInfo) -> Self {
        // Derive module-level version from the first instance that reports one
        let version = module
            .instances
            .iter()
            .find_map(|inst| inst.version.clone());

        Self {
            name: module.name.clone(),
            version,
            capabilities: module.capabilities.clone(),
            dependencies: module.dependencies.clone(),
            deployment_mode: match module.deployment_mode {
                DeploymentMode::CompiledIn => DeploymentModeDto::CompiledIn,
                DeploymentMode::OutOfProcess => DeploymentModeDto::OutOfProcess,
            },
            instances: module
                .instances
                .iter()
                .map(ModuleInstanceDto::from)
                .collect(),
            plugins: vec![],
        }
    }
}

impl From<&InstanceInfo> for ModuleInstanceDto {
    fn from(instance: &InstanceInfo) -> Self {
        Self {
            instance_id: instance.instance_id,
            version: instance.version.clone(),
            state: match instance.state {
                InstanceState::Registered => "registered",
                InstanceState::Ready => "ready",
                InstanceState::Healthy => "healthy",
                InstanceState::Quarantined => "quarantined",
                InstanceState::Draining => "draining",
            }
            .to_owned(),
            grpc_services: instance.grpc_services.clone(),
        }
    }
}