enwiro-sdk 0.5.1

Shared SDK for enwiro plugin authors: logging, gear schema, plugin protocol types
Documentation 
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

//! Shared JSON-RPC contract between `enwiro-daemon` and its clients
//! (`enw`, cookbooks, future external apps).
//!
//! See `docs/adr/0002-daemon-ipc-architecture.md`. We use jsonrpsee 0.26 as
//! the protocol layer: id correlation, envelope serialisation, error codes,
//! batching, notifications all live in the library. We own only the typed
//! trait below + the UDS transport plumbing in `rpc::client` (consumer side)
//! and `enwiro-daemon::rpc` (server side).
//!
//! Plugin↔host data emission (cookbook stdout-JSONL) is unaffected — this
//! channel is strictly for client↔daemon.

use serde::{Deserialize, Serialize};

/// Env var the daemon publishes so child processes can discover the live
/// socket without computing the path themselves.
pub const SOCKET_ENV_VAR: &str = "ENWIRO_RPC_SOCKET";

/// Env var carrying the cookbook-call chain across nested `cookbook.invoke`
/// spawns; SDK helpers forward it automatically.
pub const CALL_CHAIN_ENV_VAR: &str = "ENWIRO_RPC_CALL_CHAIN";

/// Default socket file name under `$XDG_RUNTIME_DIR/enwiro/`.
pub const SOCKET_FILENAME: &str = "rpc.sock";

/// Implementation-defined JSON-RPC error code returned when a cookbook
/// could not be located, exited non-zero, or produced invalid UTF-8.
pub const APPLICATION_ERROR_CODE: i32 = -32000;

/// Implementation-defined JSON-RPC error code returned when a
/// `cookbook.invoke` would extend a chain that already contains the
/// requested cookbook (ADR-0002 §4 cycle detection).
pub const CYCLE_DETECTED_CODE: i32 = -32001;

/// Resolve the default socket path. `$XDG_RUNTIME_DIR/enwiro/rpc.sock`.
pub fn default_socket_path() -> anyhow::Result<std::path::PathBuf> {
    let base = dirs::runtime_dir()
        .or_else(|| dirs::cache_dir().map(|d| d.join("run")))
        .ok_or_else(|| anyhow::anyhow!("could not determine runtime or cache directory"))?;
    Ok(base.join("enwiro").join(SOCKET_FILENAME))
}

/// Params for `cookbook.invoke`: delegate a cookbook operation through the
/// daemon. The daemon resolves `cookbook` to a plugin binary, spawns it
/// with the existing stdout-JSONL contract, pipes `payload` to its stdin
/// as a `CookbookPayload`, and returns the parsed result.
///
/// `payload` is the resolved cookbook configuration (caller is responsible
/// for running the project-layer config walker; the daemon has no cwd).
///
/// `call_chain` carries the names of cookbooks already invoked in the
/// current spawn tree for cycle detection. The SDK client helper forwards
/// `$ENWIRO_RPC_CALL_CHAIN` automatically.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CookbookInvokeParams {
    pub cookbook: String,
    pub op: String,
    #[serde(default)]
    pub args: Vec<String>,
    #[serde(default)]
    pub payload: serde_json::Value,
    #[serde(default)]
    pub call_chain: Vec<String>,
}

/// Result shape for `cookbook.invoke`. The cookbook's stdout is returned
/// verbatim as a string; the caller parses domain-specific JSON from it.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CookbookInvokeResult {
    pub stdout: String,
}

/// Result shape for `env.current`. The daemon returns whatever it last
/// saw from the adapter's `workspace_switch` event stream; `None` fields
/// mean "no switch event observed since daemon start".
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EnvCurrentResult {
    pub env_name: Option<String>,
    pub timestamp: Option<String>,
}

/// Params for `env.mark`: set the status of an environment.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EnvMarkParams {
    pub env_name: String,
    pub status: String,
}

/// Result shape for `env.mark`.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EnvMarkResult {
    pub ok: bool,
}

/// Single source of truth for the client↔daemon RPC surface.
#[jsonrpsee::proc_macros::rpc(server, client)]
pub trait EnwiroRpc {
    #[method(name = "cookbook.invoke")]
    async fn cookbook_invoke(
        &self,
        params: CookbookInvokeParams,
    ) -> Result<CookbookInvokeResult, jsonrpsee::types::ErrorObjectOwned>;

    #[method(name = "env.current")]
    async fn env_current(&self) -> Result<EnvCurrentResult, jsonrpsee::types::ErrorObjectOwned>;

    #[method(name = "env.mark")]
    async fn env_mark(
        &self,
        params: EnvMarkParams,
    ) -> Result<EnvMarkResult, jsonrpsee::types::ErrorObjectOwned>;
}

pub mod client;
pub use client::{connect, connect_at};