feat(smartlog): Support for rendering a sparse smartlog

claytonrcarter · claytonrcarter · commit 4d355042a3d3 · 2022-11-08T22:49:01.000-05:00
This should only happen when the user has requested to render a specific
revset, as opposed to calling `smartlog` without any arguments, or when
any of the other commands trigger a call to `smartlog`.

Note that HEAD and the head of the main branch are always displayed,
regardless of the revset provided by the user.
diff --git a/git-branchless/src/commands/smartlog.rs b/git-branchless/src/commands/smartlog.rs
@@ -52,13 +52,20 @@ mod graph {
 
         /// The OID of the parent node in the smartlog commit graph.
         ///
-        /// This is different from inspecting `commit.parents()`,& since the smartlog
+        /// This is different from inspecting `commit.parents()`, since the smartlog
         /// will hide most nodes from the commit graph, including parent nodes.
         pub parent: Option<NonZeroOid>,
 
         /// The OIDs of the children nodes in the smartlog commit graph.
         pub children: Vec<NonZeroOid>,
 
+        /// Does this commit have any non-immediate, non-main branch ancestor
+        /// nodes in the smartlog commit graph?
+        pub has_ancestors: bool,
+
+        /// The OIDs of any non-immediate descendant nodes in the smartlog commit graph.
+        pub descendants: Vec<NonZeroOid>,
+
         /// Indicates that this is a commit to the main branch.
         ///
         /// These commits are considered to be immutable and should never leave the
@@ -80,6 +87,13 @@ mod graph {
         /// where you commit directly to the main branch and then later rewrite the
         /// commit.
         pub is_obsolete: bool,
+
+        /// Indicates that this commit has descendants, but that none of them
+        /// are included in the graph.
+        ///
+        /// This allows us to indicate this "false head" to the user. Otherwise,
+        /// this commit would look like a normal, descendant-less head.
+        pub is_false_head: bool,
     }
 
     /// Graph of commits that the user is working on.
@@ -111,31 +125,27 @@ mod graph {
         }
     }
 
-    /// Find additional commits that should be displayed.
+    /// Build the smartlog graph by finding additional commits that should be displayed.
     ///
     /// For example, if you check out a commit that has intermediate parent commits
     /// between it and the main branch, those intermediate commits should be shown
     /// (or else you won't get a good idea of the line of development that happened
     /// for this commit since the main branch).
     #[instrument]
-    fn walk_from_commits<'repo>(
+    fn build_graph<'repo>(
         effects: &Effects,
         repo: &'repo Repo,
         dag: &Dag,
-        active_heads: &CommitSet,
+        commits: &CommitSet,
     ) -> eyre::Result<SmartlogGraph<'repo>> {
         let mut graph: HashMap<NonZeroOid, Node> = {
             let mut result = HashMap::new();
-            for vertex in commit_set_to_vec(active_heads)? {
+            for vertex in commit_set_to_vec(commits)? {
                 let vertex = CommitSet::from(vertex);
                 let merge_bases = dag.query().gca_all(dag.main_branch_commit.union(&vertex))?;
-                let intermediate_commits = if merge_bases.is_empty()? {
-                    vertex
-                } else {
-                    dag.query().range(merge_bases, vertex)?
-                };
+                let vertices = vertex.union(&merge_bases);
 
-                for oid in commit_set_to_vec(&intermediate_commits)? {
+                for oid in commit_set_to_vec(&vertices)? {
                     let object = match repo.find_commit(oid)? {
                         Some(commit) => NodeObject::Commit { commit },
                         None => {
@@ -150,40 +160,103 @@ mod graph {
                             object,
                             parent: None,         // populated below
                             children: Vec::new(), // populated below
+                            has_ancestors: false,
+                            descendants: Vec::new(), // populated below
                             is_main: dag.is_public_commit(oid)?,
                             is_obsolete: dag.query_obsolete_commits().contains(&oid.into())?,
+                            is_false_head: false,
                         },
                     );
                 }
             }
             result
         };
 
-        // Find immediate parent-child links.
-        let links: Vec<(NonZeroOid, NonZeroOid)> = {
-            let non_main_node_oids =
-                graph.iter().filter_map(
-                    |(child_oid, node)| if !node.is_main { Some(child_oid) } else { None },
-                );
-
-            let mut links = Vec::new();
-            for child_oid in non_main_node_oids {
-                let parent_vertexes = dag.query().parents(CommitSet::from(*child_oid))?;
-                let parent_oids = commit_set_to_vec(&parent_vertexes)?;
-                for parent_oid in parent_oids {
-                    if graph.contains_key(&parent_oid) {
-                        links.push((*child_oid, parent_oid))
+        let mut immediate_links: Vec<(NonZeroOid, NonZeroOid)> = Vec::new();
+        let mut non_immediate_links: Vec<(NonZeroOid, NonZeroOid)> = Vec::new();
+
+        let non_main_node_oids =
+            graph
+                .iter()
+                .filter_map(|(child_oid, node)| if !node.is_main { Some(child_oid) } else { None });
+
+        let graph_vertices: CommitSet = graph.keys().cloned().collect();
+        for child_oid in non_main_node_oids {
+            let parent_vertices = dag.query().parents(CommitSet::from(*child_oid))?;
+
+            // Find immediate parent-child links.
+            let parents_in_graph = parent_vertices.intersection(&graph_vertices);
+            let parent_oids = commit_set_to_vec(&parents_in_graph)?;
+            for parent_oid in parent_oids {
+                immediate_links.push((*child_oid, parent_oid))
+            }
+
+            if parent_vertices.count()? != parents_in_graph.count()? {
+                // Find non-immediate ancestor links.
+                let excluded_parents = parent_vertices.difference(&graph_vertices);
+                let excluded_parent_oids = commit_set_to_vec(&excluded_parents)?;
+                for parent_oid in excluded_parent_oids {
+                    // Find the nearest ancestor that is included in the graph and
+                    // also on the same branch.
+
+                    let parent_set = CommitSet::from(parent_oid);
+                    let merge_base = dag
+                        .query()
+                        .gca_one(dag.main_branch_commit.union(&parent_set))?;
+
+                    let path_to_main_branch = match merge_base {
+                        Some(merge_base) => {
+                            dag.query().range(CommitSet::from(merge_base), parent_set)?
+                        }
+                        None => CommitSet::empty(),
+                    };
+                    let nearest_branch_ancestor = dag
+                        .query()
+                        .heads_ancestors(path_to_main_branch.intersection(&graph_vertices))?;
+
+                    let ancestor_oids = commit_set_to_vec(&nearest_branch_ancestor)?;
+                    for ancestor_oid in ancestor_oids.iter() {
+                        non_immediate_links.push((*ancestor_oid, *child_oid));
                     }
                 }
             }
-            links
-        };
+        }
 
-        for (child_oid, parent_oid) in links.iter() {
+        for (child_oid, parent_oid) in immediate_links.iter() {
             graph.get_mut(child_oid).unwrap().parent = Some(*parent_oid);
             graph.get_mut(parent_oid).unwrap().children.push(*child_oid);
         }
 
+        for (ancestor_oid, descendent_oid) in non_immediate_links.iter() {
+            graph.get_mut(descendent_oid).unwrap().has_ancestors = true;
+            graph
+                .get_mut(ancestor_oid)
+                .unwrap()
+                .descendants
+                .push(*descendent_oid);
+        }
+
+        for (oid, node) in graph.iter_mut() {
+            let oid_set = CommitSet::from(*oid);
+            let is_main_head = !dag.main_branch_commit.intersection(&oid_set).is_empty()?;
+            let ancestor_of_main = node.is_main && !is_main_head;
+            let has_descendants_in_graph =
+                !node.children.is_empty() || !node.descendants.is_empty();
+
+            if ancestor_of_main || has_descendants_in_graph {
+                continue;
+            }
+
+            // This node has no descendants in the graph, so it's a
+            // false head if it has *any* (non-obsolete) children.
+            let children_not_in_graph = dag
+                .query()
+                .children(oid_set)?
+                .difference(&dag.query_obsolete_commits());
+
+            node.is_false_head = !children_not_in_graph.is_empty()?;
+        }
+
         Ok(SmartlogGraph { nodes: graph })
     }
 
@@ -224,11 +297,16 @@ mod graph {
         let mut graph = {
             let (effects, _progress) = effects.start_operation(OperationType::WalkCommits);
 
-            for oid in commit_set_to_vec(commits)? {
+            // HEAD and main head must be included
+            let commits = commits
+                .union(&dag.head_commit)
+                .union(&dag.main_branch_commit);
+
+            for oid in commit_set_to_vec(&commits)? {
                 mark_commit_reachable(repo, oid)?;
             }
 
-            walk_from_commits(&effects, repo, dag, commits)?
+            build_graph(&effects, repo, dag, &commits)?
         };
         sort_children(&mut graph);
         Ok(graph)
@@ -237,6 +315,7 @@ mod graph {
 
 mod render {
     use std::cmp::Ordering;
+    use std::collections::HashSet;
     use std::convert::TryFrom;
 
     use cursive::theme::Effect;
@@ -270,7 +349,16 @@ mod render {
         let mut root_commit_oids: Vec<NonZeroOid> = graph
             .nodes
             .iter()
-            .filter(|(_oid, node)| node.parent.is_none())
+            .filter(|(_oid, node)| {
+                // Common case: on main w/ no parents in graph, eg a merge base
+                node.parent.is_none() && node.is_main ||
+                    // Pathological cases: orphaned, garbage collected, etc
+                    node.parent.is_none()
+                        && !node.is_main
+                        && node.children.is_empty()
+                        && node.descendants.is_empty()
+                        && !node.has_ancestors
+            })
             .map(|(oid, _node)| oid)
             .copied()
             .collect();
@@ -337,7 +425,13 @@ mod render {
             (true, true, true) => glyphs.commit_main_obsolete_head,
         };
 
-        let first_line = {
+        let mut lines = vec![];
+
+        if current_node.has_ancestors {
+            lines.push(StyledString::plain(glyphs.vertical_ellipsis.to_string()));
+        };
+
+        lines.push({
             let mut first_line = StyledString::new();
             first_line.append_plain(cursor);
             first_line.append_plain(" ");
@@ -347,36 +441,50 @@ mod render {
             } else {
                 first_line
             }
+        });
+
+        if current_node.is_false_head {
+            lines.push(StyledString::plain(glyphs.vertical_ellipsis.to_string()));
         };
 
-        let mut lines = vec![first_line];
         let children: Vec<_> = current_node
             .children
             .iter()
             .filter(|child_oid| graph.nodes.contains_key(child_oid))
             .copied()
             .collect();
-        for (child_idx, child_oid) in children.iter().enumerate() {
+        let descendants: HashSet<_> = current_node
+            .descendants
+            .iter()
+            .filter(|descendent_oid| graph.nodes.contains_key(descendent_oid))
+            .copied()
+            .collect();
+        for (child_idx, child_oid) in children.iter().chain(descendants.iter()).enumerate() {
             if root_oids.contains(child_oid) {
                 // Will be rendered by the parent.
                 continue;
             }
 
-            if child_idx == children.len() - 1 {
+            let is_last_child = child_idx == (children.len() + descendants.len()) - 1;
+            if is_last_child {
                 let line = match last_child_line_char {
-                    Some(_) => StyledString::plain(format!(
+                    Some(_) => Some(StyledString::plain(format!(
                         "{}{}",
                         glyphs.line_with_offshoot, glyphs.slash
-                    )),
-
-                    None => StyledString::plain(glyphs.line.to_string()),
+                    ))),
+                    None if current_node.descendants.is_empty() => {
+                        Some(StyledString::plain(glyphs.line.to_string()))
+                    }
+                    None => None,
                 };
-                lines.push(line)
+                if let Some(line) = line {
+                    lines.push(line);
+                }
             } else {
                 lines.push(StyledString::plain(format!(
                     "{}{}",
                     glyphs.line_with_offshoot, glyphs.slash
-                )))
+                )));
             }
 
             let child_output = get_child_output(
@@ -389,7 +497,7 @@ mod render {
                 None,
             )?;
             for child_line in child_output {
-                let line = if child_idx == children.len() - 1 {
+                let line = if is_last_child {
                     match last_child_line_char {
                         Some(last_child_line_char) => StyledStringBuilder::new()
                             .append_plain(format!("{} ", last_child_line_char))
@@ -399,7 +507,14 @@ mod render {
                     }
                 } else {
                     StyledStringBuilder::new()
-                        .append_plain(format!("{} ", glyphs.line))
+                        .append_plain(format!(
+                            "{} ",
+                            if !current_node.descendants.is_empty() {
+                                glyphs.vertical_ellipsis
+                            } else {
+                                glyphs.line
+                            }
+                        ))
                         .append(child_line)
                         .build()
                 };
@@ -453,13 +568,10 @@ mod render {
             let last_child_line_char = {
                 if root_idx == root_oids.len() - 1 {
                     None
+                } else if has_real_parent(root_oids[root_idx + 1], *root_oid)? {
+                    Some(glyphs.line)
                 } else {
-                    let next_root_oid = root_oids[root_idx + 1];
-                    if has_real_parent(next_root_oid, *root_oid)? {
-                        Some(glyphs.line)
-                    } else {
-                        Some(glyphs.vertical_ellipsis)
-                    }
+                    Some(glyphs.vertical_ellipsis)
                 }
             };
 
@@ -508,8 +620,8 @@ mod render {
         /// as an offset from the current event.
         pub event_id: Option<isize>,
 
-        /// The commits to render. These commits and their ancestors up to the
-        /// main branch will be rendered.
+        /// The commits to render. These commits, plus any related commits, will
+        /// be rendered.
         pub revset: Revset,
 
         pub resolve_revset_options: ResolveRevsetOptions,
diff --git a/git-branchless/src/opts.rs b/git-branchless/src/opts.rs
@@ -460,8 +460,8 @@ pub enum Command {
         #[clap(value_parser, long = "event-id")]
         event_id: Option<isize>,
 
-        /// The commits to render. These commits and their ancestors up to the
-        /// main branch will be rendered.
+        /// The commits to render. These commits, plus any related commits, will
+        /// be rendered.
         #[clap(value_parser)]
         revset: Option<Revset>,
 
diff --git a/git-branchless/tests/command/test_smartlog.rs b/git-branchless/tests/command/test_smartlog.rs
