feresaria/crates/ferese-ipc/src/theme.rs

use std::io;
use std::net::Shutdown;
use std::os::unix::net::UnixStream;
use std::path::PathBuf;
use std::time::Duration;

use ferese_theme_model::{Mode, ResolvedTheme, families::Family};
use serde::{Deserialize, Serialize};
use serde_json::{Value, json};

use crate::{Request, Response, VERSION, read_frame, write_frame};

pub const SCHEMA_VERSION: u32 = 2;

#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
pub struct Snapshot {
    pub version: u32,
    pub revision: u64,
    pub mode: Mode,
    pub theme: ResolvedTheme,
    pub presented: ResolvedTheme,
    pub warnings: Vec<String>,
    pub error: Option<String>,
    pub families: Vec<Family>,
    #[serde(default)]
    pub fallback_note: Option<String>,
}

impl Snapshot {
    /// Decode older messages with the caller's catalog. Explicit empty catalogs stay empty.
    pub fn decode(mut value: Value, fallback_families: impl FnOnce() -> Vec<Family>) -> Result<Self, String> {
        if let Some(object) = value.as_object_mut()
            && !object.contains_key("families")
        {
            object.insert(
                "families".into(),
                serde_json::to_value(fallback_families()).map_err(|e| e.to_string())?,
            );
        }
        let snapshot: Self = serde_json::from_value(value).map_err(|e| e.to_string())?;
        if snapshot.version != SCHEMA_VERSION {
            return Err("Unsupported theme snapshot version".into());
        }
        Ok(snapshot)
    }
}

pub fn socket_path() -> io::Result<PathBuf> {
    std::env::var_os("XDG_RUNTIME_DIR")
        .filter(|value| !value.is_empty())
        .map(|directory| PathBuf::from(directory).join("ferese/control.sock"))
        .ok_or_else(|| io::Error::new(io::ErrorKind::NotFound, "XDG_RUNTIME_DIR is not set"))
}

pub struct Connection {
    stream: UnixStream,
    id: u64,
}

impl Connection {
    pub fn connect() -> io::Result<Self> {
        let stream = UnixStream::connect(socket_path()?)?;
        stream.set_write_timeout(Some(Duration::from_secs(2)))?;
        stream.set_read_timeout(Some(Duration::from_secs(2)))?;
        Ok(Self { stream, id: 0 })
    }

    pub fn cancellation(&self) -> io::Result<Cancellation> {
        self.stream.try_clone().map(Cancellation)
    }

    pub fn call(&mut self, command: &str, args: Value) -> Result<Value, String> {
        self.id = self.id.wrapping_add(1);
        let request = Request {
            version: VERSION,
            id: self.id,
            kind: "command".into(),
            command: command.into(),
            args,
        };
        let response = write_frame(&mut self.stream, &request).and_then(|()| read_frame::<Response>(&mut self.stream));
        let response = match response {
            Ok(response) => response,
            Err(error) => {
                let _ = self.stream.shutdown(Shutdown::Both);
                return Err(error.to_string());
            }
        };
        if response.id != self.id || response.version != VERSION {
            let _ = self.stream.shutdown(Shutdown::Both);
            return Err("Unexpected theme IPC response".into());
        }
        if let Some(error) = response.error {
            return Err(error.message);
        }
        response.result.ok_or_else(|| "Missing theme snapshot".into())
    }

    pub fn get(&mut self, fallback_families: impl FnOnce() -> Vec<Family>) -> Result<Snapshot, String> {
        Snapshot::decode(self.call("theme-get", json!({}))?, fallback_families)
    }

    pub fn watch(
        &mut self,
        revision: u64,
        fallback_families: impl FnOnce() -> Vec<Family>,
    ) -> Result<Snapshot, String> {
        Snapshot::decode(self.wait("theme-watch", json!({"since": revision}))?, fallback_families)
    }

    /// Wait for a server-side change; dropping the cancellation handle interrupts it.
    pub fn wait(&mut self, command: &str, args: Value) -> Result<Value, String> {
        self.stream.set_read_timeout(None).map_err(|e| e.to_string())?;
        let result = self.call(command, args);
        self.stream
            .set_read_timeout(Some(Duration::from_secs(2)))
            .map_err(|e| e.to_string())?;
        result
    }
}

pub struct Cancellation(UnixStream);

impl Drop for Cancellation {
    fn drop(&mut self) {
        let _ = self.0.shutdown(Shutdown::Both);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::mpsc;

    #[test]
    fn cancelling_a_blocked_watch_releases_the_client_and_server() {
        let (stream, mut server) = UnixStream::pair().unwrap();
        let mut connection = Connection { stream, id: 0 };
        let cancellation = connection.cancellation().unwrap();
        let (send, receive) = mpsc::channel();
        let worker = std::thread::spawn(move || {
            send.send(connection.watch(7, Vec::new)).unwrap();
        });
        server.set_read_timeout(Some(Duration::from_secs(2))).unwrap();
        let request: Request = read_frame(&mut server).unwrap();
        assert_eq!(request.command, "theme-watch");
        assert_eq!(request.args, json!({"since": 7}));
        drop(cancellation);
        assert!(receive.recv_timeout(Duration::from_secs(2)).unwrap().is_err());
        assert!(read_frame::<Request>(&mut server).is_err());
        worker.join().unwrap();
    }

    #[test]
    fn response_identity_is_checked_before_decoding_theme_values() {
        for wrong_version in [false, true] {
            let (stream, mut server) = UnixStream::pair().unwrap();
            server.set_read_timeout(Some(Duration::from_secs(2))).unwrap();
            stream.set_read_timeout(Some(Duration::from_secs(2))).unwrap();
            let worker = std::thread::spawn(move || {
                let request: Request = read_frame(&mut server).unwrap();
                let mut response = Response::success(request.id, json!({}));
                if wrong_version {
                    response.version += 1;
                } else {
                    response.id += 1;
                }
                write_frame(&mut server, &response).unwrap();
            });
            let error = Connection { stream, id: 0 }
                .get(|| panic!("must not decode an unrelated response"))
                .unwrap_err();
            assert_eq!(error, "Unexpected theme IPC response");
            worker.join().unwrap();
        }
    }
}