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
use crate::start::wait_for_server;
use anyhow::{anyhow, Result};
use async_compression::tokio::bufread::GzipDecoder;
#[cfg(target_family = "unix")]
use std::os::unix::prelude::PermissionsExt;
use std::path::{Path, PathBuf};
use std::process::Stdio;
use std::{ffi::OsStr, io::Cursor};
use tokio::fs::{create_dir_all, metadata, write, File};
use tokio::process::{Child, Command};
use tokio_stream::StreamExt;
use tokio_tar::Archive;
const NATS_GITHUB_RELEASE_URL: &str = "https://github.com/nats-io/nats-server/releases/download";
pub const NATS_SERVER_CONF: &str = "nats.conf";
pub const NATS_SERVER_PID: &str = "nats.pid";
#[cfg(target_family = "unix")]
pub const NATS_SERVER_BINARY: &str = "nats-server";
#[cfg(target_family = "windows")]
pub const NATS_SERVER_BINARY: &str = "nats-server.exe";
/// A wrapper around the [ensure_nats_server_for_os_arch_pair] function that uses the
/// architecture and operating system of the current host machine.
///
/// # Arguments
///
/// * `version` - Specifies the version of the binary to download in the form of `vX.Y.Z`
/// * `dir` - Where to download the `nats-server` binary to
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() {
/// use wash_lib::start::ensure_nats_server;
/// let res = ensure_nats_server("v2.8.4", "/tmp/").await;
/// assert!(res.is_ok());
/// assert!(res.unwrap().to_string_lossy() == "/tmp/nats-server");
/// # }
/// ```
pub async fn ensure_nats_server<P>(version: &str, dir: P) -> Result<PathBuf>
where
P: AsRef<Path>,
{
ensure_nats_server_for_os_arch_pair(std::env::consts::OS, std::env::consts::ARCH, version, dir)
.await
}
/// Ensures the `nats-server` binary is installed, returning the path to the executable early if it exists or
/// downloading the specified GitHub release version of nats-server from <https://github.com/nats-io/nats-server/releases/>
/// and unpacking the binary for a specified OS/ARCH pair to a directory. Returns the path to the NATS executable.
/// # Arguments
///
/// * `os` - Specifies the operating system of the binary to download, e.g. `linux`
/// * `arch` - Specifies the architecture of the binary to download, e.g. `amd64`
/// * `version` - Specifies the version of the binary to download in the form of `vX.Y.Z`
/// * `dir` - Where to download the `nats-server` binary to
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() {
/// use wash_lib::start::ensure_nats_server_for_os_arch_pair;
/// let os = std::env::consts::OS;
/// let arch = std::env::consts::ARCH;
/// let res = ensure_nats_server_for_os_arch_pair(os, arch, "v2.8.4", "/tmp/").await;
/// assert!(res.is_ok());
/// assert!(res.unwrap().to_string_lossy() == "/tmp/nats-server");
/// # }
/// ```
pub async fn ensure_nats_server_for_os_arch_pair<P>(
os: &str,
arch: &str,
version: &str,
dir: P,
) -> Result<PathBuf>
where
P: AsRef<Path>,
{
let nats_bin_path = dir.as_ref().join(NATS_SERVER_BINARY);
if let Ok(_md) = metadata(&nats_bin_path).await {
// NATS already exists, return early
return Ok(nats_bin_path);
}
// Download NATS tarball
download_nats_server_for_os_arch_pair(os, arch, version, dir).await
}
/// A wrapper around the [download_nats_server_for_os_arch_pair] function that uses the
/// architecture and operating system of the current host machine.
///
/// # Arguments
///
/// * `version` - Specifies the version of the binary to download in the form of `vX.Y.Z`
/// * `dir` - Where to download the `nats-server` binary to
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() {
/// use wash_lib::start::download_nats_server;
/// let res = download_nats_server("v2.8.4", "/tmp/").await;
/// assert!(res.is_ok());
/// assert!(res.unwrap().to_string_lossy() == "/tmp/nats-server");
/// # }
/// ```
pub async fn download_nats_server<P>(version: &str, dir: P) -> Result<PathBuf>
where
P: AsRef<Path>,
{
download_nats_server_for_os_arch_pair(
std::env::consts::OS,
std::env::consts::ARCH,
version,
dir,
)
.await
}
/// Downloads the specified GitHub release version of nats-server from <https://github.com/nats-io/nats-server/releases/>
/// and unpacking the binary for a specified OS/ARCH pair to a directory. Returns the path to the NATS executable.
/// # Arguments
///
/// * `os` - Specifies the operating system of the binary to download, e.g. `linux`
/// * `arch` - Specifies the architecture of the binary to download, e.g. `amd64`
/// * `version` - Specifies the version of the binary to download in the form of `vX.Y.Z`
/// * `dir` - Where to download the `nats-server` binary to
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() {
/// use wash_lib::start::download_nats_server_for_os_arch_pair;
/// let os = std::env::consts::OS;
/// let arch = std::env::consts::ARCH;
/// let res = download_nats_server_for_os_arch_pair(os, arch, "v2.8.4", "/tmp/").await;
/// assert!(res.is_ok());
/// assert!(res.unwrap().to_string_lossy() == "/tmp/nats-server");
/// # }
/// ```
pub async fn download_nats_server_for_os_arch_pair<P>(
os: &str,
arch: &str,
version: &str,
dir: P,
) -> Result<PathBuf>
where
P: AsRef<Path>,
{
let nats_bin_path = dir.as_ref().join(NATS_SERVER_BINARY);
// Download NATS tarball
let url = nats_url(os, arch, version);
let body = match reqwest::get(url).await {
Ok(resp) => resp.bytes().await?,
Err(e) => return Err(anyhow!("Failed to request NATS release: {:?}", e)),
};
let cursor = Cursor::new(body);
let mut nats_server = Archive::new(Box::new(GzipDecoder::new(cursor)));
// Look for nats-server binary and only extract that
let mut entries = nats_server.entries()?;
while let Some(res) = entries.next().await {
let mut entry = res.map_err(|e| {
anyhow!(
"Failed to retrieve file from archive, ensure NATS server {} exists. Original error: {}",
version, e
)
})?;
if let Ok(tar_path) = entry.path() {
match tar_path.file_name() {
Some(name) if name == OsStr::new(NATS_SERVER_BINARY) => {
// Ensure target directory exists
create_dir_all(&dir).await?;
let mut nats_server = File::create(&nats_bin_path).await?;
// Make nats-server executable
#[cfg(target_family = "unix")]
{
let mut permissions = nats_server.metadata().await?.permissions();
// Read/write/execute for owner and read/execute for others. This is what `cargo install` does
permissions.set_mode(0o755);
nats_server.set_permissions(permissions).await?;
}
tokio::io::copy(&mut entry, &mut nats_server).await?;
return Ok(nats_bin_path);
}
// Ignore LICENSE and README in the NATS tarball
_ => (),
}
}
}
Err(anyhow!(
"NATS Server binary could not be installed, please see logs"
))
}
/// Configuration for a NATS server that supports running either in "standalone" or "leaf" mode.
/// See the respective [NatsConfig::new_standalone] and [NatsConfig::new_leaf] implementations below for more information.
#[derive(Clone)]
pub struct NatsConfig {
pub host: String,
pub port: u16,
pub js_domain: Option<String>,
pub remote_url: Option<String>,
pub credentials: Option<PathBuf>,
}
/// Returns a standalone NATS config with the following values:
/// * `host`: `127.0.0.1`
/// * `port`: `4222`
/// * `js_domain`: `Some("core")`
/// * `remote_url`: `None`
/// * `credentials`: `None`
impl Default for NatsConfig {
fn default() -> Self {
NatsConfig {
host: "127.0.0.1".to_string(),
port: 4222,
js_domain: Some("core".to_string()),
remote_url: None,
credentials: None,
}
}
}
impl NatsConfig {
/// Instantiates config for a NATS leaf node. Leaf nodes are meant to extend
/// an existing NATS infrastructure like [Synadia's NGS](https://synadia.com/ngs), but can
/// also be used to extend your own NATS infrastructure. For more information,
/// our [Working with Leaf Nodes](https://wasmcloud.dev/reference/lattice/leaf-nodes/) docs
///
/// # Arguments
/// * `host`: NATS host to listen on, e.g. `127.0.0.1`
/// * `port`: NATS port to listen on, e.g. `4222`
/// * `js_domain`: Jetstream domain to use, defaults to `core`. See [Configuring Jetstream](https://wasmcloud.dev/reference/lattice/jetstream/) for more information
/// * `remote_url`: URL of NATS cluster to extend
/// * `credentials`: Credentials to authenticate to the existing NATS cluster
pub fn new_leaf(
host: &str,
port: u16,
js_domain: Option<String>,
remote_url: String,
credentials: PathBuf,
) -> Self {
NatsConfig {
host: host.to_owned(),
port,
js_domain,
remote_url: Some(remote_url),
credentials: Some(credentials),
}
}
/// Instantiates config for a standalone NATS server. Unless you're looking to extend
/// existing NATS infrastructure, this is the preferred NATS server mode.
///
/// # Arguments
/// * `host`: NATS host to listen on, e.g. `127.0.0.1`
/// * `port`: NATS port to listen on, e.g. `4222`
/// * `js_domain`: Jetstream domain to use, defaults to `core`. See [Configuring Jetstream](https://wasmcloud.dev/reference/lattice/jetstream/) for more information
pub fn new_standalone(host: &str, port: u16, js_domain: Option<String>) -> Self {
if host == "0.0.0.0" {
log::warn!("Listening on 0.0.0.0 is unsupported on some platforms, use 127.0.0.1 for best results")
}
NatsConfig {
host: host.to_owned(),
port,
js_domain,
..Default::default()
}
}
async fn write_to_path<P>(self, path: P) -> Result<()>
where
P: AsRef<Path>,
{
let leafnode_section = match (self.remote_url, self.credentials) {
(Some(url), Some(creds)) => format!(
r#"
leafnodes {{
remotes = [
{{
url: "{}"
credentials: {:?}
}}
]
}}
"#,
url,
creds.to_string_lossy()
),
_ => "".to_owned(),
};
let config = format!(
r#"
jetstream {{
domain={}
}}
{}
"#,
self.js_domain.unwrap_or_else(|| "core".to_string()),
leafnode_section
);
write(path, config).await.map_err(anyhow::Error::from)
}
}
/// Helper function to execute a NATS server binary with required wasmCloud arguments, e.g. JetStream
/// # Arguments
///
/// * `bin_path` - Path to the nats-server binary to execute
/// * `stderr` - Specify where NATS stderr logs should be written to. If logs aren't important, use std::process::Stdio::null()
/// * `config` - Configuration for the NATS server, see [NatsConfig] for options. This config file is written alongside the nats-server binary as `nats.conf`
pub async fn start_nats_server<P, T>(bin_path: P, stderr: T, config: NatsConfig) -> Result<Child>
where
P: AsRef<Path>,
T: Into<Stdio>,
{
let host_addr = format!("{}:{}", config.host, config.port);
// If we can connect to the local port, NATS won't be able to listen on that port
if tokio::net::TcpStream::connect(&host_addr).await.is_ok() {
return Err(anyhow!(
"Could not start NATS server, a process is already listening on {}:{}",
config.host,
config.port
));
}
let child = if let Some(parent_path) = bin_path.as_ref().parent() {
let config_path = parent_path.join(NATS_SERVER_CONF);
let host = config.host.to_owned();
let port = config.port;
config.write_to_path(&config_path).await?;
Command::new(bin_path.as_ref())
.stderr(stderr)
.stdin(Stdio::null())
.arg("-js")
.arg("--config")
.arg(config_path)
.arg("--addr")
.arg(host)
.arg("--port")
.arg(port.to_string())
.arg("--pid")
.arg(parent_path.join(NATS_SERVER_PID))
.spawn()
.map_err(anyhow::Error::from)
} else {
Err(anyhow!(
"Could not write config to disk, couldn't find download directory"
))
}?;
wait_for_server(&host_addr, "NATS server")
.await
.map(|_| child)
}
/// Helper function to indicate if the NATS server binary is successfully
/// installed in a directory
pub async fn is_nats_installed<P>(dir: P) -> bool
where
P: AsRef<Path>,
{
metadata(dir.as_ref().join(NATS_SERVER_BINARY))
.await
.map_or(false, |m| m.is_file())
}
/// Helper function to determine the NATS server release path given an os/arch and version
fn nats_url(os: &str, arch: &str, version: &str) -> String {
// Replace "macos" with "darwin" to match NATS release scheme
let os = if os == "macos" { "darwin" } else { os };
// Replace architecture to match NATS release naming scheme
let arch = match arch {
"aarch64" => "arm64",
"x86_64" => "amd64",
_ => arch,
};
format!("{NATS_GITHUB_RELEASE_URL}/{version}/nats-server-{version}-{os}-{arch}.tar.gz")
}
#[cfg(test)]
mod test {
use crate::start::{
ensure_nats_server, is_nats_installed, start_nats_server, NatsConfig, NATS_SERVER_BINARY,
};
use anyhow::Result;
use std::env::temp_dir;
use tokio::{
fs::{create_dir_all, remove_dir_all},
io::AsyncReadExt,
};
const NATS_SERVER_VERSION: &str = "v2.8.4";
#[tokio::test]
async fn can_handle_missing_nats_version() -> Result<()> {
let install_dir = temp_dir().join("can_handle_missing_nats_version");
let _ = remove_dir_all(&install_dir).await;
create_dir_all(&install_dir).await?;
assert!(!is_nats_installed(&install_dir).await);
let res = ensure_nats_server("v300.22.1111223", &install_dir).await;
assert!(res.is_err());
let _ = remove_dir_all(install_dir).await;
Ok(())
}
#[tokio::test]
async fn can_download_and_start_nats() -> Result<()> {
let install_dir = temp_dir().join("can_download_and_start_nats");
let _ = remove_dir_all(&install_dir).await;
create_dir_all(&install_dir).await?;
assert!(!is_nats_installed(&install_dir).await);
let res = ensure_nats_server(NATS_SERVER_VERSION, &install_dir).await;
assert!(res.is_ok());
let log_path = install_dir.join("nats.log");
let log_file = tokio::fs::File::create(&log_path).await?.into_std().await;
let config = NatsConfig::new_standalone("127.0.0.1", 10000, None);
let child_res =
start_nats_server(&install_dir.join(NATS_SERVER_BINARY), log_file, config).await;
assert!(child_res.is_ok());
// Give NATS max 5 seconds to start up
for _ in 0..4 {
let log_contents = tokio::fs::read_to_string(&log_path).await?;
if log_contents.is_empty() {
println!("NATS server hasn't started up yet, waiting 1 second");
tokio::time::sleep(std::time::Duration::from_millis(1000)).await;
} else {
// Give just a little bit of time for the startup logs to flow in
tokio::time::sleep(std::time::Duration::from_millis(1000)).await;
assert!(log_contents.contains("Starting nats-server"));
assert!(log_contents.contains("Starting JetStream"));
assert!(log_contents.contains("Server is ready"));
break;
}
}
child_res.unwrap().kill().await?;
let _ = remove_dir_all(install_dir).await;
Ok(())
}
#[tokio::test]
async fn can_gracefully_fail_running_nats() -> Result<()> {
let install_dir = temp_dir().join("can_gracefully_fail_running_nats");
let _ = remove_dir_all(&install_dir).await;
create_dir_all(&install_dir).await?;
assert!(!is_nats_installed(&install_dir).await);
let res = ensure_nats_server(NATS_SERVER_VERSION, &install_dir).await;
assert!(res.is_ok());
let config = NatsConfig::new_standalone("127.0.0.1", 10003, Some("extender".to_string()));
let nats_one = start_nats_server(
&install_dir.join(NATS_SERVER_BINARY),
std::process::Stdio::null(),
config.clone(),
)
.await;
assert!(nats_one.is_ok());
// Give NATS a few seconds to start up and listen
tokio::time::sleep(std::time::Duration::from_millis(5000)).await;
let log_path = install_dir.join("nats.log");
let log = std::fs::File::create(&log_path)?;
let nats_two = start_nats_server(&install_dir.join(NATS_SERVER_BINARY), log, config).await;
assert!(nats_two.is_err());
nats_one.unwrap().kill().await?;
let _ = remove_dir_all(install_dir).await;
Ok(())
}
#[tokio::test]
async fn can_write_properly_formed_credsfile() -> Result<()> {
let install_dir = temp_dir().join("can_write_properly_formed_credsfile");
let _ = remove_dir_all(&install_dir).await;
create_dir_all(&install_dir).await?;
assert!(
!is_nats_installed(&install_dir).await,
"NATS should not be installed"
);
let res = ensure_nats_server(NATS_SERVER_VERSION, &install_dir).await;
assert!(res.is_ok(), "NATS should be able to start");
let creds = dirs::home_dir().unwrap().join("nats.creds");
let config: NatsConfig = NatsConfig::new_leaf(
"127.0.0.1",
4243,
None,
"connect.ngs.global".to_string(),
creds.clone(),
);
config.write_to_path(creds.clone()).await?;
let mut credsfile = tokio::fs::File::open(creds.clone()).await?;
let mut contents = String::new();
credsfile.read_to_string(&mut contents).await?;
assert_eq!(contents, format!("\njetstream {{\n domain={}\n}}\n\nleafnodes {{\n remotes = [\n {{\n url: \"{}\"\n credentials: {:?}\n }}\n ]\n}}\n \n", "core", "connect.ngs.global", creds.to_string_lossy()));
// A simple check to ensure we are properly escaping quotes, this is unescaped and checks for "\\"
#[cfg(target_family = "windows")]
assert!(creds.to_string_lossy().contains("\\"));
let _ = remove_dir_all(install_dir).await;
Ok(())
}
}