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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
//! User-facing app.yaml file config: [`AppConfigV1`].
mod healthcheck;
mod http;
pub use self::{
healthcheck::{HealthCheckHttpV1, HealthCheckV1},
http::HttpRequest,
};
use std::collections::HashMap;
use anyhow::{bail, Context};
use bytesize::ByteSize;
use crate::package::PackageSource;
/// Header added to Edge app HTTP responses.
/// The value contains the app version ID that generated the response.
///
// This is used by the CLI to determine when a new version was successfully
// released.
#[allow(clippy::declare_interior_mutable_const)]
pub const HEADER_APP_VERSION_ID: &str = "x-edge-app-version-id";
/// User-facing app.yaml config file for apps.
///
/// NOTE: only used by the backend, Edge itself does not use this format, and
/// uses [`super::AppVersionV1Spec`] instead.
#[derive(
serde::Serialize, serde::Deserialize, schemars::JsonSchema, Clone, Debug, PartialEq, Eq,
)]
pub struct AppConfigV1 {
/// Name of the app.
pub name: String,
/// App id assigned by the backend.
///
/// This will get populated once the app has been deployed.
///
/// This id is also used to map to the existing app during deployments.
// #[serde(skip_serializing_if = "Option::is_none")]
// pub description: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub app_id: Option<String>,
/// Owner of the app.
///
/// This is either a username or a namespace.
#[serde(skip_serializing_if = "Option::is_none")]
pub owner: Option<String>,
/// The package to execute.
pub package: PackageSource,
/// Domains for the app.
///
/// This can include both provider-supplied
/// alias domains and custom domains.
#[serde(skip_serializing_if = "Option::is_none")]
pub domains: Option<Vec<String>>,
/// Environment variables.
#[serde(default, skip_serializing_if = "HashMap::is_empty")]
pub env: HashMap<String, String>,
// CLI arguments passed to the runner.
/// Only applicable for runners that accept CLI arguments.
#[serde(skip_serializing_if = "Option::is_none")]
pub cli_args: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub capabilities: Option<AppConfigCapabilityMapV1>,
#[serde(skip_serializing_if = "Option::is_none")]
pub scheduled_tasks: Option<Vec<AppScheduledTask>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub volumes: Option<Vec<AppVolume>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub health_checks: Option<Vec<HealthCheckV1>>,
/// Enable debug mode, which will show detailed error pages in the web gateway.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub debug: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub scaling: Option<AppScalingConfigV1>,
/// Capture extra fields for forwards compatibility.
#[serde(flatten)]
pub extra: HashMap<String, serde_json::Value>,
}
#[derive(
serde::Serialize, serde::Deserialize, schemars::JsonSchema, Clone, Debug, PartialEq, Eq,
)]
pub struct AppScalingConfigV1 {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub mode: Option<AppScalingModeV1>,
}
#[derive(
serde::Serialize, serde::Deserialize, schemars::JsonSchema, Clone, Debug, PartialEq, Eq,
)]
pub enum AppScalingModeV1 {
#[serde(rename = "single_concurrency")]
SingleConcurrency,
}
#[derive(
serde::Serialize, serde::Deserialize, schemars::JsonSchema, Clone, Debug, PartialEq, Eq,
)]
pub struct AppVolume {
pub name: String,
pub mounts: Vec<AppVolumeMount>,
}
#[derive(
serde::Serialize, serde::Deserialize, schemars::JsonSchema, Clone, Debug, PartialEq, Eq,
)]
pub struct AppVolumeMount {
/// Path to mount the volume at.
pub mount_path: String,
/// Sub-path within the volume to mount.
pub sub_path: Option<String>,
}
#[derive(
serde::Serialize, serde::Deserialize, schemars::JsonSchema, Clone, Debug, PartialEq, Eq,
)]
pub struct AppScheduledTask {
pub name: String,
// #[serde(flatten)]
// pub spec: CronJobSpecV1,
}
impl AppConfigV1 {
pub const KIND: &'static str = "wasmer.io/App.v0";
pub const CANONICAL_FILE_NAME: &'static str = "app.yaml";
pub fn to_yaml_value(self) -> Result<serde_yaml::Value, serde_yaml::Error> {
// Need to do an annoying type dance to both insert the kind field
// and also insert kind at the top.
let obj = match serde_yaml::to_value(self)? {
serde_yaml::Value::Mapping(m) => m,
_ => unreachable!(),
};
let mut m = serde_yaml::Mapping::new();
m.insert("kind".into(), Self::KIND.into());
for (k, v) in obj.into_iter() {
m.insert(k, v);
}
Ok(m.into())
}
pub fn to_yaml(self) -> Result<String, serde_yaml::Error> {
serde_yaml::to_string(&self.to_yaml_value()?)
}
pub fn parse_yaml(value: &str) -> Result<Self, anyhow::Error> {
let raw = serde_yaml::from_str::<serde_yaml::Value>(value).context("invalid yaml")?;
let kind = raw
.get("kind")
.context("invalid app config: no 'kind' field found")?
.as_str()
.context("invalid app config: 'kind' field is not a string")?;
match kind {
Self::KIND => {}
other => {
bail!(
"invalid app config: unspported kind '{}', expected {}",
other,
Self::KIND
);
}
}
let data = serde_yaml::from_value(raw).context("could not deserialize app config")?;
Ok(data)
}
}
/// Restricted version of [`super::CapabilityMapV1`], with only a select subset
/// of settings.
#[derive(
serde::Serialize, serde::Deserialize, schemars::JsonSchema, Clone, Debug, PartialEq, Eq,
)]
pub struct AppConfigCapabilityMapV1 {
/// Instance memory settings.
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<AppConfigCapabilityMemoryV1>,
/// Enables app bootstrapping with startup snapshots.
#[serde(skip_serializing_if = "Option::is_none")]
pub instaboot: Option<AppConfigCapabilityInstaBootV1>,
/// Additional unknown capabilities.
///
/// This provides a small bit of forwards compatibility for newly added
/// capabilities.
#[serde(flatten)]
pub other: HashMap<String, serde_json::Value>,
}
/// Memory capability settings.
///
/// NOTE: this is kept separate from the [`super::CapabilityMemoryV1`] struct
/// to have separation between the high-level app.yaml and the more internal
/// App entity.
#[derive(
serde::Serialize, serde::Deserialize, schemars::JsonSchema, Clone, Debug, PartialEq, Eq,
)]
pub struct AppConfigCapabilityMemoryV1 {
/// Memory limit for an instance.
///
/// Format: [digit][unit], where unit is Mb/Gb/MiB/GiB,...
#[schemars(with = "Option<String>")]
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<ByteSize>,
}
/// Enables accelerated instance boot times with startup snapshots.
///
/// How it works:
/// The Edge runtime will create a pre-initialized snapshot of apps that is
/// ready to serve requests
/// Your app will then restore from the generated snapshot, which has the
/// potential to significantly speed up cold starts.
///
/// To drive the initialization, multiple http requests can be specified.
/// All the specified requests will be sent to the app before the snapshot is
/// created, allowing the app to pre-load files, pre initialize caches, ...
#[derive(
serde::Serialize, serde::Deserialize, schemars::JsonSchema, Clone, Debug, PartialEq, Eq,
)]
pub struct AppConfigCapabilityInstaBootV1 {
/// HTTP requests to perform during startup snapshot creation.
/// Apps can perform all the appropriate warmup logic in these requests.
///
/// NOTE: if no requests are configured, then a single HTTP
/// request to '/' will be performed instead.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub requests: Vec<HttpRequest>,
/// Maximum age of snapshots.
///
/// Format: 5m, 1h, 2d, ...
///
/// After the specified time new snapshots will be created, and the old
/// ones discarded.
#[serde(skip_serializing_if = "Option::is_none")]
pub max_age: Option<String>,
}
#[cfg(test)]
mod tests {
use pretty_assertions::assert_eq;
use super::*;
#[test]
fn test_app_config_v1_deser() {
let config = r#"
kind: wasmer.io/App.v0
name: test
package: ns/name@0.1.0
debug: true
env:
e1: v1
E2: V2
cli_args:
- arg1
- arg2
scheduled_tasks:
- name: backup
schedule: 1day
max_retries: 3
timeout: 10m
invoke:
fetch:
url: /api/do-backup
headers:
h1: v1
success_status_codes: [200, 201]
"#;
let parsed = AppConfigV1::parse_yaml(config).unwrap();
assert_eq!(
parsed,
AppConfigV1 {
name: "test".to_string(),
app_id: None,
package: "ns/name@0.1.0".parse().unwrap(),
owner: None,
domains: None,
env: [
("e1".to_string(), "v1".to_string()),
("E2".to_string(), "V2".to_string())
]
.into_iter()
.collect(),
volumes: None,
cli_args: Some(vec!["arg1".to_string(), "arg2".to_string()]),
capabilities: None,
scaling: None,
scheduled_tasks: Some(vec![AppScheduledTask {
name: "backup".to_string(),
// spec: CronJobSpecV1 {
// schedule: "1day".to_string(),
// max_schedule_drift: None,
// job: crate::schema::JobDefinition {
// max_retries: Some(3),
// timeout: Some(std::time::Duration::from_secs(10 * 60).into()),
// invoke: crate::schema::JobInvoke::Fetch(
// crate::schema::JobInvokeFetch {
// url: "/api/do-backup".parse().unwrap(),
// headers: Some(
// [("h1".to_string(), "v1".to_string())]
// .into_iter()
// .collect()
// ),
// success_status_codes: Some(vec![200, 201]),
// method: None,
// }
// )
// },
// }
}]),
health_checks: None,
extra: [(
"kind".to_string(),
serde_json::Value::from("wasmer.io/App.v0")
),]
.into_iter()
.collect(),
debug: Some(true),
}
);
}
}