Improve direct dependents (#44)

* Add node and edge id to dependent * Update CHANGELOG * Fix lint
EmbarkStudios · Oct 25, 2022 · c174633 · c174633
1 parent 8a8b1cc
commit c174633
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- next-header -->
 ## [Unreleased] - ReleaseDate
+### Added
+- [PR#43](https://github.com/EmbarkStudios/krates/pull/43) and [PR#44](https://github.com/EmbarkStudios/krates/pull/44) added `Krates::direct_dependents` to more easily obtain the crates that directly depend on the specified crate/node, regardless of any features in between those crates.
+
 ## [0.12.0] - 2022-10-06
 ### Added
 - [PR#42](https://github.com/EmbarkStudios/krates/pull/42) added support for features, adding nodes for each unique future, and linking edges between dependencies and features themselves. This (hopefully) properly takes into account the existing ways of pruning the graph via targets, exclusions etc. It also allows the retrieval of that final feature set via `Krates::get_enabled_features`.

diff --git a/src/lib.rs b/src/lib.rs
@@ -272,7 +272,7 @@ impl<N, E> Krates<N, E> {
 
     /// Gets the crates that have a direct dependency on the specified node
     #[inline]
-    pub fn direct_dependents(&self, nid: NodeId) -> Vec<&N> {
+    pub fn direct_dependents(&self, nid: NodeId) -> Vec<DirectDependent<'_, N>> {
         let graph = self.graph();
         let mut direct_dependencies = Vec::new();
         let mut stack = vec![nid];
@@ -283,11 +283,15 @@ impl<N, E> Krates<N, E> {
                 match &self.graph[edge.source()] {
                     Node::Krate { krate, .. } => {
                         if visited.insert(edge.source()) {
-                            direct_dependencies.push(krate);
+                            direct_dependencies.push(DirectDependent {
+                                krate,
+                                node_id: edge.source(),
+                                edge_id: edge.id(),
+                            });
                         }
                     }
                     Node::Feature { krate_index, .. } => {
-                        if *krate_index == nid {
+                        if *krate_index == nid && visited.insert(edge.source()) {
                             stack.push(edge.source());
                         }
                     }
@@ -361,6 +365,16 @@ impl<N, E> Krates<N, E> {
     }
 }
 
+/// A crate that has a direct dependency on another crate
+pub struct DirectDependent<'krates, N> {
+    /// The crate in the node
+    pub krate: &'krates N,
+    /// The crate's node id
+    pub node_id: NodeId,
+    /// The edge that links the crate with the dependency
+    pub edge_id: EdgeId,
+}
+
 /// A trait that can be applied to the type stored in the graph nodes to give
 /// additional features on `Krates`.
 pub trait KrateDetails {

diff --git a/tests/misc.rs b/tests/misc.rs
@@ -150,7 +150,7 @@ fn direct_dependents() {
         .direct_dependents(grafs.actual.nid_for_kid(&id.0).unwrap())
         .into_iter()
         .fold(String::new(), |mut acc, jid| {
-            acc.push_str(&jid.0.repr);
+            acc.push_str(&jid.krate.0.repr);
             acc.push('\n');
             acc
         });