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 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
//! Interact with and manage wadm applications over NATS, requires the `nats` feature
//!
//! This crate is essentially a wrapper around the wadm_client crate, and it's recommended to use
//! that crate directly instead.
use std::path::{Path, PathBuf};
use std::str::FromStr;
use std::time::Duration;
use anyhow::{bail, Context};
use async_nats::Client;
use regex::Regex;
use tracing::warn;
use wadm_client::Result;
use wadm_types::api::{ModelSummary, Status, VersionInfo};
use tokio::io::{AsyncRead, AsyncReadExt};
use url::Url;
use wadm_types::Manifest;
use wasmcloud_core::tls;
use crate::config::DEFAULT_LATTICE;
#[derive(Debug)]
pub enum AppManifest {
SerializedModel(serde_yaml::Value),
ModelName(String),
}
impl AppManifest {
/// Resolve relative file paths in the given app manifest to some base path
pub fn resolve_image_relative_file_paths(&mut self, base: impl AsRef<Path>) -> Result<()> {
if let AppManifest::SerializedModel(ref mut content) = self {
resolve_relative_file_paths_in_yaml(content, base)?;
}
Ok(())
}
/// Retrieve the name of a given [`AppManifest`]
pub fn name(&self) -> Option<&str> {
match self {
AppManifest::ModelName(name) => Some(name),
AppManifest::SerializedModel(manifest) => manifest
.get("metadata")?
.get("name")
.and_then(|v| v.as_str()),
}
}
/// Retrieve the version of a given [`AppManifest`], returning None if the manifest
/// does not contain a version (or is not the type to contain a version)
pub fn version(&self) -> Option<&str> {
match self {
AppManifest::ModelName(_) => None,
AppManifest::SerializedModel(manifest) => manifest
.get("metadata")?
.get("annotations")?
.get("version")
.and_then(|v| v.as_str()),
}
}
}
/// Resolve the relative paths in a YAML value, given a base path (directory)
/// from which to resolve the relative paths that are found
fn resolve_relative_file_paths_in_yaml(
content: &mut serde_yaml::Value,
base_dir: impl AsRef<Path>,
) -> Result<()> {
match content {
// If we encounter a string anywhere that is a relative path, resolve it
serde_yaml::Value::String(s)
if s.starts_with("file://") && s.chars().nth(7).is_some_and(|v| v != '/') =>
{
// Convert the base dir + relative path into a file based URL
let full_path = base_dir.as_ref().join(
s.strip_prefix("file://")
.context("failed to strip prefix")?,
);
// Build a file based URL and replace the existing one
if let Ok(url) = Url::from_file_path(&full_path) {
*s = url.into();
} else {
warn!(
"failed to build a file URL from path [{}], is the file missing?",
full_path.display()
);
}
}
// If the YAML value is a mapping, recur into it to process more values
serde_yaml::Value::Mapping(m) => {
for (_key, value) in m.iter_mut() {
resolve_relative_file_paths_in_yaml(value, base_dir.as_ref())?;
}
}
// If the YAML value is a sequence, recur into it to process more values
serde_yaml::Value::Sequence(values) => {
for value in values {
resolve_relative_file_paths_in_yaml(value, base_dir.as_ref())?;
}
}
// All other cases we can ignore replacements
_ => {}
}
Ok(())
}
pub trait AsyncReadSource: AsyncRead + Unpin + Send + Sync {}
impl<T: AsyncRead + Unpin + Send + Sync> AsyncReadSource for T {}
pub enum AppManifestSource {
AsyncReadSource(Box<dyn AsyncReadSource>),
File(PathBuf),
Url(url::Url),
// the inner string is intended to be the model name
Model(String),
}
impl FromStr for AppManifestSource {
type Err = anyhow::Error;
fn from_str(s: &str) -> anyhow::Result<Self, Self::Err> {
if s == "-" {
return Ok(Self::AsyncReadSource(Box::new(tokio::io::stdin())));
}
// Is the source a file path?
if PathBuf::from(s).is_file() {
match PathBuf::from(s).extension() {
Some(ext) if ext == "yaml" || ext == "yml" || ext == "json" => {
return Ok(Self::File(PathBuf::from(s)));
}
_ => bail!("file {} has an unsupported extension. Only .yaml, .yml, and .json are supported at this time", s),
}
}
// Is the source a url?
if Url::parse(s).is_ok() {
if !s.starts_with("http") {
bail!("file url {} has an unsupported scheme. Only http(s):// is supported at this time", s)
}
return Ok(Self::Url(url::Url::parse(s)?));
}
// Is the source a valid model name?
let model_name_regex =
Regex::new(r"^[-\w]+$").context("failed to instantiate manifest name regex")?;
if model_name_regex.is_match(s) {
return Ok(Self::Model(s.to_owned()));
}
bail!("invalid manifest source: {}", s)
}
}
/// Undeploy a model, instructing wadm to no longer manage the given application
///
/// # Arguments
/// * `client` - The [Client](async_nats::Client) to use in order to send the request message
/// * `lattice` - Optional lattice name that the application is managed on, defaults to `default`
/// * `model_name` - Model name to undeploy
pub async fn undeploy_model(
client: &Client,
lattice: Option<String>,
model_name: &str,
) -> Result<()> {
let wadm_client = wadm_client::Client::from_nats_client(
&lattice.unwrap_or_else(|| DEFAULT_LATTICE.to_string()),
None,
client.clone(),
);
wadm_client.undeploy_manifest(model_name).await.map(|_| ())
}
/// Deploy a model, instructing wadm to manage the application
///
/// # Arguments
/// * `client` - The [Client](async_nats::Client) to use in order to send the request message
/// * `lattice` - Optional lattice name that the application will be managed on, defaults to `default`
/// * `model_name` - Model name to deploy
/// * `version` - Version to deploy, defaults to deploying the latest "put" version
pub async fn deploy_model(
client: &Client,
lattice: Option<String>,
model_name: &str,
version: Option<String>,
) -> Result<(String, Option<String>)> {
let wadm_client = wadm_client::Client::from_nats_client(
&lattice.unwrap_or_else(|| DEFAULT_LATTICE.to_string()),
None,
client.clone(),
);
wadm_client
.deploy_manifest(model_name, version.as_deref())
.await
}
/// Put a model definition, instructing wadm to store the application manifest for later deploys
///
/// # Arguments
/// * `client` - The [Client](async_nats::Client) to use in order to send the request message
/// * `lattice` - Optional lattice name that the application manifest will be stored on, defaults to `default`
/// * `model` - The full YAML or JSON string containing the OAM wadm manifest
///
/// # Returns
/// The name and version of the model that was put
pub async fn put_model(
client: &Client,
lattice: Option<String>,
model: &str,
) -> Result<(String, String)> {
let wadm_client = wadm_client::Client::from_nats_client(
&lattice.unwrap_or_else(|| DEFAULT_LATTICE.to_string()),
None,
client.clone(),
);
let manifest = model.as_bytes();
wadm_client.put_manifest(manifest).await
}
/// Deploy a model, instructing wadm to manage the application
///
/// # Arguments
/// * `client` - The [Client](async_nats::Client) to use in order to send the request message
/// * `lattice` - Optional lattice name that the application will be managed on, defaults to `default`
/// * `model` - The full YAML or JSON string containing the OAM wadm manifest
///
/// # Returns
/// The name and version of the model that was put
pub async fn put_and_deploy_model(
client: &Client,
lattice: Option<String>,
model: &str,
) -> Result<(String, String)> {
let wadm_client = wadm_client::Client::from_nats_client(
&lattice.unwrap_or_else(|| DEFAULT_LATTICE.to_string()),
None,
client.clone(),
);
let manifest = model.as_bytes();
wadm_client.put_and_deploy_manifest(manifest).await
}
/// Query wadm for the history of a given model name
///
/// # Arguments
/// * `client` - The [Client](async_nats::Client) to use in order to send the request message
/// * `lattice` - Optional lattice name that the application manifest is stored on, defaults to `default`
/// * `model_name` - Name of the model to retrieve history for
pub async fn get_model_history(
client: &Client,
lattice: Option<String>,
model_name: &str,
) -> Result<Vec<VersionInfo>> {
let wadm_client = wadm_client::Client::from_nats_client(
&lattice.unwrap_or_else(|| DEFAULT_LATTICE.to_string()),
None,
client.clone(),
);
wadm_client.list_versions(model_name).await
}
/// Query wadm for the status of a given model by name
///
/// # Arguments
/// * `client` - The [Client](async_nats::Client) to use in order to send the request message
/// * `lattice` - Optional lattice name that the application manifest is stored on, defaults to `default`
/// * `model_name` - Name of the model to retrieve status for
pub async fn get_model_status(
client: &Client,
lattice: Option<String>,
model_name: &str,
) -> Result<Status> {
let wadm_client = wadm_client::Client::from_nats_client(
&lattice.unwrap_or_else(|| DEFAULT_LATTICE.to_string()),
None,
client.clone(),
);
wadm_client.get_manifest_status(model_name).await
}
/// Query wadm for details on a given model
///
/// # Arguments
/// * `client` - The [Client](async_nats::Client) to use in order to send the request message
/// * `lattice` - Optional lattice name that the application manifest is stored on, defaults to `default`
/// * `model_name` - Name of the model to retrieve history for
/// * `version` - Version to retrieve, defaults to retrieving the latest "put" version
pub async fn get_model_details(
client: &Client,
lattice: Option<String>,
model_name: &str,
version: Option<String>,
) -> Result<Manifest> {
let wadm_client = wadm_client::Client::from_nats_client(
&lattice.unwrap_or_else(|| DEFAULT_LATTICE.to_string()),
None,
client.clone(),
);
wadm_client
.get_manifest(model_name, version.as_deref())
.await
}
/// Delete a model version from wadm
///
/// # Arguments
/// * `client` - The [Client](async_nats::Client) to use in order to send the request message
/// * `lattice` - Optional lattice name that the application manifest is stored on, defaults to `default`
/// * `model_name` - Name of the model
/// * `version` - Version to retrieve, defaults to deleting the latest "put" version (or all if `delete_all` is specified)
pub async fn delete_model_version(
client: &Client,
lattice: Option<String>,
model_name: &str,
version: Option<String>,
) -> Result<bool> {
let wadm_client = wadm_client::Client::from_nats_client(
&lattice.unwrap_or_else(|| DEFAULT_LATTICE.to_string()),
None,
client.clone(),
);
wadm_client
.delete_manifest(model_name, version.as_deref())
.await
}
/// Query wadm for all application manifests
///
/// # Arguments
/// * `client` - The [Client](async_nats::Client) to use in order to send the request message
/// * `lattice` - Optional lattice name that the application manifests are stored on, defaults to `default`
pub async fn get_models(client: &Client, lattice: Option<String>) -> Result<Vec<ModelSummary>> {
let wadm_client = wadm_client::Client::from_nats_client(
&lattice.unwrap_or_else(|| DEFAULT_LATTICE.to_string()),
None,
client.clone(),
);
wadm_client.list_manifests().await
}
// NOTE(ahmedtadde): This should probably be refactored at some point to account for cases where the source's input is unusually (or erroneously) large.
// For now, we'll just assume that the input is small enough to be a oneshot read into memory and that the default timeout of 1 sec is plenty sufficient (or even too generous?) for the desired/expected behavior.
pub async fn load_app_manifest(source: AppManifestSource) -> anyhow::Result<AppManifest> {
let load_from_source = || async {
match source {
AppManifestSource::AsyncReadSource(mut stdin) => {
let mut buffer = String::new();
stdin
.read_to_string(&mut buffer)
.await
.context("failed to read model from stdin")?;
if buffer.is_empty() {
bail!("unable to load app manifest from empty stdin input")
}
Ok(AppManifest::SerializedModel(
serde_yaml::from_str(&buffer).context("failed to parse yaml from STDIN")?,
))
}
AppManifestSource::File(path) => {
let mut manifest = AppManifest::SerializedModel(
serde_yaml::from_str(
tokio::fs::read_to_string(&path)
.await
.context("failed to read model from file")?
.as_str(),
)
.with_context(|| {
format!("failed to parse yaml from file @ [{}]", path.display())
})?,
);
// For manifests loaded from a local file, canonicalize the path that held the YAML
// and use that directory (immediate parent) to resolve relative file paths inside
manifest.resolve_image_relative_file_paths(
path.canonicalize()
.context("failed to canonicalize path to app manifest")?
.parent()
.context("failed to get parent directory of app manifest")?,
)?;
Ok(manifest)
}
AppManifestSource::Url(url) => {
let res = tls::DEFAULT_REQWEST_CLIENT
.get(url.clone())
.send()
.await
.context("request to remote model file failed")?;
let text = res
.text()
.await
.context("failed to read model from remote file")?;
serde_yaml::from_str(&text)
.with_context(|| format!("failed to parse YAML from URL [{url}]"))
.map(AppManifest::SerializedModel)
}
AppManifestSource::Model(name) => Ok(AppManifest::ModelName(name)),
}
};
// Note(ahmedtadde): considered having a timeout: Option<Duration> parameter, but decided against it since, given the use case for this fn, the callers can fairly
// assume that the manifest should be loaded within a reasonable time frame. Now, reasonable is debatable, but i think anything over 1 sec is out of the question as things stand.
const DEFAULT_TIMEOUT: Duration = Duration::from_secs(1);
tokio::time::timeout(DEFAULT_TIMEOUT, load_from_source())
.await
.context("app manifest loader timed out")?
}
#[cfg(test)]
mod test {
use super::*;
use tempfile::tempdir;
use anyhow::Result;
#[test]
#[cfg_attr(
not(can_reach_raw_githubusercontent_com),
ignore = "raw.githubusercontent.com is not reachable"
)]
fn test_app_manifest_source_from_str() -> Result<(), Box<dyn std::error::Error>> {
// test stdin
let stdin = AppManifestSource::from_str("-")?;
assert!(
matches!(stdin, AppManifestSource::AsyncReadSource(_)),
"expected AppManifestSource::AsyncReadSource"
);
// create temporary file for this test
let tmp_dir = tempdir()?;
std::fs::write(tmp_dir.path().join("foo.yaml"), "foo")?;
std::fs::write(tmp_dir.path().join("foo.toml"), "foo")?;
// test file
let file = AppManifestSource::from_str(tmp_dir.path().join("foo.yaml").to_str().unwrap())?;
assert!(
matches!(file, AppManifestSource::File(_)),
"expected AppManifestSource::File"
);
// test url
let url = AppManifestSource::from_str(
"https://raw.githubusercontent.com/wasmCloud/wasmCloud/main/examples/rust/components/http-hello-world/wadm.yaml",
)?;
assert!(
matches!(url, AppManifestSource::Url(_)),
"expected AppManifestSource::Url"
);
let url = AppManifestSource::from_str(
"https://raw.githubusercontent.com/wasmCloud/wasmCloud/main/examples/rust/components/http-hello-world/wadm.yaml",
)?;
assert!(
matches!(url, AppManifestSource::Url(_)),
"expected AppManifestSource::Url"
);
// test model
let model = AppManifestSource::from_str("foo")?;
assert!(
matches!(model, AppManifestSource::Model(_)),
"expected AppManifestSource::Model"
);
// test invalid
let invalid = AppManifestSource::from_str("foo.bar");
assert!(
invalid.is_err(),
"expected error on invalid app manifest model name"
);
let invalid = AppManifestSource::from_str("sftp://foobar.com");
assert!(
invalid.is_err(),
"expected error on invalid app manifest url source"
);
let invalid =
AppManifestSource::from_str(tmp_dir.path().join("foo.json").to_str().unwrap());
assert!(
invalid.is_err(),
"expected error on invalid app manifest file source"
);
let invalid =
AppManifestSource::from_str(tmp_dir.path().join("foo.toml").to_str().unwrap());
assert!(
invalid.is_err(),
"expected error on invalid app manifest file source"
);
Ok(())
}
#[tokio::test]
#[cfg_attr(
not(can_reach_raw_githubusercontent_com),
ignore = "raw.githubusercontent.com is not reachable"
)]
async fn test_load_app_manifest() -> Result<()> {
// test stdin
let stdin = AppManifestSource::AsyncReadSource(Box::new(std::io::Cursor::new(
"iam batman!".as_bytes(),
)));
let manifest = load_app_manifest(stdin).await?;
assert!(
matches!(manifest, AppManifest::SerializedModel(manifest) if manifest == "iam batman!"),
"expected AppManifest::SerializedModel('iam batman!')"
);
// create temporary file for this test
let tmp_dir = tempdir()?;
std::fs::write(tmp_dir.path().join("foo.yaml"), "foo")?;
// test file
let file = AppManifestSource::from_str(tmp_dir.path().join("foo.yaml").to_str().unwrap())?;
let manifest = load_app_manifest(file).await?;
assert!(
matches!(manifest, AppManifest::SerializedModel(manifest) if manifest == "foo"),
"expected AppManifest::SerializedModel('foo')"
);
// test url
let url = AppManifestSource::from_str(
"https://raw.githubusercontent.com/wasmCloud/wasmCloud/main/examples/rust/components/http-hello-world/wadm.yaml",
)?;
let manifest = load_app_manifest(url).await?;
assert!(
matches!(manifest, AppManifest::SerializedModel(_)),
"expected AppManifest::SerializedModel(_)"
);
// test model
let model = AppManifestSource::from_str("foo")?;
let manifest = load_app_manifest(model).await?;
assert!(
matches!(manifest, AppManifest::ModelName(name) if name == "foo"),
"expected AppManifest::ModelName('foo')"
);
Ok(())
}
}