diff --git a/crates/pixi_api/src/context.rs b/crates/pixi_api/src/context.rs index 10f76c72aa..750cedb27e 100644 --- a/crates/pixi_api/src/context.rs +++ b/crates/pixi_api/src/context.rs @@ -22,7 +22,7 @@ use crate::workspace::{ AddError, ChannelError, ChannelOptions, DependencyOptions, EditActivationError, EnvironmentError, InitError, InitOptions, Package, PlatformError, PreviewFlagsError, ReinstallOptions, RemoveError, RemoveFeatureError, RunOptions, SetDescriptionError, - SetNameError, ShellError, ShellOptions, + SetNameError, ShellError, ShellOptions, TaskError, }; pub struct DefaultContext { @@ -569,9 +569,11 @@ impl WorkspaceContext { pub async fn list_tasks( &self, environment: Option, - ) -> miette::Result)>> - { - crate::workspace::task::list_tasks(&self.workspace, environment).await + ) -> Result< + HashMap)>, + TaskError, + > { + crate::workspace::task::list_tasks(&self.interface, &self.workspace, environment).await } pub async fn add_task( @@ -580,7 +582,7 @@ impl WorkspaceContext { task: Task, feature: FeatureName, platform: Option, - ) -> miette::Result<()> { + ) -> Result<(), TaskError> { crate::workspace::task::add_task( &self.interface, self.workspace_mut()?, @@ -598,7 +600,7 @@ impl WorkspaceContext { task: Task, feature: FeatureName, platform: Option, - ) -> miette::Result<()> { + ) -> Result<(), TaskError> { crate::workspace::task::alias_task( &self.interface, self.workspace_mut()?, @@ -615,7 +617,7 @@ impl WorkspaceContext { names: Vec, platform: Option, feature: FeatureName, - ) -> miette::Result<()> { + ) -> Result<(), TaskError> { crate::workspace::task::remove_tasks( &self.interface, self.workspace_mut()?, diff --git a/crates/pixi_api/src/workspace/mod.rs b/crates/pixi_api/src/workspace/mod.rs index a380f0895e..95d84ce9a3 100644 --- a/crates/pixi_api/src/workspace/mod.rs +++ b/crates/pixi_api/src/workspace/mod.rs @@ -26,6 +26,7 @@ pub(crate) mod shell; pub use shell::{ShellError, ShellOptions}; pub(crate) mod task; +pub use task::TaskError; #[allow(clippy::module_inception)] pub(crate) mod workspace; diff --git a/crates/pixi_api/src/workspace/task/mod.rs b/crates/pixi_api/src/workspace/task/mod.rs index d98b071817..b0b0e26e10 100644 --- a/crates/pixi_api/src/workspace/task/mod.rs +++ b/crates/pixi_api/src/workspace/task/mod.rs @@ -1,21 +1,55 @@ -use std::collections::{HashMap, HashSet}; +use std::{ + collections::{HashMap, HashSet}, + error::Error, +}; use fancy_display::FancyDisplay; -use miette::IntoDiagnostic; +use miette::Diagnostic; use pixi_core::{ Workspace, workspace::{ - Environment, WorkspaceMut, + Environment, EnvironmentFromNameError, WorkspaceMut, virtual_packages::{EnvironmentRunnability, classify_environment_runnability}, }, }; use pixi_manifest::{ - EnvironmentName, FeatureName, HasWorkspaceManifest, PixiPlatform, PixiPlatformName, Task, - TaskName, + EnvironmentName, FeatureName, GetFeatureError, HasWorkspaceManifest, LoadManifestsError, + PixiPlatform, PixiPlatformName, PlatformEditError, Task, TaskEditError, TaskName, }; +use thiserror::Error; use crate::interface::Interface; -use crate::workspace::platforms::resolve_platforms; +use crate::workspace::{ + platforms::resolve_platforms, + workspace::{SaveManifestError, save}, +}; + +#[derive(Debug, Error, Diagnostic)] +pub enum TaskError { + #[error(transparent)] + #[diagnostic(transparent)] + LoadWorkspace(#[from] LoadManifestsError), + + #[error(transparent)] + #[diagnostic(transparent)] + EnvironmentFromName(#[from] EnvironmentFromNameError), + + #[error(transparent)] + #[diagnostic(transparent)] + Platform(#[from] PlatformEditError), + + #[error(transparent)] + #[diagnostic(transparent)] + Edit(#[from] TaskEditError), + + #[error(transparent)] + #[diagnostic(transparent)] + Feature(#[from] GetFeatureError), + + #[error(transparent)] + #[diagnostic(transparent)] + Save(#[from] SaveManifestError), +} /// Resolve `name` the same way the dependency CLI does: look it up in the /// workspace; if it's not declared, accept it as a bare conda subdir and @@ -27,7 +61,7 @@ use crate::workspace::platforms::resolve_platforms; fn resolve_task_platform( workspace: &Workspace, name: Option<&PixiPlatformName>, -) -> miette::Result> { +) -> Result, PlatformEditError> { let Some(name) = name else { return Ok(None) }; let workspace_platforms = workspace.workspace_manifest().workspace.platforms.clone(); Ok( @@ -47,7 +81,7 @@ fn declare_platform_and_add_task( task: &Task, feature: &FeatureName, platform: Option<&PixiPlatformName>, -) -> miette::Result<()> { +) -> Result<(), TaskError> { let pixi_platform = resolve_task_platform(workspace.workspace(), platform)?; // The auto-declare is idempotent on already-declared entries. if let Some(p) = &pixi_platform { @@ -61,23 +95,35 @@ fn declare_platform_and_add_task( Ok(()) } -pub async fn list_tasks( +pub async fn list_tasks( + interface: &I, workspace: &Workspace, environment: Option, -) -> miette::Result)>> { +) -> Result)>, TaskError> +{ let explicit_environment = environment .map(|n| { workspace .environment(&n) - .ok_or_else(|| miette::miette!("unknown environment '{n}'")) + .ok_or(EnvironmentFromNameError::Unknown(n)) }) .transpose()?; - let lock_file = workspace - .load_lock_file() - .await - .ok() - .map(|r| r.into_lock_file_or_empty_with_warning()); + // The lock file only refines the runnability of environments the machine + // doesn't declare, so a broken one shouldn't stop the listing. + let lock_file = match workspace.load_lock_file().await { + Ok(result) => Some(result.into_lock_file_or_empty_with_warning()), + Err(err) => { + let mut message = err.to_string(); + let mut source = err.source(); + while let Some(cause) = source { + message.push_str(&format!(": {cause}")); + source = cause.source(); + } + interface.warning(&message).await; + None + } + }; let env_task_map: HashMap)> = if let Some(explicit_environment) = explicit_environment { @@ -123,9 +169,9 @@ pub async fn add_task( task: Task, feature: FeatureName, platform: Option, -) -> miette::Result<()> { +) -> Result<(), TaskError> { declare_platform_and_add_task(&mut workspace, &name, &task, &feature, platform.as_ref())?; - workspace.save().await.into_diagnostic()?; + save(workspace).await?; interface .success(&format!( @@ -145,9 +191,9 @@ pub async fn alias_task( task: Task, feature: FeatureName, platform: Option, -) -> miette::Result<()> { +) -> Result<(), TaskError> { declare_platform_and_add_task(&mut workspace, &name, &task, &feature, platform.as_ref())?; - workspace.save().await.into_diagnostic()?; + save(workspace).await?; interface .success(&format!( @@ -166,7 +212,7 @@ pub async fn remove_tasks( names: Vec, platform: Option, feature: FeatureName, -) -> miette::Result<()> { +) -> Result<(), TaskError> { let mut to_remove = Vec::new(); // No auto-declare on removal: if the name doesn't match a declared @@ -223,7 +269,7 @@ pub async fn remove_tasks( removed.push(name); } - workspace.save().await.into_diagnostic()?; + save(workspace).await?; for name in removed { interface diff --git a/crates/pixi_cli/src/task.rs b/crates/pixi_cli/src/task.rs index acd3cf5308..2e7fea0215 100644 --- a/crates/pixi_cli/src/task.rs +++ b/crates/pixi_cli/src/task.rs @@ -494,7 +494,9 @@ async fn remove_tasks( workspace_ctx .remove_task(args.names, args.platform, feature) - .await + .await?; + + Ok(()) } fn print_tasks_json(project: &Workspace) -> miette::Result<()> { diff --git a/crates/pixi_manifest/src/manifests/workspace.rs b/crates/pixi_manifest/src/manifests/workspace.rs index 341430d0d6..ca55de63b2 100644 --- a/crates/pixi_manifest/src/manifests/workspace.rs +++ b/crates/pixi_manifest/src/manifests/workspace.rs @@ -2187,10 +2187,10 @@ pub struct FeatureNotFoundError(pub FeatureName); /// [`WorkspaceManifestMut::remove_task`]. #[derive(Debug, thiserror::Error, miette::Diagnostic)] pub enum TaskEditError { - #[error("task {0} already exists")] + #[error("task '{0}' already exists")] AlreadyExists(TaskName), - #[error("task {0} does not exist")] + #[error("task '{0}' does not exist")] NotFound(TaskName), #[error("the environment '{0}' does not exist")] @@ -7321,7 +7321,7 @@ platforms = [ ) .unwrap_err(); assert_matches::assert_matches!(&err, TaskEditError::AlreadyExists(name) if *name == hello); - assert_eq!(err.to_string(), "task hello already exists"); + assert_eq!(err.to_string(), "task 'hello' already exists"); let err = manifest .remove_task(TaskName::from("nope"), None, &FeatureName::Default) .unwrap_err(); diff --git a/scripts/into_diagnostic_baseline.toml b/scripts/into_diagnostic_baseline.toml index 187510702d..55bce41ee9 100644 --- a/scripts/into_diagnostic_baseline.toml +++ b/scripts/into_diagnostic_baseline.toml @@ -1,5 +1,5 @@ # Generated by `scripts/check_into_diagnostic.py --update`. Crates not listed are pinned at 0. -pixi_api = 10 +pixi_api = 7 pixi_build_backend = 40 pixi_build_cmake = 1 pixi_build_mojo = 2