use std::path::PathBuf;
use std::sync::OnceLock;
use std::time::Duration;
use async_trait::async_trait;
use reqwest::Client;
use serde::Deserialize;
use crate::fetcher::github::common::{cache_key, parse_options, payload};
use crate::fetcher::{FetchContext, FetchError, Fetcher, Safety};
use crate::options::OptionSchema;
use crate::paths;
use crate::payload::{Body, ImageData, Payload};
use crate::render::Shape;
const API_BASE: &str = "https://dog.ceo/api";
const ALLOWED_IMAGE_HOSTS: &[&str] = &["images.dog.ceo", "dog.ceo"];
const REQUEST_TIMEOUT: Duration = Duration::from_secs(10);
const USER_AGENT: &str = concat!("splashboard/", env!("CARGO_PKG_VERSION"));
const MAX_BYTES: usize = 5 * 1024 * 1024;
const SHAPES: &[Shape] = &[Shape::Image];
const OPTION_SCHEMAS: &[OptionSchema] = &[
OptionSchema {
name: "breed",
type_hint: "string",
required: false,
default: None,
description: "dog.ceo breed slug (e.g. `shiba`, `husky`, `golden`). Omit for any breed.",
},
OptionSchema {
name: "sub_breed",
type_hint: "string",
required: false,
default: None,
description: "dog.ceo sub-breed slug (e.g. `cocker` under `breed = \"spaniel\"`). Requires `breed`.",
},
];
pub struct RandomDogFetcher;
#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Options {
#[serde(default)]
pub breed: Option<String>,
#[serde(default)]
pub sub_breed: Option<String>,
}
#[async_trait]
impl Fetcher for RandomDogFetcher {
fn name(&self) -> &str {
"random_dog"
}
fn safety(&self) -> Safety {
Safety::Safe
}
fn description(&self) -> &'static str {
"A random dog photo from dog.ceo, downloaded each refresh cycle and rendered as an image. Optional `breed` (e.g. `shiba`, `husky`) and `sub_breed` (with `breed`) narrow the pool."
}
fn refresh_interval(&self) -> u64 {
60 * 60
}
fn shapes(&self) -> &[Shape] {
SHAPES
}
fn option_schemas(&self) -> &[OptionSchema] {
OPTION_SCHEMAS
}
fn cache_key(&self, ctx: &FetchContext) -> String {
let extra = ctx
.options
.as_ref()
.and_then(|v| toml::to_string(v).ok())
.unwrap_or_default();
cache_key(self.name(), ctx, &extra)
}
fn sample_body(&self, _shape: Shape) -> Option<Body> {
None
}
async fn fetch(&self, ctx: &FetchContext) -> Result<Payload, FetchError> {
let opts: Options = parse_options(ctx.options.as_ref()).map_err(FetchError::Failed)?;
validate_options(&opts).map_err(FetchError::Failed)?;
let key = self.cache_key(ctx);
let path = download_dog(opts.breed.as_deref(), opts.sub_breed.as_deref(), &key).await?;
Ok(payload(Body::Image(ImageData {
path: path.to_string_lossy().into_owned(),
})))
}
}
fn validate_options(opts: &Options) -> Result<(), String> {
let has_breed = opts
.breed
.as_deref()
.map(str::trim)
.is_some_and(|s| !s.is_empty());
let has_sub = opts
.sub_breed
.as_deref()
.map(str::trim)
.is_some_and(|s| !s.is_empty());
if has_sub && !has_breed {
return Err("sub_breed requires breed".into());
}
Ok(())
}
async fn download_dog(
breed: Option<&str>,
sub_breed: Option<&str>,
key: &str,
) -> Result<PathBuf, FetchError> {
let out_dir =
dog_dir().ok_or_else(|| FetchError::Failed("$HOME not available for dog cache".into()))?;
std::fs::create_dir_all(&out_dir)
.map_err(|e| FetchError::Failed(format!("create dog cache dir: {e}")))?;
let api_url = build_api_url(breed, sub_breed);
let image_url = fetch_image_url(&api_url).await?;
enforce_allowed_host(&image_url)?;
let bytes = fetch_bytes(&image_url).await?;
let ext = image_extension(&bytes)
.ok_or_else(|| FetchError::Failed("unrecognized image format from dog.ceo".into()))?;
remove_stale(&out_dir, key);
let path = out_dir.join(format!("{key}.{ext}"));
std::fs::write(&path, &bytes).map_err(|e| FetchError::Failed(format!("write dog: {e}")))?;
Ok(path)
}
fn build_api_url(breed: Option<&str>, sub_breed: Option<&str>) -> String {
let breed = breed.map(str::trim).filter(|s| !s.is_empty());
let sub_breed = sub_breed.map(str::trim).filter(|s| !s.is_empty());
match (breed, sub_breed) {
(Some(b), Some(sb)) => format!(
"{API_BASE}/breed/{}/{}/images/random",
encode_segment(b),
encode_segment(sb)
),
(Some(b), None) => format!("{API_BASE}/breed/{}/images/random", encode_segment(b)),
(None, _) => format!("{API_BASE}/breeds/image/random"),
}
}
fn encode_segment(s: &str) -> String {
s.bytes()
.map(|b| match b {
b'A'..=b'Z' | b'a'..=b'z' | b'0'..=b'9' | b'-' | b'_' | b'.' | b'~' => {
(b as char).to_string()
}
_ => format!("%{b:02X}"),
})
.collect()
}
#[derive(Deserialize)]
struct ApiResponse {
message: String,
status: String,
}
async fn fetch_image_url(api_url: &str) -> Result<String, FetchError> {
let res = http()
.get(api_url)
.send()
.await
.map_err(|e| FetchError::Failed(format!("dog API request failed: {e}")))?;
let status = res.status();
if !status.is_success() {
return Err(FetchError::Failed(format!("dog API {status}")));
}
let body: ApiResponse = res
.json()
.await
.map_err(|e| FetchError::Failed(format!("dog API body: {e}")))?;
if body.status != "success" {
return Err(FetchError::Failed(format!(
"dog API non-success status: {}",
body.status
)));
}
Ok(body.message)
}
fn enforce_allowed_host(url: &str) -> Result<(), FetchError> {
let host = url
.strip_prefix("https://")
.or_else(|| url.strip_prefix("http://"))
.and_then(|rest| rest.split('/').next())
.unwrap_or("");
if ALLOWED_IMAGE_HOSTS.contains(&host) {
Ok(())
} else {
Err(FetchError::Failed(format!(
"dog API returned off-host image URL: {url}"
)))
}
}
async fn fetch_bytes(url: &str) -> Result<Vec<u8>, FetchError> {
let res = http()
.get(url)
.send()
.await
.map_err(|e| FetchError::Failed(format!("dog image request failed: {e}")))?;
let status = res.status();
if !status.is_success() {
return Err(FetchError::Failed(format!("dog image {status}")));
}
let bytes = res
.bytes()
.await
.map_err(|e| FetchError::Failed(format!("dog image body: {e}")))?;
if bytes.len() > MAX_BYTES {
return Err(FetchError::Failed(format!(
"dog image too large: {} bytes",
bytes.len()
)));
}
Ok(bytes.to_vec())
}
fn http() -> &'static Client {
static CLIENT: OnceLock<Client> = OnceLock::new();
CLIENT.get_or_init(|| {
Client::builder()
.user_agent(USER_AGENT)
.timeout(REQUEST_TIMEOUT)
.gzip(true)
.build()
.expect("reqwest client should build with default config")
})
}
fn image_extension(bytes: &[u8]) -> Option<&'static str> {
if bytes.starts_with(b"\x89PNG\r\n\x1a\n") {
Some("png")
} else if bytes.starts_with(&[0xff, 0xd8, 0xff]) {
Some("jpg")
} else if bytes.starts_with(b"GIF87a") || bytes.starts_with(b"GIF89a") {
Some("gif")
} else if bytes.len() >= 12 && &bytes[..4] == b"RIFF" && &bytes[8..12] == b"WEBP" {
Some("webp")
} else {
None
}
}
fn dog_dir() -> Option<PathBuf> {
paths::cache_dir().map(|d| d.join("dogs"))
}
fn remove_stale(dir: &std::path::Path, key: &str) {
for ext in ["png", "jpg", "gif", "webp"] {
let _ = std::fs::remove_file(dir.join(format!("{key}.{ext}")));
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::future::Future;
use std::io::{Read, Write};
use std::net::TcpListener;
use std::thread;
fn ctx(shape: Option<Shape>, options: Option<toml::Value>) -> FetchContext {
FetchContext {
widget_id: "w".into(),
timeout: Duration::from_secs(1),
shape,
options,
..Default::default()
}
}
fn restore_home(previous: Option<String>) {
unsafe {
match previous {
Some(value) => std::env::set_var("SPLASHBOARD_HOME", value),
None => std::env::remove_var("SPLASHBOARD_HOME"),
}
}
}
fn serve_once(
status: &str,
content_type: &str,
body: &[u8],
) -> (String, thread::JoinHandle<()>) {
let listener = TcpListener::bind("127.0.0.1:0").unwrap();
let addr = listener.local_addr().unwrap();
let status = status.to_owned();
let content_type = content_type.to_owned();
let body = body.to_vec();
let handle = thread::spawn(move || {
let (mut stream, _) = listener.accept().unwrap();
let mut request = [0; 1024];
let _ = stream.read(&mut request);
let header = format!(
"HTTP/1.1 {status}\r\ncontent-type: {content_type}\r\ncontent-length: {}\r\nconnection: close\r\n\r\n",
body.len()
);
stream.write_all(header.as_bytes()).unwrap();
stream.write_all(&body).unwrap();
stream.flush().unwrap();
});
(format!("http://{addr}"), handle)
}
fn run_async<T>(future: impl Future<Output = T>) -> T {
tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
.unwrap()
.block_on(future)
}
#[test]
fn options_default_when_absent() {
let opts: Options = parse_options(None).unwrap();
assert!(opts.breed.is_none());
assert!(opts.sub_breed.is_none());
}
#[test]
fn options_reject_unknown_keys() {
let raw: toml::Value = toml::from_str("bogus = 1").unwrap();
assert!(parse_options::<Options>(Some(&raw)).is_err());
}
#[test]
fn options_accept_breed_and_sub_breed() {
let raw: toml::Value =
toml::from_str("breed = \"spaniel\"\nsub_breed = \"cocker\"").unwrap();
let opts: Options = parse_options(Some(&raw)).unwrap();
assert_eq!(opts.breed.as_deref(), Some("spaniel"));
assert_eq!(opts.sub_breed.as_deref(), Some("cocker"));
}
#[test]
fn fetcher_exposes_catalog_metadata() {
let fetcher = RandomDogFetcher;
assert_eq!(fetcher.name(), "random_dog");
assert_eq!(fetcher.safety(), Safety::Safe);
assert_eq!(fetcher.default_shape(), Shape::Image);
assert_eq!(fetcher.shapes(), SHAPES);
assert_eq!(
fetcher
.option_schemas()
.iter()
.map(|schema| schema.name)
.collect::<Vec<_>>(),
vec!["breed", "sub_breed"]
);
assert!(fetcher.description().contains("dog.ceo"));
assert!(fetcher.sample_body(Shape::Image).is_none());
}
#[test]
fn validate_rejects_sub_breed_without_breed() {
let opts = Options {
breed: None,
sub_breed: Some("cocker".into()),
};
assert!(validate_options(&opts).is_err());
}
#[test]
fn validate_treats_empty_breed_as_absent() {
let opts = Options {
breed: Some(" ".into()),
sub_breed: Some("cocker".into()),
};
assert!(validate_options(&opts).is_err());
}
#[test]
fn validate_passes_when_both_present() {
let opts = Options {
breed: Some("spaniel".into()),
sub_breed: Some("cocker".into()),
};
assert!(validate_options(&opts).is_ok());
}
#[test]
fn build_api_url_no_options() {
assert_eq!(
build_api_url(None, None),
"https://dog.ceo/api/breeds/image/random"
);
}
#[test]
fn build_api_url_breed_only() {
assert_eq!(
build_api_url(Some("shiba"), None),
"https://dog.ceo/api/breed/shiba/images/random"
);
}
#[test]
fn build_api_url_breed_and_sub_breed() {
assert_eq!(
build_api_url(Some("spaniel"), Some("cocker")),
"https://dog.ceo/api/breed/spaniel/cocker/images/random"
);
}
#[test]
fn build_api_url_treats_empty_breed_as_none() {
assert_eq!(
build_api_url(Some(" "), Some("cocker")),
"https://dog.ceo/api/breeds/image/random"
);
}
#[test]
fn build_api_url_encodes_special_chars() {
assert_eq!(
build_api_url(Some("a b"), None),
"https://dog.ceo/api/breed/a%20b/images/random"
);
}
#[test]
fn build_api_url_keeps_digits_unencoded() {
assert_eq!(
build_api_url(Some("breed99"), None),
"https://dog.ceo/api/breed/breed99/images/random"
);
}
#[test]
fn enforce_allowed_host_accepts_cdn() {
assert!(enforce_allowed_host("https://images.dog.ceo/breeds/foo/x.jpg").is_ok());
}
#[test]
fn enforce_allowed_host_accepts_apex() {
assert!(enforce_allowed_host("https://dog.ceo/anything").is_ok());
}
#[test]
fn enforce_allowed_host_rejects_off_host() {
assert!(enforce_allowed_host("https://evil.example.com/x.jpg").is_err());
assert!(enforce_allowed_host("https://dog.ceo.evil.com/x.jpg").is_err());
}
#[test]
fn enforce_allowed_host_accepts_http_scheme() {
assert!(enforce_allowed_host("http://images.dog.ceo/x.jpg").is_ok());
}
#[test]
fn enforce_allowed_host_rejects_url_without_scheme() {
assert!(enforce_allowed_host("images.dog.ceo/x.jpg").is_err());
assert!(enforce_allowed_host("ftp://images.dog.ceo/x.jpg").is_err());
}
#[test]
fn image_extension_detects_png() {
assert_eq!(image_extension(b"\x89PNG\r\n\x1a\nrest"), Some("png"));
}
#[test]
fn image_extension_detects_jpeg() {
assert_eq!(
image_extension(&[0xff, 0xd8, 0xff, 0xdb, 0x00]),
Some("jpg")
);
}
#[test]
fn image_extension_detects_gif() {
assert_eq!(image_extension(b"GIF89a..."), Some("gif"));
assert_eq!(image_extension(b"GIF87a..."), Some("gif"));
}
#[test]
fn image_extension_detects_webp() {
let mut bytes = vec![];
bytes.extend_from_slice(b"RIFF");
bytes.extend_from_slice(&[0u8; 4]);
bytes.extend_from_slice(b"WEBPVP8 ");
assert_eq!(image_extension(&bytes), Some("webp"));
}
#[test]
fn image_extension_unknown_returns_none() {
assert!(image_extension(&[0, 0, 0, 0]).is_none());
}
#[test]
fn cache_key_changes_with_breed() {
let mut ctx = FetchContext {
widget_id: "w".into(),
timeout: Duration::from_secs(1),
shape: Some(Shape::Image),
..Default::default()
};
let none_key = RandomDogFetcher.cache_key(&ctx);
ctx.options = Some(toml::Value::Table({
let mut t = toml::value::Table::new();
t.insert("breed".into(), toml::Value::String("shiba".into()));
t
}));
let shiba_key = RandomDogFetcher.cache_key(&ctx);
assert_ne!(none_key, shiba_key);
}
#[test]
fn remove_stale_removes_other_extensions() {
let tmp = tempfile::tempdir().unwrap();
let key = "abc";
for ext in ["png", "jpg", "gif", "webp"] {
std::fs::write(tmp.path().join(format!("{key}.{ext}")), b"x").unwrap();
}
remove_stale(tmp.path(), key);
for ext in ["png", "jpg", "gif", "webp"] {
assert!(
!tmp.path().join(format!("{key}.{ext}")).exists(),
"stale {ext} not removed"
);
}
}
#[test]
fn dog_dir_uses_cache_layout_under_env_override() {
let _lock = paths::TEST_ENV_LOCK
.lock()
.unwrap_or_else(|e| e.into_inner());
let tmp = tempfile::tempdir().unwrap();
let previous = std::env::var("SPLASHBOARD_HOME").ok();
unsafe { std::env::set_var("SPLASHBOARD_HOME", tmp.path()) };
assert_eq!(dog_dir(), Some(tmp.path().join("cache").join("dogs")));
restore_home(previous);
}
#[test]
fn restore_home_reapplies_previous_value_when_present() {
let _lock = paths::TEST_ENV_LOCK
.lock()
.unwrap_or_else(|e| e.into_inner());
let prior = std::env::var("SPLASHBOARD_HOME").ok();
unsafe { std::env::set_var("SPLASHBOARD_HOME", "/tmp/splashboard-dog-restore-prior") };
let captured = std::env::var("SPLASHBOARD_HOME").ok();
unsafe { std::env::set_var("SPLASHBOARD_HOME", "/tmp/splashboard-dog-restore-other") };
restore_home(captured);
assert_eq!(
std::env::var("SPLASHBOARD_HOME").ok().as_deref(),
Some("/tmp/splashboard-dog-restore-prior")
);
restore_home(prior);
}
#[test]
fn fetch_rejects_unknown_options_before_network() {
let err = run_async(RandomDogFetcher.fetch(&ctx(
Some(Shape::Image),
Some(toml::from_str("bogus = true").unwrap()),
)))
.unwrap_err();
assert!(format!("{err}").contains("unknown field"));
}
#[test]
fn fetch_rejects_sub_breed_without_breed_before_network() {
let err = run_async(RandomDogFetcher.fetch(&ctx(
Some(Shape::Image),
Some(toml::from_str("sub_breed = \"cocker\"").unwrap()),
)))
.unwrap_err();
assert_eq!(format!("{err}"), "fetch failed: sub_breed requires breed");
}
#[test]
fn fetch_image_url_reads_success_payload() {
let body = br#"{"message":"https://images.dog.ceo/breeds/shiba/x.jpg","status":"success"}"#;
let (url, server) = serve_once("200 OK", "application/json", body);
let image_url = run_async(fetch_image_url(&url)).unwrap();
server.join().unwrap();
assert_eq!(image_url, "https://images.dog.ceo/breeds/shiba/x.jpg");
}
#[test]
fn fetch_image_url_rejects_http_status() {
let (url, server) = serve_once("503 Service Unavailable", "application/json", br#"{}"#);
let err = run_async(fetch_image_url(&url)).unwrap_err();
server.join().unwrap();
assert_eq!(
format!("{err}"),
"fetch failed: dog API 503 Service Unavailable"
);
}
#[test]
fn fetch_image_url_rejects_invalid_json() {
let (url, server) = serve_once("200 OK", "application/json", br#"not-json"#);
let err = run_async(fetch_image_url(&url)).unwrap_err();
server.join().unwrap();
assert!(format!("{err}").contains("dog API body"));
}
#[test]
fn fetch_image_url_rejects_non_success_api_status() {
let body = br#"{"message":"https://images.dog.ceo/breeds/shiba/x.jpg","status":"error"}"#;
let (url, server) = serve_once("200 OK", "application/json", body);
let err = run_async(fetch_image_url(&url)).unwrap_err();
server.join().unwrap();
assert_eq!(
format!("{err}"),
"fetch failed: dog API non-success status: error"
);
}
#[test]
fn fetch_image_url_rejects_malformed_url() {
let err = run_async(fetch_image_url("https://bad host")).unwrap_err();
assert!(format!("{err}").contains("dog API request failed"));
}
#[test]
fn fetch_bytes_reads_small_body() {
let bytes = b"\x89PNG\r\n\x1a\nrest";
let (url, server) = serve_once("200 OK", "image/png", bytes);
let downloaded = run_async(fetch_bytes(&url)).unwrap();
server.join().unwrap();
assert_eq!(downloaded, bytes);
}
#[test]
fn fetch_bytes_rejects_http_status() {
let (url, server) = serve_once("404 Not Found", "text/plain", b"missing");
let err = run_async(fetch_bytes(&url)).unwrap_err();
server.join().unwrap();
assert_eq!(format!("{err}"), "fetch failed: dog image 404 Not Found");
}
#[test]
fn fetch_bytes_rejects_oversized_body() {
let (url, server) = serve_once("200 OK", "image/jpeg", &vec![b'x'; MAX_BYTES + 1]);
let err = run_async(fetch_bytes(&url)).unwrap_err();
server.join().unwrap();
assert_eq!(
format!("{err}"),
format!("fetch failed: dog image too large: {} bytes", MAX_BYTES + 1)
);
}
#[test]
fn fetch_bytes_rejects_malformed_url() {
let err = run_async(fetch_bytes("https://bad host")).unwrap_err();
assert!(format!("{err}").contains("dog image request failed"));
}
#[test]
fn fetch_surfaces_cache_dir_creation_failure_before_network() {
let _lock = paths::TEST_ENV_LOCK
.lock()
.unwrap_or_else(|e| e.into_inner());
let tmp = tempfile::tempdir().unwrap();
let file = tmp.path().join("not-a-dir");
std::fs::write(&file, b"x").unwrap();
let previous = std::env::var("SPLASHBOARD_HOME").ok();
unsafe { std::env::set_var("SPLASHBOARD_HOME", &file) };
let err = run_async(RandomDogFetcher.fetch(&ctx(
Some(Shape::Image),
Some(toml::from_str("breed = \"shiba\"").unwrap()),
)))
.unwrap_err();
assert!(format!("{err}").contains("create dog cache dir"));
restore_home(previous);
}
#[tokio::test]
#[ignore]
#[allow(clippy::await_holding_lock)]
async fn live_downloads_a_real_dog() {
let tmp = tempfile::tempdir().unwrap();
let _lock = paths::TEST_ENV_LOCK
.lock()
.unwrap_or_else(|e| e.into_inner());
unsafe { std::env::set_var("SPLASHBOARD_HOME", tmp.path()) };
let path = download_dog(None, None, "test-dog").await.unwrap();
eprintln!("wrote {}", path.display());
let bytes = std::fs::read(&path).unwrap();
assert!(
bytes.len() > 256,
"dog suspiciously small: {} bytes",
bytes.len()
);
assert!(
image_extension(&bytes).is_some(),
"unrecognized image format"
);
unsafe { std::env::remove_var("SPLASHBOARD_HOME") };
}
}