Skip to main content

gitoxide_core/repository/merge/
tree.rs

1use crate::OutputFormat;
2
3pub struct Options {
4    pub format: OutputFormat,
5    pub file_favor: Option<gix::merge::tree::FileFavor>,
6    pub tree_favor: Option<gix::merge::tree::TreeFavor>,
7    pub in_memory: bool,
8    pub debug: bool,
9    pub message: Option<String>,
10    pub update_head: bool,
11}
12
13pub(super) mod function {
14
15    use std::collections::BTreeSet;
16
17    use anyhow::{Context, anyhow, bail};
18    use gix::{
19        bstr::{BString, ByteSlice},
20        merge::tree::TreatAsUnresolved,
21        prelude::Write,
22    };
23
24    use super::Options;
25    use crate::OutputFormat;
26
27    pub fn tree(
28        mut repo: gix::Repository,
29        out: &mut dyn std::io::Write,
30        err: &mut dyn std::io::Write,
31        base: BString,
32        ours: BString,
33        theirs: BString,
34        Options {
35            format,
36            file_favor,
37            tree_favor,
38            in_memory,
39            debug,
40            message,
41            update_head,
42        }: Options,
43    ) -> anyhow::Result<()> {
44        if format != OutputFormat::Human {
45            bail!("JSON output isn't implemented yet");
46        }
47        if update_head && in_memory {
48            bail!("`--update-head` cannot be used with `--in-memory` - cannot set head to nothing");
49        }
50        if update_head && message.is_none() {
51            bail!("`--update-head` requires `--message`");
52        }
53        repo.object_cache_size_if_unset(repo.compute_object_cache_size_for_tree_diffs(&**repo.index_or_empty()?));
54        if in_memory || message.is_some() {
55            repo.objects.enable_object_memory();
56        }
57        let (base_ref, base_id) = refname_and_tree(&repo, base)?;
58        let (ours_ref, ours_id) = refname_and_tree(&repo, ours)?;
59        let (theirs_ref, theirs_id) = refname_and_tree(&repo, theirs)?;
60
61        let options = repo
62            .tree_merge_options()?
63            .with_file_favor(file_favor)
64            .with_tree_favor(tree_favor);
65        let base_id_str = base_id.to_string();
66        let ours_id_str = ours_id.to_string();
67        let theirs_id_str = theirs_id.to_string();
68        let labels = gix::merge::blob::builtin_driver::text::Labels {
69            ancestor: base_ref
70                .as_ref()
71                .map_or(base_id_str.as_str().into(), |n| n.as_bstr())
72                .into(),
73            current: ours_ref
74                .as_ref()
75                .map_or(ours_id_str.as_str().into(), |n| n.as_bstr())
76                .into(),
77            other: theirs_ref
78                .as_ref()
79                .map_or(theirs_id_str.as_str().into(), |n| n.as_bstr())
80                .into(),
81        };
82        let res = repo.merge_trees(base_id, ours_id, theirs_id, labels, options)?;
83        let has_conflicts = !res.conflicts.is_empty();
84        let has_unresolved_conflicts = res.has_unresolved_conflicts(TreatAsUnresolved::default());
85        if message.is_some() && has_unresolved_conflicts {
86            write_unresolved_conflict_paths(err, &res.conflicts)?;
87            if debug {
88                writeln!(err, "{:#?}", res.conflicts)?;
89            }
90            bail!("Tree conflicted, refusing to write commit");
91        }
92
93        let tree_id = {
94            let _span = gix::trace::detail!("Writing merged tree");
95            let mut written = 0;
96            let tree_id = res
97                .tree
98                .detach()
99                .write(|tree| {
100                    written += 1;
101                    repo.write(tree)
102                })
103                .map_err(|err| anyhow!("{err}"))?;
104            writeln!(out, "{tree_id} (wrote {written} trees)")?;
105            tree_id
106        };
107
108        let conflicts = res.conflicts;
109        if message.is_some() && !in_memory {
110            persist_in_memory_objects(&mut repo)?;
111        }
112
113        if let Some(message) = message {
114            let head_id = repo.head_id()?;
115            let commit_id = if update_head {
116                let commit_id = repo.commit("HEAD", message, tree_id, Some(head_id))?;
117                let mut index = repo.index_from_tree(&tree_id)?;
118                index.write(Default::default())?;
119                commit_id
120            } else {
121                repo.new_commit(message, tree_id, Some(head_id))?.id()
122            };
123            writeln!(out, "{commit_id} (commit)")?;
124            return Ok(());
125        }
126
127        if debug {
128            writeln!(err, "{conflicts:#?}")?;
129        }
130        if has_conflicts {
131            writeln!(err, "{} possibly resolved conflicts", conflicts.len())?;
132        }
133        if has_unresolved_conflicts {
134            bail!("Tree conflicted")
135        }
136        Ok(())
137    }
138
139    fn persist_in_memory_objects(repo: &mut gix::Repository) -> anyhow::Result<()> {
140        let objects = repo.objects.take_object_memory().expect("always write in memory first");
141        for (_id, (kind, data)) in objects.iter() {
142            repo.write_buf(*kind, data).map_err(|err| anyhow!("{err}"))?;
143        }
144        Ok(())
145    }
146
147    fn write_unresolved_conflict_paths(
148        err: &mut dyn std::io::Write,
149        conflicts: &[gix::merge::tree::Conflict],
150    ) -> std::io::Result<()> {
151        let how = TreatAsUnresolved::default();
152        let mut paths = BTreeSet::new();
153        for conflict in conflicts.iter().filter(|conflict| conflict.is_unresolved(how)) {
154            let (ours, theirs) = conflict.changes_in_resolution();
155            for path in [
156                ours.source_location(),
157                ours.location(),
158                theirs.source_location(),
159                theirs.location(),
160            ] {
161                if !path.is_empty() {
162                    paths.insert(path);
163                }
164            }
165        }
166        for path in paths {
167            err.write_all(path.as_ref())?;
168            err.write_all(b"\n")?;
169        }
170        Ok(())
171    }
172
173    fn refname_and_tree(
174        repo: &gix::Repository,
175        revspec: BString,
176    ) -> anyhow::Result<(Option<BString>, gix::hash::ObjectId)> {
177        let spec = repo.rev_parse(revspec.as_bstr())?;
178        let tree_id = spec
179            .single()
180            .context("Expected revspec to expand to a single rev only")?
181            .object()?
182            .peel_to_tree()?
183            .id;
184        let refname = spec.first_reference().map(|r| r.name.shorten().as_bstr().to_owned());
185        Ok((refname, tree_id))
186    }
187}