fix: solve build source relative to the manifest path (#4863)

Author: nichmor

crates/pixi/tests/integration_rust/build_tests.rs

@@ -340,3 +340,94 @@ my-package = {{ path = "./my-package" }}
         "my-package",
     ));
 }
+
+/// Test that verifies [package.build] source.path is resolved relative to the
+/// package manifest directory, not the workspace root.
+///
+/// This tests the fix for out-of-tree builds where a package manifest
+/// specifies `source.path = "src"` and expects it to be resolved relative
+/// to the package manifest's parent directory.
+#[tokio::test]
+async fn test_package_build_source_relative_to_manifest() {
+    setup_tracing();
+
+    // Create a PixiControl instance with PassthroughBackend
+    let backend_override = BackendOverride::from_memory(PassthroughBackend::instantiator());
+    let pixi = PixiControl::new()
+        .unwrap()
+        .with_backend_override(backend_override);
+
+    // Create the package structure:
+    // workspace/
+    //   pixi.toml (workspace and package manifest)
+    //   src/      (source directory - should be found relative to package manifest)
+    //     pixi.toml (build source manifest)
+
+    let package_source_dir = pixi.workspace_path().join("src");
+    fs::create_dir_all(&package_source_dir).unwrap();
+
+    // Create a pixi.toml in the source directory that PassthroughBackend will read
+    let source_pixi_toml = r#"
+[package]
+name = "test-build-source"
+version = "0.1.0"
+
+[package.build]
+backend = { name = "in-memory", version = "0.1.0" }
+"#;
+    fs::write(package_source_dir.join("pixi.toml"), source_pixi_toml).unwrap();
+
+    // Create a manifest where the package has [package.build] with source.path
+    // The source.path should be resolved relative to the package manifest directory
+    let manifest_content = format!(
+        r#"
+[workspace]
+channels = []
+platforms = ["{}"]
+preview = ["pixi-build"]
+
+[package]
+name = "test-build-source"
+version = "0.1.0"
+description = "Test package for build source path resolution"
+
+[package.build]
+backend = {{ name = "in-memory", version = "0.1.0" }}
+# This should resolve to <package_manifest_dir>/src, not <workspace_root>/src
+source.path = "src"
+
+[dependencies]
+test-build-source = {{ path = "." }}
+"#,
+        Platform::current(),
+    );
+
+    // Write the manifest
+    fs::write(pixi.manifest_path(), manifest_content).unwrap();
+
+    // Actually trigger the build process to test the bug
+    // This will call build_backend_metadata which uses alternative_root
+    let result = pixi.update_lock_file().await;
+
+    // The test should succeed if the source path is resolved correctly
+    // If the bug exists (manifest_path instead of manifest_path.parent()),
+    // the build will fail because it will try to find src relative to pixi.toml (a file)
+    // instead of relative to the directory containing pixi.toml
+    assert!(
+        result.is_ok(),
+        "Lock file update should succeed when source.path is resolved correctly. Error: {:?}",
+        result.err()
+    );
+
+    let lock_file = result.unwrap();
+
+    // Verify the package was built and is in the lock file
+    assert!(
+        lock_file.contains_conda_package(
+            consts::DEFAULT_ENVIRONMENT_NAME,
+            Platform::current(),
+            "test-build-source",
+        ),
+        "Built package should be in the lock file"
+    );
+}

crates/pixi_command_dispatcher/src/build_backend_metadata/mod.rs

@@ -138,7 +138,22 @@ impl BuildBackendMetadataSpec {
         } else if let Some(build_source) = &discovered_backend.init_params.build_source {
             Some(
                 command_dispatcher
-                    .pin_and_checkout(build_source.clone())
+                    .pin_and_checkout(
+                        build_source.clone(),
+                        Some(
+                            discovered_backend
+                                .init_params
+                                .manifest_path
+                                .parent()
+                                .ok_or_else(|| {
+                                    SourceCheckoutError::ParentDir(
+                                        discovered_backend.init_params.manifest_path.clone(),
+                                    )
+                                })
+                                .map_err(BuildBackendMetadataError::SourceCheckout)
+                                .map_err(CommandDispatcherError::Failed)?,
+                        ),
+                    )
                     .await
                     .map_err_with(BuildBackendMetadataError::SourceCheckout)?,
             )

crates/pixi_command_dispatcher/src/command_dispatcher/mod.rs

@@ -565,7 +565,20 @@ impl CommandDispatcher {
     ///
     /// This function resolves the source specification to a concrete checkout
     /// by:
-    /// 1. For path sources: Resolving relative paths against the root directory
+    /// 1. For path sources: Resolving relative paths against the root directory or against an alternative root path
+    ///
+    /// i.e. in the case of an out-of-tree build.
+    /// Some examples for different inputs:
+    /// - `/foo/bar` => `/foo/bar` (absolute paths are unchanged)
+    /// - `./bar` => `<root_dir>/bar`
+    /// - `bar` => `<root_dir>/bar` (or `<alternative_root>/bar` if provided)
+    /// - `../bar` => `<alternative_root>/../bar` (normalized, validated for security)
+    /// - `~/bar` => `<home_dir>/bar`
+    ///
+    /// Usually:
+    /// * `root_dir` => workspace root directory (parent of workspace manifest)
+    /// * `alternative_root` => package root directory (parent of package manifest)
+    ///
     /// 2. For git sources: Cloning or fetching the repository and checking out
     ///    the specified reference
     /// 3. For URL sources: Downloading and extracting the archive (currently
@@ -578,6 +591,7 @@ impl CommandDispatcher {
     pub async fn pin_and_checkout(
         &self,
         source_location_spec: SourceLocationSpec,
+        alternative_root: Option<&Path>,
     ) -> Result<SourceCheckout, CommandDispatcherError<SourceCheckoutError>> {
         match source_location_spec {
             SourceLocationSpec::Url(url) => {
@@ -586,7 +600,7 @@ impl CommandDispatcher {
             SourceLocationSpec::Path(path) => {
                 let source_path = self
                     .data
-                    .resolve_typed_path(path.path.to_path())
+                    .resolve_typed_path(path.path.to_path(), alternative_root)
                     .map_err(SourceCheckoutError::from)
                     .map_err(CommandDispatcherError::Failed)?;
                 Ok(SourceCheckout {
@@ -618,7 +632,7 @@ impl CommandDispatcher {
             PinnedSourceSpec::Path(ref path) => {
                 let source_path = self
                     .data
-                    .resolve_typed_path(path.path.to_path())
+                    .resolve_typed_path(path.path.to_path(), None)
                     .map_err(SourceCheckoutError::from)
                     .map_err(CommandDispatcherError::Failed)?;
                 Ok(SourceCheckout {
@@ -653,7 +667,11 @@ impl CommandDispatcherData {
     ///
     /// This function does not check if the path exists and also does not follow
     /// symlinks.
-    fn resolve_typed_path(&self, path_spec: Utf8TypedPath) -> Result<PathBuf, InvalidPathError> {
+    fn resolve_typed_path(
+        &self,
+        path_spec: Utf8TypedPath,
+        alternative_root: Option<&Path>,
+    ) -> Result<PathBuf, InvalidPathError> {
         if path_spec.is_absolute() {
             Ok(Path::new(path_spec.as_str()).to_path_buf())
         } else if let Ok(user_path) = path_spec.strip_prefix("~/") {
@@ -663,7 +681,20 @@ impl CommandDispatcherData {
             debug_assert!(home_dir.is_absolute());
             normalize_absolute_path(&home_dir.join(Path::new(user_path.as_str())))
         } else {
-            let root_dir = self.root_dir.as_path();
+            let root_dir = match alternative_root {
+                Some(root_path) => {
+                    debug_assert!(
+                        root_path.is_absolute(),
+                        "alternative_root must be absolute, got: {root_path:?}"
+                    );
+                    debug_assert!(
+                        !root_path.is_file(),
+                        "alternative_root should be a directory, not a file: {root_path:?}"
+                    );
+                    root_path
+                }
+                None => self.root_dir.as_path(),
+            };
             let native_path = Path::new(path_spec.as_str());
             debug_assert!(root_dir.is_absolute());
             normalize_absolute_path(&root_dir.join(native_path))

crates/pixi_command_dispatcher/src/solve_pixi/source_metadata_collector.rs

@@ -171,7 +171,7 @@ impl SourceMetadataCollector {
         // will pick build_source; we only override the build pin later.
         let source = self
             .command_queue
-            .pin_and_checkout(spec.location)
+            .pin_and_checkout(spec.location, None)
             .await
             .map_err(|err| CollectSourceMetadataError::SourceCheckoutError {
                 name: name.as_source().to_string(),

crates/pixi_command_dispatcher/src/source_build/mod.rs

@@ -267,7 +267,22 @@ impl SourceBuildSpec {
             discovered_backend.init_params.build_source.clone()
         {
             let build_source_checkout = command_dispatcher
-                .pin_and_checkout(manifest_build_source)
+                .pin_and_checkout(
+                    manifest_build_source,
+                    Some(
+                        discovered_backend
+                            .init_params
+                            .manifest_path
+                            .parent()
+                            .ok_or_else(|| {
+                                SourceCheckoutError::ParentDir(
+                                    discovered_backend.init_params.manifest_path.clone(),
+                                )
+                            })
+                            .map_err(SourceBuildError::SourceCheckout)
+                            .map_err(CommandDispatcherError::Failed)?,
+                    ),
+                )
                 .await
                 .map_err_with(SourceBuildError::SourceCheckout)?;
             build_source_checkout.path

crates/pixi_command_dispatcher/src/source_checkout/mod.rs

@@ -32,6 +32,9 @@ pub enum SourceCheckoutError {
 
     #[error(transparent)]
     GitError(#[from] GitError),
+
+    #[error("the manifest path {0} should have a parent directory")]
+    ParentDir(PathBuf),
 }
 
 #[derive(Debug, Error)]

crates/pixi_global/src/project/mod.rs

@@ -1372,7 +1372,7 @@ impl Project {
     ) -> Result<PackageName, InferPackageNameError> {
         let command_dispatcher = self.command_dispatcher()?;
         let checkout = command_dispatcher
-            .pin_and_checkout(source_spec.location)
+            .pin_and_checkout(source_spec.location, None)
             .await
             .map_err(|e| InferPackageNameError::BuildBackendMetadata(Box::new(e)))?;