From d5b4e64fea360a13f86e8af67a5e2a7c559cb164 Mon Sep 17 00:00:00 2001
From: Ilya Grigoriev <ilyagr@users.noreply.github.com>
Date: Tue, 25 Jun 2024 22:20:18 -0700
Subject: [PATCH] conflicts: insert trailing newline when materializing
 conflicts

This happens for non-empty files only; the materialization code can
handle files and hunks with 0 or more lines, but each line should
terminate in a newline.

This is an imperfect fix to #3968, a better fix is TODO; see #3975.

This also implements `Merge::into_map` to avoid distracting iterations
and MergeBuilders. I could split it into a separate commit, but then
it'd have no uses.
---
 CHANGELOG.md                |  6 ++++++
 lib/src/conflicts.rs        | 13 +++++++++++++
 lib/tests/test_conflicts.rs | 24 ++++++++++++++++++++----
 3 files changed, 39 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index b26e7da4f56..99cc6690f25 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -58,6 +58,12 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 * `jj diff --git` no longer shows the contents of binary files.
 
+* Conflicts involving non-empty files that do not end in a newline no longer
+  look broken when materialized.
+  [#3968](https://github.com/martinvonz/jj/issues/3968). This is a partial fix,
+  see also [#3975](https://github.com/martinvonz/jj/issues/3968) which is not
+  yet fixed.
+
 ## [0.19.0] - 2024-07-03
 
 ### Breaking changes
diff --git a/lib/src/conflicts.rs b/lib/src/conflicts.rs
index 1ffd73ea1da..243ebbfd7c9 100644
--- a/lib/src/conflicts.rs
+++ b/lib/src/conflicts.rs
@@ -52,6 +52,8 @@ static CONFLICT_MARKER_REGEX: once_cell::sync::Lazy<Regex> = once_cell::sync::La
         .unwrap()
 });
 
+/// This function assumes that each hunk consists of 0 or more lines, each
+/// ending with a newline.
 fn write_diff_hunks(hunks: &[DiffHunk], file: &mut dyn Write) -> std::io::Result<()> {
     for hunk in hunks {
         match hunk {
@@ -217,6 +219,16 @@ pub fn materialize_merge_result(
     single_hunk: Merge<ContentHunk>,
     output: &mut dyn Write,
 ) -> std::io::Result<()> {
+    // The following code assumes that each version of the file contains 0 or
+    // more lines, each ending with `\n`. For now, we force this to be true.
+    // TODO(#3795): A better solution for this.
+    let single_hunk: Merge<ContentHunk> = single_hunk.into_map(|ContentHunk(mut side)| {
+        if !side.is_empty() && !side.ends_with(b"\n") {
+            side.push(b'\n');
+        };
+        ContentHunk(side)
+    });
+
     let slices = single_hunk.map(|content| content.0.as_slice());
     let merge_result = files::merge(&slices);
     match merge_result {
@@ -238,6 +250,7 @@ pub fn materialize_merge_result(
                     output.write_all(
                         format!(" Conflict {conflict_index} of {num_conflicts}\n").as_bytes(),
                     )?;
+
                     let mut add_index = 0;
                     for (base_index, left) in hunk.removes().enumerate() {
                         // The vast majority of conflicts one actually tries to
diff --git a/lib/tests/test_conflicts.rs b/lib/tests/test_conflicts.rs
index 79325b1e106..82b0224f799 100644
--- a/lib/tests/test_conflicts.rs
+++ b/lib/tests/test_conflicts.rs
@@ -345,15 +345,31 @@ fn test_materialize_conflict_no_newlines_at_eof() {
         @r###"
     <<<<<<< Conflict 1 of 1
     %%%%%%% Changes from base to side #1
-    -base+++++++ Contents of side #2
-    right>>>>>>> Conflict 1 of 1 ends
+    -base
+    +++++++ Contents of side #2
+    right
+    >>>>>>> Conflict 1 of 1 ends
     "###
     );
-    // BUG(#3968): These conflict markers cannot be parsed
+    // These conflict markers can be parsed (#3968)
+    // TODO(#3975): BUG: The result of the parsing has newlines where original files
+    // didn't.
     insta::assert_debug_snapshot!(parse_merge_result(
         materialized.as_bytes(),
         conflict.num_sides()
-    ),@"None");
+    ),@r###"
+    Some(
+        [
+            Conflicted(
+                [
+                    "",
+                    "base\n",
+                    "right\n",
+                ],
+            ),
+        ],
+    )
+    "###);
 }
 
 #[test]