refactor: Move diff into a separate pixi_diff crate (#4697)

Author: haecker-felix

Cargo.lock

@@ -187,6 +187,7 @@ pixi_config = { path = "crates/pixi_config" }
 pixi_consts = { path = "crates/pixi_consts" }
 pixi_core = { path = "crates/pixi_core" }
 pixi_default_versions = { path = "crates/pixi_default_versions" }
+pixi_diff = { path = "crates/pixi_diff" }
 pixi_git = { path = "crates/pixi_git" }
 pixi_glob = { path = "crates/pixi_glob" }
 pixi_global = { path = "crates/pixi_global" }

Cargo.toml

@@ -69,6 +69,7 @@ pixi_command_dispatcher = { workspace = true }
 pixi_config = { workspace = true }
 pixi_consts = { workspace = true }
 pixi_core = { workspace = true }
+pixi_diff = { workspace = true }
 pixi_git = { workspace = true }
 pixi_global = { workspace = true }
 pixi_manifest = { workspace = true, features = ["rattler_lock"] }

crates/pixi_cli/Cargo.toml

@@ -2,13 +2,12 @@ use clap::Parser;
 use miette::{Context, IntoDiagnostic};
 use pixi_core::{
     WorkspaceLocator,
-    diff::{LockFileDiff, LockFileJsonDiff},
     environment::LockFileUsage,
     lock_file::{LockFileDerivedData, UpdateLockFileOptions},
 };
+use pixi_diff::{LockFileDiff, LockFileJsonDiff};
 
 use crate::cli_config::NoInstallConfig;
-
 use crate::cli_config::WorkspaceConfig;
 
 /// Solve environment and update the lock file without installing the
@@ -54,7 +53,7 @@ pub async fn execute(args: Args) -> miette::Result<()> {
     // Format as json?
     if args.json {
         let diff = LockFileDiff::from_lock_files(&original_lock_file, &lock_file);
-        let json_diff = LockFileJsonDiff::new(Some(&workspace), diff);
+        let json_diff = LockFileJsonDiff::new(Some(workspace.named_environments()), diff);
         let json = serde_json::to_string_pretty(&json_diff).expect("failed to convert to json");
         println!("{}", json);
     } else if lock_updated {

crates/pixi_cli/src/lock.rs

@@ -6,14 +6,12 @@ use itertools::Itertools;
 use miette::{Context, IntoDiagnostic, MietteDiagnostic};
 use pixi_config::ConfigCli;
 use pixi_consts::consts;
+use pixi_core::WorkspaceLocator;
 use pixi_core::{
     Workspace,
     lock_file::{UpdateContext, filter_lock_file},
 };
-use pixi_core::{
-    WorkspaceLocator,
-    diff::{LockFileDiff, LockFileJsonDiff},
-};
+use pixi_diff::{LockFileDiff, LockFileJsonDiff};
 use pixi_manifest::EnvironmentName;
 use rattler_conda_types::Platform;
 use rattler_lock::{LockFile, LockedPackageRef};
@@ -182,7 +180,7 @@ pub async fn execute(args: Args) -> miette::Result<()> {
     // Format as json?
     if args.json {
         let diff = LockFileDiff::from_lock_files(loaded_lock_file, &lock_file);
-        let json_diff = LockFileJsonDiff::new(Some(&workspace), diff);
+        let json_diff = LockFileJsonDiff::new(Some(workspace.named_environments()), diff);
         let json = serde_json::to_string_pretty(&json_diff).expect("failed to convert to json");
         println!("{}", json);
     } else if diff.is_empty() {

crates/pixi_cli/src/update.rs

@@ -9,10 +9,10 @@ use pep508_rs::{MarkerTree, Requirement};
 use pixi_config::ConfigCli;
 use pixi_core::{
     WorkspaceLocator,
-    diff::{LockFileDiff, LockFileJsonDiff},
     lock_file::UpdateContext,
     workspace::{MatchSpecs, PypiDeps, WorkspaceMut},
 };
+use pixi_diff::{LockFileDiff, LockFileJsonDiff};
 use pixi_manifest::{FeatureName, SpecType};
 use pixi_pypi_spec::PixiPypiSpec;
 use pixi_spec::PixiSpec;
@@ -223,7 +223,8 @@ pub async fn execute(args: Args) -> miette::Result<()> {
                 .update()
                 .await?;
             let diff = LockFileDiff::from_lock_files(&original_lock_file, &derived.lock_file);
-            let json_diff = LockFileJsonDiff::new(Some(workspace.workspace()), diff);
+            let json_diff =
+                LockFileJsonDiff::new(Some(workspace.workspace().named_environments()), diff);
             let json = serde_json::to_string_pretty(&json_diff).expect("failed to convert to json");
             println!("{}", json);
             // Revert changes after computing the diff in dry-run mode.
@@ -233,7 +234,7 @@ pub async fn execute(args: Args) -> miette::Result<()> {
             let saved_workspace = workspace.save().await.into_diagnostic()?;
             let updated_lock_file = saved_workspace.load_lock_file().await?;
             let diff = LockFileDiff::from_lock_files(&original_lock_file, &updated_lock_file);
-            let json_diff = LockFileJsonDiff::new(Some(&saved_workspace), diff);
+            let json_diff = LockFileJsonDiff::new(Some(saved_workspace.named_environments()), diff);
             let json = serde_json::to_string_pretty(&json_diff).expect("failed to convert to json");
             println!("{}", json);
         }

crates/pixi_cli/src/upgrade.rs

@@ -12,7 +12,6 @@ version = "0.1.0"
 slow_integration_tests = []
 
 [dependencies]
-ahash = { workspace = true }
 async-once-cell = { workspace = true }
 barrier_cell = { workspace = true }
 chrono = { workspace = true }
@@ -40,6 +39,7 @@ pixi_command_dispatcher = { workspace = true }
 pixi_config = { workspace = true }
 pixi_consts = { workspace = true }
 pixi_default_versions = { workspace = true }
+pixi_diff = { workspace = true }
 pixi_git = { workspace = true }
 pixi_glob = { workspace = true }
 pixi_install_pypi = { workspace = true }

crates/pixi_core/Cargo.toml

@@ -1,7 +1,6 @@
 #![deny(clippy::dbg_macro, clippy::unwrap_used)]
 
 pub mod activation;
-pub mod diff;
 pub mod environment;
 pub mod lock_file;
 pub mod prompt;

crates/pixi_core/src/lib.rs

@@ -22,7 +22,6 @@ use std::{
 
 use crate::{
     activation::{CurrentEnvVarBehavior, initialize_env_variables},
-    diff::LockFileDiff,
     lock_file::filter_lock_file,
     repodata::Repodata,
 };
@@ -39,6 +38,7 @@ use pixi_build_frontend::BackendOverride;
 use pixi_command_dispatcher::{CacheDirs, CommandDispatcher, CommandDispatcherBuilder, Limits};
 use pixi_config::{Config, RunPostLinkScripts};
 use pixi_consts::consts;
+use pixi_diff::LockFileDiff;
 use pixi_manifest::{
     AssociateProvenance, BuildVariantSource, EnvironmentName, Environments, ExplicitManifestError,
     HasWorkspaceManifest, LoadManifestsError, ManifestProvenance, Manifests, PackageManifest,
@@ -441,6 +441,14 @@ impl Workspace {
             .collect()
     }
 
+    /// Returns a HashMap of environments in this project.
+    pub fn named_environments(&self) -> HashMap<EnvironmentName, Environment> {
+        self.environments()
+            .iter()
+            .map(|env| (env.name().clone(), env.clone()))
+            .collect()
+    }
+
     /// Returns an environment in this project based on a name or an environment
     /// variable.
     pub fn environment_from_name_or_env_var(

crates/pixi_core/src/workspace/mod.rs

@@ -15,6 +15,7 @@ use pixi_command_dispatcher::{
     CommandDispatcherError, MissingChannelError, SolvePixiEnvironmentError::MissingChannel,
 };
 use pixi_config::PinningStrategy;
+use pixi_diff::LockFileDiff;
 use pixi_manifest::{
     DependencyOverwriteBehavior, FeatureName, FeaturesExt, HasFeaturesIter, LoadManifestsError,
     ManifestDocument, ManifestKind, PypiDependencyLocation, SpecType, TomlError, WorkspaceManifest,
@@ -28,7 +29,6 @@ use toml_edit::DocumentMut;
 
 use crate::{
     Workspace,
-    diff::LockFileDiff,
     environment::LockFileUsage,
     lock_file::{LockFileDerivedData, ReinstallPackages, UpdateContext, UpdateMode},
     workspace::{