lenso-contracts 0.3.20

Shared declaration contracts for the Lenso backend framework.
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

//! Host-owned lifecycle declarations for module manifests.
//!
//! Lifecycle entries are data, not startup callbacks. The host validates these
//! declarations and schedules runtime-owned work during worker startup.

use serde::{Deserialize, Serialize};
use serde_json::Value;
use utoipa::ToSchema;

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, ToSchema, schemars::JsonSchema)]
pub struct LifecycleSurface {
    #[serde(default)]
    pub startup_checks: Vec<LifecycleStartupCheckDeclaration>,
    #[serde(default)]
    pub activation_jobs: Vec<LifecycleActivationJobDeclaration>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, ToSchema, schemars::JsonSchema)]
pub struct LifecycleStartupCheckDeclaration {
    pub name: String,
    #[serde(default)]
    pub required: bool,
    #[serde(flatten)]
    pub check: LifecycleStartupCheckKind,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, ToSchema, schemars::JsonSchema)]
#[serde(tag = "kind", rename_all = "snake_case")]
#[non_exhaustive]
pub enum LifecycleStartupCheckKind {
    FunctionRegistered { function_name: String },
    CapabilityDeclared { capability: String },
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, ToSchema, schemars::JsonSchema)]
pub struct LifecycleActivationJobDeclaration {
    pub name: String,
    pub function_name: String,
    #[serde(default = "default_every_startup")]
    pub run_policy: LifecycleActivationRunPolicy,
    #[serde(default)]
    pub input: Value,
    #[serde(default)]
    pub required: bool,
}

#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, ToSchema, schemars::JsonSchema,
)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum LifecycleActivationRunPolicy {
    EveryStartup,
}

fn default_every_startup() -> LifecycleActivationRunPolicy {
    LifecycleActivationRunPolicy::EveryStartup
}