feat: always log json parameters to debug folder (#433)

* chore: always log json parameters to debug folder

* Update backends/pixi-build-ros/src/pixi_build_ros/config.py

Co-authored-by: nichmor <[email protected]>

* Fix some comments

* Save to the correct work directory

* Change directory back

* Fix test

---------

Co-authored-by: nichmor <[email protected]>

Author: remimimimimi

Cargo.lock

@@ -1,5 +1,6 @@
 import os
 import re
+import warnings
 from pathlib import Path
 from typing import Any
 
@@ -192,6 +193,18 @@ def _parse_debug_dir(cls, value: Any, info: pydantic.ValidationInfo) -> Path | N
             base_path = Path(info.context["manifest_root"])
         return _parse_str_as_abs_path(value, base_path)
 
+    @pydantic.model_validator(mode="after")
+    def _warn_deprecated_debug_dir(self) -> "ROSBackendConfig":
+        """Warn when the deprecated debug_dir setting is used."""
+        if self.debug_dir:
+            warnings.warn(
+                "`debug-dir` backend configuration is deprecated and ignored, it will be removed later. "
+                "Debug data is now written to the build work directory.",
+                UserWarning,
+                stacklevel=2,
+            )
+        return self
+
     @pydantic.field_validator("extra_package_mappings", mode="before")
     @classmethod
     def _parse_package_mappings(

backends/pixi-build-ros/src/pixi_build_ros/config.py

@@ -160,14 +160,6 @@ def generate_recipe(
             env=script_env,
         )
 
-        if backend_config.debug_dir:
-            recipe = generated_recipe.recipe.to_yaml()
-            package = generated_recipe.recipe.package
-            debug_file_path = backend_config.debug_dir / f"{package.name.get_concrete()}-{package.version}-recipe.yaml"
-            debug_file_path.parent.mkdir(parents=True, exist_ok=True)
-            with open(debug_file_path, "w") as debug_file:
-                debug_file.write(recipe)
-
         # Test the build script before running to early out.
         # TODO: returned script.content list is not a list of strings, a container for that
         # so it cant be compared directly with the list yet

backends/pixi-build-ros/src/pixi_build_ros/ros_generator.py

@@ -0,0 +1 @@
+pub const DEBUG_OUTPUT_DIR: &str = "debug";

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

@@ -34,9 +34,11 @@ use rattler_build::{
 use rattler_conda_types::{Platform, compression_level::CompressionLevel, package::ArchiveType};
 
 use serde::Deserialize;
+use tracing::warn;
 
 use crate::{
     TargetSelector,
+    consts::DEBUG_OUTPUT_DIR,
     dependencies::{
         convert_binary_dependencies, convert_dependencies, convert_input_variant_configuration,
     },
@@ -129,6 +131,13 @@ impl<T: GenerateRecipe> IntermediateBackend<T> {
             .into_diagnostic()
             .context("failed to parse configuration")?;
 
+        if let Some(path) = config.debug_dir() {
+            warn!(
+                path = %path.display(),
+                "`debug-dir` backend configuration is deprecated and ignored; debug data is now written to the build work directory."
+            );
+        }
+
         let target_config = target_config
             .into_iter()
             .map(|(target, config)| {
@@ -160,12 +169,6 @@ where
     T: GenerateRecipe + Clone + Send + Sync + 'static,
     T::Config: Send + Sync + 'static,
 {
-    fn debug_dir(configuration: Option<serde_json::Value>) -> Option<PathBuf> {
-        configuration
-            .and_then(|config| serde_json::from_value::<T::Config>(config).ok())
-            .and_then(|config| config.debug_dir().map(|d| d.to_path_buf()))
-    }
-
     async fn initialize(
         &self,
         params: InitializeParams,
@@ -217,10 +220,6 @@ where
     T: GenerateRecipe + Clone + Send + Sync + 'static,
     T::Config: BackendConfig + Send + Sync + 'static,
 {
-    fn debug_dir(&self) -> Option<&Path> {
-        self.config.debug_dir()
-    }
-
     async fn conda_outputs(
         &self,
         params: CondaOutputsParams,
@@ -369,18 +368,18 @@ where
             );
 
             // Save intermediate recipe and the used variant
-            // in the work dir by hash of the variant
-            // and entire variants.yaml at the root of work_dir
-            let work_dir = &directories.work_dir;
+            // in the debug dir by hash of the variant
+            // and entire variants.yaml at the root of debug_dir
+            let debug_dir = &directories.build_dir.join("debug");
 
-            let recipe_path = work_dir.join("recipe.yaml");
-            let variants_path = work_dir.join("variants.yaml");
+            let recipe_path = debug_dir.join("recipe.yaml");
+            let variants_path = debug_dir.join("variants.yaml");
 
-            let package_work_dir = work_dir.join("recipe").join(&hash.hash);
-            let package_recipe_path = package_work_dir.join("recipe.yaml");
-            let package_variant_path = package_work_dir.join("variants.yaml");
+            let package_debug_dir = debug_dir.join("recipe").join(&hash.hash);
+            let package_recipe_path = package_debug_dir.join("recipe.yaml");
+            let package_variant_path = package_debug_dir.join("variants.yaml");
 
-            tokio_fs::create_dir_all(&package_work_dir)
+            tokio_fs::create_dir_all(&package_debug_dir)
                 .await
                 .into_diagnostic()?;
 
@@ -398,7 +397,7 @@ where
                 .await
                 .into_diagnostic()?;
 
-            // write the entire variants.yaml at the root of work_dir
+            // write the entire variants.yaml at the root of debug_dir
             if !variants_saved {
                 let variants = serde_yaml::to_string(&variant_config)
                     .into_diagnostic()
@@ -619,21 +618,18 @@ where
         );
 
         // Save intermediate recipe and the used variant
-        // in the work dir by hash of the variant
+        // in the debug dir by hash of the variant
         let variant = discovered_output.used_vars;
 
         // Save intermediate recipe and the used variant
-        // in the work dir by hash of the variant
-        // and entire variants.yaml at the root of work_dir
-        let work_dir = &directories.work_dir;
+        // in the debug dir by hash of the variant
+        // and entire variants.yaml at the root of debug_dir
+        let debug_dir = &directories.build_dir.join(DEBUG_OUTPUT_DIR);
 
-        let recipe_path = work_dir.join("recipe.yaml");
-        let variants_path = work_dir.join("variants.yaml");
+        let recipe_path = debug_dir.join("recipe.yaml");
+        let variants_path = debug_dir.join("variants.yaml");
 
-        let package_dir = directories
-            .work_dir
-            .join("recipe")
-            .join(&discovered_output.hash.hash);
+        let package_dir = debug_dir.join("recipe").join(&discovered_output.hash.hash);
 
         let package_recipe_path = package_dir.join("recipe.yaml");
         let package_variant_path = package_dir.join("variants.yaml");
@@ -656,7 +652,7 @@ where
             .await
             .into_diagnostic()?;
 
-        // write the entire variants.yaml at the root of work_dir
+        // write the entire variants.yaml at the root of debug_dir
         let variants = serde_yaml::to_string(&variant_config)
             .into_diagnostic()
             .context("failed to serialize variant config to YAML")?;

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

@@ -17,6 +17,8 @@ pub mod traits;
 pub mod utils;
 pub mod variants;
 
+pub mod consts;
+
 pub use traits::{PackageSourceSpec, PackageSpec, ProjectModel, TargetSelector, Targets};
 
 pub use cli::main_ext as cli_main;

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

@@ -1,5 +1,3 @@
-use std::path::{Path, PathBuf};
-
 use pixi_build_types::procedures::conda_build_v1::{CondaBuildV1Params, CondaBuildV1Result};
 use pixi_build_types::procedures::conda_outputs::{CondaOutputsParams, CondaOutputsResult};
 use pixi_build_types::procedures::{
@@ -11,10 +9,6 @@ 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(
@@ -34,10 +28,6 @@ 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 outputs for a Conda package.
     async fn conda_outputs(
         &self,