running-process 4.2.0__tar.gz → 4.3.0__tar.gz

{running_process-4.2.0 → running_process-4.3.0}/Cargo.lock

@@ -1085,7 +1085,7 @@ checksum = "dc897dd8d9e8bd1ed8cdad82b5966c3e0ecae09fb1907d58efaa013543185d0a"
 
 [[package]]
 name = "running-process"
-version = "4.2.0"
+version = "4.3.0"
 dependencies = [
  "anyhow",
  "blake3",
@@ -1120,7 +1120,7 @@ dependencies = [
 
 [[package]]
 name = "running-process-py"
-version = "4.2.0"
+version = "4.3.0"
 dependencies = [
  "interprocess",
  "libc",

{running_process-4.2.0 → running_process-4.3.0}/Cargo.toml

@@ -3,7 +3,7 @@ resolver = "2"
 members = ["crates/running-process", "crates/running-process-py", "crates/test-watchdog"]
 
 [workspace.package]
-version = "4.2.0"
+version = "4.3.0"
 edition = "2021"
 rust-version = "1.85"
 license = "BSD-3-Clause"

{running_process-4.2.0 → running_process-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: running_process
-Version: 4.2.0
+Version: 4.3.0
 License-File: LICENSE
 Summary: A Rust-backed subprocess wrapper with split stdout/stderr streaming
 Home-Page: https://github.com/zackees/running-process

{running_process-4.2.0 → running_process-4.3.0}/crates/running-process/Cargo.toml

@@ -91,6 +91,11 @@ daemon = [
     "dep:rusqlite", "dep:toml",
 ]
 originator-scan = []               # used by running-process-py for cwd-tagging
+# #433 R4: opt-in test seam. Gates the `RUNNING_PROCESS_FAKE_BACKEND` backdoor
+# inside `connect_to_backend`. OFF by default and never listed by production
+# consumers, so the backdoor is physically absent from every shipped build.
+# Enabled only by the crate's own test pass (see `ci/test.py`).
+test-seams = ["client"]
 # #415: consumer-consumable conformance test kit
 # (`crate::test_support::conformance`). Off by default; consumers opt in
 # from their `dev-dependencies`.

{running_process-4.2.0 → running_process-4.3.0}/crates/running-process/src/bin/daemon.rs

@@ -140,6 +140,32 @@ fn parse_duration_secs(value: &str) -> Result<u64, String> {
     Ok(n.saturating_mul(unit_secs))
 }
 
+/// Set the visible process/thread name for the running daemon (#222).
+///
+/// The daemon binary is still `running-process-daemon` (renaming it is out
+/// of Phase 2 scope), but the *visible long-running identity* must be
+/// `runpm-daemon`. On Linux `prctl(PR_SET_NAME)` renames the main thread,
+/// which is what `ps`, `top`, and `/proc/<pid>/comm` report. On other
+/// platforms this is currently a no-op; full argv0 rewriting there is
+/// tracked as follow-up work.
+fn set_daemon_process_name(name: &str) {
+    #[cfg(target_os = "linux")]
+    {
+        // PR_SET_NAME truncates to 15 bytes + NUL; "runpm-daemon" fits.
+        if let Ok(cstr) = std::ffi::CString::new(name) {
+            // SAFETY: prctl with PR_SET_NAME and a valid NUL-terminated
+            // pointer only writes the calling thread's name.
+            unsafe {
+                libc::prctl(libc::PR_SET_NAME, cstr.as_ptr() as libc::c_ulong, 0, 0, 0);
+            }
+        }
+    }
+    #[cfg(not(target_os = "linux"))]
+    {
+        let _ = name;
+    }
+}
+
 /// Initialize structured logging via `tracing-subscriber`.
 ///
 /// Logs go to stderr (standard daemon practice).  The level is controlled by
@@ -165,6 +191,11 @@ fn main() {
             socket_path,
             db_path,
         } => {
+            // #222: the long-running supervisor identity is `runpm-daemon`,
+            // not the launcher binary name. Rename the process so it shows
+            // up that way in `ps`/`top` without renaming the binary (which
+            // would churn paths, spawn, and packaging across phases).
+            set_daemon_process_name("runpm-daemon");
             init_logging();
             // #391: warn at startup when a systemd KillMode would reap
             // spawned children on unit stop. Silent when not under systemd.

{running_process-4.2.0 → running_process-4.3.0}/crates/running-process/src/bin/runpm.rs

@@ -10,7 +10,7 @@ use clap::{Parser, Subcommand};
 
 use running_process::client::{connect_or_start, ClientError, DaemonClient};
 use running_process::maintenance::run_release_handles;
-use running_process::proto::daemon::{DaemonResponse, ServiceConfig, StatusCode};
+use running_process::proto::daemon::{DaemonResponse, ServiceConfig, ServiceState, StatusCode};
 
 #[derive(Parser)]
 #[command(
@@ -70,7 +70,11 @@ enum Commands {
     },
     /// List all supervised services
     #[command(alias = "ls", alias = "status")]
-    List,
+    List {
+        /// Emit JSON instead of a human-readable table
+        #[arg(long)]
+        json: bool,
+    },
     /// Show details about a single service
     #[command(alias = "describe")]
     Show {
@@ -160,7 +164,7 @@ fn main() -> ExitCode {
         Commands::Delete { target } => {
             cmd_simple_target("delete", &target, |c, t| c.service_delete(t))
         }
-        Commands::List => cmd_list(),
+        Commands::List { json } => cmd_list(json),
         Commands::Show { target } => cmd_show(&target),
         Commands::Logs {
             target,
@@ -267,19 +271,38 @@ fn cmd_start(
 
     let mut client = connect()?;
     let resp = client.service_start(config).map_err(client_err)?;
-    print_status("start", &resp)
+    ensure_ok("start", &resp)?;
+    if let Some(svc) = resp.service_start.and_then(|r| r.service) {
+        println!(
+            "started '{}' (id={}, pid={}, status={})",
+            svc.name, svc.id, svc.pid, svc.status
+        );
+    }
+    Ok(())
 }
 
-fn cmd_list() -> Result<()> {
+fn cmd_list(json: bool) -> Result<()> {
     let mut client = connect()?;
     let resp = client.service_list().map_err(client_err)?;
-    print_status("list", &resp)
+    ensure_ok("list", &resp)?;
+    let services = resp.service_list.map(|r| r.services).unwrap_or_default();
+    if json {
+        print_services_json(&services);
+    } else {
+        print_services_table(&services);
+    }
+    Ok(())
 }
 
 fn cmd_show(target: &str) -> Result<()> {
     let mut client = connect()?;
     let resp = client.service_describe(target).map_err(client_err)?;
-    print_status("show", &resp)
+    ensure_ok("show", &resp)?;
+    match resp.service_describe.and_then(|r| r.service) {
+        Some(svc) => print_service_detail(&svc),
+        None => println!("no such service: {target}"),
+    }
+    Ok(())
 }
 
 fn cmd_logs(target: &str, lines: u32, follow: bool) -> Result<()> {
@@ -301,7 +324,18 @@ where
 {
     let mut client = connect()?;
     let resp = call(&mut client, target).map_err(client_err)?;
-    print_status(label, &resp)
+    ensure_ok(label, &resp)?;
+    let count = match label {
+        "stop" => resp.service_stop.as_ref().map(|r| r.stopped_count),
+        "restart" => resp.service_restart.as_ref().map(|r| r.restarted_count),
+        "delete" => resp.service_delete.as_ref().map(|r| r.deleted_count),
+        _ => None,
+    };
+    match count {
+        Some(n) => println!("{label}: {n} service(s)"),
+        None => println!("OK: {label}"),
+    }
+    Ok(())
 }
 
 fn cmd_no_arg<F>(label: &str, call: F) -> Result<()>
@@ -353,8 +387,14 @@ fn client_err(err: ClientError) -> anyhow::Error {
 }
 
 fn print_status(label: &str, resp: &DaemonResponse) -> Result<()> {
+    ensure_ok(label, resp)?;
+    println!("OK: {label}");
+    Ok(())
+}
+
+/// Return an error if the daemon responded with a non-OK status code.
+fn ensure_ok(label: &str, resp: &DaemonResponse) -> Result<()> {
     if resp.code == StatusCode::Ok as i32 {
-        println!("OK: {label}");
         Ok(())
     } else {
         Err(anyhow!(
@@ -368,6 +408,75 @@ fn print_status(label: &str, resp: &DaemonResponse) -> Result<()> {
     }
 }
 
+// ---------------------------------------------------------------------------
+// Service rendering
+// ---------------------------------------------------------------------------
+
+fn print_services_table(services: &[ServiceState]) {
+    if services.is_empty() {
+        println!("no services");
+        return;
+    }
+    println!(
+        "{:<4} {:<20} {:<10} {:<8} {:<8} COMMAND",
+        "ID", "NAME", "STATUS", "PID", "RESTARTS"
+    );
+    for s in services {
+        let command = s
+            .config
+            .as_ref()
+            .map(|c| c.cmd.join(" "))
+            .unwrap_or_default();
+        println!(
+            "{:<4} {:<20} {:<10} {:<8} {:<8} {}",
+            s.id, s.name, s.status, s.pid, s.restart_count, command
+        );
+    }
+}
+
+fn print_service_detail(s: &ServiceState) {
+    println!("name:          {}", s.name);
+    println!("id:            {}", s.id);
+    println!("status:        {}", s.status);
+    println!("pid:           {}", s.pid);
+    println!("restart_count: {}", s.restart_count);
+    println!("last_exit:     {}", s.last_exit_code);
+    if let Some(c) = &s.config {
+        println!("command:       {}", c.cmd.join(" "));
+        if !c.cwd.is_empty() {
+            println!("cwd:           {}", c.cwd);
+        }
+        println!("autorestart:   {}", c.autorestart);
+        println!("max_restarts:  {}", c.max_restarts);
+    }
+}
+
+fn print_services_json(services: &[ServiceState]) {
+    let values: Vec<serde_json::Value> = services
+        .iter()
+        .map(|s| {
+            serde_json::json!({
+                "id": s.id,
+                "name": s.name,
+                "status": s.status,
+                "pid": s.pid,
+                "restart_count": s.restart_count,
+                "last_started_at": s.last_started_at,
+                "last_exited_at": s.last_exited_at,
+                "last_exit_code": s.last_exit_code,
+                "command": s.config.as_ref().map(|c| c.cmd.clone()).unwrap_or_default(),
+                "cwd": s.config.as_ref().map(|c| c.cwd.clone()).unwrap_or_default(),
+                "autorestart": s.config.as_ref().map(|c| c.autorestart).unwrap_or(false),
+                "max_restarts": s.config.as_ref().map(|c| c.max_restarts).unwrap_or(0),
+            })
+        })
+        .collect();
+    match serde_json::to_string_pretty(&values) {
+        Ok(s) => println!("{s}"),
+        Err(e) => eprintln!("failed to serialize JSON: {e}"),
+    }
+}
+
 fn parse_env(args: &[String]) -> Result<HashMap<String, String>> {
     let mut out = HashMap::new();
     for entry in args {

running_process-4.3.0/crates/running-process/src/broker/adopt.rs

@@ -0,0 +1,273 @@
+//! One-call broker adoption: negotiate → dial → ready-to-talk client (#433 R1).
+//!
+//! [`connect_to_backend`] returns a raw
+//! [`BackendConnection`] — a bare
+//! socket the consumer must still wrap in a [`FrameClient`] before it can send
+//! a single request. Every consumer (zccache, soldr, clud, fbuild) repeats the
+//! same three lines: check the disable env, call `connect_to_backend`, wrap the
+//! stream. [`BrokerSession::adopt`] is that recipe, owned once here so the
+//! contract is a single call:
+//!
+//! ```no_run
+//! use running_process::broker::adopt::BrokerSession;
+//! use running_process::broker::client::ConnectBackendRequest;
+//!
+//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
+//! let request = ConnectBackendRequest::new("broker.sock", "zccache", "1.11.20", "1.11.20");
+//! let mut session = BrokerSession::adopt(request)?;
+//! let reply = session.request(0x7A63, b"ping".to_vec())?;
+//! assert_eq!(reply.payload, b"pong");
+//! # Ok(()) }
+//! ```
+//!
+//! The blocking [`BrokerSession`] is the wire-of-record; the async
+//! [`AsyncBrokerSession`] (feature `client-async`, #433 R3) is a thin
+//! `spawn_blocking` wrapper so tokio daemons get the same one-call adoption
+//! without re-implementing the negotiation against `AsyncRead`/`AsyncWrite`.
+
+use crate::broker::backend_sdk::{FrameClient, FrameClientError};
+use crate::broker::client::{
+    broker_disabled_by_env, connect_to_backend, BackendConnection, BackendConnectionRoute,
+    BrokerClientError, BrokerDisableEnvError, ConnectBackendRequest,
+};
+use crate::broker::protocol::{Frame, Negotiated};
+
+/// A negotiated, dialed, and framed broker backend connection.
+///
+/// Produced by [`BrokerSession::adopt`]. Wraps the
+/// [`BackendConnection`] stream in a
+/// [`FrameClient`] so the caller can issue correlated request/response frames
+/// immediately, while still exposing how the connection was reached
+/// ([`route`](Self::route)), the cacheable [`endpoint`](Self::endpoint), and the
+/// broker's [`negotiated`](Self::negotiated) metadata.
+pub struct BrokerSession {
+    client: FrameClient,
+    route: BackendConnectionRoute,
+    endpoint: String,
+    negotiated: Option<Negotiated>,
+}
+
+impl BrokerSession {
+    /// Negotiate through the broker and return a ready-to-talk session.
+    ///
+    /// Honours the canonical escape hatch first: if
+    /// `RUNNING_PROCESS_DISABLE=1` is set, this returns
+    /// [`AdoptError::BrokerDisabled`] so the consumer falls back to its direct
+    /// path instead of silently dialing the broker. An invalid disable value
+    /// surfaces as [`AdoptError::DisableEnv`].
+    pub fn adopt(request: ConnectBackendRequest<'_>) -> Result<Self, AdoptError> {
+        if broker_disabled_by_env()? {
+            return Err(AdoptError::BrokerDisabled);
+        }
+        Ok(Self::from_connection(connect_to_backend(request)?))
+    }
+
+    fn from_connection(connection: BackendConnection) -> Self {
+        Self {
+            client: FrameClient::from_stream(connection.stream),
+            route: connection.route,
+            endpoint: connection.endpoint,
+            negotiated: connection.negotiated,
+        }
+    }
+
+    /// How the backend connection was reached.
+    pub fn route(&self) -> BackendConnectionRoute {
+        self.route
+    }
+
+    /// Negotiated backend endpoint, suitable as a Hello-skip cache key.
+    pub fn endpoint(&self) -> &str {
+        &self.endpoint
+    }
+
+    /// Broker negotiation metadata, present when the broker path was used.
+    pub fn negotiated(&self) -> Option<&Negotiated> {
+        self.negotiated.as_ref()
+    }
+
+    /// Send one correlated request and await its response frame.
+    pub fn request(
+        &mut self,
+        payload_protocol: u32,
+        payload: Vec<u8>,
+    ) -> Result<Frame, FrameClientError> {
+        self.client.request(payload_protocol, payload)
+    }
+
+    /// Borrow the underlying frame client for advanced use.
+    pub fn client_mut(&mut self) -> &mut FrameClient {
+        &mut self.client
+    }
+
+    /// Consume the session and return the owned frame client.
+    pub fn into_client(self) -> FrameClient {
+        self.client
+    }
+}
+
+/// Errors from [`BrokerSession::adopt`] / [`AsyncBrokerSession::adopt`].
+#[derive(Debug, thiserror::Error)]
+pub enum AdoptError {
+    /// `RUNNING_PROCESS_DISABLE=1` is set — the caller should use its direct
+    /// (non-broker) path. Not a failure of the broker itself.
+    #[error("broker disabled via RUNNING_PROCESS_DISABLE=1; use the direct path")]
+    BrokerDisabled,
+    /// The disable env var held an invalid value.
+    #[error(transparent)]
+    DisableEnv(#[from] BrokerDisableEnvError),
+    /// Broker negotiation or backend dial failed. Use
+    /// [`BrokerClientError::refusal_kind`] to branch on broker refusals.
+    #[error(transparent)]
+    Connect(#[from] BrokerClientError),
+    /// The async adoption worker thread failed to join (panicked or was
+    /// cancelled). Only reachable on the `client-async` path.
+    #[cfg(feature = "client-async")]
+    #[error("async adopt worker failed to join: {0}")]
+    AsyncJoin(String),
+}
+
+/// Owned inputs for [`AsyncBrokerSession::adopt`] (#433 R3).
+///
+/// The blocking [`ConnectBackendRequest`] borrows `&str`, which cannot cross a
+/// `spawn_blocking` boundary. This owned mirror carries the same fields by
+/// value; [`AsyncBrokerSession::adopt`] reconstructs a borrowed
+/// [`ConnectBackendRequest`] from it inside the worker thread.
+#[cfg(feature = "client-async")]
+#[derive(Clone, Debug)]
+pub struct OwnedConnectRequest {
+    /// Broker pipe/socket endpoint.
+    pub broker_endpoint: String,
+    /// Logical service name, such as `zccache`.
+    pub service_name: String,
+    /// Backend version the caller wants.
+    pub wanted_version: String,
+    /// Version of the caller's own service binary.
+    pub self_version: String,
+    /// Previously negotiated backend endpoint, if the caller has one.
+    pub cached_backend_endpoint: Option<String>,
+    /// Informational client version.
+    pub client_version: String,
+    /// Client library name for diagnostics.
+    pub client_lib_name: String,
+    /// Client library version for diagnostics.
+    pub client_lib_version: String,
+    /// Proposed keepalive interval.
+    pub client_keepalive_secs: u64,
+    /// Opt in to adopting a handed-off backend connection.
+    pub adopt_handed_off_connection: bool,
+    /// Deadline for the handoff-ready relay when adoption is enabled.
+    pub handoff_ready_timeout: std::time::Duration,
+}
+
+#[cfg(feature = "client-async")]
+impl OwnedConnectRequest {
+    /// Build an owned request with running-process defaults.
+    pub fn new(
+        broker_endpoint: impl Into<String>,
+        service_name: impl Into<String>,
+        wanted_version: impl Into<String>,
+        self_version: impl Into<String>,
+    ) -> Self {
+        Self {
+            broker_endpoint: broker_endpoint.into(),
+            service_name: service_name.into(),
+            wanted_version: wanted_version.into(),
+            self_version: self_version.into(),
+            cached_backend_endpoint: None,
+            client_version: String::new(),
+            client_lib_name: "running-process".to_string(),
+            client_lib_version: env!("CARGO_PKG_VERSION").to_string(),
+            client_keepalive_secs: 0,
+            adopt_handed_off_connection: false,
+            handoff_ready_timeout: crate::broker::client::DEFAULT_HANDOFF_READY_TIMEOUT,
+        }
+    }
+
+    fn as_request(&self) -> ConnectBackendRequest<'_> {
+        ConnectBackendRequest {
+            broker_endpoint: &self.broker_endpoint,
+            service_name: &self.service_name,
+            wanted_version: &self.wanted_version,
+            self_version: &self.self_version,
+            cached_backend_endpoint: self.cached_backend_endpoint.as_deref(),
+            client_version: &self.client_version,
+            client_lib_name: &self.client_lib_name,
+            client_lib_version: &self.client_lib_version,
+            client_keepalive_secs: self.client_keepalive_secs,
+            adopt_handed_off_connection: self.adopt_handed_off_connection,
+            handoff_ready_timeout: self.handoff_ready_timeout,
+        }
+    }
+}
+
+/// Async counterpart of [`BrokerSession`] for tokio daemons (#433 R3).
+///
+/// Runs the blocking negotiation on `tokio::task::spawn_blocking` and wraps the
+/// resulting [`FrameClient`] in an [`AsyncFrameClient`] so every later request
+/// is `.await`-able without a manual `spawn_blocking` at the call site.
+///
+/// [`AsyncFrameClient`]: crate::broker::backend_sdk::AsyncFrameClient
+#[cfg(feature = "client-async")]
+pub struct AsyncBrokerSession {
+    client: crate::broker::backend_sdk::AsyncFrameClient,
+    route: BackendConnectionRoute,
+    endpoint: String,
+    negotiated: Option<Negotiated>,
+}
+
+#[cfg(feature = "client-async")]
+impl AsyncBrokerSession {
+    /// Negotiate through the broker on a blocking worker and return a
+    /// ready-to-talk async session.
+    pub async fn adopt(request: OwnedConnectRequest) -> Result<Self, AdoptError> {
+        let joined = tokio::task::spawn_blocking(move || {
+            BrokerSession::adopt(request.as_request()).map(|session| {
+                (
+                    session.route,
+                    session.endpoint,
+                    session.negotiated,
+                    session.client,
+                )
+            })
+        })
+        .await
+        .map_err(|err| AdoptError::AsyncJoin(err.to_string()))?;
+        let (route, endpoint, negotiated, client) = joined?;
+        Ok(Self {
+            client: crate::broker::backend_sdk::AsyncFrameClient::from_blocking(client),
+            route,
+            endpoint,
+            negotiated,
+        })
+    }
+
+    /// How the backend connection was reached.
+    pub fn route(&self) -> BackendConnectionRoute {
+        self.route
+    }
+
+    /// Negotiated backend endpoint, suitable as a Hello-skip cache key.
+    pub fn endpoint(&self) -> &str {
+        &self.endpoint
+    }
+
+    /// Broker negotiation metadata, present when the broker path was used.
+    pub fn negotiated(&self) -> Option<&Negotiated> {
+        self.negotiated.as_ref()
+    }
+
+    /// Send one correlated request and await its response frame.
+    pub async fn request(
+        &mut self,
+        payload_protocol: u32,
+        payload: Vec<u8>,
+    ) -> Result<Frame, FrameClientError> {
+        self.client.request(payload_protocol, payload).await
+    }
+
+    /// Consume the session and return the owned async frame client.
+    pub fn into_client(self) -> crate::broker::backend_sdk::AsyncFrameClient {
+        self.client
+    }
+}