feat: extend logging (#119)

Extends debug logging to the rest of the backends

Author: Hofer-Julian

crates/pixi-build-backend/src/protocol.rs

@@ -1,3 +1,5 @@
+use std::path::{Path, PathBuf};
+
 use pixi_build_types::procedures::{
     conda_build::{CondaBuildParams, CondaBuildResult},
     conda_metadata::{CondaMetadataParams, CondaMetadataResult},
@@ -9,6 +11,10 @@ use pixi_build_types::procedures::{
 /// and endpoint that can handle the RPC calls.
 #[async_trait::async_trait]
 pub trait ProtocolInstantiator: Send + Sync + 'static {
+    /// Get the debug directory
+    /// If set, internal state will be logged as files in that directory
+    fn debug_dir(configuration: Option<serde_json::Value>) -> Option<PathBuf>;
+
     /// Called when negotiating capabilities with the client.
     /// This is determine how the rest of the initialization will proceed.
     async fn negotiate_capabilities(
@@ -28,6 +34,10 @@ pub trait ProtocolInstantiator: Send + Sync + 'static {
 /// server as an endpoint for the RPC calls.
 #[async_trait::async_trait]
 pub trait Protocol {
+    /// Get the debug directory
+    /// If set, internal state will be logged as files in that directory
+    fn debug_dir(&self) -> Option<&Path>;
+
     /// Called when the client requests metadata for a Conda package.
     async fn conda_get_metadata(
         &self,

crates/pixi-build-backend/src/server.rs

@@ -1,11 +1,14 @@
-use std::{net::SocketAddr, sync::Arc};
+use std::{net::SocketAddr, path::Path, sync::Arc};
 
+use fs_err::tokio as tokio_fs;
 use jsonrpc_core::{Error, IoHandler, Params, serde_json, to_value};
-use miette::{IntoDiagnostic, JSONReportHandler};
+use miette::{Context, IntoDiagnostic, JSONReportHandler};
+use pixi_build_types::VersionedProjectModel;
 use pixi_build_types::procedures::{
     self, conda_build::CondaBuildParams, conda_metadata::CondaMetadataParams,
     initialize::InitializeParams, negotiate_capabilities::NegotiateCapabilitiesParams,
 };
+
 use tokio::sync::RwLock;
 
 use crate::protocol::{Protocol, ProtocolInstantiator};
@@ -85,6 +88,10 @@ impl<T: ProtocolInstantiator> Server<T> {
                         return Err(Error::invalid_request());
                     };
 
+                    let debug_dir = T::debug_dir(params.configuration.clone());
+                    let _ =
+                        log_initialize(debug_dir.as_deref(), params.project_model.clone()).await;
+
                     let (protocol_endpoint, result) = initializer
                         .initialize(params)
                         .await
@@ -105,8 +112,14 @@ impl<T: ProtocolInstantiator> Server<T> {
                 async move {
                     let params: CondaMetadataParams = params.parse()?;
                     let state = state.read().await;
-                    state
-                        .as_endpoint()?
+                    let endpoint = state.as_endpoint()?;
+
+                    let debug_dir = endpoint.debug_dir();
+                    log_conda_get_metadata(debug_dir, &params)
+                        .await
+                        .map_err(convert_error)?;
+
+                    endpoint
                         .conda_get_metadata(params)
                         .await
                         .map(|value| to_value(value).expect("failed to convert to json"))
@@ -124,8 +137,14 @@ impl<T: ProtocolInstantiator> Server<T> {
                 async move {
                     let params: CondaBuildParams = params.parse()?;
                     let state = state.read().await;
-                    state
-                        .as_endpoint()?
+                    let endpoint = state.as_endpoint()?;
+
+                    let debug_dir = endpoint.debug_dir();
+                    log_conda_build(debug_dir, &params)
+                        .await
+                        .map_err(convert_error)?;
+
+                    endpoint
                         .conda_build(params)
                         .await
                         .map(|value| to_value(value).expect("failed to convert to json"))
@@ -151,3 +170,78 @@ fn convert_error(err: miette::Report) -> jsonrpc_core::Error {
         data: Some(data),
     }
 }
+
+async fn log_initialize(
+    debug_dir: Option<&Path>,
+    project_model: Option<VersionedProjectModel>,
+) -> miette::Result<()> {
+    let Some(debug_dir) = debug_dir else {
+        return Ok(());
+    };
+
+    let project_model = project_model
+        .ok_or_else(|| miette::miette!("project model is required if debug_dir is given"))?
+        .into_v1()
+        .ok_or_else(|| miette::miette!("project model needs to be v1"))?;
+
+    let project_model_json = serde_json::to_string_pretty(&project_model)
+        .into_diagnostic()
+        .context("failed to serialize project model to JSON")?;
+
+    let project_model_path = debug_dir.join("project_model.json");
+    tokio_fs::write(&project_model_path, project_model_json)
+        .await
+        .into_diagnostic()
+        .context("failed to write project model JSON to file")?;
+    Ok(())
+}
+
+async fn log_conda_get_metadata(
+    debug_dir: Option<&Path>,
+    params: &CondaMetadataParams,
+) -> miette::Result<()> {
+    let Some(debug_dir) = debug_dir else {
+        return Ok(());
+    };
+
+    let json = serde_json::to_string_pretty(&params)
+        .into_diagnostic()
+        .context("failed to serialize parameters to JSON")?;
+
+    tokio_fs::create_dir_all(&debug_dir)
+        .await
+        .into_diagnostic()
+        .context("failed to create data directory")?;
+
+    let path = debug_dir.join("conda_metadata_params.json");
+    tokio_fs::write(&path, json)
+        .await
+        .into_diagnostic()
+        .context("failed to write JSON to file")?;
+    Ok(())
+}
+
+async fn log_conda_build(
+    debug_dir: Option<&Path>,
+    params: &CondaBuildParams,
+) -> miette::Result<()> {
+    let Some(debug_dir) = debug_dir else {
+        return Ok(());
+    };
+
+    let json = serde_json::to_string_pretty(&params)
+        .into_diagnostic()
+        .context("failed to serialize parameters to JSON")?;
+
+    tokio_fs::create_dir_all(&debug_dir)
+        .await
+        .into_diagnostic()
+        .context("failed to create data directory")?;
+
+    let path = debug_dir.join("conda_build_params.json");
+    tokio_fs::write(&path, json)
+        .await
+        .into_diagnostic()
+        .context("failed to write JSON to file")?;
+    Ok(())
+}

crates/pixi-build-cmake/src/config.rs

@@ -1,3 +1,5 @@
+use std::path::PathBuf;
+
 use indexmap::IndexMap;
 use serde::Deserialize;
 
@@ -10,6 +12,8 @@ pub struct CMakeBackendConfig {
     /// Environment Variables
     #[serde(default)]
     pub env: IndexMap<String, String>,
+    /// If set, internal state will be logged as files in that directory
+    pub debug_dir: Option<PathBuf>,
 }
 
 #[cfg(test)]

crates/pixi-build-cmake/src/protocol.rs

@@ -1,4 +1,8 @@
-use std::{str::FromStr, sync::Arc};
+use std::{
+    path::{Path, PathBuf},
+    str::FromStr,
+    sync::Arc,
+};
 
 use miette::{Context, IntoDiagnostic};
 use pixi_build_backend::{
@@ -60,6 +64,10 @@ impl CMakeBuildBackendInstantiator {
 }
 #[async_trait::async_trait]
 impl Protocol for CMakeBuildBackend<ProjectModelV1> {
+    fn debug_dir(&self) -> Option<&Path> {
+        self.config.debug_dir.as_deref()
+    }
+
     async fn conda_get_metadata(
         &self,
         params: CondaMetadataParams,
@@ -372,6 +380,12 @@ impl Protocol for CMakeBuildBackend<ProjectModelV1> {
 
 #[async_trait::async_trait]
 impl ProtocolInstantiator for CMakeBuildBackendInstantiator {
+    fn debug_dir(configuration: Option<serde_json::Value>) -> Option<PathBuf> {
+        configuration
+            .and_then(|config| serde_json::from_value::<CMakeBackendConfig>(config).ok())
+            .and_then(|config| config.debug_dir)
+    }
+
     async fn initialize(
         &self,
         params: InitializeParams,

crates/pixi-build-python/src/config.rs

@@ -1,6 +1,6 @@
 use indexmap::IndexMap;
 use serde::Deserialize;
-use std::convert::identity;
+use std::{convert::identity, path::PathBuf};
 
 #[derive(Debug, Default, Deserialize)]
 #[serde(rename_all = "kebab-case")]
@@ -9,10 +9,11 @@ pub struct PythonBackendConfig {
     /// to `true`.
     #[serde(default)]
     pub noarch: Option<bool>,
-
     /// Environment Variables
     #[serde(default)]
     pub env: IndexMap<String, String>,
+    /// If set, internal state will be logged as files in that directory
+    pub debug_dir: Option<PathBuf>,
 }
 
 impl PythonBackendConfig {

crates/pixi-build-python/src/protocol.rs

@@ -1,4 +1,8 @@
-use std::{str::FromStr, sync::Arc};
+use std::{
+    path::{Path, PathBuf},
+    str::FromStr,
+    sync::Arc,
+};
 
 use miette::{Context, IntoDiagnostic};
 use pixi_build_backend::{
@@ -38,6 +42,10 @@ use crate::{
 
 #[async_trait::async_trait]
 impl<P: ProjectModel + Sync> Protocol for PythonBuildBackend<P> {
+    fn debug_dir(&self) -> Option<&Path> {
+        self.config.debug_dir.as_deref()
+    }
+
     async fn conda_get_metadata(
         &self,
         params: CondaMetadataParams,
@@ -424,6 +432,12 @@ impl PythonBuildBackendInstantiator {
 
 #[async_trait::async_trait]
 impl ProtocolInstantiator for PythonBuildBackendInstantiator {
+    fn debug_dir(configuration: Option<serde_json::Value>) -> Option<PathBuf> {
+        configuration
+            .and_then(|config| serde_json::from_value::<PythonBackendConfig>(config.clone()).ok())
+            .and_then(|config| config.debug_dir)
+    }
+
     async fn initialize(
         &self,
         params: InitializeParams,

crates/pixi-build-rattler-build/src/config.rs

@@ -4,6 +4,7 @@ use std::path::PathBuf;
 #[derive(Debug, Default, Deserialize)]
 #[serde(rename_all = "kebab-case")]
 pub struct RattlerBuildBackendConfig {
+    /// If set, internal state will be logged as files in that directory
     pub debug_dir: Option<PathBuf>,
 }