From cdc972499eafeac548f6a6d106ae4b6eec1165b5 Mon Sep 17 00:00:00 2001
From: lucasholten <lucasholten@dreamsolution.nl>
Date: Thu, 2 Jan 2025 15:50:51 +0100
Subject: [PATCH] Automatically sort crate graph

---
 crates/base-db/src/input.rs       | 16 +++++++---------
 crates/project-model/src/tests.rs |  2 --
 2 files changed, 7 insertions(+), 11 deletions(-)

diff --git a/crates/base-db/src/input.rs b/crates/base-db/src/input.rs
index b263e7382d..a0fc8c31ea 100644
--- a/crates/base-db/src/input.rs
+++ b/crates/base-db/src/input.rs
@@ -490,19 +490,11 @@ impl CrateGraph {
         }
     }
 
-    pub fn sort_deps(&mut self) {
-        self.arena
-            .iter_mut()
-            .for_each(|(_, data)| data.dependencies.sort_by_key(|dep| dep.crate_id));
-    }
-
     /// Extends this crate graph by adding a complete second crate
     /// graph and adjust the ids in the [`ProcMacroPaths`] accordingly.
     ///
     /// This will deduplicate the crates of the graph where possible.
-    /// Note that for deduplication to fully work, `self`'s crate dependencies must be sorted by crate id.
-    /// If the crate dependencies were sorted, the resulting graph from this `extend` call will also
-    /// have the crate dependencies sorted.
+    /// Furthermore dependencies are sorted by crate id to make deduplication easier.
     ///
     /// Returns a map mapping `other`'s IDs to the new IDs in `self`.
     pub fn extend(
@@ -510,6 +502,12 @@ impl CrateGraph {
         mut other: CrateGraph,
         proc_macros: &mut ProcMacroPaths,
     ) -> FxHashMap<CrateId, CrateId> {
+        // Sorting here is a bit pointless because the input is likely already sorted.
+        // However, the overhead is small and it makes the `extend` method harder to misuse.
+        self.arena
+            .iter_mut()
+            .for_each(|(_, data)| data.dependencies.sort_by_key(|dep| dep.crate_id));
+
         let m = self.len();
         let topo = other.crates_in_topological_order();
         let mut id_map: FxHashMap<CrateId, CrateId> = FxHashMap::default();
diff --git a/crates/project-model/src/tests.rs b/crates/project-model/src/tests.rs
index 74d4143605..8bb130433a 100644
--- a/crates/project-model/src/tests.rs
+++ b/crates/project-model/src/tests.rs
@@ -232,7 +232,6 @@ fn rust_project_is_proc_macro_has_proc_macro_dep() {
 #[test]
 fn crate_graph_dedup_identical() {
     let (mut crate_graph, proc_macros) = load_cargo("regex-metadata.json");
-    crate_graph.sort_deps();
 
     let (d_crate_graph, mut d_proc_macros) = (crate_graph.clone(), proc_macros.clone());
 
@@ -253,7 +252,6 @@ fn crate_graph_dedup() {
     let (regex_crate_graph, mut regex_proc_macros) = to_crate_graph(regex_workspace, &mut file_map);
     assert_eq!(regex_crate_graph.iter().count(), 50);
 
-    crate_graph.sort_deps();
     crate_graph.extend(regex_crate_graph, &mut regex_proc_macros);
     assert_eq!(crate_graph.iter().count(), 108);
 }